CliQr is now part of Cisco Learn More About Cisco

Create Extension

Details

API Details
NameCreate Extension
DescriptionCreate an extension on the CloudCenter platform to ease the resource-creation process. See Extensions for additional context.
MethodPOST
URI
  • v1/extensions/connectApic

  • /v1/extensions/aci
CloudCenter Release

Introduced in CloudCenter 4.6.0   

Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • Updated to work with the Create Extension.
  • Provides a HTTP Location URL that you can use to query the system until this call returns a success or failure HTTP Status Codes.
  • The password parameter is displayed in clear text for users with write or admin access. For all other users, the CloudCenter platform displays ===redacted=== in the password attribute.
ESB Headeraction: create.extensions

Example 1 – Connect to ACI Endpoint

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/extensions/connectApic"

Request Body

Example 2 – Save the ACI Endpoint

curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/extensions/aci"

Request Body

Example 3 – Save the ACI Endpoint with a Bridge Domain Template

Request Body

 

Response

When you issue a GET request using the  HTTP Location URL, you receive the following response:

or

Request Attributes

apicEndpoint
  • Description: The URL for the Cisco Application Policy Infrastructure Controller (Cisco APIC) endpoint.
  • Type: String
username
  • Description: Unique, CloudCenter-generated name reference for this user.
  • Type: String
password
  • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
  • Type: String
 connectingCloudType 
  • Description: The CCO cloud used to manage the APIC endpoint.
  • Type: String
extensionType
  • Description: Identifies the type of extension on the CloudCenter platform. 
  • Type: Enumeration

    EnumerationDescription
    ACI Identifies this extension as an ACI resource. See ACI for additional context.
    --No other extensions are currently available. See Extensions for additional context.
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

aciConnectionInfo (click for additional details)

bdTemplates (click for additional details)

Response Attributes

perms (click for additional details)
id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String
aciConnectionInfo
  • Description: Identifies the information for the APIC endpoint.
  • Type: Sequence of details about this ACI type

    apicEndpoint
    • Description: The URL for the Cisco Application Policy Infrastructure Controller (Cisco APIC) endpoint.
    • Type: String
    username
    • Description: Unique, CloudCenter-generated name reference for this user.
    • Type: String
    password
    • Description: Password for the user's account. Effective Cloud Center 4.6.1, the CloudCenter platform enforces a minimum password length of 5 characters for all settings.
    • Type: String
     connectingCloudType 
    • Description: The CCO cloud used to manage the APIC endpoint.
    • Type: String
bdTemplates (click for additional details)
extensionType
  • Description: Identifies the type of extension on the CloudCenter platform. 
  • Type: Enumeration

    EnumerationDescription
    ACI Identifies this extension as an ACI resource. See ACI for additional context.
    --No other extensions are currently available. See Extensions for additional context.
name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
 ownerUserId 
  • DescriptionUnique, system-generated identifier for the owner of the tenant to which this service owner belongs
  • Type: String
endpoint
  • Description: The URL of the APIC device that is connected to the network directly or indirectly.
  • Type: String