VI-Toolkit - User contributions [en]

PowerShell

2009-03-24T12:46:00Z

Virtu-al:

If you are not running windows 2008 and don't have PowerShell installed then go get it from Microsoft's [http://www.microsoft.com/windowsserver2003/technologies/management/powershell/default.mspx PowerShell landing page]

* [[Powershell CMDLET list]] (thank you Alan Renouf for the idea and initial work)

==== Scripts on other locations ====

* [http://virtualfuture.info/2008/07/powershell-remove-connected-iso/ Remove connected iso's]

* [http://communities.vmware.com/docs/DOC-6973 HBA Load Balancer]

* [http://communities.vmware.com/docs/DOC-6972 Deploy and Redeploy vm's (from templates) from a .csv]

* [http://communities.vmware.com/docs/DOC-9610 Resourcepool Reservation Script]

* [http://communities.vmware.com/docs/DOC-7090 Add/Remove active directory user accounts who belong to a particular security group on all ESX hosts]

* [http://mikedatl.typepad.com/mikedvirtualization/2008/10/quick-migration.html Quick migration]

[[Category: Powershell]][[Category: VI-Toolkit]]

BEGINNERS PAGE

2009-03-24T12:37:40Z

Virtu-al: New page: Looking to Get-Started with the VI Toolkit ? Check out the below links to find useful resources or add your own: * [http://communities.vmware.com/docs/DOC-4210 Managing VMware with Power...

Looking to Get-Started with the VI Toolkit ?

Check out the below links to find useful resources or add your own:

* [http://communities.vmware.com/docs/DOC-4210 Managing VMware with PowerShell FAQ]
* [http://www.virtu-al.net/2009/02/23/vi-toolkit-quick-reference-guide/ VI Toolkit Quick Reference Guide]

Podcasts you should listen to:

* [http://get-scripting.blogspot.com/ Get-Scripting Podcast] by [[Alan Renouf]] and [[Jonathan Medd]]
* [http://powerscripting.wordpress.com/ PowerScripting Podcast] by [[Jonathan Walz]] and [[Hal Rottenberg]]

Add your own Tips here:

Category:Powershell

2009-03-24T12:36:12Z

Virtu-al: New page: The Powershell Catergory is a place to store all VI Toolkit / PowerCLI knowledge, a central place for VI Admins to find scripts which have already been shared by other VI Admins. If you r...

The Powershell Catergory is a place to store all VI Toolkit / PowerCLI knowledge, a central place for VI Admins to find scripts which have already been shared by other VI Admins.

If you require help with scripts or are looking for something which can not be found on this site please search the great [http://communities.vmware.com/community/developer/windows_toolkit VMware VI Toolkit communities site] where LucD will probably answer your question within 5 minutes.

Please feel free to add your own scripts/pages/examples/links the intention is to add all cmdlets to this area to help people by enabling a quick help to the scripts which are added to this site.

So what now ?

Why not visit the [[Powershell CMDLET list]] to get a list of all cmdlets in the current version of the VI Toolkit and some help with each one.

Or if your new to the VI Toolkit check out the [[BEGINNERS PAGE]] where you can find links to the best VI Toolkit related sites or tips and tricks on getting started in the big wide world of the VI Toolkit.

Get-VM

2009-03-24T12:24:46Z

Virtu-al: New page: NAME Get-VM SYNOPSIS Gets from a VMware Infrastructure server one or more virtual machines. SYNTAX Get-VM [-Datastore <Datastore[]>] [-Location <VIContainer[]>] [[-Na...

NAME
Get-VM

SYNOPSIS
Gets from a VMware Infrastructure server one or more virtual machines.

SYNTAX
Get-VM [-Datastore <Datastore[]>] [-Location <VIContainer[]>] [[-Name] <Str
ing[]>] [-Id <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonPara
meters>]

DETAILED DESCRIPTION
Gets from a VMware Infrastructure server one or more objects that represent
virtual machines. Returns a set of virtual machines that correspond to the
filter criteria provided by the cmdlet parameters. For virtual machines wi
th multiple NICs and therefore multiple IP addresses, the "IPAddress" prope
rty of the VMGuest object contains all IP addresses of the virtual machine.
The IP at position 0 is the primary IP address.

PARAMETERS
-Datastore <Datastore[]>
Gets the virtual machines associated with one or more of the specified
datastores. Passing values to this parameter through a pipeline is depr
ecated and will be removed in one of the following releases.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Location <VIContainer[]>
Specifies one or more virtual infrastructure container objects (e.g. fo
lders, datacenters, clusters) to search for virtual machines.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name <String[]>
Specifies one or more names of virtual machine names to get. Use commas
to separate multiple names. Using wildcards is supported.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Id <String[]>
Specifies one or more virtual machine hosts by ID. Use commas to separa
te multiple IDs.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-NoRecursion
Get-VM searches recursively from any provided starting point. Setting t
his parameter disables the command recursive behavior.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server <VIServer[]>
One or more virtual Infrastructure servers to apply the command on. If
no value is given to this parameter, the command takes the server curre
ntly specified in the $DefaultVIServer variable.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type,
"get-help about_commonparameters".

INPUT TYPE

RETURN TYPE
VirtualMachine[]

NOTES

-------------- EXAMPLE 1 --------------

C:\PS>Get-VM

Retrieves information about all of the virtual machines registered with the
currently selected VMware Infrastructure server.

-------------- EXAMPLE 2 --------------

C:\PS>Get-VM -Name webTier*

This command retrieves information about all virtual machines registered wi
th the currently-selected VMware Infrastructure server whose names begin wi
th "webTier."

RELATED LINKS
[[Remove-VM]]
[[New-VM]]
[[Set-VM]]
[[Move-VM]]
[[Start-VM]]
[[Stop-VM]]
[[Suspend-VM]]

Get-VMHost

2009-03-24T12:24:07Z

Virtu-al: New page: NAME Get-VMHost SYNOPSIS Gets from a VMware Infrastructure server one or more virtual machine hosts. SYNTAX Get-VMHost [-Datastore <Datastore[]>] [-State <VMHostState...

NAME
Get-VMHost

SYNOPSIS
Gets from a VMware Infrastructure server one or more virtual machine hosts.

SYNTAX
Get-VMHost [-Datastore <Datastore[]>] [-State <VMHostState[]>] [-Location <
VIContainer[]>] [[-Name] <String[]>] [-Id <String[]>] [-NoRecursion] [-Serv
er <VIServer[]>] [<CommonParameters>]

Get-VMHost [-VM <VirtualMachine[]>] [-ResourcePool <ResourcePool[]>] [-Data
store <Datastore[]>] [-Location <VIContainer[]>] [[-Name] <String[]>] [-Id
<String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]

DETAILED DESCRIPTION
Gets from a VMware Infrastructure server one or more objects that represent
virtual machine hosts. Returns the set of virtual machine hosts that corre
spond to the filter criteria provided by the cmdlet parameters. To specify
a server different from the default one, use the -Server parameter.
When connected directly to an ESX host, the Name property of the returned V
MHost object contains either the DNS name of the host, or the IP of the ES
X host, depending on which of them was specified when connecting with Conne
ct-VIServer.

PARAMETERS
-Datastore <Datastore[]>
If set, the command retrieves the virtual machine hosts associated with
one or more of the specified datastores. Passing values to this parame
ter through a pipeline is deprecated and will be removed after one of t
he following releases.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-State <VMHostState[]>
Specifies the state of the virtual machine hosts to be returned by the
Get-VMHost command. It must be one of the following: Connected, Disconn
ected, NotResponding, Maintenance.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Location <VIContainer[]>
Specifies one or more virtual infrastructure container objects (e.g. fo
lders, datacenters, clusters) to search for virtual machine hosts.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-Name <String[]>
Specifies one or more names of virtual machine hosts to get. Use commas
to separate multiple names. Using wildcards is supported.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Id <String[]>
Specifies one or more virtual machine hosts by Id. To specify multiple
Ids, use commas to separate the Ids.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-NoRecursion
Get-VMHost searches recursively from any provided starting point. Setti
ng this parameter disables the command recursive behavior.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server <VIServer[]>
A VMware Infrastructure server to apply the command on. If no value is
given to this parameter, the command takes the server currently specifi
ed in the $DefaultVIServer variable.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VM <VirtualMachine[]>
Specifies one or more virtual machines running on the virtual machine h
osts retrieved by the command.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

-ResourcePool <ResourcePool[]>
Specifies one or more resource pools associated with the standalone vir
tual machine hosts retrieved by the command.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? true

<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug,
-ErrorAction, -ErrorVariable, -WarningAction, -WarningVariable,
-OutBuffer and -OutVariable. For more information, type,
"get-help about_commonparameters".

INPUT TYPE

RETURN TYPE
VMHost[]

NOTES

When connected directly to ESX, the Name property of the returned VMHos
t object contains either the DNS name of the host, or the
IP of the ESX, depending on which of them was specified when connecting
with Connect-VIServer.

-------------- Example 1 --------------

C:\PS>Get-VMHost -Location (Get-Datacenter -Name New) -VM (Get-VM -Name "MS
Win XP SP2") | fl

Retrieves the virtual machine host, which is located in the New datacenter
and on which the MS Win XP SP2 virtual machine is hosted.

State : Connected
CustomFields : {}
ID : HostSystem-host-8
Name : 10.23.113.212

RELATED LINKS
[[Remove-VMHost]]
[[Move-VMHost]]
[[Set-VMHost]]
[[Add-VMHost]]