Get Environment List 1
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).
Request
URI
GET
https://10.71.204.121:9443/api/v2/lcm/environment
COPY
Query Parameters
integer
pageSize
Optional
Number of environments to be returned. Default: 20
integer
page
Optional
The page index. Default: 1
boolean
asc
Optional
Sort the resulting list of environments ascending. If not defined, will return chronological order, otherwise alphabetically ordered (by environment ID), either ascending or descending
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.
[
{
"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"
}
],
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"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": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
],
"environmentType": "string"
}
]
401
Unauthorized access
[
{
"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"
}
],
"deployment": {
"vcenterName": "string",
"datacenterName": "string",
"clusterName": "string",
"resourcePool": "string",
"vmFolder": "string",
"datastoreNames": [
"string"
]
},
"endpointAddress": "string",
"status": {
"status": "string",
"messages": [
"string"
],
"lastDiscovery": "string"
},
"nodes": [
{
"nodeId": "integer",
"isPrimary": "boolean",
"cpuNum": "integer",
"ramMemory": "integer",
"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": "boolean",
"dns": [
"string"
],
"ntp": [
"string"
]
}
}
]
}
]
}
],
"environmentType": "string"
}
]