Vcenter Topology Nodes get

Vcenter Topology Nodes get

Retrieve details for a given identifier of the vCenter or Platform Services Controller node.

This operation was added in vSphere API 6.7.2.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires System.Read.
Request
URI
GET
https://{api_host}/api/vcenter/topology/nodes/{node}
COPY
Path Parameters
string
node
Required

Identifier of the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node.

The parameter must be an identifier for the resource type: com.vmware.vcenter.VCenter.name.

Authentication
This operation uses the following authentication methods.
Responses
200

vCenter or Platform Services Controller node details with replication partners and client affinity information as applicable. See Vcenter Topology Nodes Info.

Returns Vcenter Topology Nodes Info of type(s) application/json 
{
    "domain": "string",
    "type": "string",
    "replication_partners": [
        "string"
    ],
    "client_affinity": "string"
}
string
domain
Required

Domain name of the node.

This property was added in vSphere API 6.7.2.

string
type
Required

Appliance type of the node.

For more information see: Vcenter Topology Nodes ApplianceType.

This property was added in vSphere API 6.7.2.

array of string
replication_partners
Optional

List of replication partners' node identifiers. Identifiers can be either IP address or DNS resolvable name of the partner node.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of type is one of Vcenter Topology Nodes ApplianceType.VCSA_EMBEDDED or Vcenter Topology Nodes ApplianceType.PSC_EXTERNAL.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.VCenter.name.

string
client_affinity
Optional

Identifier of the affinitized Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the affinitized node.

This property was added in vSphere API 6.7.2.

This property is optional and it is only relevant when the value of type is Vcenter Topology Nodes ApplianceType.VCSA_EXTERNAL.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.VCenter.name. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.VCenter.name.


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthorized0 
"Vapi Std Errors Unauthorized Object"

404

if a node doesn't exist for given node identifier.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/topology/nodes/{node}
On This Page
Vcenter Operations
GET
Vcenter Topology Nodes list
GET
Vcenter Topology Nodes get