Save Tenant Environment

Save Tenant Environment

Use this endpoint to save environment details
Authorized Roles : PROVIDER

Request
URI
POST
https://{api_host}/provider/registered-environments/{envId}/onboarding
COPY
Path Parameters
string
envId
Required

UUID of the registered environment

Header Parameters
string
X-Org-ID
Required

X-Org-ID

string
Authorization
Required

Authorization

Request Body
ProviderTenantEnvironmentDTO of type(s) application/json
Required

Show optional properties

{
    "tenantId": "string",
    "vcIpAddress": "string",
    "vcDatacenter": {},
    "vcVMFolder": {},
    "vcCluster": {},
    "vcVmDatastores": {},
    "vcAppNetworks": {},
    "lcpNetwork": {},
    "clusterType": "string",
    "templateStorage": {
        "name": "string",
        "endpoint": "string",
        "bucket": "string",
        "accessKey": "string",
        "secretKey": [
            {}
        ]
    }
}
{
    "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
    },
    "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
    },
    "vcSsoUsername": "string",
    "vcSolutionUsername": "string",
    "vcSsoPassword": "string",
    "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
    }
}
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

object
vcDatacenter
Required

vcDatacenter

object
vcVMFolder
Required

vcVMFolder

object
vcCluster
Required

vcCluster

object
vcVmDatastores
Required

vcVmDatastores

object
vcAppNetworks
Required

vcAppNetworks

object
lcpNetwork
Required

lcpNetwork

string
vcSsoUsername
Optional

vcSsoUsername

string
vcSolutionUsername
Optional

vcSolutionUsername

string
vcSsoPassword
Optional

vcSsoPassword

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,
object
providerRabbitSettings
Optional

providerRabbitSettings

array of object
runtimeInfo
Optional

runtimeInfo

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,
object
templateStorage
Required

S3 Storage Details

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ProviderTenantEnvironmentDTO of type(s) application/vnd.vmware.dms-v1+json 
"ProviderTenantEnvironmentDTO Object"
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

object
vcDatacenter
Required

vcDatacenter

object
vcVMFolder
Required

vcVMFolder

object
vcCluster
Required

vcCluster

object
vcVmDatastores
Required

vcVmDatastores

object
vcAppNetworks
Required

vcAppNetworks

object
lcpNetwork
Required

lcpNetwork

string
vcSsoUsername
Optional

vcSsoUsername

string
vcSolutionUsername
Optional

vcSolutionUsername

string
vcSsoPassword
Optional

vcSsoPassword

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,
object
providerRabbitSettings
Optional

providerRabbitSettings

array of object
runtimeInfo
Optional

runtimeInfo

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,
object
templateStorage
Required

S3 Storage Details


400

Bad Request

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"clusterType:"string","lcpNetwork:"object","templateStorage:"object","tenantId:"string","vcAppNetworks:"object","vcCluster:"object","vcDatacenter:"object","vcIpAddress:"string","vcVMFolder:"object","vcVmDatastores:"object"}' https://{api_host}/provider/registered-environments/{envId}/onboarding
On This Page
Provider Onboarding Operations
POST
Validate VC Permission
POST
Validate VC
POST
Vc Login
POST
Validate Storage
POST
Validate PSC
GET
Get Tenant Environment Json
POST
Save Tenant Environment
GET
Get Running Shovels
GET
Get VM Folder
GET
Get Cluster
GET
Get Network
GET
Get Datastore
GET
Get Datacenters
GET
Get Thumbprint
DELETE
Vc Logout