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
List of all members
Com::Vmware::Vcenter::VM::FilterSpec Class Reference
Inheritance diagram for Com::Vmware::Vcenter::VM::FilterSpec:

Avaliable Methods

public method set_resource_pools ()
 
public method get_hosts ()
 
public method set_datacenters ()
 
public method set_power_states ()
 
public method set_folders ()
 
public method get_clusters ()
 
public method new ()
 
public method get_vms ()
 
public method set_hosts ()
 
public method get_folders ()
 
public method get_names ()
 
public method get_resource_pools ()
 
public method get_datacenters ()
 
public method set_clusters ()
 
public method set_names ()
 
public method get_power_states ()
 
public method set_vms ()
 

Detailed Description

The Com::Vmware::Vcenter::VM::FilterSpec class contains fields used to filter the results when listing virtual machines (see :func:Com::Vmware::Vcenter::VM.list ). If multiple fields are specified, only virtual machines matching all of the fields match the filter.

Member Function Documentation

public method Com::Vmware::Vcenter::VM::FilterSpec::get_clusters ( )

Gets the value of 'clusters' property.

Return values
clusters- The current value of the field. Clusters that must contain the virtual machine for the virtual machine to match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_datacenters ( )

Gets the value of 'datacenters' property.

Return values
datacenters- The current value of the field. Datacenters that must contain the virtual machine for the virtual machine to match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_folders ( )

Gets the value of 'folders' property.

Return values
folders- The current value of the field. Folders that must contain the virtual machine for the virtual machine to match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_hosts ( )

Gets the value of 'hosts' property.

Return values
hosts- The current value of the field. Hosts that must contain the virtual machine for the virtual machine to match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_names ( )

Gets the value of 'names' property.

Return values
names- The current value of the field. Names that virtual machines must have to match the filter (see :attr:Com::Vmware::Vcenter::VM::Info.name ). Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_power_states ( )

Gets the value of 'power_states' property.

Return values
power_states- The current value of the field. Power states that a virtual machine must be in to match the filter (see :attr:Com::Vmware::Vcenter::Vm::Power::Info.state . Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_resource_pools ( )

Gets the value of 'resource_pools' property.

Return values
resource_pools- The current value of the field. Resource pools that must contain the virtual machine for the virtual machine to match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::get_vms ( )

Gets the value of 'vms' property.

Return values
vms- The current value of the field. Identifiers of virtual machines that can match the filter. Optional#
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::new ( )

Constructor to initialize the Com::Vmware::Vcenter::VM::FilterSpec structure

Return values
Blessedobject
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_clusters ( )

Sets the given value for 'clusters' property.

Parameters
clusters- New value for the field. Clusters that must contain the virtual machine for the virtual machine to match the filter.
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_datacenters ( )

Sets the given value for 'datacenters' property.

Parameters
datacenters- New value for the field. Datacenters that must contain the virtual machine for the virtual machine to match the filter.
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_folders ( )

Sets the given value for 'folders' property.

Parameters
folders- New value for the field. Folders that must contain the virtual machine for the virtual machine to match the filter.
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_hosts ( )

Sets the given value for 'hosts' property.

Parameters
hosts- New value for the field. Hosts that must contain the virtual machine for the virtual machine to match the filter.
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_names ( )

Sets the given value for 'names' property.

Parameters
names- New value for the field. Names that virtual machines must have to match the filter (see :attr:Com::Vmware::Vcenter::VM::Info.name ).
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_power_states ( )

Sets the given value for 'power_states' property.

Parameters
power_states- New value for the field. Power states that a virtual machine must be in to match the filter (see :attr:Com::Vmware::Vcenter::Vm::Power::Info.state .
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_resource_pools ( )

Sets the given value for 'resource_pools' property.

Parameters
resource_pools- New value for the field. Resource pools that must contain the virtual machine for the virtual machine to match the filter.
Code:
click to view
public method Com::Vmware::Vcenter::VM::FilterSpec::set_vms ( )

Sets the given value for 'vms' property.

Parameters
vms- New value for the field. Identifiers of virtual machines that can match the filter.
Code:
click to view

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