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::Folder Class Reference
Inheritance diagram for Com::Vmware::Vcenter::Folder:
Com::Vmware::Vapi::Bindings::VapiInterface

Classes

class  FilterSpec
 
class  Summary
 
class  Type
 

Avaliable Methods

public method new ()
 
public method list ()
 

Detailed Description

The Folder interface provides methods for manipulating a vCenter Server folder. Constant String::RESOURCE_TYPE # The resource type for the vCenter folder

Member Function Documentation

public method Com::Vmware::Vcenter::Folder::list ( )

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

Parameters
filter[OPTIONAL] Specification of matching folders for which information should be returned. If null , the behavior is equivalent to a class Com::Vmware::Vcenter::Folder::FilterSpec with all fields null which means all folders match the filter. . The value must be Com::Vmware::Vcenter::Folder::FilterSpec or None.
Return values
Commonlyused information about the folders matching the class Com::Vmware::Vcenter::Folder::FilterSpec . The return type will be Array of Com::Vmware::Vcenter::Folder::Summary
Exceptions
Com::Vmware::Vapi::Std::Errors::InvalidArgumentif the :attr:Com::Vmware::Vcenter::Folder::FilterSpec.type field contains a value that is not supported by the server.
Com::Vmware::Vapi::Std::Errors::UnableToAllocateResourceif more than 1000 folders match the class Com::Vmware::Vcenter::Folder::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::Folder::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: