CliQr is now part of Cisco Learn More About Cisco

View Child CCM Details

Details

API Details
Name

View Child CCM Details

Description
MethodGET
URIv1/tenants/3/links?type=CLOUD_CENTER_LINK_TO_CHILD
CloudCenter ReleaseIntroduced in CloudCenter 4.5.2.
Notes
  • Available in CloudCenter 4.5.2. 
  • For additional context on <PORT> usage in the following example(s), see Base URI Format.
  • The CloudCenter GET APIs display up to 20 entities in the listing by default. If you have more than 20 entities in your resource listing, use the pagination query parameters to view them beyond the first 20 entities returned by default. See the CloudCenter API Overview  > Pagination  section for additional context.
  • When submitting jobs from a linked Child CCM in a Federated CCM environment, use the additional target CCID parameter, -H "x-cliqr-ccid: ccm4", in the HTTP header. In place of ccm4, use your remote deployment identifier, CloudCenter ID (CCID) – remoteCloudCenterId, that is included in the response to this API call (see the example below).
ESB Header

action: get.tenants.tenantId
actionparam: type=CLOUD_CENTER_LINK_TO_CHILD

Example: Managed VMs

curl -k -X GET -H "Accept: application/json" -u cloudcenteradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/3/links?type=CLOUD_CENTER_LINK_TO_CHILD"

Response

 

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource
  • Type: String

See pageResource or Pagination 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
tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String
disabled
  • Description: Indicates whether this resource is disabled.
    • True = resource is disabled
    • false = resource is not disabled
  • Type: Boolean
status
  • Description: Status of this resource 
  • Type: Enumeration

    EnumerationDescription
    RUNNINGThe cloud account is operational
    STOPPEDThe cloud account is not operational
lastApproved
  • Description: If the connection was successfully established, this is the date when this resource was last approved. See Federated CCM Management for additional context.

  • Type: Long

lastUpdated
  • Description: Date that this resource was last updated. This attribute is the same as the lastUpdatedTime attribute.

  • Type: Long

created
  • Description: The date that this resource or favorite was created (system generated). This is a read-only attribute and cannot be configured.
  • Type: Long

remoteTenantId
  • Description: Unique, system-generated identifier for the federated tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Federated CCM Management for additional context.
  • Type: String

remoteTenantShortName
  • Description: Unique short version of this federated CCM tenant's name to be used in the Login page. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency. See Federated CCM Management for additional context.
  • Type: String

remoteCloudCenterId
  • Description: Unique, system-generated identifier for the federated CCM's CloudCenter ID (CCID). This ID is auto-generated by CloudCenter. See Certificate Authentication and Federated CCM Management for additional context.

    Icon

    When submitting jobs from a linked Child CCM in a Federated CCM environment, use the additional target CCID parameter, -H "x-cliqr-ccid: ccm4", in the HTTP header. In place of ccm4, use your remote deployment identifier, CloudCenter ID (CCID) – remoteCloudCenterId, that is included in the response to the View Child CCM Details API call.

  • Type: String

remoteEndpoint
  • Description: Unique URL to access the remote federated CCM server. See Federated CCM Management for additional context.
  • Type: String

remoteLinkId
  • Description: Once the tenant admin for the Subordinate (child) CCM approves the link request and the federated registration is established, CloudCenter assigns a a unique, system-generated identifier for the link. See Federated CCM Management for additional context.
  • Type: String

relation
  • Description: Identifies the relation between the tenantId and the remoteTenantId in a federated environment. 

  • Type: Enumeration

    EnumerationDescription
    CLOUD_CENTER_LINK_TO_PARENT Indicates that this server is the Child CCM.
    CLOUD_CENTER_LINK_TO_CHILDIndicates that this server is the Parent CCM.

approvedLinkState 
  • Description: Identifies the possible states for linked CCMs in a federated environment.
  • Type: Enumeration

    EnumerationDescription
     CONNECTED The federated CCM link is successfully established.
    CANNOT_ESTABLISH_LINKCloudCenter is unable to establish a federated CCM link between the identified CCMs.
     DISABLED The federated CCM link cannot be accessed by the remote server as the request may have been declined by the Subordinate CCM's admin.
    DID_NOT_CHECKDefault. The remote CCM admin may not have checked the link connection request and the link is still not mutually authenticated.

requestComment
  • Description: Comments or descriptions about the federated link request and can include information on the reason(s), requester information, and so forth.
  • Type: String

rejectReason
  • Description: The reason that the federated link request was rejected.
  • Type: String

requesterName
  • Description: The name of the user (on the parent CCM) who is initiating the federated link request.
  • 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

remoteCaCert

remoteLaunchOk
  • Description: Identifies if the child CCM administrator permitted this job to launch from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Remote Launch).
  • Type: Boolean
    • true = Allow App Remote Launch is selected.
    • false = Allow App Remote Launch is not selected.

remoteTerminationOk
  • Description: Identifies if the child CCM administrator permitted this job to be terminated from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Remote Termination).
  • Type: Boolean
    • trueAllow App Remote Termination is selected.
    • falseAllow App Remote Termination is not selected.

remotePolicyCreationOk
  • Description: Identifies if the child CCM administrator permitted this policy to be created from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow Policy Remote Creation).
  • Type: Boolean
    • trueAllow Policy Remote Creation is selected.
    • falseAllow Policy Remote Creation is not selected.

remoteAppProfileCreationOk
  • Description: Identifies if the child CCM administrator permitted this application profile to be created from the parent CCM. See Federated CCM Management > Parent CCM Link Initiation (Parent Manager Permissions – Allow App Profile Remote Creation).
  • Type: Boolean
    • trueAllow App Profile Remote Creation is selected.
    • falseAllow App Profile Remote Creation is not selected.