vSphere PowerCLI User's Guide - Documentation - VMware

4
vSphere PowerCLI Usage Examples 4
This chapter provides examples of usage of the vSphere PowerCLI cmdlets.
The chapter discusses these topics:
“Basic Cmdlets Usage” on page 15
“Advanced Cmdlets Usage” on page 17
“API Access Cmdlets” on page 31
“The Inventory Provider” on page 33
“The Datastore Provider” on page 34
Basic Cmdlets Usage
This section provides some examples of basic vSphere PowerCLI cmdlets usage.
Display Help for a Cmdlet
You can get help for a specific cmdlet by supplying the Get-Help command in the vSphere PowerCLI console.
To get information on a cmdlet
1 Run the Get-Help cmdlet with the specific cmdlet name:
Get-Help Add-VMHost
2 (opt) Retrieve more detailed information by using the -full parameter:
Get-Help Add-VMHost -full
Connect to a Server
In vSphere PowerCLI, you can have more than one connections to the same server. To disconnect from a server,
you must close all active connections to this server running the Disconnect-VIServer cmdlet.
To connect to a local server
1 Run the Connect-VIServer cmdlet with the server name:
Connect-VIServer -Server esx3.example.com
The cmdlet prompts for user credentials, as they are not passed as parameters.
NOTE If a proxy server is used for the connection, the administrator should verify that it is configured
properly, so that the connection is kept alive long enough not to break the long running vSphere PowerCLI
tasks. To remove a proxy, run the following command:
Set-PowerCLIConfiguration -ProxyPolicy NoProxy
VMware, Inc. 15