Update Datacenter Component

Update Datacenter Component

Update a datacenter component.

Request
URI
PUT
https://{api_host}/https://{{host}}:{{port}}/api/v5/lcm/datacenter/{datacenterId}
COPY
Path Parameters
string
datacenterId
Required

The ID of the datacenter component

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

Show optional properties

{
    "fqdn": "string",
    "username": "string",
    "password": "string"
}
{
    "properties": {
        "properties": {}
    },
    "componentName": "string",
    "version": "string",
    "datacenterComponentType": "string",
    "fqdn": "string",
    "username": "string",
    "password": "string",
    "content": {
        "certificate": {
            "validFrom": "string",
            "validTo": "string",
            "thumbprint": "string"
        }
    },
    "purpose": "string",
    "tags": [
        "string"
    ],
    "managedBy": "string",
    "relatedProducts": [
        {
            "id": "string",
            "type": "string",
            "hostname": "string",
            "ip": "string",
            "version": "string",
            "username": "string",
            "password": "string",
            "additionalDetail": {
                "additionalDetail": {}
            }
        }
    ]
}
object
properties
Optional

Additional properties

string
componentName
Optional

The component name is the identifier for the datacenter component.

string
version
Optional

The version of the datacenter component.

string
datacenterComponentType
Optional

The type of the datacenter component.

Possible values are : VCENTER, NSXT, VRSLCM, VROPS, VRLI, NSXALB, SDDC, TMC, SRM, VSAN,
string As ^([a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-zA-Z0-9])?\.)*[a-z_A-Z0-9]([a-z_A-Z0-9\-]*[a-z_A-Z0-9])?$
fqdn
Required

The FQDN or IP of the datacenter component.

string
username
Required

The username to authenticate with the datacenter component.

string As (^[^'"]{2,32}$)|(^ref:password:[a-zA-Z0-9]{20}$)
password
Required

The password to authenticate with the datacenter component.

DcBaseObject
content
Optional

Additional content of the datacenter component.

string
purpose
Optional

The specified purpose of the datacenter component, defining how this component will be used (e.g. for management or resource purposes).

Possible values are : ANY, MANAGEMENT, RESOURCE,
array of string
tags
Optional

DC tags.

string
managedBy
Optional

If this component is managed by another datacenter component (e.g. by SDDC manager, the reference to the other component is specified here).

array of DcRelatedProductSpec
relatedProducts
Optional

Other products that are related to this one (e.g. VCs managed by this SDDC manager).

Responses
200

Confirmation for update.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


400

Invalid datacenter spec

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


401

Unauthorized access

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


404

Datacenter component not found.

Returns TaskResponse of type(s) */* 
{
    "taskId": "string",
    "precedingTasks": [
        0
    ]
}
string
taskId
Required

The ID of the task that was created for the operation. Use this ID to get the state and result of the task.

array of integer
precedingTasks
Optional

List of task IDs for tasks that have to be processed before this task can start.


On This Page
Datacenter Operations
POST
Add Dc Component
DELETE
Delete Dc Component
POST
Discover Datacenter Component
GET
Get Dc Component
GET
Get Dc Component List
PUT
Update Datacenter Component