Get Environment List
You can use this operation to get a list of LCM environments. The list might contain all available environments, a subset defined by the pagesize or a subset matching the specified filter. The list can also be sorted alphabetically (by environmentId) or by version.
Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/environment
COPY
Query Parameters
integer
pageSize
Optional
Number of environments to be returned. Default: 20
integer
page
Optional
The page index. Default: 1
string of array
filterKey
Optional
If filterValue is also specified, list of DC keys to use for filtering
array
filterValue
Optional
If filterKey is also specified, list of DC values to use for filtering
string
sortKey
Optional
Sort the resulting list of environments alphabetically (by environmentId) or by version. If not defined, will return chronological order.
boolean
hideSecret
Optional
Hide secrets in the resulting list. If not specified or false, secrets will be defined with references (no plain text shown).
Responses
200
List of LCM environments.
[
{
"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"
}
]
401
Unauthorized access
[
{
"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"
}
]
Environment Operations
POST
Create Environment
DELETE
Delete Environment
GET
Get Environment
GET
Get Environment List