View Clouds

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameView Clouds
Description

Displays information for each cloud or for a specified cloud within the specified tenant

Allowed Role(s)

WM_USER, WM_ADMIN

MethodGET
URI
  • v1/tenants/tenantId/clouds
  • v1/tenants/tenantId/clouds?detail=true
  • v1/tenants/tenantId/clouds/cloudId


  • cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds
  • cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds?detail=true
  • cloudcenter-cloud-setup/api/v1/tenants/tenantId/clouds/cloudId
Sample Request
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/clouds"
curl -k -X GET -H "Accept: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds"
Release
  • Introduced in CloudCenter 4.0
  • Enhanced in CloudCenter 4.9.0 to include the cloudFamilyType attribute and deprecate the publicCloud attribute

Modified in CloudCenter Suite 5.0.0

Notes
  • Only resource owners and users with WRITE perms can view all the fields for this resource.
  • Other users can only view common fields like name, description, and so forth. See Permission Control for additional context.
  • If you include a cloudId to identify a cloud, the response only includes information for that cloud.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

  • action: get.tenants.tenantId.clouds
  • action: get.tenants.tenantId.clouds
    actionparam: detail=true
  • action: get.tenants.tenantId.clouds.cloudId


See the Enterprise Service Bus (ESB) section for additional context.

Not applicable

Sample Response 1 – v1/tenants/1/clouds

{
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds",
    "size": 4,
    "pageNumber": 0,
    "totalElements": 4,
    "totalPages": 1,
    "clouds": [
        {
            "id": "1",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1",
            "perms": [],
            "name": "OpenStack",
            "cloudFamily": "Openstack",
            "description": "Cliqr's OpenStack Data Center",
            "publicCloud": false,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "2",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/2",
            "perms": [],
            "name": "Amazon",
            "cloudFamily": "Amazon",
            "description": "Amazon Cloud Group belonging to root tenant",
            "publicCloud": true,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "3",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/3",
            "perms": [],
            "name": "vCD",
            "cloudFamily": "Vcd",
            "description": "vCD",
            "publicCloud": false,
            "tenantId": "1",
            "detail": null
        },
        {
            "id": "4",
            "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/4",
            "perms": [],
            "name": "MyAmazon",
            "cloudFamily": "Amazon",
            "description": "MyAmazon",
            "publicCloud": true,
            "tenantId": "1",
            "detail": null
        }
    ]
}

Sample Response 2 –  v1/tenants/1/clouds?detail=true

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1?detail=true",
    "perms": [],
    "name": "OpenStack",
    "cloudFamily": "Openstack",
    "description": "CliQr's OpenStack Data Center",
    "publicCloud": false,
    "tenantId": "1",
    "detail": {
        "cloudAccounts": [
            {
                "id": "1",
                "resource": "https: //<HOST>: <PORT>/v1/tenants/1/clouds/1/cloudAccounts/1",
                "perms": [],
                "displayName": "VP's US DC OpenStack cloud account",
                "cloudId": "1",
                "userId": "2",
                "accountName": "vp",
                "accountId": "VP's US DC OpenStack cloud account",
                "accountPassword": "***************",
                "accountDescription": "VP's US Data Center OpenStack cloud account",
                "manageCost": true,
                "publicVisible": false,
                "allowedUsers": [],
                "accessPermission": "USERS_AND_SUBTENANT_USERS",
                "accountProperties": [
                    {
                        "name": "QuantumEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Region",
                        "value": "regionOne"
                    },
                    {
                        "name": "TenantName",
                        "value": "vp"
                    },
                    {
                        "name": "NeutronEndpoint",
                        "value": ""
                    },
                    {
                        "name": "NovaEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Endpoint",
                        "value": "http://10.100.1.75:5000/v2.0"
                    },
                    {
                        "name": "PreferredNetwork",
                        "value": ""
                    }
                ]
            }
        ],
        "cloudRegions": [
            {
                "id": "1",
                "resource": "https: //<HOST>: <PORT>/v1/tenants/1/clouds/1/cloudRegions/1",
                "perms": [],
                "cloudId": "1",
                "displayName": "OpenStack-regionOne",
                "regionName": "OpenStack-regionOne",
                "description": null,
                "importRegion": null,
                "gateway": {
                    "address": "10.110.12.145",
                    "dnsName": null,
                    "status": "RUNNING",
                    "cloudId": "1",
                    "cloudAccountId": "1"
                },
                "storage": null,
                "enabled": true,
                "activated": true,
                "numUsers": 17,
                "status": "RUNNING",
                "statusDetail": null,
                "regionProperties": [
                    {
                        "name": "QuantumEndpoint",
                        "value": ""
                    },
                    {
                        "name": "Region",
                        "value": "regionOne"
                    },
                    {
                        "name": "AvailabilityZones",
                        "value": ""
                    },
                    {
                        "name": "NodeNameConfig",
                        "value": ""
                    },
                    {
                        "name": "Endpoint",
                        "value": "http://10.100.1.75:5000/v2.0"
                    },
                    {
                        "name": "NodesPerBatch",
                        "value": ""
                    }
                ]
            }
        ],
        "status": "RUNNING",
        "statusDetail": "RUNNING"
    }
}

Sample Response 3 – v1/tenants/1/clouds/1

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/tenants/1/clouds/1",
    "perms": [],
    "name": "OpenStack",
    "cloudFamily": "Openstack",
    "description": "Cliqr's OpenStack Data Center",
    "publicCloud": false,
    "tenantId": "1",
    "detail": null
}

Sample Response 4 – CloudCenter Suite 5.0

{
   "resource":"https://<HOST?:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds?detail=true&size=0",
   "size":6,
   "pageNumber":0,
   "totalElements":6,
   "totalPages":1,
   "clouds":[
      {
         "id":"3",
         "resource":"https://<HOST?:<PORT>/cloudcenter-cloud-setup/api/v1/tenants/1/clouds/3?detail=true&size=0",
         "name":"AWS2",
         "cloudFamily":"Amazon",
         "description":"",
         "cloudFamilyType":"Public",
         "tenantId":"1",
         "canDelete":true,
         "detail":{
            "cloudAccounts":[
               {
                  "id":"2",
                  "resource":null,
                  "perms":[
                     "administration"
                  ],
                  "displayName":"Master",
                  "cloudId":"3",
                  "userId":"1",
                  "accountDescription":"",
                  "manageCost":false,
                  "allowedUsers":[

                  ],
                  "accessPermission":"PRIVATE",
                  "enableAccountFor":"PROVISIONING_REPORTING",
                  "enableReportingByOrg":false,
                  "billingUnitIds":"956656273757,157624380227,837435521567,147129246202,804685808463,052904131800,613204116379,453971079189,512570952472,743340435259,610632381733",
                  "billingUnitNames":"user1,user2,Test Account MO,user3,CloudCenterMaster,Slan User,Cliqr User 10,Cliqr Appstore,CPSG,CloudCenter,Core"
               },
               {
                  "id":"6",
                  "resource":null,
                  "perms":[
                     "administration"
                  ],
                  "displayName":"Master2",
                  "cloudId":"3",
                  "userId":"1",
                  "accountDescription":"",
                  "manageCost":false,
                  "allowedUsers":[

                  ],
                  "accessPermission":"PRIVATE",
                  "enableAccountFor":"PROVISIONING_REPORTING",
                  "enableReportingByOrg":false,
                  "billingUnitIds":"157624380227,804685808463,837435521567,052904131800,613204116379,956656273757,147129246202,453971079189,512570952472,743340435259,610632381733",
                  "billingUnitNames":"user2,CloudCenterMaster,Test Account MO,Slan User,Cliqr User 10,user1,user3,Cliqr Appstore,CPSG,CloudCenter,Core"
               },
               {
                  "id":"7",
                  "resource":null,
                  "perms":[
                     "administration"
                  ],
                  "displayName":"Masyer3",
                  "cloudId":"3",
                  "userId":"1",
                  "accountDescription":"",
                  "manageCost":false,
                  "allowedUsers":[

                  ],
                  "accessPermission":"PRIVATE",
                  "enableAccountFor":"PROVISIONING_REPORTING",
                  "enableReportingByOrg":false,
                  "billingUnitIds":"157624380227,147129246202,956656273757,837435521567,804685808463,052904131800,613204116379,453971079189,512570952472,610632381733,743340435259",
                  "billingUnitNames":"user2,user3,user1,Test Account MO,CloudCenterMaster,Slan User,Cliqr User 10,Cliqr Appstore,CPSG,Core,CloudCenter"
               },
               {
                  "id":"8",
                  "resource":null,
                  "perms":[
                     "administration"
                  ],
                  "displayName":"Master4",
                  "cloudId":"3",
                  "userId":"1",
                  "accountDescription":"",
                  "manageCost":false,
                  "allowedUsers":[

                  ],
                  "accessPermission":"PRIVATE",
                  "enableAccountFor":"PROVISIONING_REPORTING",
                  "enableReportingByOrg":false,
                  "billingUnitIds":"804685808463,052904131800,613204116379,453971079189,512570952472,743340435259,157624380227,837435521567,956656273757,147129246202,610632381733",
                  "billingUnitNames":"CloudCenterMaster,Slan User,Cliqr User 10,Cliqr Appstore,CPSG,CloudCenter,user2,Test Account MO,user1,user3,Core"
               }
            ],
            "cloudRegions":[
               {
                  "id":"3",
                  "resource":null,
                  "perms":[
                     "administration"
                  ],
                  "cloudId":"3",
                  "displayName":"US East (Ohio)",
                  "regionName":"AWS2-us-east-2",
                  "description":"Amazon Web Services",
                  "importRegion":null,
                  "gateway":{

                  },
                  "enabled":true,
                  "activated":true,
                  "numUsers":1,
                  "status":"RUNNING",
                  "statusDetail":"GATEWAY_NOT_RUNNING",
                  "regionProperties":[
                     {
                        "name":"guacamoleHost",
                        "value":"10.8.144.137"
                     },
                     {
                        "name":"guacamoleRoutingKey",
                        "value":"cliqr.guacamole.local"
                     },
                     {
                        "name":"artifactsKey",
                        "value":null
                     },
                     {
                        "name":"connectionBrokerEgressPort",
                        "value":"31895"
                     },
                     {
                        "name":"RegionEndPoint",
                        "value":"ec2.us-east-2.amazonaws.com"
                     },
                     {
                        "name":"guacamoleServicePort",
                        "value":"31587"
                     },
                     {
                        "name":"enableProxyForWorker",
                        "value":"false"
                     },
                     {
                        "name":"WorkerAMQPPort",
                        "value":"30670"
                     },
                     {
                        "name":"bladeIp",
                        "value":"cloudcenter-blade-amazon-3-6bdd"
                     },
                     {
                        "name":"WorkerAMQPIpAddress",
                        "value":"10.8.144.137"
                     },
                     {
                        "name":"connectionBrokerIngressPort",
                        "value":"31209"
                     },
                     {
                        "name":"brokerVirtualHost",
                        "value":"3-cloudendpoint9457b7"
                     },
                     {
                        "name":"LocalAMQPPort",
                        "value":"30670"
                     },
                     {
                        "name":"enableProxyForCloudEndpoint",
                        "value":"false"
                     },
                     {
                        "name":"LocalAMQPIpAddress",
                        "value":"10.8.144.137"
                     },
                     {
                        "name":"amqpAccessibleFromCloud",
                        "value":"true"
                     },
                     {
                        "name":"bladePort",
                        "value":"8443"
                     },
                     {
                        "name":"lpPort",
                        "value":"9009"
                     },
                     {
                        "name":"bladeStatusUpdateTime",
                        "value":"2019-05-08T18:12:03.526Z"
                     }
                  ],
                  "externalBundleLocation":null,
                  "lastInstanceSyncTime":null,
                  "cloudBladeStatus":"SUCCESS",
                  "cloudConnectStatus":"NOT_APPLICABLE",
                  "strategyBundleLocation":null,
                  "strategy":{
                     "properties":[

                     ],
                     "propertyDefsType":{
                        "propertyValueConstraintDefs":null,
                        "propertyMetadataDefs":[
                           {
                              "name":"InstanceNamingStrategy",
                              "description":"Instance Naming Strategy",
                              "type":"string",
                              "displayType":"combo",
                              "choices":"[{'value':'Default','displayText':'Default'},{'value':'CliQrMacroReplacement','displayText': 'CliQr Macro Replacement'},{'value':'CalloutHostname','displayText':'Hostname Callout'}]",
                              "mandatory":false,
                              "mutable":true,
                              "customizable":true,
                              "scope":"REGION",
                              "children":[

                              ],
                              "default":null
                           },
                           {
                              "name":"NodeNameConfig",
                              "description":"Node Name Config",
                              "type":"string",
                              "displayType":null,
                              "choices":null,
                              "mandatory":false,
                              "mutable":true,
                              "customizable":true,
                              "scope":"REGION",
                              "children":[

                              ],
                              "default":null
                           },
                           {
                              "name":"InstanceIPAMStrategy",
                              "description":"Instance IPAM Strategy",
                              "type":"string",
                              "displayType":"combo",
                              "choices":"[{'value':'NoIPAM','displayText':'No IPAM'},{'value':'IPAMCallout','displayText':'IPAM Callout'}]",
                              "mandatory":false,
                              "mutable":true,
                              "customizable":true,
                              "scope":"REGION",
                              "children":[

                              ],
                              "default":null
                           }
                        ]
                     },
                     "strategyActions":[

                     ]
                  },
                  "externalActions":[

                  ],
                  "actions":[

                  ]
               }
            ],
            "status":"RUNNING",
            "statusDetail":"RUNNING"
         },
         "regionEndpoint":null,
         "enableProxyForCloudEndpoint":false,
         "enableProxyForWorker":false,
         "amqpAccessibleFromCloud":true
      }
   ]
}


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 the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

  • Type: String
cloudId
  • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

  • Type: String

Response Attributes

resource
  • Description: Unique URL to access this resource.
  • Type: String
See pageResource or Pagination for additional context

clouds
  • Description: Information about each cloud family.
  • Type: Array of cloud

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

    • Type: String
    resource
    • Description: Unique URL to access this resource.
    • Type: String
    perms (click for additional details)
    name
    • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

    • Type: String

    cloudFamily                                                                                                                                                                                
    • Description: The cloud provider name.                     
    • Type: String

    description
    • DescriptionA brief description for this CloudCenter Resource.

    • Type: String

    publicCloud (Deprecated)
    • Description: Indicates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
    • Type: Boolean
      • true = This is a public cloud. See the Public Clouds section for the relevant release for a complete list.
      • false = This is not a public cloud. See the Datacenters and Private Clouds section for the relevant release for a complete list.

    cloudFamilyType
    • Description: Indicates if this is a public cloud, a private cloud/datacenter, or a container cloud. This attribute is useful to identify features that are not available in all cloud environments. For example, sync storage and add storage type are not applicable to public clouds.
    • Type: Enumeration

      EnumerationDescription
      PublicAny cloud listed in the Public Clouds section for the applicable release.
      PrivateAny cloud listed in the Datacenters and Private Clouds section for the applicable release.
      ContainerAny cloud listed in the Container Clouds section for the applicable release.

    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 the Tenant ID and Tenant Name Dependency section for the relevant release for additional context.

    • Type: String

    detail (click for additional details)

    If the request URL does not have a detail query parameter with the value=true, then this field displays null.

     

detail
  • Description: Identifies the cloud account and cloud region details.

  • String: Sequence of cloud details

     cloudAccounts (click for additional details)

    cloudAccounts
    • Description: Identifies information about each cloud account
    • Type: Array of cloud accounts

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

      • Type: String

      resource
      • Description: Unique URL to access this resource.
      • Type: String
      perms (click for additional details)

      displayName
      • DescriptionA descriptive name for this CloudCenter resource.
      • Type: String

      Required

      cloudId
      • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

      • Type: String

      Required

      userId
      • Description: Unique, system-generated identifier for a user
      • Type: String

      Required

      accountName
      • Description:The account name associated with this cloud account
      • Type: String 

      Required

      accountId
      • Description: Unique, system-generated identifier for the account of the cloud provider
      • Type: String

      Required

      accountPassword
      • Description:Password for the account of the cloud provider
      • Type: String

      Required

      accountDescription
      • Description:A brief description of this cloud account
      • Type: String

      Required

      manageCost
      • Description: Indicates whether the CloudCenter platform tracks your cloud account costs for billing purposes. See the Configure a Cloud and Cloud Account section for the relevant release for additional context.

        • true = The CloudCenter platform tracks your cloud account costs
        • false = Default. The CloudCenter platform does not track your cloud account costs
      • Type: Boolean
      publicVisible
      • Description: Indicates whether this cloud publicly accessible. See the Supported Public Clouds section for the relevant release for additional context.

        • true = cloud is publicly accessible
        • false = cloud is not publicly accessible
      • Type: Boolean 
      allowedUsers
      • Description: Indicates the IDs of the users who are authorized to access this cloud account
      • Type: Integer (array)
       accessPermission 
      • Description: Identifies who can access this cloud account. Once set you cannot change this attribute.

      • Type: Enumeration

        EnumerationDescription
        PRIVATEDefault. The cloud account is accessible only by the owner of the cloud account.
        USERSThe cloud account is accessible by all tenant users of the cloud account.
        USERS_AND_SUBTENANT_USERSThe cloud account is accessible by all tenant and sub-tenant users of the cloud account.

      accountProperties
      • Description: Property information for this cloud account
      • Type: Name-Value Pair (array)

      enableAccountFor
      • Description: Identifies tracking for billing and reporting purposes. Effective CloudCenter Suite 5.0.0 and later.

      • Type: Enumeration

        EnumerationDescription
        PROVISIONING_REPORTINGDefault. Account is used for both provisioning and reporting.
        REPORTINGCost Optimizer and Workload Manager will track cloud costs for this account. Typical usage: master cloud accounts which are used for billing aggregation.
        PROVISIONINGWorkload Manager can deploy jobs using this account.

      enableReportingByOrg
      • Description: This filed only applies to AWS and Google clouds and if set to true, it saves the time of manually creating a comparable cost hierarchy within Cost Optimizer. See Cost Groups Configuration for more information on cost hierarchies in Cost Optimizer. Effective CloudCenter Suite 5.0.0 and later.

      • Type: Boolean

        • true = Causes Cost Optimizer to import the cost hierarchy created in the cloud provider portal.

        • false = Default. You must manually create a cost hierarchy, if required.

      billingUnitIds
      • Description: A billing unit is the most granular level of cloud cost recording in CloudCenter Suite. This field identifies the number of billing units for this cloud account by listing each billing unit ID. Effective CloudCenter 5.0.0 and later.

      • Type: String

      billingUnitNames
      • Description: A billing unit is the most granular level of cloud cost recording in CloudCenter Suite. This field identifies the number of billing units for this cloud account by listing each billing unit name. Effective CloudCenter 5.0.0 and later.

      • Type: String

       

     cloudRegions (click for additional details)

    cloudRegions
    • Description: Identifies details about each cloud region
    • Type: Array of cloudRegion

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

      • Type: String

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

      perms (click for additional details)

      cloudId
      • Description: Unique, system-generated identifier for a cloud representation (see View Deployment Environments for additional details)

      • Type: String

      displayName
      • DescriptionA descriptive name for this CloudCenter resource.
      • Type: String
      regionName
      • DescriptionThe name of this cloud region as listed in the Supported Public Clouds section for the relevant release.
      • Type: String
      description
      • DescriptionA brief description for this CloudCenter Resource.

      • Type: String
      importRegion
      • Description: Identified the cloud region details
      • Type: Sequence of attributes

        name
        • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

        • Type: String

        displayName
        • DescriptionA descriptive name for this CloudCenter resource.
        • Type: String

      gateway (click for additional details)

      storage (click for additional details)

      enabled
      • Description: Indicates that this resource has been enabled. The default differs based on the resource.

        • true = The resource has been enabled (v2 aging and suspension policies are enabled by default).

        • false = The resource has not been enabled.

      • Type: Boolean

      activated
      • Description: Indicates whether this account has been activated.

        • true = the account has been activated
        • false = the account has not been activated
      • Type: Boolean
      publicCloud (Deprecated)
      • Description: Indicates if this is a public cloud. This attribute is useful to identify datacenters and private clouds as features like sync storage and add storage type is not applicable to public clouds.
      • Type: Boolean
        • true = This is a public cloud. See the Public Clouds section for the relevant release for a complete list.
        • false = This is not a public cloud. See the Datacenters and Private Clouds section for the relevant release for a complete list.
      numUsers
      • DescriptionNumber of users that are currently using this resource
      • Type: Long
      status
      • Description: Status of this resource 
      • Type: Enumeration

        EnumerationDescription
        RunningThe cloud account is operational
        StoppedThe cloud account is not operational
        MaintenanceModeThe cloud account is under maintenance
      statusDetail
      • Description: Indicates the status of this cloud
      • Type: Enumeration

        EnumerationDescription
        CLOUD_ACCOUNT_NOT_CONFIGUREDThere are no cloud accounts configured for this cloud.
        NO_REGION_RUNNINGThe cloud does not have a region that is in running state.
        RUNNINGThe cloud has at least one configured cloud account with at least one cloud region in running state
      regionProperties
      • Description: Properties for this region
      • TypeName-Value Pair (array)
      externalActions
      • Description: Defines the actions to be defined for each service for each phase when you create/update the service
      • Type: Array of service lifecycle actions. See the Service Lifecycle Actions section for the relevant release for additional context.

        actionName
        • Type: Enumeration
        actionType
        • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
        • Type: Enumeration

          EnumerationDescription
          SCRIPT

          Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

          The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
          - Linux VMs = /usr/local/osmosix/service/serviceName
          - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

          See the Service Lifecycle Action section for the relevant release for additional context.

           This option is not available for Container Service.

          URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

          The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
          CMD

          Indicates the command that is be executed on the VM during actionName step.

          The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

          - Linux VMs = cliqruser

          - WindowsVMs = cliqr

          See the Service Lifecycle Action section for the relevant release for additional context.

          Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

        actionValue
        • Description: Identifies the value that you provide for the selected actionType.

        • Type: String

       externalBundleLocation
      • Description: Location of the zip file that contains the external Bundle Store artifacts that are downloaded during deployment orchestration. 
        • The External Actions Bundle zip file contains all scripts required to manage the external lifecycle. You must provide the following information for this zip file depending on the resource being configured:

          • If you are configuring this file at the cloud region level – this file must contain a directory called cloudregion which contains all the scripts.

          • If you are configuring this file for a service – name this file as ServiceID.zip. For example, tomcat6.zip, where tomcat6 is the Service ID.

        • This attribute is available for all service types
        • The bundle is validated against associated repositories.
        • The repositories field should not be empty.
        • The Service Lifecycle Actions definition (if it is a SCRIPT) is used to locate the scripts in this ZIP file.
        • See Manage Services and the "Parameters and Macros" sections for the relevant release or additional context.
      • Type: String

      lastInstanceSyncTime
      • Description: Administrators have the ability to sync instance type and price information from the Package Store when they see a change in cloud provider instance type definitions and price information. This field identifies the date and time when the instance was last synced. See the Manage Instance Type section for additional details.
      • Type: Long

      Unable to render {include} The included page could not be found.

      cloudConnectStatus
      • Description: The state of the cloud connection. Effective CloudCenter Suite 5.0 and later releases.

      • Type: Enumeration

        EnumerationDescription
        WAITINGThe system is waiting to receive a status.
        CONNECTEDThe cloud is connected.
        NOT_APPLICABLEThe state does not apply to the CloudCenter Suite.

      strategyBundleLocation
      • Description: The location from where the CloudCenter Suite downloads the installation bundles. Effective CloudCenter Suite 5.0 and later releases.

      • Type: String

      strategy
      • Description:Identifies the overall strategy, properties, definitions, and restrictions for the cloud region. Effective CloudCenter 5.0.0 and later.

      • Type: Array of details for the cloud strategy

        properties
        • Description: Identifies the VM Naming and IPAM Strategies on a per cloud region basis (Strategy Bundle, Instance Naming Strategy, Node Name Config, Instance IPAM Strategy, Custom VM NAme, IPAM Alloc Rule, and IPAM Dealloc Rule – based on the information provided in the Guidance for Callout Scripts section).

        • Type: Array of strategy management details for each region


        propertyDefsType
        • Description: Identifies the  property value restrictions and the metadata definitions  for each property description.

        • Type: Array of value details

          propertyValueConstraintDefs
          • Description: Identifies the restrictions for each property value.
          • Type: String

          propertyMetadataDefs
          • Description: Information about the resource property

          • Type: Array of name-value pairs

            name
            • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

            • Type: String

            value
            • Description: Indicates the set value for this property
            • Type: Float

        strategyActions
        • Description: Identifies the possible actions for each strategy.

        • Type: Enumeration

          StrategyEnumerationDescription
          Instance IPAM Strategy

          IPAM_ALLOCThe location of your custom IPAM address allocation script
          IPAM_DEALLOCThe location of your custom IPAM address deallocation script.
          VM_NAMINGCalled before each node is launched. It is injected into the script with all the name variables (name of application, name of tier, image selected) for each job.
          Instance Naming Strategy

          DefaultThe default method provided by Cisco is generation of a string consisting of a predefined token prefixed with cqjw-
          CliQrMacroReplacementThe Node Name Config details are required.
          HostnameCalloutThe Custom VM Name details are required.

      externalActions
      • Description: Defines the actions to be defined for each service for each phase when you create/update the service
      • Type: Array of service lifecycle actions. See the Service Lifecycle Actions section for the relevant release for additional context.

        actionName
        • Type: Enumeration
        actionType
        • Description: The value of this attribute is interpreted based on the value of the actionName attribute for this Service Lifecycle Action. See the Service Lifecycle Action section for the relevant release for additional context.
        • Type: Enumeration

          EnumerationDescription
          SCRIPT

          Indicates the script (baked into the image that is used to launch the VM) name and parameters (if any) to be executed on the VM during the corresponding actionName step.

          The entity to be run for this Service Lifecycle Action is a script located at a path relative to where the service bundle zip file is extracted:
          - Linux VMs = /usr/local/osmosix/service/serviceName
          - Windows VMs = C:\program files\osmosix\service\$SERVICE_NAME

          See the Service Lifecycle Action section for the relevant release for additional context.

           This option is not available for Container Service.

          URLIndicates the location from where the script is to be downloaded and executed on the VM during the corresponding actionName step.

          The entity to be run for this Service Lifecycle Action is a HTTP URL pointing to a script that is downloaded (the HTTP URL must be accessible from this VM). See the Service Lifecycle Action section for the relevant release for additional context.
          CMD

          Indicates the command that is be executed on the VM during actionName step.

          The entity to be run for this Service Lifecycle Action is a command that is accessible in the PATH for the user (built into the image that is used to launch the VMs):

          - Linux VMs = cliqruser

          - WindowsVMs = cliqr

          See the Service Lifecycle Action section for the relevant release for additional context.

          Effective CloudCenter 4.1.1, admins can configure the local user on application VMs. The CCO configuration file (/usr/local/osmosix/etc/gateway_config.properties) has an optional property called agent.username to specify the local user. If no user name is specified then cliqruser is the default user.

        actionValue
        • Description: Identifies the value that you provide for the selected actionType.

        • Type: String

      actions (click for additional details)

       

    status
    • Description: Identifies the overall status of the region.
    • Type: Enumeration

      EnmerationDescription
      IN_PROGRESSThe cloud region creation is in progress.
      WAITING_FOR_CLOUDCONNECT_CONFIG_APPLYThe user is yet to apply the Cloud Remote configuration or Cloud Remote is yet to connect to the CloudCenter Suite.
      WAITING_FOR_CLOUDCONNECT_ADDRESSThe user is yet to enter the Cloud Remote address in the region settings page.
      WAITING_FOR_CLOUD_ENDPOINTThe user is yet to enter cloud endpoint in the region settings.
      WAITING_FOR_BLADEThe system is waiting for the cloud blade to come up.
      CLOUDCONNECT_DISCONNECTEDThe CloudCenter Suite cannot reach the Cloud Remote component.
      FAILEDThe cloud region creation failed.
      ERRORThe cloud region creation encountered an error and timed out.
      RUNNINGThe cloud region is up and running, usable state.
      STOPPED

      The cloud blade is stopped.

      WORKER_AMQP_IP_REQUIREDThe user is yet enter the application VM's AMQP IP address in the cloud region settings page

    statusDetail
    • Description: Indicates the status of this cloud
    • Type: Enumeration

      EnumerationDescription
      CLOUD_ACCOUNT_NOT_CONFIGUREDThere are no cloud accounts configured for this cloud.
      NO_REGION_RUNNINGThe cloud does not have a region that is in running state.
      RUNNINGThe cloud has at least one configured cloud account with at least one cloud region in running state





© 2017-2019 Cisco Systems, Inc. All rights reserved