REST API - summary

vcenter topology nodes: summary

The summary structure contains commonly used information of vCenter or Platform Services Controller node. This structure was added in vSphere API 6.7.2.

Representation:

JSON

{
    "node" : "obj-103",
    "replication_partners" : [
        "obj-103",
        "obj-103"
    ],
    "client_affinity" : "obj-103",
    "type" : "VCSA_EMBEDDED"
}

Attributes:

Name	Type	Description
Required
node	string	Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. This attribute was added in vSphere API 6.7.2. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.VCenter.name`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.VCenter.name`.
type	string	Appliance type of the node. This attribute was added in vSphere API 6.7.2. Defines values for valid appliance types for the vCenter and Platform Services Controller node. See vcenter.topology.nodes.info. This enumeration was added in vSphere API 6.7.2. Value is one of: VCSA_EMBEDDED: vCenter Server Appliance with an embedded Platform Services Controller. This constant was added in vSphere API 6.7.2. VCSA_EXTERNAL: vCenter Server Appliance with an external Platform Services Controller. This constant was added in vSphere API 6.7.2. PSC_EXTERNAL: An external Platform Services Controller. This constant was added in vSphere API 6.7.2.
Optional
replication_partners	string[]	List of replication partners' node identifiers. Identifiers can be either IP address or DNS resolvable name of the partner node. This attribute was added in vSphere API 6.7.2. Optional. It is only relevant when type has value [VCSA_EMBEDDED, PSC_EXTERNAL]. This field is optional and it is only relevant when the value of `type` is one of VCSA_EMBEDDED or PSC_EXTERNAL.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: `com.vmware.vcenter.VCenter.name`. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: `com.vmware.vcenter.VCenter.name`.
client_affinity	string	Identifier of the affinitized Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the affinitized node. This attribute was added in vSphere API 6.7.2. Optional. It is only relevant when type has value VCSA_EXTERNAL. This field is optional and it is only relevant when the value of `type` is VCSA_EXTERNAL.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vcenter.VCenter.name`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vcenter.VCenter.name`.