vSphere SDK for Perl Programming Guide - Documentation - VMware

vSphere SDK for Perl Programming Guide
Table 1-3. Options Available for all vSphere SDK for Perl Scripts (Continued)
Parameter and Environment
Variable Description
--help Prints a brief usage message. The message lists first each command‐specific option
and then the common options.
--passthroughauth
VI_PASSTHROUGHAUTH
--passthroughauthpackage
VI_PASSTHROUGHAUTHPACKAGE=
--password
VI_PASSWORD=
--portnumber
VI_PORTNUMBER=
--protocol
VI_PROTOCOL=
--savesessionfile
VI_SAVESESSIONFILE=
--server
VI_SERVER=
--servicepath
VI_SERVICEPATH=
--sessionfile
VI_SESSIONFILE=
--url
VI_URL=
--username
VI_USERNAME=
When the vSphere SDK for Perl runs, the system uses the Microsoft Windows
Security Support Provider Interface (SSPI) for authentication. You are not
prompted for a user name and password. See the Microsoft Web site for a detailed
discussion of SSPI.
This option is supported only if you are running vSphere SDK for Perl on a
Windows system and connecting to a vCenter Server system.
When used in conjunction with --passthroughauth, specifies a domain‐level
authentication protocol to be used by Windows. By default, SSPI uses the
Negotiate protocol, which means that client and server attempt to negotiate a
mutually supported protocol.
If the vCenter Server system to which you are connecting is configured to use a
specific protocol, you can specify that protocol using this parameter.
This option is supported only if you are running vSphere SDK for Perl on a
Windows system and connecting to a vCenter Server system.
Password (used in conjunction with --username) for log in to the server.
If ‐‐server specifies a vCenter Server system, the user name and password
apply to that server. No passwords are then needed to run on the ESX/ESXi
hosts that server manages.
If ‐‐server specifies an ESX/ESXi system, the user name and password apply to
that system.
NOTE: Use the empty string (' ' on Linux and “ “ on Windows) to indicate no
password.
If you do not specify a user name and password on the command line, and
authentication is not set up by other means, you are prompted.
Port to connect to the ESX/ESXi host. Default is 443.
Protocol to connect to the ESX/ESXi host. Default is HTTPS.
Saves a session to the specified file. The session expires if it has been unused for
thirty minutes.
vSphere server to use. Default is localhost.
Service path to use to connect to the ESX/ESXi host. Default is /sdk/webService.
Session file to use to load a previously saved session. The session must be
unexpired.
vSphere Web Services SDK URL to connect to.
User name to use to log in.
If --server specifies a vCenter Server system, the user name and password
apply to that server. No passwords are then needed to run on the ESX/ESXi
hosts that server manages.
If --server specifies an ESX/ESXi system, the user name and password apply
to that system.
If you do not specify a user name and password on the command line, you are
prompted.
--verbose Displays additional debugging information.
--version Displays version information.
16 VMware, Inc.