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
VMware, Inc. 43
Chapter 4 vSphere SDK for Perl Subroutine Reference
Valueoftheoption,aspassedtothescript
Undefifnoneoftheabovearespecified
option_is_set
Checkswhetheranoptionhasbeenexplicitlysetbyascriptorfromthecommandlineorwhethertheoption
hasadefaultvalueorcomputedvalue(returnvalueofafunc).
Parameters
Returns
Boolean.Returns1(true)iftheoptionvaluehasbeenexplicitlyset.Returns0(false)ifthe
optionvalueisa
defaultvalue,isnull,orhasnotbeenexplicitlyset.ForadiscussionofBoolean,see“vSphereSDKforPerl
ProgrammingConventions”onpage 11.
parse
Readsoptionsfromthecommandline,anenvironmentvariable,oraconfigurationfileandtransformsthe
optionintoappropriatedatastructuresforvalidation.
Parameters
Noparameters.
Returns
Returnsnothing.Displaysanerrormessageandquitsiftheparseoperationisnotsuccessful.Ifyouwantto
useaconfigurationfile,callOpts::get_config()
tomakesurethefilecanbeopened.See
“Opts::get_config()”onpage 40.
validate
Ensuresthatinputvalues(fromthecommandline,anenvironmentvariable,oraconfigurationfile)are
complete,consistent,andvalid.
Parameters
Noparameters.
Returns
Returnsnothing.Itdisplaysanerrormessageandquitsiftheparseoperationisnotsuccessful.
usage
Displaysthehelptextmessage.
Parameters
Noparameters.
Returns
Returnsnothing.
Subroutines in the Util Package
TheUtilpackageincludesthefollowingsubroutines:
Parameter Description
option_name Stringvalueofthebuilt‐inorcustomoption.