Description

This Javadoc generated documentation set provides information about the sample applications included with the VMware vSphere Web Services SDK package. The samples include:

Helper classes that provided client-application infrastructure (connect to server, handle command-line options, and so on)
Samples
Credential store administration utility and client API

Documentation for all of these is included. This page contains:

Running the Samples
Packages List

Running the Samples

All the samples use classes from the apputils package to authenticate the user running the application and create a connection to the server. Minimally, each application requires:

URL to the server running the Web service, specified using the --url option
User account that has privileges on the target server, specified using the --userName option
Password for the userName, specified using the --password option.

Example

java com.vmware.samples.packagename.SampleClassName --url https://myserver --userName username --password password --ignorecert

Here’s the complete list of built-in command-line parameters (options) provided by the apputils classes:

Parameter	Description	Example
--url	Required. Complete URL for the vSphere API Web service for the connection.	--url https://www.myserver.com/sdk
--userName	Required. User account with privileges to connect to the host.	--userName root
--password	Required. Password for the user account.	--password mypassword
--config	Location of an optional configuration file that contains the required parameters.	--config c:\myfilename
--protocol	Protocol for the server connection (HTTP, HTTPS; HTTPS is the default).	--protocol http
--server	Fully-qualified name of the server to connect to, such as myserver.mycompany.com.	--server myserver.mycompany.com
--portNumber	Server port for the vSphere API Web service. Default is 443 (for HTTPS).	--portNumber 8080
--servicePath	Service path for the vSphere API, such as /sdk, /sdk/webService	--servicePath sdk
--sessionFile	File containing a previously saved session cookie, for re-establishing connection to the server.	--sessionFile c:\mysessionfile
--help	Display usage information for the application or script.	--help
--ignorecert	Avoid the SSL server-certificate validation process. Using the `--ignorecert` option lets you by-pass importing server-certificates and creating a vmware.keystore (using the Java keytool utility).	--ignorecert