Get All Environments With V Center V2 Using GET

Get All Environments With V Center V2 Using GET

This API is used to get all environments associated with a vCenter.

Request
URI
GET
https://{api_host}/lcm/lcops/api/v2/datacenters/{dataCenterVmid}/vcenters/{vCenterName}/environments
COPY
Path Parameters
string
dataCenterVmid
Required

dataCenterVmid

string
vCenterName
Required

vCenterName

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Array of EnvironmentRequestDTO of type(s) application/json 
[
    {
        "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": "administrator@vsphere.local",
                "vcPassword": "locker:password:<vmid>:<alias>",
                "acceptEULA": "true",
                "enableTelemetry": "true",
                "adminEmail": "adminuser@vmware.com",
                "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"
            }
        ]
    }
]

400

Bad Request

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
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

Returns GenericErrorResponseDTO of type(s) application/json 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
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 
{
    "errorCode": "LCM_EXAMPLE_API_ERROR0000",
    "errorLabel": "Example Error!",
    "message": "Something went wrong!",
    "recommendations": []
}
string
errorCode
Optional

errorCode

string
errorLabel
Optional

errorLabel

string
message
Optional

message

array of string
recommendations
Optional

recommendations


On This Page
Data Center Controller Operations
POST
Create Data Center V2 Using POST
POST
Create V Center V2 Using POST
DELETE
Delete Data Center V2 Using DELETE
DELETE
Delete V Center V2 Using DELETE
GET
Get All Data Centers V2 Using GET
GET
Get All Environment From Data Center V2 Using GET
GET
Get All Environments With V Center V2 Using GET
GET
Get All V Centers V2 Using GET
GET
Get All V Ms Using GET
GET
Get Data Center V2 Using GET
GET
Get V Center V2 Using GET
POST
Import V Centers V2 Using POST
POST
Trigger V Center Data Collection V2 Using POST
PUT
Update Data Center V2 Using PUT
PUT
Update V Center V2 Using PUT
POST
Validate Import V Centers V2 Using POST
POST
Validate V Center V2 Using POST