Update Sddc

Update Sddc

Update a specific Software-Defined Datacenter.

Request
URI
PUT
https://{api_host}/cloudapi/1.0.0/sddcs/{id}
COPY
Path Parameters
string
id
Required

SDDC ID URN

string
id
Required

SDDC ID URN

Request Body

The updated SDDC model.

Sddc of type(s) application/json
Required 
{
    "name": "SDDC Sample Name",
    "id": "string",
    "description": "SDDC Sample Description",
    "enabled": false,
    "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "version": "6.7.0",
    "overallStatus": "string",
    "stats": {
        "totalVMs": 0,
        "poweredOnVMs": 0,
        "cpu": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        },
        "memory": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        },
        "storage": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        }
    },
    "defaultProxy": {
        "name": "SDDC Proxy Sample Name",
        "id": "string",
        "sddcId": "urn:vcloud:sddc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "enabled": false,
        "tenantVisible": false,
        "targetHost": "sampleVc.vmware.com",
        "active": false,
        "token": "string",
        "defaultProxy": false,
        "parentProxyId": "urn:vcloud:sddcProxy:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "uiUrl": "https://sampleVc.vmware.com"
    },
    "defaultEndpoint": {
        "name": "SDDC Endpoint Sample Name",
        "id": "string",
        "endpoint": "string",
        "proxyId": "string",
        "targetUrl": "https://sampleVc.vmware.com/ui",
        "proxy": {
            "name": "string",
            "id": "string"
        },
        "sddc": {
            "name": "string",
            "id": "string"
        },
        "isDefault": false
    }
}
string
name
Required

name

string
id
Optional

id

string
description
Optional

description

boolean
enabled
Optional

enabled

string
vcId
Required

URN of the associated vCenter. This is not editable once the SDDC has been created.

string
version
Optional

Version of the associated vCenter. This is not editable.

OverallStatus
overallStatus
Optional

Overall status of the entity

Possible values are : GRAY, RED, YELLOW, GREEN,
SddcStats
stats
Optional

A read-only list of resource allocations for the associated SDDC

SddcProxy
defaultProxy
Optional

SDDC proxy configuration

SddcEndpoint
defaultEndpoint
Optional

An available network connections exposed by the SDDC

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Sddc of type(s) application/json;version=39.0 
{
    "name": "SDDC Sample Name",
    "id": "string",
    "description": "SDDC Sample Description",
    "enabled": false,
    "vcId": "urn:vcloud:vimserver:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "version": "6.7.0",
    "overallStatus": "string",
    "stats": {
        "totalVMs": 0,
        "poweredOnVMs": 0,
        "cpu": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        },
        "memory": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        },
        "storage": {
            "numTotal": 0,
            "numUsed": 0,
            "numReserved": 0
        }
    },
    "defaultProxy": {
        "name": "SDDC Proxy Sample Name",
        "id": "string",
        "sddcId": "urn:vcloud:sddc:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "enabled": false,
        "tenantVisible": false,
        "targetHost": "sampleVc.vmware.com",
        "active": false,
        "token": "string",
        "defaultProxy": false,
        "parentProxyId": "urn:vcloud:sddcProxy:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "uiUrl": "https://sampleVc.vmware.com"
    },
    "defaultEndpoint": {
        "name": "SDDC Endpoint Sample Name",
        "id": "string",
        "endpoint": "string",
        "proxyId": "string",
        "targetUrl": "https://sampleVc.vmware.com/ui",
        "proxy": {
            "name": "string",
            "id": "string"
        },
        "sddc": {
            "name": "string",
            "id": "string"
        },
        "isDefault": false
    }
}
string
name
Required

name

string
id
Optional

id

string
description
Optional

description

boolean
enabled
Optional

enabled

string
vcId
Required

URN of the associated vCenter. This is not editable once the SDDC has been created.

string
version
Optional

Version of the associated vCenter. This is not editable.

OverallStatus
overallStatus
Optional

Overall status of the entity

Possible values are : GRAY, RED, YELLOW, GREEN,
SddcStats
stats
Optional

A read-only list of resource allocations for the associated SDDC

SddcProxy
defaultProxy
Optional

SDDC proxy configuration

SddcEndpoint
defaultEndpoint
Optional

An available network connections exposed by the SDDC


Availability
Added in 32.0
On This Page
Sddcs Operations
POST
Create Sddc
POST
Create Sddc Endpoint
DELETE
Delete Sddc
DELETE
Delete Sddc Endpoint
GET
Get Endpoints For Sddc
GET
Get Proxies For Sddc
GET
Get Sddc
GET
Get Sddc Endpoint
GET
Get Sddc Owner
GET
Get Sddcs
GET
Query Sddc Tenants
POST
Sddc Publish To Tenants
POST
Sddc Unpublish From Tenants
PUT
Set Sddc Owner
PUT
Set Sddc Tenants
PUT
Update Sddc
PUT
Update Sddc Endpoint