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.
Service developers and service provider customers can create their own custom cloud adapters for use with Cisco ICFPP by using the Cisco ICFPP developer guidelines. These guidelines ensure that any custom cloud adapter will work seamlessly with Cisco ICFPP. To obtain a copy of the guidelines, contact your Cisco representative.
After a custom cloud adapter is developed, customers can load the adapter code into Cisco ICFPP and enable the cloud adapter functions for the targeted tenants as described in the following workflow:
The following figure illustrates how custom cloud adapter code can be loaded into Cisco ICFPP and be used to process incoming Cisco Intercloud Fabric cloud API requests that are issued by a tenant.
The following tables summarize the current southbound API stub functions that are supported in the cloud adapter classes.
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
Management Session Interface | createClientSession | CapiTenantAccountVO account | Session ID | Creates a management session with a cloud platform instance. |
deleteClientSession | Session ID | Deletes a management session. | ||
validateClientSession | CapiTenantAccountVO account | Validates a current management session. |
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
Service Management Interface | listCapabilities | Provider Capability | Lists the cloud platform capabilities. | |
listLocations | Location Details | Lists the locations or sites supported by the provider. |
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
listPublicIpAddress | CapiTenantAccountVO account | IP address List | Gets the list of public IP addresses. |
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
Template Management Interface API | createTemplate | CapiTenantAccountVO account, capiTemplate template | Template ID | Creates a template based on an image. |
deleteTemplate | CapiTenantAccountVO account, Template ID | Deletes a template. |
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
VM Management Interface API | deployVirtualMachine | CapiTenantAccountVO account, capiServer server | capiServer server | Deploys a virtual machine based on the template ID. |
destroyVirtualMachine | CapiTenantAccountVO account, Server ID | Destroys a virtual machine based on the server ID. | ||
downloadVirtualMachine | CapiTenantAccountVO account, capiServer server, string diskId, capiVMAction vmAction | Downloads the VM disk from the cloud provider catalog toCisco ICFPP. | ||
listVirtualMachine | CapiTenantAccountVO account, capiServer server | capiServer server | Lists all of the virtual machines that were instantiated by the tenant. | |
rebootVirtualMachine | CapiTenantAccountVO account, capiServer serverserver, capiAction actionType | Reboots a virtual machine based on the server. | ||
startVirtualMachine | CapiTenantAccountVO account, capiServer server, capiAction actionType | Starts a virtual machine that was previously stopped. | ||
stopVirtualMachine | CapiTenantAccountVO account, capiServer server, capiAction actionType | Stops a virtual machine. | ||
updateVirtualMachine | CapiTenantAccountVO account, capiServer server | Updates attributes of a virtual machine, such as the IP address. |
Class API Category | API Name | Input Parameters | Output Parameters | Comments |
---|---|---|---|---|
VPC Management Interface API | createVpc | CapiTenantAccountVO account, capiProviderVpcDetail model | capiProviderVpcDetails vpcdetails | Creates a provider VPC. |
createVpcNetwork | CapiTenantAccountVO account, capiProviderVpcNetwork networkModel, capiProviderVpcDetails model | capiProviderVpcNetwork networkModel | Creates a VPC network. | |
deleteVpc | CapiTenantAccountVO account, vpcId | Deletes a VPC. | ||
deleteVpcNetwork | CapiTenantAccountVO account, vpcId, networkId | Deletes a network from a VPC. | ||
listProviderVpc | CapiTenantAccountVO account | Lists the VPCs of a tenant. | ||
listVpcById | CapiTenantAccountVO account, vpcId | Lists the specified VPC of a tenant. | ||
listVpcNetworkById | CapiTenantAccountVO account, vpcId, networkId | Lists a network of a VPC from a tenant. | ||
updateVpc | CapiTenantAccountVO account, capiProviderVpcDetail model | Updates a VPC. |
You can install or upgrade an adapter by using this procedure.
Confirm that the adapter file is:
You can validate whether an adapter was installed or upgraded successfully by choosing Cisco ICFPP GUI. The Adapters table lists all installed adapters, the version currently installed, the creation date, and the date that the adapter was last updated.
in the