Update Extension

Details

API Details
NameUpdate Deployment Environment
Description

Updates the information for a specified Deployment Environment.

MethodPUT
URI

v1/ extensions/aci/  extensionId

CloudCenter Release

 

  • Introduced in CloudCenter 4.6.0 
  • Enhanced to include the associatedL3Out, l3OutForRouteProfile, and dhcpRelayLbls parameters.


Notes
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.

  • 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: update.extensions.aci.extensionId

Example 1 – Change the Extension Name

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

Request Body

{
    "perms": ["write", "administration", "read", "access", "delete"],
    "id": "8",
    "resource": "https://<HOST>:<PORT>/v1/extensions/aci/8",
    "aciConnectionInfo ": {
        "apicEndpoint ": "http: //<HOST>:<PORT>",
        "username": "admin",
        "password": "===redacted===",
        "connectingCloudType": "Vmware-default",
        "vmmDomainName": null,
        "tenant": null
    },
    "bdTemplates": [],
    "extensionType": "ACI",
    "name": "DocDemo1",
    "description": null,
    "ownerUserId": 2,
    "endpoint": "http://<HOST>:<PORT>"}

Example 2 – Add a Bridge Domain Template

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

Request Body

{
    "extensionType": "ACI",
    "perms": ["write", "administration", "read", "access", "delete"],
    "id": "8",
    "resource": "https://<HOST>:<PORT>/v1/extensions/aci/8",
    "aciConnectionInfo": {
        "apicEndpoint": "http://<HOST>:<PORT>",
        "username ": "admin ",
        "password ": "===redacted===",
        "connectingCloudType ": "Vmware -default ",
        "vmmDomainName ": null,
        "tenant": null
    },
    "bdTemplates": [{
        "name": "Template1",
        "nameConfig": "Tenant_auto332-VRF",
        "vrfTemplate": "Tenant_auto332-VRF",
        "tenantName": "Tenant_auto332",
        "dynamicVrfTemplate": false,
        "bdtSubnet": {
            "subnetScope": "private",
            "bdtSubnetPools": [{
                "masterSubnet": "<HOST>/24",
                "poolSubnet": "/25"
            }],
            "ndraPrefix": true
        }
    }],
    "name": "DocDemo1",
    "description": null,
    "ownerUserId": 2,
    "endpoint": "http://<HOST>:<PORT>"
}

Response

The configuration is updated and a 200 OK status update is issued.

Requests 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)

Required: name, nameConfig, vrfTemplate, tenantName, dynamicVrfTemplate, bdtSubnet (subnetScope, bdtSubnetPools [masterSubnet and poolSubnet], and ndraPrefix)

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

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