Create Environment

Create Environment

Create a new LCM environment by deploying or registering the specified products. Options: Validate, Import, Deploy

Request
URI
POST
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/environment
COPY
Query Parameters
string
action
Optional

The action to perform for the environment - VALIDATE, IMPORT or DEPLOY.

Possible values are : DEPLOY, IMPORT, VALIDATE,
boolean
ignoreValidation
Optional

Flag to ignore the result of the validation and anyway proceed with deployment.

boolean
replaceExisting
Optional

Flag to check if there is already existing environment with the specified name/id.

Request Body
EnvironmentSpecV2 of type(s) application/json
Required

Show optional properties

{
    "environmentName": "string",
    "products": [
        {
            "productType": "string",
            "productId": "string",
            "version": "string",
            "adminPassword": "string"
        }
    ]
}
{
    "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.

array of ProductSpecV2
products
Required

products

string
environmentType
Optional

The type of this environment - production or nonproduction.

Possible values are : PRODUCTION, NONPRODUCTION,
Responses
200

Task ID for the task creating the environment.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


400

Invalid environment spec

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


On This Page
Environment Operations
POST
Create Environment
DELETE
Delete Environment
GET
Get Environment
GET
Get Environment List