VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::ClusterStub Class Reference

Remote stub implementation of the Cluster API service. More...

Inherits vmware::vcenter::Cluster.

List of all members.

Public Member Functions

 ClusterStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
 ClusterStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
global::System.Collections.Generic.List
< vmware.vcenter.ClusterTypes.Summary
List (vmware.vcenter.ClusterTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .
global::System.Collections.Generic.List
< vmware.vcenter.ClusterTypes.Summary
List (vmware.vcenter.ClusterTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.ClusterTypes.Summary > > 
ListAsync (vmware.vcenter.ClusterTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.ClusterTypes.Summary > > 
ListAsync (vmware.vcenter.ClusterTypes.FilterSpec filter, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .
vmware.vcenter.ClusterTypes.Info Get (string cluster)
 Retrieves information about the cluster corresponding to cluster .
vmware.vcenter.ClusterTypes.Info Get (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about the cluster corresponding to cluster .
global::System.Threading.Tasks.Task
< vmware.vcenter.ClusterTypes.Info
GetAsync (string cluster)
 Retrieves information about the cluster corresponding to cluster .
global::System.Threading.Tasks.Task
< vmware.vcenter.ClusterTypes.Info
GetAsync (string cluster, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about the cluster corresponding to cluster .

Detailed Description

Remote stub implementation of the Cluster API service.


Constructor & Destructor Documentation

vmware::vcenter::ClusterStub::ClusterStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.TypeConverter  typeConverter,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]
vmware::vcenter::ClusterStub::ClusterStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

vmware.vcenter.ClusterTypes.Info vmware::vcenter::ClusterStub::Get ( string  cluster) [inline]

Retrieves information about the cluster corresponding to cluster .

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the session id is missing from the request or the corresponding session object cannot be found.
vmware.vapi.std.errors.Unauthorizedif the user doesn't not have the required privileges.
Parameters:
clusterIdentifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
Returns:
The Cluster.Info instances that corresponds to the cluster .

Implements vmware::vcenter::Cluster.

vmware.vcenter.ClusterTypes.Info vmware::vcenter::ClusterStub::Get ( string  cluster,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Retrieves information about the cluster corresponding to cluster .

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the session id is missing from the request or the corresponding session object cannot be found.
vmware.vapi.std.errors.Unauthorizedif the user doesn't not have the required privileges.
Parameters:
clusterIdentifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The Cluster.Info instances that corresponds to the cluster .

Implements vmware::vcenter::Cluster.

global::System.Threading.Tasks.Task<vmware.vcenter.ClusterTypes.Info> vmware::vcenter::ClusterStub::GetAsync ( string  cluster,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Retrieves information about the cluster corresponding to cluster .

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the session id is missing from the request or the corresponding session object cannot be found.
vmware.vapi.std.errors.Unauthorizedif the user doesn't not have the required privileges.
Parameters:
clusterIdentifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
The Cluster.Info instances that corresponds to the cluster .

Implements vmware::vcenter::Cluster.

global::System.Threading.Tasks.Task<vmware.vcenter.ClusterTypes.Info> vmware::vcenter::ClusterStub::GetAsync ( string  cluster) [inline]

Retrieves information about the cluster corresponding to cluster .

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no cluster associated with cluster in the system.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the session id is missing from the request or the corresponding session object cannot be found.
vmware.vapi.std.errors.Unauthorizedif the user doesn't not have the required privileges.
Parameters:
clusterIdentifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource .
Returns:
The Cluster.Info instances that corresponds to the cluster .

Implements vmware::vcenter::Cluster.

global::System.Collections.Generic.List<vmware.vcenter.ClusterTypes.Summary> vmware::vcenter::ClusterStub::List ( vmware.vcenter.ClusterTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 clusters match the Cluster.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching clusters for which information should be returned. If null, the behavior is equivalent to a Cluster.FilterSpec with all fields null which means all clusters match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the clusters matching the Cluster.FilterSpec .

Implements vmware::vcenter::Cluster.

global::System.Collections.Generic.List<vmware.vcenter.ClusterTypes.Summary> vmware::vcenter::ClusterStub::List ( vmware.vcenter.ClusterTypes.FilterSpec  filter) [inline]

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 clusters match the Cluster.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching clusters for which information should be returned. If null, the behavior is equivalent to a Cluster.FilterSpec with all fields null which means all clusters match the filter.
Returns:
Commonly used information about the clusters matching the Cluster.FilterSpec .

Implements vmware::vcenter::Cluster.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.ClusterTypes.Summary> > vmware::vcenter::ClusterStub::ListAsync ( vmware.vcenter.ClusterTypes.FilterSpec  filter) [inline]

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 clusters match the Cluster.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching clusters for which information should be returned. If null, the behavior is equivalent to a Cluster.FilterSpec with all fields null which means all clusters match the filter.
Returns:
Commonly used information about the clusters matching the Cluster.FilterSpec .

Implements vmware::vcenter::Cluster.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.ClusterTypes.Summary> > vmware::vcenter::ClusterStub::ListAsync ( vmware.vcenter.ClusterTypes.FilterSpec  filter,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

Returns information about at most 1000 visible (subject to permission checks) clusters in vCenter matching the Cluster.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 clusters match the Cluster.FilterSpec .
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
filterSpecification of matching clusters for which information should be returned. If null, the behavior is equivalent to a Cluster.FilterSpec with all fields null which means all clusters match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the clusters matching the Cluster.FilterSpec .

Implements vmware::vcenter::Cluster.


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