Update Deployment Environment

Details

API Details
NameUpdate Deployment Environment
Description

Updates the information for a specified Deployment Environment.

MethodPUT
URI

v1/environments/depEnvId

CloudCenter Release
  • Updated in CloudCenter 4.0
  • 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 Deployment Environments for additional context.  
    • Includes the regionId of each associated cloud account.   
    • Contains new sections called cloudAssociationDefaults and default.   
Notes
ESB Headeraction: update. environments.depEnvId

Example

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

Request Body

  {
    "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": "archana"
                }, 
                {
                    "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": "archana"
                },
                {
                    "name": "networkId",
                    "value": "acb2b98e-ad27-4dcf-9ec2-78c66b852cf3"
                },
                {
                    "name": "privateIPAllocationMode",
                    "value": "DHCP"
                },
                {
                    "name": "networkName",
                    "value": "archana-net01"
                }
            ],
            "default": false
        }, 
        {
            "regionId": "2",
            "regionName": "VMware-Dev1",
            "regionDisplayName": "Dev1",
            "cloudFamily": "Vmware",
            "cloudId": "2",
            "cloudAccountId": "3",
            "cloudName": "VMware",
            "cloudAccountName": "archana",
            "cloudAssociationDefaults":
            [
                {
                    "name": "publicIpAllocate",
                    "value": "true"
                },
                {
                    "name": "UserClusterName",
                    "value": "test"
                },
                {
                    "name": "networkId",
                    "value": "1015-SE (CliQrDSwitch)"
                },
                {
                    "name": "UserTargetDeploymentFolder",
                    "value": "/Archana"
                },
                {
                    "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
}

Response

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

Requests Attributes

depEnvId
  • DescriptionUnique, system-generated identifier for the deployment environment. See Deployment Environments for additional details. This attribute is the same as the environmentId attribute.
  • Type: String

Response Attributes

deploymentEnvironment
  • Description: Identifies details about a deployment environment
  • Type: Array of mapped attributes

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

    • Type: String

    Required

    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

    Required

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

       totalAppCost 
      • Description: The total cost of using metered applications. See Cost and Fees and Markterplace Application Fee 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