Create Deployment Environment

Details

API DetailsRelease-Specific Information
CloudCenter Platform 4xCloudCenter Suite 5x
NameCreate Deployment Environment
Description

Create deployment environments to map the cloud infrastructure to deployed applications

Allowed Role(s)WM_USER
MethodPOST
URI

/v1/environments

cloudcenter-ccm-backend/api/v1/environments

Sample Request
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/environments"
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/cloudcenter-ccm-backend/api/v1/environments"
Release
  • Introduced in CloudCenter 3.2.5
  • Enhanced in CloudCenter 4.2 to include the cloudId, totalDeployments, and costDetails attributes and to reflect a modified associatedClouds attribute
  • Enhanced in CloudCenter 4.4 to reflect a modified associatedClouds attribute – see the Deployment Environments section for the relevant release for additional context
    • Includes the regionId of each associated cloud account
    • Contains new sections called cloudAssociationDefaults and default
  • Enhanced in CloudCenter 4.8.2 to include the extensionId attribute – see Example 2 below and the Configuring ServiceNow Extensions section for the relevant release for additional context
  • Enhanced in CloudCenter 4.10.0 to include policy attributes as part of the tagless governance feature (Sample 3).

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.
  • Provides a HTTP Location URL that you can use to query the system until this call returns a success or failure code.
Back To LinksCloudCenter Platform 4x APIWorkload Manager API

ESB Header

action: create.environments

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

Not applicable

Sample 1 Request Body – Without Extension Details

 Click here to expand...
{
    "name": "AllClouds",
    "description": "",
    "allowedClouds": null,
    "defaultSettings": "{\"defaultCloud\":\"Openstack-na-west1\",\"defaultInstanceType\":\"5073b9a8-....-....-....-..................\"}",
    "requiresApproval": false,
    "associatedClouds": [
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "1",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc1",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d9844.................."
                }, 
                {
                    "name": "TenantName",
                    "value": "arch"
                }, 
                {
                    "name": "networkId",
                    "value": "ae358c6c-....-....-....-............"

                }, 
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "saad-net01"
                }
            ],
            "default": true
        }, 
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "2",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc2",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d98441faeda6cc90decaac1"
                },
                {
                    "name": "TenantName",
                    "value": "arch"
                },
                {
                    "name": "networkId",
                    "value": "acb2b98e-ad27-4dcf-9ec2-78c66b852cf3"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "arch-net01"
                }
            ],
            "default": false
        }, 
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "3",
            "cloudName": "VMware",
            "cloudAccountName": "arch",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "UserClusterName",
                    "value": "test"
                },
                {
                    "name": "networkId",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserTargetDeploymentFolder",
                    "value": "/arch"
                },
                {
                    "name": "UserDataCenterName",
                    "value": "SCL2"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": ""
                },
                {
                    "name": "networkName",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserDatastoreCluster",
                    "value": "QA-DS-cluster"
                }
            ],
            "default": true
        }, {

            "regionId": "3",
            "regionName": "AWSCloud-us-east-1",
            "regionDisplayName": "US East (Virginia)",
            "cloudFamily": "Amazon",
            "cloudId": "4",
            "cloudAccountId": "5",
            "cloudName": "AWSCloud",
            "cloudAccountName": "QA_AWS",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "vpcId",
                    "value": "vpc-3e41595b"
                },
                {
                    "name": "networkId",
                    "value": "subnet-1fafee46"
                }, 
                {
                    "name": "availabilityZoneId",
                    "value": "us-east-1a"
                }, 
                {
                    "name": "subnetId",
                    "value": "subnet-1fafee46"
                }, {

                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "subnet-1fafee46 | CIDR: 10.1.1.0/2"
                }
            ],
            "default": true
        },
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "10",
            "cloudName": "VMware",
            "cloudAccountName": "sanand",
            "cloudAssociationDefaults": [],
            "default": false
        }
    ]
}

Response

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

  {
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/environments/1/",
    "perms": [
        "read",
        "delete",
        "execute",
        "write",
        "administration",
        "authorize",
        "move_out",
        "approve",
        "move_in",
        "manage"
    ],
    "name": "AllClouds",
    "description": "",
    "allowedClouds": null,
    "defaultSettings": "{\"defaultCloud\":\"Openstack-na-west1\",
\"defaultInstanceType\":\"5073b9a8-....-....-....-..................\"}",
    "requiresApproval": false,
    "associatedClouds": [
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "1",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc1",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d9844.................."
                }, 
                {
                    "name": "TenantName",
                    "value": "arch"
                }, 
                {
                    "name": "networkId",
                    "value": "ae358c6c-....-....-....-............"

                }, 
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "saad-net01"
                }
            ],
            "default": true
        }, 
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "2",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc2",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "TenantId",
                    "value": "9ecc4e427d98441faeda6cc90decaac1"
                },
                {
                    "name": "TenantName",
                    "value": "arch"
                },
                {
                    "name": "networkId",
                    "value": "acb2b98e-ad27-4dcf-9ec2-78c66b852cf3"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "arch-net01"
                }
            ],
            "default": false
        }, 
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "3",
            "cloudName": "VMware",
            "cloudAccountName": "arch",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "UserClusterName",
                    "value": "test"
                },
                {
                    "name": "networkId",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserTargetDeploymentFolder",
                    "value": "/arch"
                },
                {
                    "name": "UserDataCenterName",
                    "value": "SCL2"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": ""
                },
                {
                    "name": "networkName",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserDatastoreCluster",
                    "value": "QA-DS-cluster"
                }
            ],
            "default": true
        }, {

            "regionId": "3",
            "regionName": "AWSCloud-us-east-1",
            "regionDisplayName": "US East (Virginia)",
            "cloudFamily": "Amazon",
            "cloudId": "4",
            "cloudAccountId": "5",
            "cloudName": "AWSCloud",
            "cloudAccountName": "QA_AWS",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "vpcId",
                    "value": "vpc-3e41595b"
                },
                {
                    "name": "networkId",
                    "value": "subnet-1fafee46"
                }, 
                {
                    "name": "availabilityZoneId",
                    "value": "us-east-1a"
                }, 
                {
                    "name": "subnetId",
                    "value": "subnet-1fafee46"
                }, {

                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "subnet-1fafee46 | CIDR: 10.1.1.0/2"
                }
            ],
            "default": true
        },
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "10",
            "cloudName": "VMware",
            "cloudAccountName": "sanand",
            "cloudAssociationDefaults": [],
            "default": false
        }
    ],
    "totalDeployments": 0,
    "costDetails": null
}

Sample 2 – With Extension Details

 Click here to expand...
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/environments"

Request

{
   "name":"ENV_17",
   "description":"API Test",
   "allowedClouds":null,
   "extensionId":"2",
   "requiresApproval":false,
   "associatedClouds":[
      {
         "regionId":"1",
         "regionName":"openstack-RegionOne",
         "regionDisplayName":"RegioneOne",
         "cloudFamily":"Openstack",
         "cloudId":"1",
         "cloudAccountId":"1",
         "cloudName":"openstack",
         "cloudAccountName":"openstack-ac",
         "cloudAssociationDefaults":[

         ],
         "default":false
      }
   ]
}

Response

{
    "id": "1",
    "resource": "https://<HOST>:<PORT>/v1/environments/17/",
    "perms": [
        "read",
        "delete",
        "execute",
        "write",
        "administration",
        "authorize",
        "move_out",
        "approve",
        "move_in",
        "manage"
    ],
    "name": "ENV_17",
    "description": "ExtensionID Test",
    "allowedClouds": null,
    "extensionId":"2",
    "defaultSettings": "{\"defaultCloud\":\"Openstack-na-west1\"}",
    "requiresApproval": false,
    "associatedClouds": [
        {
            "regionId": "1",
            "regionName": "Openstack-na-west1",
            "regionDisplayName": "North America West",
            "cloudFamily": "Openstack",
            "cloudId": "1",
            "cloudAccountId": "1",
            "cloudName": "Openstack",
            "cloudAccountName": "ClAcc1",
            "cloudAssociationDefaults": [ ],
            "default": true
        } ],
    "totalDeployments": 0,
    "costDetails": null
}

Sample 3 – Tagless Governance

 Click here to expand...
curl -k -X POST -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/environments"

Request

{
   "name":"MyDepEnv57",
   "description":"MyDepEnv57",
   "requiresApproval":false,
   "extensionId":null,
   "defaultRegionId":"1",
   "networkTypeEnabled":false,
   "networkTypes":[

   ],
   "associatedClouds":[
      {
         "regionId":"1",
         "cloudAccountId":"1",
         "default":true,
         "preference":null,
         "networkSettings":[

         ],
         "basicSettings":[

         ],
         "defaultSshKey":null,
         "defaultInstance":null,
         "enableResourcePlacement":false,
         "enableResourceValidation":false,
         "resourcePlacementScript":null,
         "resourceValidationScript":null,
         "calloutPackage":""
      }
   ],
   "policySettings":{
      "agingPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "mandatory":false,
         "allPolicies":false,
         "policies":[
            {
               "policyId":1,
               "default":true
            },
            {
               "policyId":2,
               "default":false
            }
         ]
      },
      "suspensionPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "mandatory":false,
         "allPolicies":false,
         "policies":[
            {
               "policyId":1,
               "default":true
            },
            {
               "policyId":2,
               "default":false
            }
         ]
      },
      "securityPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "mandatory":false,
         "policies":[
            {
               "policyId":1,
               "default":true,
               "locked":true
            },
            {
               "policyId":2,
               "default":false,
               "locked":false
            }
         ]
      },
      "allowTerminateProtection":true
   }
}

Response

{
   "id":"13",
   "resource":"https://<HOST>:<PORT>/v1/environments/13",
   "name":"MyDepEnv57",
   "description":"MyDepEnv57",
   "defaultSettings":"",
   "owner":2,
   "requiresApproval":false,
   "associatedClouds":[
      {
         "regionId":"1",
         "regionName":"OpenStack-RegionOne",
         "regionDisplayName":"RegionOne",
         "cloudFamily":"Openstack",
         "cloudId":"1",
         "cloudAccountId":"1",
         "cloudName":"OpenStack",
         "cloudAccountName":"OpenStackAccount",
         "networkSettings":[

         ],
         "defaultInstance":null,
         "defaultSshKey":null,
         "basicSettings":[

         ],
         "preference":"VISIBLE_UNLOCKED",
         "defaultCloudSettings":[

         ],
         "enableResourcePlacement":false,
         "enableResourceValidation":false,
         "resourcePlacementScript":null,
         "resourceValidationScript":null,
         "calloutPackage":null,
         "cloudAssociationDefaults":[

         ],
         "default":true
      }
   ],
   "totalDeployments":0,
   "costDetails":null,
   "networkTypes":[

   ],
   "networkTypeEnabled":false,
   "restrictedUser":false,
   "defaultRegionId":"1",
   "extensionId":null,
   "extension":null,
   "policySettings":{
      "agingPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "allPolicies":false,
         "mandatory":false,
         "policies":[
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v2/agingPolicies/2",
                  "name":"MyAgingPolicy2",
                  "description":"",
                  "enabled":true,
                  "type":"TIME",
                  "limit":{
                     "amount":1,
                     "unit":"MONTHS"
                  },
                  "terminateWhenPolicyEnds":false,
                  "allowGracePeriodForTermination":false,
                  "graceLimit":null,
                  "allowPolicyExtension":false,
                  "extensionLimit":null,
                  "allowGracePeriodNotification":false,
                  "allowPolicyExpiryNotification":false,
                  "notifications":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "created":1519864644672,
                  "lastUpdated":1519864644672,
                  "resources":[

                  ],
                  "priority":2,
                  "ownerId":2
               },
               "default":false
            },
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v2/agingPolicies/1",
                  "name":"MyAgingPolicy",
                  "description":"",
                  "enabled":true,
                  "type":"TIME",
                  "limit":{
                     "amount":1,
                     "unit":"MONTHS"
                  },
                  "terminateWhenPolicyEnds":false,
                  "allowGracePeriodForTermination":false,
                  "graceLimit":null,
                  "allowPolicyExtension":false,
                  "extensionLimit":null,
                  "allowGracePeriodNotification":false,
                  "allowPolicyExpiryNotification":false,
                  "notifications":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "created":1519864287534,
                  "lastUpdated":1519864287534,
                  "resources":[

                  ],
                  "priority":1,
                  "ownerId":2
               },
               "default":true
            }
         ]
      },
      "suspensionPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "allPolicies":false,
         "mandatory":false,
         "policies":[
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v2/suspensionPolicies/2",
                  "name":"sadfas",
                  "description":"",
                  "enabled":true,
                  "schedules":[
                     {
                        "type":"DAILY",
                        "days":[

                        ],
                        "startTime":"08:00",
                        "endTime":"17:00",
                        "repeats":"1"
                     }
                  ],
                  "blockoutPeriods":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "resourcesMaps":[

                  ],
                  "priority":2,
                  "created":1521516000221,
                  "lastUpdated":1521516000221,
                  "ownerId":2
               },
               "default":false
            },
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v2/suspensionPolicies/1",
                  "name":"MySuspensionPolicy",
                  "description":"",
                  "enabled":true,
                  "schedules":[
                     {
                        "type":"DAILY",
                        "days":[

                        ],
                        "startTime":"08:00",
                        "endTime":"17:00",
                        "repeats":"1"
                     }
                  ],
                  "blockoutPeriods":[

                  ],
                  "isPolicyActiveOnResources":false,
                  "resourcesMaps":[

                  ],
                  "priority":1,
                  "created":1519864307976,
                  "lastUpdated":1519864307976,
                  "ownerId":2
               },
               "default":true
            }
         ]
      },
      "securityPolicySettings":{
         "visibleState":"VISIBLE_ENABLED",
         "mandatory":false,
         "policies":[
            {
               "policyId":2,
               "policy":{
                  "id":"2",
                  "resource":"https://<HOST>:<PORT>/v1/securityProfiles/2",
                  "perms":[
                     "administration",
                     "write",
                     "read",
                     "delete"
                  ],
                  "name":"dsfa",
                  "description":"",
                  "securityProfileRules":[
                     {
                        "fromPort":1234,
                        "toPort":5678,
                        "comment":"",
                        "protocol":"TCP",
                        "ruleType":"INBOUND",
                        "remoteType":"CIDR",
                        "sourceIps":[
                           "0.0.0.0/0"
                        ],
                        "id":2
                     }
                  ]
               },
               "locked":false,
               "default":false
            },
            {
               "policyId":1,
               "policy":{
                  "id":"1",
                  "resource":"https://<HOST>:<PORT>/v1/securityProfiles/1",
                  "perms":[
                     "administration",
                     "write",
                     "read",
                     "delete"
                  ],
                  "name":"mysecurityprofile",
                  "description":"",
                  "securityProfileRules":[
                     {
                        "fromPort":1234,
                        "toPort":5678,
                        "comment":"",
                        "protocol":"TCP",
                        "ruleType":"INBOUND",
                        "remoteType":"CIDR",
                        "sourceIps":[
                           "0.0.0.0/0"
                        ],
                        "id":1
                     }
                  ]
               },
               "locked":true,
               "default":true
            }
         ]
      },
      "allowTerminateProtection":true
   }
}


Request Attributes

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

extensionId
  • DescriptionUnique, system-generated identifier for the extension. See the Extensions section for the relevant release for additional details.
  • Type: String

defaultSettings
  • Description: The default settings for the deployment environment
  • Type: String

requiresApproval
  • Description: A flag to indicate if approval is required to deploy in this environment
  • Type: Boolean
associatedClouds (click for additional details)

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

Response Attributes

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

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String
allowedClouds
  • Description: Identifies cloud infrastructures under the cloud accounts set up and shared by their parent tenant. If the tenant does not have any restriction, this attribute displays "null" to indicate the lack of restrictions.
  • Type: String
defaultSettings
  • Description: The default settings for the deployment environment
  • Type: String
requiresApproval
  • Description: A flag to indicate if approval is required to deploy in this environment
  • Type: Boolean
associatedClouds (click for additional details)

policySettings
  • Description: Identifies the same deployment environments that are governed by the same set of allowed policies (aging, suspension, and security). If different users or applications require different sets of allowed policies at deploy time, then these users can create additional deployment environments to account for each permutation.

  • Type: Array of policy details

    agingPolicySettings
    • Description: Identifies the aging policy that causes the CloudCenter platform to suspend and optionally terminate each application deployment that is associated with the policy after the application deployment has been running for a designated period or reaches a designated deployment cost.

      An aging policy and the prevent termination feature cannot be used simultaneously for a deployment because both items control the terminate and suspend behavior of VMs that are mapped to a deployment.

    • Type: An array of aging policy settings

      visibleState
      • Description: Identifies if user have visibility to this policy.
      • Type: Enumeration

        EnumerationDescription
        VISIBLE_ENABLEDUsers in any sub-tenant can view or use a policy in this state.
        VISIBLE_DISABLEDDefault. No user in any sub-tenant can view or use a policy in this state.

        VISIBLE_ENABLED_READONLY

        Users in tenants that are further down the hierarchy can only View (read only) these policies, if shared.

      allPolicies
      • Description: When a deployment environment or application profile is shared with a sub-tenant or users in a sub-tenant, all policies (and system tags) associated with that environment or application profile can still be used in the shared environment or application profile.
      • Type: Boolean
        • true = All policies are associated with the deployment environment.
        • false = Specific policies are associated with the deployment environment.

      mandatory
      • Description: Identifies if a value is required.
      • Type: Boolean
        • true = Required.
        • false = Not required (default)

      policies (click for additional details)

    suspensionPolicySettings
    • Description: Identifies a policy to help conserve resources by taking a deployment out of Running state when it is not needed, or for preventing a deployment from running during times that it should not be accessed. It can also be useful to keep a deployment in a suspended state during a holiday or a holiday period.

    • Type: An array of suspension policy settings

      visibleState
      • Description: Identifies if user have visibility to this policy.
      • Type: Enumeration

        EnumerationDescription
        VISIBLE_ENABLEDUsers in any sub-tenant can view or use a policy in this state.
        VISIBLE_DISABLEDDefault. No user in any sub-tenant can view or use a policy in this state.

        VISIBLE_ENABLED_READONLY

        Users in tenants that are further down the hierarchy can only View (read only) these policies, if shared.

      allPolicies
      • Description: When a deployment environment or application profile is shared with a sub-tenant or users in a sub-tenant, all policies (and system tags) associated with that environment or application profile can still be used in the shared environment or application profile.
      • Type: Boolean
        • true = All policies are associated with the deployment environment.
        • false = Specific policies are associated with the deployment environment.

      mandatory
      • Description: Identifies if a value is required.
      • Type: Boolean
        • true = Required.
        • false = Not required (default)

      policies (click for additional details)

    securityPolicySettings
    • Description: Identifies a policy that can contain ingress and egress rules and can be dynamically attached to a CloudCenter deployment. Security policies are configured at the tenant level and can be associated with System Tags.

    • Type: An array of security policy settings

      visibleState
      • Description: Identifies if user have visibility to this policy.
      • Type: Enumeration

        EnumerationDescription
        VISIBLE_ENABLEDUsers in any sub-tenant can view or use a policy in this state.
        VISIBLE_DISABLEDDefault. No user in any sub-tenant can view or use a policy in this state.

        VISIBLE_ENABLED_READONLY

        Users in tenants that are further down the hierarchy can only View (read only) these policies, if shared.

      allPolicies
      • Description: When a deployment environment or application profile is shared with a sub-tenant or users in a sub-tenant, all policies (and system tags) associated with that environment or application profile can still be used in the shared environment or application profile.
      • Type: Boolean
        • true = All policies are associated with the deployment environment.
        • false = Specific policies are associated with the deployment environment.

      mandatory
      • Description: Identifies if a value is required.
      • Type: Boolean
        • true = Required.
        • false = Not required (default)

      policies (click for additional details)

    allowTerminateProtection
    • Description: Identifies if the deployment owner has prevented this deployment from being terminated by a user.

      The Prevent Termination feature is only applicable to N-tier jobs.

    • Type: Boolean
      • true = The enable terminate protection function is configured and users cannot terminate this deployment.
      • false = The enable terminate protection function is not configured and users can terminate this deployment.

totalDeployments
  • Description: The total number of deployments associated with this deployment environment
  • Type: Long
costDetails
  • Description: A breakdown of multiple costs associated with this cloud.
  • Type: Sequence of cost details

     totalCloudCost 
    • Description: The cloud infrastructure costs charged by the cloud provider. See the Supported Public Clouds or the Supported Datacenters and Private Clouds section for the relevant release for all deployments, runs, users, VMs, instance types, and so forth. See the CloudCenter Cost and Fees section for the relevant release for additional context.
    • Type: Float

     totalAppCost 
    • Description: The total cost of using metered applications. See the CloudCenter Cost and Fees section and the Markterplace Application Fee section for the relevant release for additional context.
    • Type: Float
     totalJobsCost 
    • Description: The total cost associated with the cloud for a particular job, the management cost associated with the jobs run to date.
    • Type: Float



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