vSphere SDK for Perl Programming Guide - Documentation - VMware

More documents

Recommendations

Info

vSphere SDK for Perl Programming Guide Table 4-2. Subroutines in the Vim Package (Continued) Subroutine Description 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-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. 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 Parameter Description %opts Name of the hash variable that consists of the option name and its attributes. Returns Returns nothing. get_option Retrieves the value of the specified built‐in or custom option. Parameters Parameter Description option_name String value of the built‐in or custom option. 42 VMware, Inc.
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 Value of the option, as passed to the script Undef if none of the above are specified option_is_set parse Chapter 4 vSphere SDK for Perl Subroutine Reference Checks whether an option has been explicitly set by a script or from the command line or whether the option has a default value or computed value (return value of a func). Parameters Returns Boolean. Returns 1 (true) if the option value has been explicitly set. Returns 0 (false) if the option value is a default value, is null, or has not been explicitly set. For a discussion of Boolean, see “vSphere SDK for Perl Programming Conventions” on page 12. Reads options from the command line, an environment variable, or a configuration file and transforms the option into appropriate data structures for validation. Parameters No parameters. Returns Returns nothing. Displays an error message and quits if the parse operation is not successful. If you want to use a configuration file, call Opts::get_config() to make sure the file can be opened. See “Opts::get_config()” on page 40. validate Ensures that input values (from the command line, an environment variable, or a configuration file) are complete, consistent, and valid. usage Parameter Description option_name String value of the built‐in or custom option. Parameters No parameters. Returns Returns nothing. It displays an error message and quits if the parse operation is not successful. Displays the help text message. Parameters No parameters. Returns Returns nothing. VMware, Inc. 43
Page 1 and 2: vSphere SDK for Perl Programming Gu
Page 3 and 4: Contents About This Book 7 Revision
Page 5 and 6: Get 56 WSMan::WSBasic Examples 56 G
Page 7 and 8: About This Book This book, the vSph
Page 9 and 10: 1 Getting Started with 1 vSphere SD
Page 11 and 12: The following materials are availab
Page 13 and 14: Specifying Options You can specify
Page 15 and 16: Chapter 1 Getting Started with vSph
Page 17 and 18: Hello Host: Running Your First Scri
Page 19 and 20: 2 Writing vSphere SDK for Perl Scri
Page 21 and 22: Chapter 2 Writing vSphere SDK for P
Page 23 and 24: See “Understanding Server‐Side
Page 25 and 26: Figure 2-1. Managed Object Browser
Page 27 and 28: Chapter 2 Writing vSphere SDK for P
Page 29 and 30: Working with View Object Property V
Page 31 and 32: Non-Blocking and Blocking Methods C
Page 33 and 34: 3 Refining vSphere SDK for Perl Scr
Page 35 and 36: Filtering Views Selectively Using P
Page 37 and 38: Chapter 3 Refining vSphere SDK for
Page 39 and 40: 23 print Dumper ($host_view->summar
Page 41: 4 vSphere SDK for Perl Subroutine 4
Page 45 and 46: trace Chapter 4 vSphere SDK for Per
Page 47 and 48: Returns Chapter 4 vSphere SDK for P
Page 49 and 50: login Parameters Parameter Descript
Page 51 and 52: A Web Services for Management Perl
Page 53 and 54: Appendix A Web Services for Managem
Page 55 and 56: Example $client->register_xml_ns((w
Page 57 and 58: Appendix A Web Services for Managem
Page 59 and 60: Arguments A hash. Keys are the pref
Page 61 and 62: B Credential Store Perl Library B T
Page 63 and 64: vSphere Credential Store Subroutine
Page 65 and 66: get_usernames close Appendix B Cred
Page 67 and 68: Glossary A appliance See virtual ap
Page 69 and 70: Index A AlarmManager managed object
Page 71 and 72: untime 9 W WBEM 51 web services for

vSphere SDK for Perl Programming Guide - Documentation - VMware

Create successful ePaper yourself

Delete template?

Save as template?