6.5

vSphere SDK for Perl Programming Guide
42 VMware, Inc.
Subroutines in the Opts Package
TheOptspackageincludesthefollowingsubroutines:
 “add_options”onpage 42
 “get_option”onpage 42
 “option_is_set”onpage 43
 “parse”onpage 43
 “validate”onpage 43
 “usage”onpage 43
add_options
Addscustomoptionssothattheycanbesubmittedtoparsingandvalidation.Afterthescripthasvalidated
theoptions,thescriptcanusethematruntime.
Parameters
Returns
Returnsnothing.
get_option
Retrievesthevalueofthespecifiedbuilt‐inorcustomoption.
Parameters
Returns
Returnsoneofthefollowing,dependingupontheattributesdefinedfortheoption:
 Returnvalueoffunc(afterexecution)ifafunctionisassociatedwiththeoption
 Defaultvalue,ifoneisspecifiedfortheoption
logout DisconnectstheclientfromtheserverandclosestheconnectiontotheWebservice.
save_session Savesasessioncookie,whichisatextfile.
update_view_data Refreshesthepropertyvaluesofaviewobject.
Table 4-2. Subroutines in the Vim Package (Continued)
Subroutine Description
Table 4-3. Subroutines in the Util Package
Subroutine Description
connect Establishesasessionbyusingthetokenprovidedinapreviously‐savedsessionfile,orbyusingtheuser
nameandpasswordprovidedonthecommandline,inenvironmentvariables,orinaconfigurationfile.
disconnect Ifusedinconjunctionwithconnect(andasessionfile),doesnothing.Ifusedin
conjunctionwithauser
nameandpassword,logsoutandclosesthesession.
get_inventory_path Returnstheinventorypathforthespecifiedmanagedentity.
trace General‐purposeloggingfunctionusedinconjunctionwiththe--verbosecommand‐lineoption.
Parameter Description
%opts Nameofthehashvariablethatconsistsoftheoptionnameanditsattributes.
Parameter Description
option_name Stringvalueofthebuilt‐inorcustomoption.