EnvironmentSpec

EnvironmentSpec
EnvironmentSpec

The environment specification defining the environment and products to deploy.

JSON Example
{
    "environmentName": "string",
    "environmentId": "string",
    "environmentState": "string",
    "products": [
        {
            "productType": "string",
            "productId": "string",
            "version": "string",
            "buildNumber": "string",
            "productInternalId": "string",
            "license": "string",
            "adminPassword": "string",
            "integrations": [
                {
                    "integrationId": "string",
                    "integrationUsername": "string",
                    "integrationPassword": "string",
                    "status": "string",
                    "ref": "string",
                    "version": "string"
                }
            ],
            "infraReference": "string",
            "nodes": [
                {
                    "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",
                    "nics": [
                        {
                            "ipAddress": "string",
                            "networkName": "string",
                            "staticRoutes": [
                                "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.

object
deploymentInfrastructures
Required

The deployment infrastructure defining the target infrastructure to deploy in.

array of ProductSpec
products
Required

products