VMware vSphere Automation SDK Perl
The VMware vSphere Automation SDK for Perl supports the client-side vSphere Automation API for access to vSphere services and capabilities
 All Classes Files Functions
Classes | List of all members
Com::Vmware::Vcenter::ResourcePool Class Reference
Inheritance diagram for Com::Vmware::Vcenter::ResourcePool:
Com::Vmware::Vapi::Bindings::VapiInterface

Classes

class  FilterSpec
 
class  Info
 
class  Summary
 

Avaliable Methods

public method get ()
 
public method new ()
 
public method list ()
 

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.

Constant String::RESOURCE_TYPE # The resource type for the vCenter resource pool

Member Function Documentation

public method Com::Vmware::Vcenter::ResourcePool::get ( )

Retrieves information about the resource pool indicated by resource_pool .

Parameters
resource_pool[REQUIRED] Identifier of the resource pool for which information should be retrieved. The value must be an identifier for the resource type getQualifiedName(ResourcePool). . The value must be str.
Return values
informationabout the resource pool. The return type will be Com::Vmware::Vcenter::ResourcePool::Info
Exceptions
Com::Vmware::Vapi::Std::Errors::NotFoundif the resource pool indicated by resource_pool does not exist.
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Code:
click to view
public method Com::Vmware::Vcenter::ResourcePool::list ( )

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

Parameters
filter[OPTIONAL] Specification of matching resource pools for which information should be returned. If null , the behavior is equivalent to a class Com::Vmware::Vcenter::ResourcePool::FilterSpec with all fields null which means all resource pools match the filter. . The value must be Com::Vmware::Vcenter::ResourcePool::FilterSpec or None.
Return values
Commonlyused information about the resource pools matching the class Com::Vmware::Vcenter::ResourcePool::FilterSpec . The return type will be Array of Com::Vmware::Vcenter::ResourcePool::Summary
Exceptions
Com::Vmware::Vapi::Std::Errors::UnableToAllocateResourceif more than 1000 resource pools match the class Com::Vmware::Vcenter::ResourcePool::FilterSpec .
Com::Vmware::Vapi::Std::Errors::ServiceUnavailableif the system is unable to communicate with a service to complete the request.
Com::Vmware::Vapi::Std::Errors::Unauthenticatedif the user can not be authenticated.
Com::Vmware::Vapi::Std::Errors::Unauthorizedif the user doesn't have the required privileges.
Code:
click to view
public method Com::Vmware::Vcenter::ResourcePool::new ( )

Constructor to initialize the object

Parameters
api_provider- protocol connection to use with stubs created by this factory
StubConfig- Stub's additional configuration
Return values
Blessedobject
Code:
click to view

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