Getting Started (PowerCLI) - Revision history

Sstrutt: Updated Syntax Highlighting

2016-09-27T07:46:52Z

Updated Syntax Highlighting

← Older revision		Revision as of 07:46, 27 September 2016
Line 19:		Line 19:
	<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>		<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>

	Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob. This is effectively where you end up once you've completed the <~~code~~> Connect-VIServer </~~code~~> command.		Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob. This is effectively where you end up once you've completed the <syntaxhighlight lang="powershell" inline> Connect-VIServer </syntaxhighlight> command.

	Try some of the following...		Try some of the following...
Line 25:		Line 25:
	Get-Cluster		Get-Cluster
	Get-VMHost		Get-VMHost
	Get-VM </source>		Get-VM
			</source>

	Be aware that PowerShell commands generally return objects, rather than simple variables containing text or numbers. So the textual representation of the return object is often abbreviated for simplicity. To see the entire return for a command, pipe the result into <~~code~~>Format-List</~~code~~>. To complicate matters further, some return objects contain further objects, see examples below		Be aware that PowerShell commands generally return objects, rather than simple variables containing text or numbers. So the textual representation of the return object is often abbreviated for simplicity. To see the entire return for a command, pipe the result into <syntaxhighlight lang="powershell" inline>Format-List</syntaxhighlight>. To complicate matters further, some return objects contain further objects, see examples below

	<source lang="powershell">		<source lang="powershell">

Sstrutt: Added "Import into PowerShell "

2013-01-30T11:38:24Z

Added "Import into PowerShell "

← Older revision		Revision as of 11:38, 30 January 2013
Line 104:		Line 104:
	Id : VirtualMachine-vm-697/4002		Id : VirtualMachine-vm-697/4002
	Name : Network Adapter 3		Name : Network Adapter 3
			</source>

			== Import into PowerShell ==
			You can just run PowerCLI by running the shell directly. In order to be able to use PowerCLI CmdLets in a normal PowerShell session you need to import the module in...
			<source lang="powershell">
			Add-PSSnapin VMware.VimAutomation.Core
	</source>		</source>

	== Installed Version ==		== Installed Version ==
	To determine the version of PowerCLI currently installed use;		To determine the version of PowerCLI currently installed use;
	* <~~code~~> Get-PowerCLIversion </~~code~~>
			<source lang="powershell">Get-PowerCLIversion </source>

	== Scheduling ==		== Scheduling ==

Sstrutt: Bit of rewording

2012-07-03T14:50:06Z

Bit of rewording

← Older revision		Revision as of 14:50, 3 July 2012
Line 1:		Line 1:
	== The Basics ==		== The Basics ==

	Before being able to use any the following script you need to install...		Before being able to use any the following script you need to install...
	* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]		* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]
	* [http://support.microsoft.com/kb/968929 Windows Powershell V2]		* [http://support.microsoft.com/kb/968929 Windows Powershell V2] - Available for Win7 or Win2008
	* [http://www.vmware.com/go/powershell VI Toolkit]		* [http://www.vmware.com/go/powershell PowerCLI] - Formerly known as the VI Toolkit
			** Note that versions are broadly speaking, backwards compatible. So even if you've only got the v4 vCentre's and ESX's, install the latest v5 version of PowerCLI

	On the first run you need to allow ~~the Toolkit~~ to run properly by running (you need to run this command as an administrator, so if you're using Windows 7, for example, you'll need to start the ~~Powershell~~ console as an administrator, regardless of whether you're currently logged in as an admin)...		=== Set Execution Policy ===
			On the first run you need to allow PowerCLI to run properly by running (you need to run this command as an administrator, so if you're using Windows 7, for example, you'll need to start the PowerShell console as an administrator, regardless of whether you're currently logged in as an admin)...
	<source lang="powershell"> Set-ExecutionPolicy RemoteSigned </source>		<source lang="powershell"> Set-ExecutionPolicy RemoteSigned </source>

			If you don't do this you'll get the following error when the PowerCLI Snap-In attempts to load into your session.
			* '''...Initialize-PowerCLIEnvironment.ps1 cannot be loaded because the execution of scripts is disabled on this system. ...'''

			If it takes a long time (minutes) for the PowerCLI console to start, see [[Getting_Started_(PowerShell)#Slow_Start-Up\|Slow Start-Up]].

			=== Connect to Infrastructure ===
	Connect to the Virtual Centre (or ESX) server using the following command using your normal username and password (same as you'd use to log into the VI Client). You will need access to the servers on TCP 443.		Connect to the Virtual Centre (or ESX) server using the following command using your normal username and password (same as you'd use to log into the VI Client). You will need access to the servers on TCP 443.
	<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>		<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>
Line 14:		Line 21:
	Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob. This is effectively where you end up once you've completed the <code> Connect-VIServer </code> command.		Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob. This is effectively where you end up once you've completed the <code> Connect-VIServer </code> command.

	Be aware that PowerShell commands generally return objects, rather than text~~, and that~~ the textual representation of the return object is often abbreviated for simplicity. To see the entire return for a command, pipe the result into <code>Format-List</code>. To complicate matters further, some return objects contain further objects, see examples below		Try some of the following...
			<source lang="powershell">
			Get-Cluster
			Get-VMHost
			Get-VM </source>

			Be aware that PowerShell commands generally return objects, rather than simple variables containing text or numbers. So the textual representation of the return object is often abbreviated for simplicity. To see the entire return for a command, pipe the result into <code>Format-List</code>. To complicate matters further, some return objects contain further objects, see examples below

	<source lang="powershell">		<source lang="powershell">

Sstrutt: /* Log Output */ Typo

2012-06-18T14:31:03Z

Log Output: Typo

← Older revision		Revision as of 14:31, 18 June 2012
Line 111:		Line 111:
	* <code> > script-stdout.log 2> script-errout.log </code>		* <code> > script-stdout.log 2> script-errout.log </code>

	This may capture more than you would be able to see from a Transcript of the script run (see [[Getting_Started_%28PowerShell%29#Logging\|PowerShell Logging]].		This may capture more than you would be able to see from a Transcript of the script run (see [[Getting_Started_%28PowerShell%29#Logging\|PowerShell Logging]]).

	=== Force 32-bit ===		=== Force 32-bit ===

Sstrutt: /* Scheduling */ Added "Log Output"

2012-06-18T14:30:44Z

Scheduling: Added "Log Output"

← Older revision		Revision as of 14:30, 18 June 2012
Line 106:		Line 106:
	* Program/script: <code> Powershell </code>		* Program/script: <code> Powershell </code>
	* Add arguments (optional): <code>-PSConsoleFile "C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>		* Add arguments (optional): <code>-PSConsoleFile "C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>

			=== Log Output ===
			To capture the Standard Output and Error Output streams from the script being run, append something similar the following to the end of your command line
			* <code> > script-stdout.log 2> script-errout.log </code>

			This may capture more than you would be able to see from a Transcript of the script run (see [[Getting_Started_%28PowerShell%29#Logging\|PowerShell Logging]].

	=== Force 32-bit ===		=== Force 32-bit ===

Sstrutt: Added Meta

2012-05-28T13:58:30Z

Added Meta

← Older revision		Revision as of 13:58, 28 May 2012
Line 1:		Line 1:
			== The Basics ==

	Before being able to use any the following script you need to install...		Before being able to use any the following script you need to install...
	* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]		* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]

Sstrutt: /* Scheduling */ Added "Force 32-bit"

2012-05-28T13:55:24Z

Scheduling: Added "Force 32-bit"

← Older revision		Revision as of 13:55, 28 May 2012
Line 102:		Line 102:
	* <code> C:\WINDOWS\system32\windowspowershell\v1.0\powershell.exe -PSConsoleFile "C:\Program Files\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>		* <code> C:\WINDOWS\system32\windowspowershell\v1.0\powershell.exe -PSConsoleFile "C:\Program Files\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>
	Or on a Win7 or Win2k8 (64bit) machine you might have something like...		Or on a Win7 or Win2k8 (64bit) machine you might have something like...
	* <code> Powershell -PSConsoleFile "C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>		* Program/script: <code> Powershell </code>
			* Add arguments (optional): <code>-PSConsoleFile "C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>

			=== Force 32-bit ===
			To ensure that a script runs in a 32-bit environment rather than 64-bit, you need to run with 32-bit version of PowerShell, so you'd use the following in the Program/script box...
			* <code> C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell.exe </code>

	== Certificates ==		== Certificates ==

Sstrutt: Move of content from original PowerCLI/VIToolkit page

2011-10-25T21:36:36Z

Move of content from original PowerCLI/VIToolkit page

New page

Before being able to use any the following script you need to install...
* [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/download.mspx Windows PowerShell V1]
* [http://support.microsoft.com/kb/968929 Windows Powershell V2]
* [http://www.vmware.com/go/powershell VI Toolkit]

On the first run you need to allow the Toolkit to run properly by running (you need to run this command as an administrator, so if you're using Windows 7, for example, you'll need to start the Powershell console as an administrator, regardless of whether you're currently logged in as an admin)...
<source lang="powershell"> Set-ExecutionPolicy RemoteSigned </source>

Connect to the Virtual Centre (or ESX) server using the following command using your normal username and password (same as you'd use to log into the VI Client). You will need access to the servers on TCP 443.
<source lang="powershell"> Connect-VIServer -Server <server> -User <user> -Password <pass> </source>

Once connected you can do real work with the PowerCLI, to see what's available, login to https://server/mob. This is effectively where you end up once you've completed the <code> Connect-VIServer </code> command.

Be aware that PowerShell commands generally return objects, rather than text, and that the textual representation of the return object is often abbreviated for simplicity. To see the entire return for a command, pipe the result into <code>Format-List</code>. To complicate matters further, some return objects contain further objects, see examples below

<source lang="powershell">
[vSphere PowerCLI] E:\> get-vm -name "vserver1"

Name PowerState Num CPUs Memory (MB)
---- ---------- -------- -----------
vserver1 PoweredOn 1 756

[vSphere PowerCLI] E:\> get-vm -name "vserver1" | Format-List *

PowerState : PoweredOn
Description :
Guest : VMware.VimAutomation.Client20.VMGuestImpl
NumCpu : 1
MemoryMB : 756
CDDrives : {CD/DVD Drive 1}
FloppyDrives : {Floppy Drive 1}
HardDisks : {Hard Disk 1}
NetworkAdapters : {Network Adapter 1}
Host : esx1.domain.com
HostId : HostSystem-host-301
HARestartPriority : ClusterRestartPriority
HAIsolationResponse : AsSpecifiedByCluster
DrsAutomationLevel : AsSpecifiedByCluster
CustomFields : {}
Id : VirtualMachine-vm-25136
Name : vserver1

[vSphere PowerCLI] E:\> get-vm -name "vserver2" | Format-List *

PowerState : PoweredOff
Description :
Guest : VMware.VimAutomation.Client20.VMGuestImpl
NumCpu : 2
MemoryMB : 2048
CDDrives : {CD/DVD Drive 1}
FloppyDrives : {Floppy Drive 1}
HardDisks : {Hard Disk 1}
NetworkAdapters : {Network Adapter 1, Network Adapter 2, Network Adapter 3}
Host : vserver2.domain.com
HostId : HostSystem-host-662
HARestartPriority : ClusterRestartPriority
HAIsolationResponse : AsSpecifiedByCluster
DrsAutomationLevel : AsSpecifiedByCluster
CustomFields : {}
Id : VirtualMachine-vm-697
Name : vserver2

[vSphere PowerCLI] E:\> get-vm -name "vserver2" | ForEach-Object {$_.NetworkAdapters}

MacAddress : 00:50:AB:CD:40:59
WakeOnLanEnabled : True
NetworkName : Some_Network
Type : Flexible
ConnectionState : VMware.VimAutomation.Client20.ConnectInfoImpl
Id : VirtualMachine-vm-697/4000
Name : Network Adapter 1

MacAddress : 00:50:AB:CD:55:40
WakeOnLanEnabled : True
NetworkName : Another_Network
Type : Flexible
ConnectionState : VMware.VimAutomation.Client20.ConnectInfoImpl
Id : VirtualMachine-vm-697/4001
Name : Network Adapter 2

MacAddress : 00:50:AB:CD:56:da
WakeOnLanEnabled : True
NetworkName : Yet_Another_Network
Type : Flexible
ConnectionState : VMware.VimAutomation.Client20.ConnectInfoImpl
Id : VirtualMachine-vm-697/4002
Name : Network Adapter 3
</source>

== Installed Version ==
To determine the version of PowerCLI currently installed use;
* <code> Get-PowerCLIversion </code>

== Scheduling ==
To schedule a script to run you need to include the PowerCLI VIM console file so that PowerCLI Cmd-lets are available to your script. The command should use the following structure...
* <code> Powershell.exe -PSConsoleFile <vim.psc1> &<script.ps1> </code>

For example, on a WinXP or Win2k3 (32bit) machine you might have something like...
* <code> C:\WINDOWS\system32\windowspowershell\v1.0\powershell.exe -PSConsoleFile "C:\Program Files\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>
Or on a Win7 or Win2k8 (64bit) machine you might have something like...
* <code> Powershell -PSConsoleFile "C:\Program Files (x86)\VMware\Infrastructure\vSphere PowerCLI\vim.psc1" "& C:\Scripts\ESX-probe.ps1" </code>

== Certificates ==
A regular irritation is the certificate warnings that pop-up whenever you connect to a Virtual Centre. To completely fix you need update the default, out of the box, self-signed certificates that are created during the install with proper certs that can be tracked back to a fully trusted root (see http://www.vmware.com/pdf/vi_vcserver_certificates.pdf for further info).

To install a VC's certificate on your client machine (or any machine you want to run PowerCLI from and avoid the warnings)...
# Map a drive, or do whatever so you can access the VC's cert from the client machine
#* Default location on Win2k3: <code>C:\Documents and Settings\All Users\Application Data\VMware\VMware VirtualCenter\SSL\rui.crt</code>
#* Default location on Win2k8: <code>C:\ProgramData\VMware\VMware VirtualCenter\SSL\rui.crt</code>
# On the client machine, start the Certificate Manager (run <code> certmgr.msc </code>)
# Right-click over '''Trusted Root Certificate Authorities''', and click '''All Tasks > Import...'''
# Use the wizard to add the certificate
# Once added, go to the certificate's '''Properties''' and put your VC's hostname in the '''Friendly Name''' field

Alternatively, and to suppress all warning messages during a connect, use the following syntax...
<source lang="powershell">
Connect-VIServer -Server hostname -WarningAction SilentlyContinue
</source>

[[Category:PowerCLI]]
[[Category:Getting Started]]