EnvironmentSpecV2

EnvironmentSpecV2
EnvironmentSpecV2

The environment specification defining the environment and products to deploy.

JSON Example
{
    "properties": {
        "properties": {}
    },
    "environmentName": "string",
    "environmentId": "string",
    "environmentState": "string",
    "products": [
        {
            "properties": {
                "properties": {}
            },
            "productType": "string",
            "productId": "string",
            "version": "string",
            "buildNumber": "string",
            "productInternalId": "string",
            "license": "string",
            "adminPassword": "string",
            "integrations": [
                {
                    "properties": {
                        "properties": {}
                    },
                    "integrationId": "string",
                    "integrationUsername": "string",
                    "integrationPassword": "string",
                    "status": "string",
                    "ref": "string",
                    "version": "string"
                }
            ],
            "certificate": {
                "certificate": {
                    "validFrom": "string",
                    "validTo": "string",
                    "thumbprint": "string",
                    "certificate": "string",
                    "privateKey": "string",
                    "keyPassword": "string"
                }
            },
            "tags": [
                "string"
            ],
            "environmentId": "string",
            "deployment": {
                "vcenterName": "string",
                "datacenterName": "string",
                "clusterName": "string",
                "resourcePool": "string",
                "vmFolder": "string",
                "datastoreNames": [
                    "string"
                ]
            },
            "endpointAddress": "string",
            "status": {
                "status": "string",
                "messages": [
                    "string"
                ],
                "lastDiscovery": "string"
            },
            "nodes": [
                {
                    "properties": {
                        "properties": {}
                    },
                    "nodeId": 0,
                    "isPrimary": false,
                    "cpuNum": 0,
                    "ramMemory": 0,
                    "hostName": "string",
                    "vmName": "string",
                    "deploymentOption": "string",
                    "datastoreName": "string",
                    "clusterName": "string",
                    "resourcePool": "string",
                    "datacenterName": "string",
                    "rootPassword": "string",
                    "gateway": "string",
                    "deployment": {
                        "vcenterName": "string",
                        "datacenterName": "string",
                        "clusterName": "string",
                        "resourcePool": "string",
                        "vmFolder": "string",
                        "datastoreNames": [
                            "string"
                        ]
                    },
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "string"
                            ],
                            "dcVcenterNetworksSpec": {
                                "portGroupName": "string",
                                "gateway": "string",
                                "subnetMask": "string",
                                "domainName": "string",
                                "searchPath": [
                                    "string"
                                ],
                                "useDhcp": false,
                                "dns": [
                                    "string"
                                ],
                                "ntp": [
                                    "string"
                                ]
                            }
                        }
                    ],
                    "status": "string"
                }
            ]
        }
    ],
    "environmentType": "string"
}
object
properties
Optional

Additional properties

string
environmentName
Required

Name of an environment. If no ID is specified, this name will be normalized and used as ID.

string As [a-zA-Z0-9_\-.]{3,}
environmentId
Optional

ID of an environment.

string
environmentState
Optional

The state of the environment - will be discovered by VCP LCM.

products
Required

products

string
environmentType
Optional

The type of this environment - production or nonproduction.

Possible values are : PRODUCTION, NONPRODUCTION,