VMware vSphere Automation SDK for .NET 6.5.0
vmware::vcenter::ResourcePool Interface Reference

The ResourcePool interface provides methods for manipulating a vCenter Server resource pool. More...

Inherited by vmware::vcenter::ResourcePoolStub.

List of all members.

Public Member Functions

vmware.vcenter.ResourcePoolTypes.Info Get (string resourcePool)
 Retrieves information about the resource pool indicated by resourcePool .
vmware.vcenter.ResourcePoolTypes.Info Get (string resourcePool, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about the resource pool indicated by resourcePool .
global::System.Threading.Tasks.Task
< vmware.vcenter.ResourcePoolTypes.Info
GetAsync (string resourcePool)
 Retrieves information about the resource pool indicated by resourcePool .
global::System.Threading.Tasks.Task
< vmware.vcenter.ResourcePoolTypes.Info
GetAsync (string resourcePool, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Retrieves information about the resource pool indicated by resourcePool .
global::System.Collections.Generic.List
< vmware.vcenter.ResourcePoolTypes.Summary
List (vmware.vcenter.ResourcePoolTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec .
global::System.Collections.Generic.List
< vmware.vcenter.ResourcePoolTypes.Summary
List (vmware.vcenter.ResourcePoolTypes.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) resource pools in vCenter matching the ResourcePool.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.ResourcePoolTypes.Summary > > 
ListAsync (vmware.vcenter.ResourcePoolTypes.FilterSpec filter)
 Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec .
global::System.Threading.Tasks.Task
< global::System.Collections.Generic.List
< vmware.vcenter.ResourcePoolTypes.Summary > > 
ListAsync (vmware.vcenter.ResourcePoolTypes.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) resource pools in vCenter matching the ResourcePool.FilterSpec .

Detailed Description

The ResourcePool interface provides methods for manipulating a vCenter Server resource pool.

This interface does not include virtual appliances in the inventory of resource pools even though part of the behavior of a virtual appliance is to act like a resource pool.


Member Function Documentation

vmware.vcenter.ResourcePoolTypes.Info vmware::vcenter::ResourcePool::Get ( string  resourcePool)

Retrieves information about the resource pool indicated by resourcePool .

Exceptions:
vmware.vapi.std.errors.NotFoundif the resource pool indicated by resourcePool does not exist.
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:
resourcePoolIdentifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool .
Returns:
information about the resource pool.

Implemented in vmware::vcenter::ResourcePoolStub.

vmware.vcenter.ResourcePoolTypes.Info vmware::vcenter::ResourcePool::Get ( string  resourcePool,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieves information about the resource pool indicated by resourcePool .

Exceptions:
vmware.vapi.std.errors.NotFoundif the resource pool indicated by resourcePool does not exist.
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:
resourcePoolIdentifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
information about the resource pool.

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Threading.Tasks.Task<vmware.vcenter.ResourcePoolTypes.Info> vmware::vcenter::ResourcePool::GetAsync ( string  resourcePool,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Retrieves information about the resource pool indicated by resourcePool .

Exceptions:
vmware.vapi.std.errors.NotFoundif the resource pool indicated by resourcePool does not exist.
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:
resourcePoolIdentifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
information about the resource pool.

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Threading.Tasks.Task<vmware.vcenter.ResourcePoolTypes.Info> vmware::vcenter::ResourcePool::GetAsync ( string  resourcePool)

Retrieves information about the resource pool indicated by resourcePool .

Exceptions:
vmware.vapi.std.errors.NotFoundif the resource pool indicated by resourcePool does not exist.
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:
resourcePoolIdentifier of the resource pool for which information should be retrieved. The parameter must be an identifier for the resource type: ResourcePool .
Returns:
information about the resource pool.

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Collections.Generic.List<vmware.vcenter.ResourcePoolTypes.Summary> vmware::vcenter::ResourcePool::List ( vmware.vcenter.ResourcePoolTypes.FilterSpec  filter)

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 resource pools match the ResourcePool.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 resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePool.FilterSpec with all fields null which means all resource pools match the filter.
Returns:
Commonly used information about the resource pools matching the ResourcePool.FilterSpec .

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Collections.Generic.List<vmware.vcenter.ResourcePoolTypes.Summary> vmware::vcenter::ResourcePool::List ( vmware.vcenter.ResourcePoolTypes.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) resource pools in vCenter matching the ResourcePool.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 resource pools match the ResourcePool.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 resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePool.FilterSpec with all fields null which means all resource pools match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the resource pools matching the ResourcePool.FilterSpec .

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.ResourcePoolTypes.Summary> > vmware::vcenter::ResourcePool::ListAsync ( vmware.vcenter.ResourcePoolTypes.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) resource pools in vCenter matching the ResourcePool.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 resource pools match the ResourcePool.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 resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePool.FilterSpec with all fields null which means all resource pools match the filter.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Commonly used information about the resource pools matching the ResourcePool.FilterSpec .

Implemented in vmware::vcenter::ResourcePoolStub.

global::System.Threading.Tasks.Task<global::System.Collections.Generic.List<vmware.vcenter.ResourcePoolTypes.Summary> > vmware::vcenter::ResourcePool::ListAsync ( vmware.vcenter.ResourcePoolTypes.FilterSpec  filter)

Returns information about at most 1000 visible (subject to permission checks) resource pools in vCenter matching the ResourcePool.FilterSpec .

Exceptions:
vmware.vapi.std.errors.UnableToAllocateResourceif more than 1000 resource pools match the ResourcePool.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 resource pools for which information should be returned. If null, the behavior is equivalent to a ResourcePool.FilterSpec with all fields null which means all resource pools match the filter.
Returns:
Commonly used information about the resource pools matching the ResourcePool.FilterSpec .

Implemented in vmware::vcenter::ResourcePoolStub.


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