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.
Cisco ICFPP, which is a virtual appliance that is deployed on the service provider cloud data center, enables service provider customers to access cloud resources using Cisco Intercloud Fabric APIs. The virtual appliance provides a virtual network interface that enables a customer's Cisco Intercloud Fabric Director to reach the Cisco ICFPP appliance instance from public networks. The following figure shows the Cisco ICFPP appliance architecture.
The ICFPP architecture includes four major interfacing modules:
Module |
Description |
---|---|
Northbound Cisco Intercloud Fabric Cloud API |
Implements the Cisco Intercloud Fabric Cloud API, which is consumed by the Cloud API translations (customer private cloud) for workload provisioning purposes. |
Northbound Cisco Intercloud Fabric Provider API |
Implements two sets of APIs for the service provider administrator to use to: |
Core Application Logic |
Implements the main application logic of ICFPP, such as Cloud API translations. |
Southbound Cloud Adapter Layer |
Implements the various cloud platform interfacing adapters, each of which is responsible for interfacing with a specific cloud platform, such as the Cisco Hybrid Cloud Bundle – in partnership with Dimension Data. |
The northbound Cisco Intercloud Fabric module uses Representational State Transfer (REST) APIs that are consumed by the Cisco Intercloud Fabric (customer private cloud) for provisioning workloads and managing workload images and templates.
A service provider administrator uses the northbound Cisco Intercloud Fabric provider APIs to configure and manage the Cisco ICFPP virtual appliance. These APIs belong to the following categories:
For details on these APIs, see Service Provider APIs.
The following table identifies the cloud instance management APIs:
Category | HTTP Method | Request URL | Request Header / Body | Response Body | Comments |
---|---|---|---|---|---|
Cloud Instance Management |
POST |
/capi/v1/cloudinstances |
API session key, cloud instance |
Cloud instance ID |
Creates a new cloud instance. |
PUT |
/capi/v1/cloudinstances/ cloudID |
API session key, cloud instance ID |
Cloud instance ID |
Updates an existing cloud instance. |
|
GET |
/capi/v1/cloudinstances/ cloudID |
API session key, cloud instance ID, cloud credentials |
Cloud record |
Gets a cloud record. |
|
GET |
/capi/v1/cloudinstances |
API session key |
Cloud record |
Gets all cloud records in the database. |
|
DELETE |
/capi/v1/cloudinstances/ cloudID |
API session key, cloud instance ID |
Cloud record |
Deletes a cloud instance. |
The following table identifies the tenant management APIs:
Category | HTTP Method | Request URL | Request Header / Body | Response Body | Comments |
---|---|---|---|---|---|
Tenant Management |
POST |
/capi/v1/tenants |
API session key, tenant record (such as name and resource limits) |
Tenant ID |
Provisions a new tenant record. |
PUT |
/capi/v1/tenants/ tenantID |
API session key, tenant ID |
Tenant ID |
Updates an existing tenant record. |
|
GET |
/capi/v1/tenants/ tenantID |
Tenant ID |
Tenant record |
Gets a tenant record. |
|
GET |
/capi/v1/tenants/ tenantID/details |
API session key, tenant ID |
Tenant record |
Gets the details of a tenant. |
|
GET |
/capi/v1/tenants |
API session key |
Tenant record |
Gets all tenant records in the database. |
|
DELETE |
/capi/v1/tenants/ tenantID |
API session key, tenant ID |
Tenant record |
Deletes a tenant. |
|
DELETE |
/capi/v1/tenants/ tenantID/purge |
API session key, tenant ID |
Tenant record |
Deletes a tenant and all of its resources from the database. |
|
GET |
/capi/v1/servers/ serverID |
API session key, server ID |
Server record |
Gets a server record. |
Many APIs can be used with other troubleshooting tools to build diagnostic suites that a service provider administrator can use to debug appliance-level and tenant-level problems.
Category |
HTTP Method |
Request URL |
Request Header / Body |
Response Body |
Comments |
---|---|---|---|---|---|
Remote Syslog Configuration |
POST |
/capi/v1/logs/syslogconfig |
API session key, log level, remote syslog server |
Syslog server configuration |
Configures the remote syslog server in Cisco ICFPP. |
GET |
/capi/v1/logs/syslogconfig |
API session key |
Syslog server configuration |
Retrieves the remote syslog server from Cisco ICFPP. |
Category |
HTTP Method |
Request URL |
Request Header / Body |
Response Body |
Comments |
---|---|---|---|---|---|
Logging |
GET |
/capi/v1/logs/current |
API session key |
Zipped file of current logs |
Downloads the current logs in a zipped file. |
GET |
/capi/v1/logs/all |
API session key |
Zipped file of all logs |
Downloads all logs in a zipped file. |
Many APIs can be used with other troubleshooting tools to build diagnostic suites that a service provider administrator can use to debug appliance-level and tenant-level problems.
The core application logic module handles the following functions:
Function |
Description |
---|---|
Intercloud cloud API back-end processing |
The back end of Intercloud cloud API processing. Based on the cloud platform type that is configured for the tenant, this function calls the appropriate cloud adapter function for fulfilling the cloud orchestration requests that are issued by Cisco Intercloud Fabric Director (ICFD). |
Cloud instance and tenant provisioning |
Creates and manages cloud platform instance records and tenant records. |
Tenant resource usage limit enforcing |
Enforces the usage limit based on per-tenant resource usage limits, such as the number of virtual machines, that the provider administrator has configured for a tenant. |
Tenant resource usage metering |
Collects all relevant resource usage rates for usage-metering applications, based on cloud resource allocation and provisioning requests and responses. |
Tenant resource monitoring |
Issues relevant cloud platform API requests for resource monitoring purposes. The service provider can use the relevant northbound APIs to retrieve the resource monitoring status on demand. |
The southbound cloud adapter layer implements cloud adapters that communicate with cloud platforms to provision workloads and orchestrate cloud infrastructures. The Cisco ICFPP cloud adapter layer defines APIs that are to be implemented by the cloud platforms.
Cisco ICFPP supports built-in cloud adapters that facilitate the integration with the following cloud platforms in the service provider's environment:
The service providers who use these cloud platforms can use these built-in cloud adapters. Service providers who use other cloud platforms must build platform-specific adapters for Cisco ICFPP to work the targeted cloud platforms. To facilitate the cloud adapter development, Cisco's Custom Cloud Adapter Integration framework simplifies cloud adapter development for service provider customers.
Cloud adapters must issue one or more API requests to the targeted cloud platforms and expect an asynchronous event when they receive corresponding API responses from the cloud platforms. The following figure shows the logical flow of the Cisco ICFPP cloud adapter infrastructure when it is shared between built-in and custom adapters.