Topology_Nodes_Summary

The Nodes.Summary structure contains commonly used information of vCenter or Platform Services Controller node.

JSON Example

{
    "node": "string",
    "type": "string",
    "replication_partners": [
        "string"
    ],
    "client_affinity": "string"
}

string

node

Required

Identifier for the vCenter or Platform Services Controller node. Identifier can be either IP address or DNS resolvable name of the node. 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.

Topology_Nodes_ApplianceType

type

Required

The Nodes.ApplianceType enumerated type defines values for valid appliance types for the vCenter and Platform Services Controller node. See Nodes.Info.
VCSA_EMBEDDED : vCenter Server Appliance with an embedded Platform Services Controller.
VCSA_EXTERNAL : vCenter Server Appliance with an external Platform Services Controller.
PSC_EXTERNAL : An external Platform Services Controller.

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 field is optional and it is only relevant when the value of Nodes.Summary.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.

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 field is optional and it is only relevant when the value of Nodes.Summary.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.