This API has a deprecated equivalent from v7.0U1.
List Nodes
Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec. if you do not have all of the privileges described as follows: - Operation execution requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/topology/nodes
Query Parameters
Query Parameters
array of
TopologyNodesApplianceType
types
Optional
Types of the appliance that a vCenter and Platform Services Controller node must be to match the filter (see Nodes.ApplianceType. If unset or empty, node of any ApplianceType match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
TopologyNodesSummary
of type application/json
commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec.
[
{
"client_affinity": "string",
"node": "string",
"replication_partners": [
"string"
],
"type": "VCSA_EMBEDDED"
}
]
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.
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.
Possible values are: VCSA_EMBEDDED , VCSA_EXTERNAL , PSC_EXTERNAL
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.
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.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Nodes.FilterSpec.types field contains a value that is not supported.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-ListTopologyNodes -Types "VCSA_EMBEDDED"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/topology/nodes
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/topology/nodes
x-vmw-doc-operation: list
Availability
Added in 7.0U2
On This Page
Nodes Operations
get
get
