6.5
Table Of Contents
- vSphere SDK for Perl Programming Guide
- Contents
- Getting Started with vSphere SDK for Perl
- Writing vSphere SDK for Perl Scripts
- Refining vSphere SDK for Perl Scripts
- Creating and Using Filters
- Filtering Views Selectively Using Properties
- Retrieving the ServiceInstance Object on a vSphere Host
- Saving and Using Sessions
- Using Multiple Sessions
- Learning About Object Structure Using Data::Dumper
- Specifying Untyped Arguments in Scheduled Tasks and Callbacks
- Using Advanced Subroutines
- vSphere SDK for Perl Subroutine Reference
- Web Services for Management Perl Library
- Credential Store Perl Library
vSphere SDK for Perl Programming Guide
46 VMware, Inc.
Parameters
Returns
Referencetoaviewobjectcontainingthesamepropertiesasthemanagedentity.Ifmorethanonemanaged
entitymatchesthespecifiedentitytype,thesubroutinereturnsonlythefirstmanagedentityfound.Ifno
matchingmanagedentitiesarefound,thesubroutinereturnsundef.
find_entity_views
Searchestheinventorytreeformanagedobjectsthatmatchthespecifiedentitytype.
Toavoidperformanceproblems,usethiscommandwithafilterorspecifythepropertiesargument.By
default,thissubroutineretrievesallpropertiesofanentity.See“CreatingandUsingFilters”onpage 33and
“FilteringViewsSelectivelyUsingProperties”
onpage 34.
SeethevSphereSDKforPerlAPIReferenceforalistofproperties.Youcanspecifypropertiesinheritedfrom
ManagedEntityorlocaltoaspecificentitytype.
Parameters
Parameter Description
view_type Managedentitytypespecifiedasoneofthesestrings:
“ClusterComputeResource”
“ComputeResource”
“Datacenter”
“Datastore”
“DistributedVirtualSwitch”
“Folder”
“HostSystem”
“Network”
“ResourcePool”
“VirtualApp”
“VirtualMachine”
begin_entity
(optional)
Managedobjectreferencethatspecifiesthestartingpointforthesearchintheinventory.This
parameterhelpsyounarrowthescope.
filter Hashofoneormorename‐valuepairs.Thenamerepresentsthepropertyvaluetotestandthevalue
representsapatternthatthepropertymustmatch.
Ifmorethanonepairisspecified,allthepatterns
mustmatch.
Usefilterstoavoidperformanceproblems.See“CreatingandUsingFilters”onpage 33and
“FilteringViewsSelectivelyUsingProperties”onpage 34.
Parameter Description
view_type Managedentitytypespecifiedasoneofthesestrings:
“ClusterComputeResource”
“ComputeResource”
“Datacenter”
“Datastore”
“DistributedVirtualSwitch”
“Folder”
“HostSystem”
“Network”
“ResourcePool”
“VirtualApp”
“VirtualMachine”
begin_entity
(optional)
Managedobjectreferencethatspecifiesthestartingpointforsearchintheinventory.Thisparameter
helpsyounarrowthescope.