Get Tenant Environment Json
Use this endpoint to get details of onboarded environment
Authorized Roles : PROVIDER
Request
URI
GET
https://{api_host}/provider/registered-environments/{id}/onboarding
COPY
Path Parameters
string
id
Required
ID of the registered environment
Responses
200
OK
Returns
ProviderTenantEnvironmentDTO
of type(s)
application/vnd.vmware.dms-v1+json
{
"environmentId": "string",
"tenantId": "string",
"vcInstanceUuid": "string",
"vcIpAddress": "string",
"pscFqdn": "string",
"vcThumbprint": "string",
"pscThumbprint": "string",
"vcDatacenter": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcVMFolder": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcCluster": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcResourcePool": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcResourcePoolPath": "string",
"vcVmDatastores": {
"list": [
{
"mor": "string",
"datastoreName": "string",
"isDefault": false
}
]
},
"vcAppNetworks": {
"list": [
{
"mor": "string",
"appNetworkName": "string",
"isDefault": false
}
]
},
"lcpNetwork": {
"id": "string",
"moId": "string",
"name": "string",
"type": "string",
"isDefault": false
},
"vcDmsUsername": "string",
"vcDmsUserPassword": "string",
"vcDmsROUsername": "string",
"vcDmsROUserPassword": "string",
"tenantNtp": "string",
"tenantIpAddress": "string",
"state": "string",
"providerRabbitSettings": {
"rabbitEndpoints": [
{
"endpoint": "string",
"port": 0
}
],
"username": "string",
"password": "string"
},
"runtimeInfo": [
{
"environmentId": "string",
"alertType": "string",
"alertStatus": "string",
"alertTime": "string",
"environmentName": "string"
}
],
"status": "string",
"version": "string",
"vmRootPassword": "string",
"clusterType": "string",
"templateStorage": {
"id": "string",
"name": "string",
"endpoint": "string",
"bucket": "string",
"accessKey": "string",
"secretKey": [
"string"
],
"region": "string",
"thumbprint": "string",
"templateStorage": false
},
"agentVMName": "string"
}
string As uuid
As uuid
environmentId
Optional
environmentId
string As uuid
As uuid
tenantId
Required
tenantId
string As uuid
As uuid
vcInstanceUuid
Optional
vcInstanceUuid
string
vcIpAddress
Required
vcIpAddress
string
pscFqdn
Optional
pscFqdn
string
vcThumbprint
Optional
vcThumbprint
string
pscThumbprint
Optional
pscThumbprint
string
vcResourcePoolPath
Optional
vcResourcePoolPath
string
vcDmsUsername
Optional
vcDmsUsername
string
vcDmsUserPassword
Optional
vcDmsUserPassword
string
vcDmsROUsername
Optional
vcDmsROUsername
string
vcDmsROUserPassword
Optional
vcDmsROUserPassword
string
tenantNtp
Optional
tenantNtp
string
tenantIpAddress
Optional
tenantIpAddress
string
state
Optional
state
Possible values are :
ACTIVE_MODE,
MAINTENANCE_INIT_MODE,
MAINTENANCE_ACTIVATED_MODE,
string
status
Optional
status
Possible values are :
INIT,
ONLINE,
MAINTENANCE_MODE,
DEGRADED,
WARNING,
string
version
Optional
version
string
vmRootPassword
Optional
vmRootPassword
string
clusterType
Required
clusterType
Possible values are :
VMC,
VSPHERE,
string
agentVMName
Optional
agentVMName
400
Bad Request
Operation doesn't return any data structure
Provider Onboarding Operations
GET
Get Cluster 1
GET
Get Datacenters 1
GET
Get Datastore 1
GET
Get Network 1
GET
Get Resource Pools 1
GET
Get Running Shovels
GET
Get Tenant Environment Json
GET
Get Thumbprint
GET
Get VM Folder 1
POST
Save Tenant Environment
POST
Validate PSC
POST
Validate Storage
POST
Validate VC 1
POST
Validate VC Permission
POST
Vc Login
DELETE
Vc Logout