Create Cloud Environment Using POST

Create Cloud Environment Using POST

This API is used to create a cloud proxy environment.

Request
URI
POST
https://{api_host}/lcm/lcops/api/v2/cloudproxyenvironments
COPY
Request Body

environmentRequestDTO

EnvironmentRequestDTO of type(s) application/json
Optional
{
    "environmentDescription": "vRealize Automation Environment",
    "environmentHealth": "string",
    "environmentId": "string",
    "environmentName": "vRealize Automation Environment",
    "environmentStatus": "COMPLETED",
    "infrastructure": {
        "properties": {
            "dataCenterVmid": "d250f635-df41-44b9-b44c-1705c1ed304f",
            "regionName": "default",
            "zoneName": "default",
            "vCenterName": "vCenter-1",
            "vCenterHost": "vcenter-1.example.com",
            "vcUsername": "[email protected]",
            "vcPassword": "locker:password:<vmid>:<alias>",
            "acceptEULA": "true",
            "enableTelemetry": "true",
            "adminEmail": "[email protected]",
            "defaultPassword": "locker:password:<vmid>:<alias>",
            "certificate": "locker:certificate:<vmid>:<alias>",
            "cluster": "<vc-datacenter>#<cluster>",
            "storage": "<storage>",
            "folderName": "<folder>",
            "resourcePool": "<resource-pool>",
            "diskMode": "thin",
            "network": "<network>",
            "masterVidmEnabled": "false",
            "dns": "<dns-server1-ip>,<dns-server2-ip>",
            "domain": "<domain>",
            "gateway": "<gateway>",
            "netmask": "<subnet mask>",
            "searchpath": "<search path>",
            "timeSyncMode": "<host/ntp>",
            "ntp": "<ntp-server1>,<ntp-server2>"
        }
    },
    "logHistory": "string",
    "metaData": {
        "metaData": "string"
    },
    "products": [
        {
            "clusterVIP": {
                "clusterVips": [
                    {
                        "properties": {
                            "properties": "string"
                        },
                        "type": "string"
                    }
                ]
            },
            "collectorGroups": {
                "collectorGroups": [
                    {
                        "description": "string",
                        "id": "d7d5624a-f975-48c0-864b-868ca883d979",
                        "name": "test collector group",
                        "nodes": [
                            {
                                "properties": {
                                    "properties": "string"
                                },
                                "type": "vrava-primary"
                            }
                        ]
                    }
                ],
                "collectorsName": [
                    "string"
                ],
                "operationType": "add"
            },
            "id": "vra",
            "logHistory": "string",
            "nodes": [
                {
                    "properties": {
                        "properties": "string"
                    },
                    "type": "vrava-primary"
                }
            ],
            "patchHistory": "string",
            "properties": {
                "properties": "string"
            },
            "snapshotHistory": "string",
            "version": "8.3.0"
        }
    ]
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GenericRequestResponse of type(s) application/json
"GenericRequestResponse Object"
string
requestId
Optional

Request ID


201

Created

Operation doesn't return any data structure

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json
"GenericErrorResponseDTO Object"
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

409

Conflict

Returns GenericErrorResponseDTO of type(s) application/json
"GenericErrorResponseDTO Object"
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


500

Internal Server Error

Returns GenericErrorResponseDTO of type(s) application/json
"GenericErrorResponseDTO Object"
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/lcm/lcops/api/v2/cloudproxyenvironments