Cisco Intercloud Fabric for Provider Administrator Guide, Release 3.1.1

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Book Contents
Find Matches in This Book
Available Languages
Download Options

Book Title

Cisco Intercloud Fabric for Provider Administrator Guide, Release 3.1.1

Chapter Title

Service Provider APIs

Results

Updated:
July 28, 2016

Chapter: Service Provider APIs

Service Provider APIs

Supported Protocols and Formats

The Cisco ICFP APIs are compatible with any HTTPS browser and use code formatted in XML.

Recommended Tools

The Cisco ICFP APIs use HTTPS. You can use any compatible browser or client with user account access to submit requests to the Cisco ICFP API. Most programming languages have built-in or open source libraries that provide REST API access and XML parsing.

To test the APIs, we recommend that you use the Mozilla Firefox RESTClient add-on, which provides useful options for parsing and viewing API requests and responses. For more information, see https:/​/​addons.mozilla.org/​En-us/​firefox/​addon/​restclient/​.

Login

Description

Enables a user to log in to Cisco ICFP. Use an administrator account to provision a cloud or tenant.

Resource URL

URL Type

Value

Resource URL /capi/v1/login
Sample URL https://myserver/capi/v1/login

HTTP Methods

Method

Description

POST

Logs a user in to Cisco ICFP and returns the session key value pair that is used to form the header for subsequent requests.

Request Body

<GetKeys username='admin' password='abc123' expiration='90' />

Response

Status

Response

200

User is authenticated. 

<GetKeys status="valid" value="A6665E4664FD416EA903774A5103D760" name="X-Capi-Request" 
username="admin" />

400

Invalid input.

403

Account login failed.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

GetKeys

username

Use the username admin to log in through the administrator account. This username is used only for the service provider APIs.

Use username@tenant to log in through a tenant account.

The tenant username is the same string that was provisioned by the service provider. This username is expected to be passed by the service provider to the Cisco Intercloud Fabric administrator on the customer portal.

String

Mandatory

password

The password that is associated with the specified account.

String

Mandatory

expiration

The length of time in minutes after which a new key must be requested. The maximum allowed time is 1440 minutes (24 hours).

String

Mandatory

Cloud Instance Management APIs

Cisco ICFP provides APIs that can manage cloud instances. A cloud instance is a unique identifier that binds the back-end cloud URI to a southbound adapter installed by the service provider. Multiple back-end URIs can have multiple cloud instances. A tenant is a part of a single cloud instance.

Provision Cloud Instance

Description

Provisions a cloud instance. The caller must save the response cloud instance ID to make subsequent modifications to the cloud instance, such as a URI change.

Resource URL

URL Type

Value

Resource URL

/capi/v1/cloudinstances

Sample URL

https://myserver/capi/v1/cloudinstances

HTTP Methods

Method

Description

POST

Creates a new cloud instance.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

<CloudInstances instanceName="mycloud" type="cisco" moduleName="CSP" >
    <CloudCredentials endpointURI="http://csserver:8080/client/api" />
</CloudInstances>

The following example shows a request for an OpenStack cloud that uses a group-based policy framework: 

<CloudInstances instanceName="juno-aci-gbp" moduleName="OSP" type="Cisco"> 
    <CloudCredentials endpointURI="http://10.193.180.230:5000/v3"/>
    <ParameterList> 
        <Parameter name="imageConversionSupportOnCloud" value="NO"/> 
        <Parameter name="firstBootImageConversion" value="NO"/>

Response

Status

Response

201

Cloud instance is created. 

<CloudInstances status="ACTIVE" instanceName="mycloud" 
cloudId="a7e4a384-afb8-418e-a958-a978496fa95c"/>

400

Invalid input.

401

Resource not authorized.

401

User is not allowed to perform this operation.

403

Cloud instance instance-name already exists.

403

Required fields error.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

CloudInstances

instanceName

A unique name that binds a moduleName to a back-end cloud URI address. This name is used when provisioning a new tenant.

String

Mandatory

type

The following values are valid:

  • custom—Third-party developed plugin.

  • cisco—The plugin that is part of the current Cisco delivery.

The type attribute also ensures that the moduleName is unique in the system.

String

Mandatory

moduleName

A unique string that maps a plugin to Cisco ICFP. This name must be the same name by which the plugin has been developed as a prefix for all code and classes. Supported names are CSP and VCDP.

String

Mandatory

CloudCredentials

CloudCredentials tag inside the CloudInstances tag.

Mandatory

endpointURI

The endpoint for the cloud provider server. The value can be an IP address, hostname, or URI.

String

Mandatory

ParameterList

ParameterList tag inside CloudInstances tag. This tag allows an API user to pass additional parameters.

Optional

Parameter

Parameter tag under ParameterList tag.

Optional

name

Parameter name. For a Cisco Intercloud Services – V cloud, a parameter with the name ftpservername must be passed in ParameterList.

String

Optional

value

Parameter value.

String

Optional

 

name

For an OpenStack cloud, the following parameters can be passed:

  • imageConversionSupportOnCloud

  • firstBootImageConversion

  • isGroupBasePolicyEnabled

  • isKeyStoneV3APIEnabled

  • isBootfromVolumeEnabled

String

Optional
 

value

Values:

  • Yes or No for imageConversionSupportOnCloud and firstBootImageConversion. If a value is not provided, the value is set to No.

  • True or False for isGroupBasedPolicyEnabled, isKeyStoneV3APIEnabled, and isBootfromVolumeEnabled. If a value is not provided, the value is set to False.

String

Optional

Update Cloud Instance

Description

Updates the endpoint URI of a cloud instance.

Resource URL

URL Type

Value

Resource URL

/capi/v1/cloudinstances/cloudId

Sample URL

https://myserver/capi/v1/cloudinstances/a7e4a384-afb8-418e-a958-a978496fa95c

HTTP Methods

Method

Description

PUT

Updates an existing cloud instance.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

<CloudInstances>
    <CloudCredentials endpointURI="http://newcsserver:8080/client/api" />
</CloudInstances>

Response

Status

Response

200

Cloud instance is updated. 

<CloudInstances status="ACTIVE" instanceName="mycloud" 
cloudId="a7e4a384-afb8-418e-a958-a978496fa95c"/>

400

Invalid input.

401

Resource not authorized.

401

User is not allowed to perform this operation.

403

Required fields error.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

CloudCredentials

CloudCredentials tag inside CloudInstances tag.

Mandatory

endpointURI

The endpoint to reach the cloud provider server. The value can be an IP address, hostname, or URI.

String

Mandatory

ParameterList

ParameterList tag inside CloudInstances tag. This tag allows the API user to pass additional parameters.

Optional

Parameter

Parameter tag under the ParameterList tag.

Optional

name

Parameter name.

String

Optional

value

Parameter value.

String

Optional

Get Cloud Instance

Description

Retrieves the details of the specified cloud instance. The cloud identifier is obtained as part of creating a cloud instance.

Resource URL

URL Type

Value

Resource URL

/capi/v1/cloudinstances/cloudId

Sample URL

https://myserver/capi/v1/cloudinstances/a7e4a384-afb8-418e-a958-a978496fa95c

HTTP Methods

Method

Description

GET

Queries the specified cloud instance.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<CloudInstances moduleName="CSP" type="CISCO" 
instanceName="mycloud" cloudId="a7e4a384-afb8-418e-a958-a978496fa95c "/>

The following example shows a response for an OpenStack cloud using a group-based policy framework and Keystone V3 Identity service: 

<CloudInstances cloudId="91fbd62f-9204-a343-13e1-927e81691099"
instanceName="juno-aci-gbp" type="CISCO" moduleName="OSP">
  <CloudCredentials endpointURI="http://10.193.180.230:5000/v3"/>
    <ParameterList>
       <Parameter name="imageConversionSupportOnCloud" value="NO"/>
       <Parameter name="firstBootImageConversion" value="NO"/>
       <Parameter name="isGroupBasePolicyEnabled" value="true"/>
       <Parameter name="isKeyStoneV3APIEnabled" value="true"/>
    </ParameterList>
</CloudInstances>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

500

Internal server error.

Get All Cloud Instances

Description

Retrieves a list of all cloud instances provisioned on Cisco ICFP.

Resource URL

URL Type

Value

Resource URL

/capi/v1/cloudinstances

Sample URL

https://myserver/capi/v1/cloudinstances

HTTP Methods

Method

Description

GET

Returns a list of all cloud instances.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<CloudInstancesList>
    <CloudInstances 
     moduleName="CSP" 
     type="CISCO"
     instanceName="mycloud" 
     cloudId="a7e4a384-afb8-418e-a958-a978496fa95c" />
    <CloudInstances
     moduleName="OSP"
     type="CISCO"
     instanceName="ci2" 
     cloudId="baaffdf95-4dd6-5103-0db2-ab3cd8dfca65" />
</CloudInstancesList>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

500

Internal server error.

Delete Cloud Instance

Description

Deletes a cloud instance. A cloud instance cannot be deleted if one or more tenants are associated with it.

Resource URL

URL Type

Value

Resource URL

/capi/v1/cloudinstances/cloudId

Sample URL

https://myserver/capi/v1/cloudinstances/a7e4a384-afb8-418e-a958-a978496fa95c

HTTP Methods

Method

Description

DELETE

Deletes an existing cloud instance.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200

Cloud instance is deleted. 

<CloudInstances status="DELETED" cloudId="a7e4a384-afb8-418e-a958-a978496fa95c"/>

401

Resource is not authorized.

401

User is not allowed to perform this operation.

403

Cannot delete. One or more tenants are associated with the cloud instance.

500

Internal server error.

Database Management APIs

Cisco ICFP provides APIs that enable you to back up and restore the Cisco ICFP database.

Post Database Backup

Description

Creates a database backup set.

Resource URL

URL Type

Value

Resource URL

/capi/v1/dbbackup

Sample URL

https://myserver/capi/v1/dbbackup

HTTP Methods

Method

Description

POST

Takes a database backup.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

<DBBackup name="test-db-backup" protocol="ftp" destinationIP="10.36.21.213" user="root" 
password=”xyz123” destinationFolder="/home/host/" destinationFile=”database_backup.tar.gz” startManual="true" />

Response

Status

Response

200

Database backup is started. 

<DBBackup id="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”In-Progress” />

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

403

Required field error.

403

Database backup field validation error.

403

Database backup is already running.

403

Database backup is not supported. Database backups are supported only on standalone and primary nodes.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

DBBackup

name

A unique name for the database backup.

String

Mandatory

protocol

Protocol to use for the backup. Allowed protocol: FTP.

String

Mandatory

destinationIP

IP address of the location where the backup file is to be stored.

String

Mandatory

user

Username for accessing the destination IP address.

String

Mandatory

password

Password for accessing the destination IP address.

String

Mandatory

destinationFolder

Directory location in which to place the backup file. If no location is specified, the file is placed in the root directory.

String

Optional

destinationFile

Filename to use for the database backup file. If no name is specified, the filename database_backup.tar.gz is used.

String

Optional

startManual

Set to true for a one-time backup. Scheduling multiple backups is not supported.

String

Mandatory

frequency

The frequency of backups if scheduling multiple backups: Daily, Weekly, or Monthly. Scheduling multiple backups is not supported.

String

Optional

Get Database Backup

Description

Retrieves the status of the database backup with the specified ID.

Resource URL

URL Type

Value

Resource URL

/capi/v1/dbbackup/{backupId}

Sample URL

https://myserver/capi/v1/dbbackup/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4

HTTP Methods

Method

Description

GET

Returns the database backup details.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<DBBackup name="test-db-backup" protocol="ftp" destinationIP="10.36.21.213" 
user="root" destinationFolder="/home/host/" destinationFile=”database_backup.tar.gz” 
status=”Completed” />

Post Database Restore

Description

Restores the database from the specified backup file.

Resource URL

URL Type

Value

Resource URL

/capi/v1/dbrestore

Sample URL

https://myserver/capi/v1/dbrestore

HTTP Methods

Method

Description

POST

Restores the database.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

<DBRestore name="test-db-backup" protocol="ftp" remoteIp="10.36.21.213" user="root" 
password=”xyz123” remoteFolder="/home/host/" remoteDBFile="database_backup.tar.gz"/>

Response

Status

Response

201

The database is being restored. 

<DBRestore id="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”In-Progress” />

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

403

Required field error.

403

Database restore field validation error.

403

The database restore operation is already running.

403

Database restore is not supported. Database restores are supported only on standalone and primary nodes.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

DBRestore

name

A unique name associated with the database to restore.

String

Mandatory

protocol

Protocol to use for the restore operation. Allowed protocol: FTP.

String

Mandatory

remoteIp

IP address of the location where the file to restore resides.

String

Mandatory

user

Username for accessing the destination IP address.

String

Mandatory

password

Password for accessing the destination IP address.

String

Mandatory

remoteFolder

Directory in which the restore file resides. If no location is specified, the file is placed in the root directory.

String

Optional

remoteDBFile

Name of the database restore file. If no name is specified, the filename database_backup.tar.gz is used.

String

Optional

Get Database Restore

Description

Retrieves the status of the specified database restore operation.

Resource URL

URL Type

Value

Resource URL

/capi/v1/dbrestore/{restoreId}

Sample URL

https://myserver/capi/v1/dbrestore/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4

HTTP Methods

Method

Description

GET

Retrieves the database restore details.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<DBRestore id="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”Completed” />

Tenant Management APIs

Cisco ICFP provides APIs that can provision tenants and add users.

Provision Tenant

Description

Provisions a tenant. You must provision a cloud instance before you can provision a tenant.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants

Sample URL

https://myserver/capi/v1/tenants

HTTP Methods

Method

Description

POST

Creates a new tenant.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

<Tenants tenantName="acme" instanceName="mycloud">
    <ResourceLimits maxServers="100"/>
    <ParameterList>
        <Parameter name="paramone" value="param_one_value"/>
        <Parameter name="paramtwo" value="param_two_value"/>
    </ParameterList>
    <AccountsList>
        <Accounts username="peter" 
         apiKey="ABCDEF"
         secretKey="AB12345"/>
    </AccountsList>
</Tenants>

The following example shows a request body for a tenant on an OpenStack cloud that uses a group-based policy framework and Keystone V3 Identity service: 

<Tenants tenantName="TenantACIGBP" instanceName="juno-aci-gbp" orgName="icf-devtest-tenant">
    <AccountsList>
       <Accounts username="testharness1" password="testharness1"/>
       </AccountsList>
       <ParameterList>
           <Parameter name="externalSegmentName" value="Datacenter-Out" />
           <Parameter name="domainName" value="Default" />
       </ParameterList>
</Tenants>

Response

Status

Response

201

Tenant is created. 

<Tenants status=”ACTIVE” 
    tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" 
    tenantName="acme" 
    instanceName="mycloud">
    <ResourceLimits maxServers="100"/>
    <ParameterList>
        <Parameter name="paramone" value="param_one_value"/>
        <Parameter name="paramtwo" value="param_two_value"/>
    </ParameterList>
    <AccountsList>
        <Accounts username="peter" 
         passkey=”23455#adfcc” 
         apiKey="ABCDEF" 
         secretKey="AB12345” />
    </AccountsList>
</Tenants>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

403

Required fields error.

403

Tenant tenant-name already exists.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

Tenants

tenantName

A unique name associated with the tenant.

String

Mandatory

instanceName

The cloud instance name.

String

Mandatory

enabled

Indicates whether the tenant is enabled or disabled. To disable the tenant and any accounts under it, set the value to false. The default value is true.

String

Optional

orgName

The name of the organization that is associated with the tenant. Different back-end cloud providers have parallel concepts.

For CloudStack, this name is not needed because it can be provisioned dynamically.

String

Optional

ResourceLimits

The resource limits tag.

Optional

maxServers

The maximum server count. The default value is 1000.

Integer

Mandatory

ParameterList

ParameterList tag inside the Tenants tag. This tag allows the API user to pass additional parameters.

Optional

Parameter

Parameter tag under ParameterList tag.

Optional

name

externalSegmentName: Required only if isGroupBasePolicyEnabled is set to True during cloudInstance provisioning.

String

Optional

  value

externalSegmentName: Name of the group-based policy external segment that is used to connect to the Internet and, from there, to Cisco Intercloud Fabric for Business. The group-based policy external segment is referred to as external connectivity in the OpenStack Horizon UI.

String

Optional
 

name

externalGroupName: (Optional) Valid only if isGroupBasePolicyEnabled is set to True during cloudInstance provisioning.

String

Optional

value

externalGroupName: Name of the external group used to connect internal groups to the Internet. If an external group with the specified name does not exist, Cisco ICFP creates the external group. If this parameter is not specified, Cisco ICFP automatically generates a name for the external group.

String

Optional

name

domainName: Required only if isKeyStoneV3APIEnabled is set to True during cloudInstance provisioning.

String

Optional

value

domainName: Name of the OpenStack Keystone domain to use when authenticating a user.

String

Optional

AccountsList

A list of accounts.

Mandatory

Accounts

The accounts tag.

Mandatory

username

The username of the tenant account. The name is used to log in to the Cisco ICFP REST API. For example, username@tenant.

String

Mandatory

apiKey

This attribute is required for cloud providers who require a key for back-end API access.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

secretKey

This attribute is used with the apiKey parameter for cloud providers who require a key for back-end API access.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

enabled

Indicates whether the account is enabled or disabled. To disable the account, set the value to false. The default value is true.

String

Optional

email

The email address that is associated with the user. If this attribute is not provided, the value defaults to username@tenantName.

String

Optional

passkey

Password key generated as a response for the apiKey and secretKey. For cloud providers that use usernames and passwords, this attribute is not created or presented to the API.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

Update Tenant

Description

Updates the attributes of an existing tenant.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4

HTTP Methods

Method

Description

PUT

Updates an existing tenant.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body Example 1

<Tenants>
    <ResourceLimits maxServers="200"/>
    <ParameterList>
        <Parameter name="paramone" value="param_one_new_value"/>
    </ParameterList>
    <AccountsList>
        <Accounts username="peter"
            email="peter@acme" apiKey="ABCDEFXYZ" secretKey="AB12345678"/>
    </AccountsList>
</Tenants>

Request Body Example 2

<Tenants enabled=”false” >
	<AccountsList>
		<Accounts username="peter" 
			email="peter@acme" apiKey="ABCDEFXYZ" secretKey="AB12345678"/>
	</AccountsList>
</Tenants>

Response

Status

Response

200

Tenant is updated. 

<Tenants status=”ACTIVE” tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4"
	tenantName="acme" instanceName="mycloud">
	<ResourceLimits maxServers="100" />
	<ParameterList>
		<Parameter name="paramone" value="param_one_value" />
		<Parameter name="paramtwo" value="param_two_value" />
	</ParameterList>
	<AccountsList>
		<Accounts username="peter" passkey=”1255#adfbc” apiKey="ABCDEFXYZ" 
   secretKey="AB12345678" />
	</AccountsList>
</Tenants>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

404

Tenant with the tenant ID does not exist.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

Tenants

Mandatory

enabled

Indicates whether the tenant is enabled or disabled. To disable this tenant for a period of time, set the value to false. This attribute is set to true by default.

String

Optional

ResourceLimits

The resource limits tag.

Optional

maxServers

The maximum server count.

Integer

Optional

ParameterList

ParameterList tag inside Tenants tag. This attribute allows the API user to pass additional parameters.

Optional

Parameter

Parameter tag inside the ParameterList tag.

Optional

name

The parameter name.

String

Optional

value

The parameter value.

String

Optional

AccountsList

A list of accounts.

Mandatory

Accounts

The accounts tag.

Mandatory

username

The username of the tenant account.

String

Mandatory

apiKey

This attribute is required for cloud providers who require a key for back-end API access.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

secretKey

This attribute is used with the apiKey attribute for cloud providers who require a key for back-end API access.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

enabled

Indicates whether the account is enabled or disabled. To disable an account for a period of time, set the value to false. This attribute is set to true by default.

String

Optional

email

The email address of the tenant account.

String

Optional

passkey

The password key is generated in response to the apiKey and secretKey attributes.

This attribute is mandatory for CloudStack-based tenants.

String

Optional

Get Tenant

Description

Retrieves the tenant details of the specified tenant ID.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4

HTTP Methods

Method

Description

GET

Returns tenant details.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200

Response for an existing tenant. 

<Tenants tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”ACTIVE”
    instanceName="mycloud" tenantName="acme">
    <ResourceLimits maxServers="200"/>
    <ParameterList>
        <Parameter name="paramone" value="param_one_new_value"/>
        <Parameter name="paramtwo" value="param_two_value"/>
    </ParameterList>
    <AccountsList>
        <Accounts secretKey="AB12345678" apiKey="ABCDEFXYZ" username="peter" passkey=”123#2445” 
         accountId="141a5ce8-e9b8-45d6-88e9-dbf851634786" email="peter@acme">
            <Servers inactiveServers="0" activeServers="0"/>
        </Accounts>
    </AccountsList>
</Tenants>

200

Response for a tenant that has been deleted.

A resource in the response can have the value of server, template, or network. The value for backendResourceId is the ID that the cloud platform understands. If FaultList is included in the response, those resources must be removed manually. 
 
<Tenants tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status="DELETED"
    tenantName="acme">
	<AccountList>
		<Accounts username="abcuser"
			<FaultList>
				<!-- Information from CapiFaults -->
				<Fault locationId="867a374b-b5ff-4190-9b7b-d9f602bea503"
					locationName="Zone-1" resource="server" resourceName="myserver"
					resourceId="abc-xyz-123" backendResourceId="defal-1020" errorCode="ICFPP specific error"
					errorMessage="can be anything, exception from backend" />
				<Fault locationId="867a374b-b5ff-4190-9b7b-d9f602bea503"
					locationName="Zone-1" resource="server" resourceName="myserver2"
					resourceId="abc-def-456" backendResourceId="defal-5678" errorCode="ICFPP specific error"
					errorMessage="can be anything, exception from backend" />
			</FaultList>
		</Accounts>
	</AccountsList>
</Tenants>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

404

The specified tenant does not exist.

500

Internal server error.

Response Details

Tag

Attribute

Description

Format

Presence

Servers

The server tag.

Mandatory

inactiveServers

Number of servers that are not in Running state (such as Stopped, Failed, or any other state).

String

Mandatory

activeServers

Number of servers that are in Running state with an assigned private IP address.

String

Mandatory

Get Tenant Servers

Description

Retrieves the details of the tenant and any servers that are associated with the specified tenant.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId/servers

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4/servers

Pagination Options

Pagination options limit the number of records (servers) displayed per tenant:

  • The pageSize option sets the number of records in each query.

  • The page option specifies the index of the page being fetched.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId/servers?pageSize=size &page=index

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4 /servers?pageSize=5&page=3

Date Filter Options

The date filter options retrieve all VM activity for the tenant between the specified startDate and time and endDate and time.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId/servers?startDate=yyyy-MM-ddTHH:mm:ss

&endDate=yyyy-MM-ddTHH:mm:ss

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4/

servers?startDate=2014-09-07T08:00:00&endDate=2014-09-15T23:00:00

HTTP Methods

Method

Description

GET

Returns tenant details.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<Tenants tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”ACTIVE”
	instanceName="mycloud" tenantName="acme">
	<ResourceLimits maxServers="100" />
	<AccountsList>
		<Accounts secretKey="AB12345678" apiKey="ABCDEFXYZ" passkey=”1255#adfbc”
			username="peter" accountId="141a5ce8-e9b8-45d6-88e9-dbf851634786"
			email="peter@acme">				
				<Servers activeServers="2" inactiveServers="1">
					<Server type="APPLICATION" 
						name="myserver" status="Running"
						activeHours="12:05:35" inactiveHours="01:30:10" 
						timeOfProvision="2014-09-05T08:40:51" 
						serverid="c0aafcd9-d65daa0e-2f38-a49e42af1758" 
						backendServerId="12345-232accaa-ccd-ddd" 
						serviceOffering="abcd12345-efghi-sdfsdfsd-098765"
						locationId="c0aafcd9-d65daa0e-abc12-a49e42af1758" 
						resourceCpu="2" resourceMem="2048" />
					<Server type="APPLICATION" 
						name="myserver2" status="Stopped" 
						activeHours="04:45:59" inactiveHours="11:15:01" 
						timeOfProvision="2014-09-07T08:40:51"	
						serverid="dec44172-35fd-7900-fde7-d9bed5edca5e" 
						backendServerId="12345-232accee-ccd-ddd" 
						serviceOffering="abcd12345-efghi-sdfsdfsd-098765"
						locationId="c0aafcd9-d65daa0e-abc12-a49e42af1758" 
						resourceCpu="2" resourceMem="4096" />
					<Server type="APPLICATION" 
						name="mydelServer" status="Deleted" 
						activeHours="1:00:00" inactiveHours="11:00:00" 
						timeOfProvision="2014-09-07T08:40:51" 
						deleteTime="2014-09-07T09:40:51"  
						serverid="deaa172-35fd-7900-fde7-d9bed5edca5e" 
						backendServerId="12345-232accdd-ccd-ddd" 
						serviceOffering="abcd12345-efghi-sdfsdfsd-098765" 
						locationId="c0aafcd9-d65daa0e-abc12-a49e42af1758"
						resourceCpu="2" resourceMem="4096" />
					<Server type="INFRA_CSR" 
						name="mycsr" status="Running" 
						activeHours="04:05:35" inactiveHours="00:00:00" 
						timeOfProvision="2014-09-15T11:40:51" 
						serverid="t1aafcd9-d65daa0e-2f38-b49e42af1758" 
						backendServerId="12345-232acccc-ccd-ddd" 
						serviceOffering="xyzd12335-efghi-sdfsdfsd-098765"
						locationId="c0aafcd9-d65daa0e-abc12-a49e42af1758" 
						resourceCpu="2" resourceMem="4096" />
				</Servers>
		</Accounts>
	</AccountsList>
</Tenants>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform the operation.

404

The specified tenant does not exist.

500

Internal server error.

Get All Tenants

Description

Retrieves a list of all tenants.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants

Sample URL

https://myserver/capi/v1/tenants

Pagination Options

Pagination options limit the number of records displayed:

  • The pageSize option sets the number of records in each query.

  • The page option specifies the index of the page being fetched.

URL Type

Value

Resource URL

/capi/v1/tenants?pageSize=size&page=index

Sample URL

https://myserver/capi/v1/tenants?pageSize=5&page=3

HTTP Methods

Method

Description

GET

Returns a list of all tenants.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<TenantsList>
	<Tenants tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4" status=”ACTIVE”
		instanceName="mycloud" tenantName="acme">
		<ResourceLimits maxServers="100"/>
		<AccountsList>
			<Accounts secretKey="AB12345678" apiKey="ABCDEFXYZ" passkey=”1255#adfbc” 
				username="peter" accountId="141a5ce8-e9b8-45d6-88e9-dbf851634786" 
				email="peter@acme">	     
				<Servers activeServers="2" inactiveServers="1"/>         
			</Accounts>
		</AccountsList>
	</Tenants>
	<Tenants tenantId="d4af5cbc-a2dd-430e-b3cd-205846784feb" status=”ACTIVE”
      instanceName="mycloud" tenantName="mytenant">
		<ResourceLimits maxServers="50"/>
		<AccountsList>
			<Accounts secretKey="DEF98765" apiKey="ABCXYZ" passkey=”fff12456343#” 
				username="parker" accountId="c9cb6428-f295-43ca-929e-4e314f6181fc" 
				email="parker@mytenant">         
				<Servers activeServers="0" inactiveServers="0"/>         
			</Accounts>
		</AccountsList>
	</Tenants>
</TenantsList>

The following example show an example of a response for tenants on an OpenStack cloud that uses a group-based policy framework and Keystone V3 Identity service: 

<TenantsList>
    <Tenants tenantName="TenantACIGBP" status="ACTIVE" instanceName="juno-aci-gbp" 
      orgName="icf-devtest-tenant" tenantId="c0d0640e-7c70-6c0f-5066-cedf0ef233cb">
      <ResourceLimits maxServers="1000"/>
      <ParameterList>
         <Parameter name="externalSegmentName" value="Datacenter-Out"/>
         <Parameter name="domainName" value="Default"/>
      </ParameterList>
      <AccountsList>
         <Accounts email="testharness1@devtest.org" 
           accountId="8097b61c-4c9b-36ee-090a-9114f82bd772"
           username="testharness1"/>
      </AccountsList>
    </Tenants>
</TenantsList>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform the operation.

500

Internal server error.

Delete Tenant

Description

Deletes a tenant and all servers associated with the tenant.

The initial response of this call is DELETING. Subsequent queries using the Get Tenant API call eventually result with the status of DELETED.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4

HTTP Methods

Method

Description

DELETE

Deletes an existing tenant.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200

Tenant is deleting. 

<Tenants status="DELETING" tenantName="acme" 
tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4"/>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform the operation.

404

Tenant is currently being deleted.

404

Tenant is already deleted.

404

The specified tenant does not exist.

500

Internal server error.

Purge Tenant

Description

Purges a tenant and all of its resources (such as servers, images, and templates) from the database. Run the delete tenant request before issuing the purge tenant request. If the tenant is deleted before the purge request is issued, all tenant resources are removed from the database. If the tenant is active when the purge tenant request is issued, only the inactive servers are deleted and removed from the database.

The response of this call shows the status of PURGED.

Resource URL

URL Type

Value

Resource URL

/capi/v1/tenants/tenantId/purge

Sample URL

https://myserver/capi/v1/tenants/8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4/purge

HTTP Methods

Method

Description

DELETE

Purges an existing tenant.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200

Tenant is purged. 

<Tenants status="PURGED" tenantName="acme" tenantId="8116a2f7-7f8c-4961-8ee1-9e486b6b2aa4"/>

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform the operation.

404

The specified tenant does not exist.

500

Internal server error.

Get Server

Description

Retrieves the details of the server with the specified ID.

Resource URL

URL Type

Value

Resource URL

/capi/v1/servers/serverId

Sample URL

https://myserver/capi/v1/servers/dec44172-35fd-7900-fde7-d9bed5edca5e

HTTP Methods

Method

Description

GET

Returns server details.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<Server status="Stopped" serverid="dec44172-35fd-7900-fde7-d9bed5edca5e"
name="mytestvm-5F7E1410264747593" providerVpcId="cd58fd3c-ad28-8dd8-4f5d-fe39c5b1bdb7"
templateId="943c3728-4799-07ab-918e-45f7c7fe1731" locationId="867a374b-b5ff-4190-9b7b-d9f602bea503" 
resourceCpu="2" resourceMem”4096” >
	<VnicInfoList>
		<VnicInfo providerVpcNetworkId="39c4d1d1-9d0e-d5f4-651e-4ac2353dbdfd">
			<VnicIpInfoList>
				<VnicIpInfo assignPublicIp="false" privateIpNetmask="255.255.255.0" privateIp="10.0.0.186" 
     isPrimary="true"/>
			</VnicIpInfoList>
		</VnicInfo>
	</VnicInfoList>
	<Disks>
		<Disk downloadStatus="none" size="33554432" diskId="97952a38-729b-4277-b09e-95efdeac685a" 
   index="0"/>
	</Disks>
	<Tags>
		<Tag>VNMC_RES_ID-0004f5b6-4000-4273-0004-f5b640004273</Tag>
	</Tags>
	<ParameterList>
		<Parameter value="0004f5b6-4000-4273-0004-f5b640004273" name="resource-id"/>
	</ParameterList>
</Server>

400

Invalid input.

401

Resource is not authorized.

404

The specified server does not exist.

500

Internal server error.

Syslog Configuration APIs

You can configure Cisco ICFP to send messages to syslog servers. If syslog service is enabled, Cisco ICFP sends syslog messages whenever a tenant, cloud instance, template, or server is created or deleted.

Configure Syslog Servers

Description

Configures syslog servers in Cisco ICFP. This API also enables, disables, or updates syslog server configurations in Cisco ICFP.

Resource URL

URL Type

Value

Resource URL

/capi/v1/syslogconfig

Sample URL

https://myserver/capi/v1/syslogconfig

HTTP Methods

Method

Description

POST

Posts the syslog configuration.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body—Local Logging

<SyslogConfig logLevel="NORMAL" enabled="true"/>

Response—Local Logging

Status

Response

200

Configures the local syslog server in Cisco ICFP and returns the current configuration. 

<SyslogConfig logLevel="NORMAL" enabled="true"/>

Request Body—Local, Primary, and Secondary Server

<SyslogConfig logLevel="NORMAL" enabled="true">
	<PrimaryServer protocol="UDP" port="514" host="192.168.10.101"/>
	<SecondaryServer protocol="UDP" port="514" host="192.168.10.102"/>
</SyslogConfig>

Response—Local, Primary, and Secondary Server

Status

Response

200

Configures the local and remote syslog servers in Cisco ICFP and returns the current configuration. 

<SyslogConfig logLevel="NORMAL" enabled="true">
	<PrimaryServer protocol="UDP" port="514" host="192.168.10.101"/>
	<SecondaryServer protocol="UDP" port="514" host="192.168.10.102"/>
</SyslogConfig>

Error Responses

HTTP Code

Error Message

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

403

Required: Syslog level.

Invalid Syslog level.

500

Internal server error.

Request Details

Tag

Attribute

Description

Format

Presence

SyslogConfig

enabled

Enable syslog configuration.

Allowed values: true or false.

String

Mandatory

logLevel

Allowed values: DEBUG, NORMAL, MINOR, or MAJOR.

String

Mandatory

PrimaryServer

Primary syslog server configuration.

Optional

host

Primary syslog server hostname or IP address.

String

Optional

port

Primary syslog server port. Allowed port: 514.

Optional

protocol

Remote syslog messaging protocol. Allowed protocol: UDP.

Optional

SecondaryServer

Secondary syslog server configuration.

Optional

host

Secondary syslog server hostname or IP address.

String

Optional

port

Primary syslog server port. Allowed port: 514.

Optional

protocol

Remote syslog messaging protocol. Allowed protocol: UDP.

Optional

Get Syslog Configuration

Description

Retrieves the syslog configuration from Cisco ICFP.

Resource URL

URL Type

Value

Resource URL

/capi/v1/syslogconfig

Sample URL

https://myserver/capi/v1/syslogconfig

HTTP Methods

Method

Description

GET

Get syslog configuration.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

<SyslogConfig logLevel="NORMAL" enabled="true">
	  <PrimaryServer protocol="UDP" port="514" host="192.168.10.101"/>
	  <SecondaryServer protocol="UDP" port="514" host="192.168.10.102"/>
</SyslogConfig>

401

Resource is not authorized.

401

User is not allowed to perform this operation.

500

Internal server error.

Logging APIs

You can use Cisco ICFP APIs to download the current logs or all logs.

Download Current Logs

Description

Downloads the current Cisco ICFP logs in a zipped file.

Resource URL

URL Type

Value

Resource URL

/capi/v1/logs/current

Sample URL

https://myserver/capi/v1/logs/current

HTTP Methods

Method

Description

GET

Returns the Cisco ICFP application and web server logs.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

reply: 'HTTP/1.1 200 OK\r\n' 
header: Content-Disposition: attachment; 
filename="CurrentLogs.zip"  
header: Content-Type: application/zip

400

Invalid input.

401

Resource is not authorized.

401

User is not allowed to perform this operation.

500

Internal server error.

Download All Logs

Description

Downloads all Cisco ICFP logs in a zipped file.

Resource URL

URL Type

Value

Resource URL

/capi/v1/logs/all

Sample URL

https://myserver/capi/v1/logs/all

HTTP Methods

Method

Description

GET

Returns all Cisco ICFP logs.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response

Status

Response

200 

reply: 'HTTP/1.1 200 OK\r\n' 
header: Content-Disposition: attachment; 
filename="AllLogs.zip"  
header: Content-Type: application/zip

400

Invalid input.

401

Resource is not authorized.

402

User is not allowed to perform this operation.

500

Internal server error.

System Information

Description

Retrieves information about Cisco ICFP nodes.

Resource URL

URL Type

Value

Resource URL

/capi/v1/systeminfo

Sample URL

https://myserver/capi/v1/systeminfo

HTTP Methods

Method

Description

GET

Returns system information.

HTTP Headers

Header Name

Value

Description

X-Capi-Request

A6665E4664FD416EA903774A5103D760

The API session key.

Request Body

No Body

Response—Standalone Node

Status

Response

200 

<SystemInfo>
	<ICFPNodes>
		<ICFPNode status="ACTIVE" infoTime="2015-11-09T11:30:10">
			<SystemCpu osversion="2.6.18-164.el5" arch="amd64" numCpu="4" 
							load="0.0" unit="percent"/>
			<SystemDisk free="91276" used="4891" capacity="101184" unit="MB"/>
			<SystemMemory free="74" used="7908" capacity="7983" unit="MB"/>
			<SystemNodeInfo type="PRIMARY" numServiceNodes="2" 
							upTime="2 Day (s) 18 hour (s) 53 Minute (s)"
							versionHash="74c388ffc484bd46e483c5c89e5a97e7b014684d" 
							buildDate="Fri Nov 06 16:24:11 PST 2015" 
							buildNumber="2222" productVersion="2.3.1" 
							ipAddress="10.30.30.111" name="PN1" />
			<DBInfo status="OK" ipAddress="127.0.0.1">
				<DBReplication status="OK"/>
			</DBInfo>
			<JVMInfo jvmVersion="1.8.0_66-b17" jvmName="Java HotSpot(TM) 64-Bit Server VM"/>
			<Applications>
				<Application numberOfThreads="94" name="Infra Manager"/>
				<Application numberOfThreads="72" name="Controller"/>
				<Application numberOfThreads="35" name="Console Client"/>
				<Application numberOfThreads="36" name="Event Manager"/>
				<Application numberOfThreads="34" name="Local Broker"/>
				<Application numberOfThreads="69" name="Tomcat"/>
				<Application numberOfThreads="83" name="IDAccess Manager"/>
			</Applications>
		</ICFPNode>
		<ICFPNode status="ACTIVE" infoTime="2015-11-09T11:30:12">
			<SystemCpu osversion="2.6.18-164.el5" arch="amd64" numCpu="4" 
							load="0.0" unit="percent"/>
			<SystemDisk free="91537" used="4630" capacity="101184" unit="MB"/>
			<SystemMemory free="3952" used="4030" capacity="7983" unit="MB"/>
			<SystemNodeInfo type="SERVICE" 
							upTime="2 Day (s) 19 hour (s) 12 Minute (s)"
							versionHash="74c388ffc484bd46e483c5c89e5a97e7b014684d" 
							buildDate="Fri Nov 06 16:24:11 PST 2015" 
							buildNumber="2222" productVersion="2.3.1" 
							ipAddress="10.30.30.121" name="SN1" />
			<DBInfo status="OK" ipAddress="10.30.30.111"/>
			<JVMInfo jvmVersion="1.8.0_66-b17" jvmName="Java HotSpot(TM) 64-Bit Server VM"/>
			<Applications>
				<Application numberOfThreads="134" name="Infra Manager"/>
				<Application numberOfThreads="72" name="Controller"/>
				<Application numberOfThreads="31" name="Console Client"/>
				<Application numberOfThreads="36" name="Event Manager"/>
				<Application numberOfThreads="33" name="Local Broker"/>
				<Application numberOfThreads="71" name="Tomcat"/>
				<Application numberOfThreads="83" name="IDAccess Manager"/>
			</Applications>
		</ICFPNode>
		<ICFPNode status="INACTIVE" infoTime="2015-11-09T11:30:14">
			<SystemNodeInfo type="SERVICE" 
							ipAddress="10.30.30.112" name="SN2" />
		</ICFPNode>
	</ICFPNodes>
</SystemInfo>

Response—Multiple-Node Configuration

Status

Response

200 

<SystemInfo>
	<ICFPNodes>
		<ICFPNode status="ACTIVE" infoTime="2015-11-09T11:30:10">
			<SystemCpu osversion="2.6.18-164.el5" arch="amd64" numCpu="4" 
							load="0.0" unit="percent"/>
			<SystemDisk free="91276" used="4891" capacity="101184" unit="MB"/>
			<SystemMemory free="74" used="7908" capacity="7983" unit="MB"/>
			<SystemNodeInfo type="PRIMARY" numServiceNodes="2" 
							upTime="2 Day (s) 18 hour (s) 53 Minute (s)"
							versionHash="74c388ffc484bd46e483c5c89e5a97e7b014684d" 
							buildDate="Fri Nov 06 16:24:11 PST 2015" 
							buildNumber="2222" productVersion="2.3.1" 
							ipAddress="10.30.30.111" name="PN1" />
			<DBInfo status="OK" ipAddress="127.0.0.1">
				<DBReplication status="OK"/>
			</DBInfo>
			<JVMInfo jvmVersion="1.8.0_66-b17" jvmName="Java HotSpot(TM) 64-Bit Server VM"/>
			<Applications>
				<Application numberOfThreads="94" name="Infra Manager"/>
				<Application numberOfThreads="72" name="Controller"/>
				<Application numberOfThreads="35" name="Console Client"/>
				<Application numberOfThreads="36" name="Event Manager"/>
				<Application numberOfThreads="34" name="Local Broker"/>
				<Application numberOfThreads="69" name="Tomcat"/>
				<Application numberOfThreads="83" name="IDAccess Manager"/>
			</Applications>
		</ICFPNode>
		<ICFPNode status="ACTIVE" infoTime="2015-11-09T11:30:12">
			<SystemCpu osversion="2.6.18-164.el5" arch="amd64" numCpu="4" 
							load="0.0" unit="percent"/>
			<SystemDisk free="91537" used="4630" capacity="101184" unit="MB"/>
			<SystemMemory free="3952" used="4030" capacity="7983" unit="MB"/>
			<SystemNodeInfo type="SERVICE" 
							upTime="2 Day (s) 19 hour (s) 12 Minute (s)"
							versionHash="74c388ffc484bd46e483c5c89e5a97e7b014684d" 
							buildDate="Fri Nov 06 16:24:11 PST 2015" 
							buildNumber="2222" productVersion="2.3.1" 
							ipAddress="10.30.30.121" name="SN1" />
			<DBInfo status="OK" ipAddress="10.30.30.111"/>
			<JVMInfo jvmVersion="1.8.0_66-b17" jvmName="Java HotSpot(TM) 64-Bit Server VM"/>
			<Applications>
				<Application numberOfThreads="134" name="Infra Manager"/>
				<Application numberOfThreads="72" name="Controller"/>
				<Application numberOfThreads="31" name="Console Client"/>
				<Application numberOfThreads="36" name="Event Manager"/>
				<Application numberOfThreads="33" name="Local Broker"/>
				<Application numberOfThreads="71" name="Tomcat"/>
				<Application numberOfThreads="83" name="IDAccess Manager"/>
			</Applications>
		</ICFPNode>
		<ICFPNode status="INACTIVE" infoTime="2015-11-09T11:30:14">
			<SystemNodeInfo type="SERVICE" 
							ipAddress="10.30.30.112" name="SN2" />
		</ICFPNode>
	</ICFPNodes>
</SystemInfo>

Error Responses

HTTP Code

Error Message

401

Resource is not authorized.

401

User is not allowed to perform this operation.

500

Internal server error.

Was this Document Helpful?

FeedbackFeedback

Contact Cisco