vmware::vcenter::topology::Nodes Interface Reference

The Nodes interface provides methods to retrieve vCenter and Platform Services Controller nodes information in the topology. More...

Inherited by vmware::vcenter::topology::NodesStub.

List of all members.

Public Member Functions
global::System.Collections.Generic.List < vmware.vcenter.topology.NodesTypes.Summary >	List (vmware.vcenter.topology.NodesTypes.FilterSpec filter)
	Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .
global::System.Collections.Generic.List < vmware.vcenter.topology.NodesTypes.Summary >	List (vmware.vcenter.topology.NodesTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.topology.NodesTypes.Summary > >	ListAsync (vmware.vcenter.topology.NodesTypes.FilterSpec filter)
	Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .
global::System.Threading.Tasks.Task < global::System.Collections.Generic.List < vmware.vcenter.topology.NodesTypes.Summary > >	ListAsync (vmware.vcenter.topology.NodesTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .
vmware.vcenter.topology.NodesTypes.Info	Get (string node)
	Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
vmware.vcenter.topology.NodesTypes.Info	Get (string node, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
global::System.Threading.Tasks.Task < vmware.vcenter.topology.NodesTypes.Info >	GetAsync (string node)
	Retrieve details for a given identifier of the vCenter or Platform Services Controller node.
global::System.Threading.Tasks.Task < vmware.vcenter.topology.NodesTypes.Info >	GetAsync (string node, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Retrieve details for a given identifier of the vCenter or Platform Services Controller node.

---

Detailed Description

The Nodes interface provides methods to retrieve vCenter and Platform Services Controller nodes information in the topology.

This interface was added in vSphere API 6.7.2.

---

Member Function Documentation

vmware.vcenter.topology.NodesTypes.Info vmware::vcenter::topology::Nodes::Get

(

string

node

)

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

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.NotFound	if a node doesn't exist for given node identifier.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

node	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 .

Returns:

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

Implemented in vmware::vcenter::topology::NodesStub.

vmware.vcenter.topology.NodesTypes.Info vmware::vcenter::topology::Nodes::Get	(	string	node,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

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

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.NotFound	if a node doesn't exist for given node identifier.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

node	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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Threading.Tasks.Task<vmware.vcenter.topology.NodesTypes.Info> vmware::vcenter::topology::Nodes::GetAsync	(	string	node,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

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

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.NotFound	if a node doesn't exist for given node identifier.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

node	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 .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

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

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Threading.Tasks.Task<vmware.vcenter.topology.NodesTypes.Info> vmware::vcenter::topology::Nodes::GetAsync

(

string

node

)

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

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.NotFound	if a node doesn't exist for given node identifier.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

node	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 .

Returns:

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

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Collections.Generic.List<vmware.vcenter.topology.NodesTypes.Summary> vmware::vcenter::topology::Nodes::List	(	vmware.vcenter.topology.NodesTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.InvalidArgument	if the Nodes.FilterSpec.types field contains a value that is not supported.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

filter	Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a Nodes.FilterSpec with all fields null which means all nodes match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Collections.Generic.List<vmware.vcenter.topology.NodesTypes.Summary> vmware::vcenter::topology::Nodes::List

(

vmware.vcenter.topology.NodesTypes.FilterSpec

filter

)

Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.InvalidArgument	if the Nodes.FilterSpec.types field contains a value that is not supported.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

filter

Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a Nodes.FilterSpec with all fields null which means all nodes match the filter.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.topology.NodesTypes.Summary> > vmware::vcenter::topology::Nodes::ListAsync

(

vmware.vcenter.topology.NodesTypes.FilterSpec

filter

)

Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.InvalidArgument	if the Nodes.FilterSpec.types field contains a value that is not supported.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

filter

Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a Nodes.FilterSpec with all fields null which means all nodes match the filter.

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

Implemented in vmware::vcenter::topology::NodesStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.topology.NodesTypes.Summary> > vmware::vcenter::topology::Nodes::ListAsync	(	vmware.vcenter.topology.NodesTypes.FilterSpec	filter,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns information about all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

This method was added in vSphere API 6.7.2.

Exceptions:

vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.Unauthorized	if the user doesn't have the required privileges.
vmware.vapi.std.errors.InvalidArgument	if the Nodes.FilterSpec.types field contains a value that is not supported.
vmware.vapi.std.errors.Unauthorized	if you do not have all of the privileges described as follows: Method execution requires System.Read .

Parameters:

filter	Specification of matching vCenter and Platform Services Controller nodes for which information should be returned. If null, the behavior is equivalent to a Nodes.FilterSpec with all fields null which means all nodes match the filter.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

commonly used information for all vCenter and Platform Services Controller nodes matching the Nodes.FilterSpec .

Implemented in vmware::vcenter::topology::NodesStub.

---

The documentation for this interface was generated from the following file:

• Nodes.cs