Get Dc Component 1 | VMware Cloud Provider Lifecycle Manager API

Get Dc Component 1

Get the details of a specific registered datacenter component.

Request

URI

GET

https://10.71.204.121:9443/api/v2/lcm/datacenter/{datacenterId}

COPY

Path Parameters

string

datacenterId

Required

The ID of the datacenter component

Responses

200

Details of datacenter component.

Returns DatacenterComponentSpec of type(s) */*

{
    "componentName": "string",
    "version": "string",
    "datacenterComponentType": "string",
    "fqdn": "string",
    "username": "string",
    "password": "string",
    "content": {
        "certificate": {
            "validFrom": "string",
            "validTo": "string",
            "thumbprint": "string"
        }
    },
    "purpose": "string"
}

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.

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 username to authenticate with the datacenter component.

DcBase

content

Optional

content

string

purpose

Optional

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

401

Unauthorized access

Returns DatacenterComponentSpec of type(s) */*

{
    "componentName": "string",
    "version": "string",
    "datacenterComponentType": "string",
    "fqdn": "string",
    "username": "string",
    "password": "string",
    "content": {
        "certificate": {
            "validFrom": "string",
            "validTo": "string",
            "thumbprint": "string"
        }
    },
    "purpose": "string"
}

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.

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 username to authenticate with the datacenter component.

DcBase

content

Optional

content

string

purpose

Optional

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

404

Datacenter component not found.

Returns DatacenterComponentSpec of type(s) */*

{
    "componentName": "string",
    "version": "string",
    "datacenterComponentType": "string",
    "fqdn": "string",
    "username": "string",
    "password": "string",
    "content": {
        "certificate": {
            "validFrom": "string",
            "validTo": "string",
            "thumbprint": "string"
        }
    },
    "purpose": "string"
}

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.