vSphere PowerCLI Reference

Get-Datacenter

Synopsis

Retrieves the datacenters available on a vSphere server.

Syntax

Get-Datacenter [-VM <VirtualMachine[]>] [-Cluster <Cluster[]>] [-VMHost <VMHost[]>] [-Location <VIContainer[]>] [[-Name] <String[]>] [-NoRecursion] [-Server <VIServer[]>] [<CommonParameters>]
Get-Datacenter -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Related Commands

Online version
Move-Datacenter
New-Datacenter
Remove-Datacenter
Set-Datacenter

Detailed Description

Retrieves the datacenters available on a vSphere server. Returns a set of datacenters that correspond to the filter criteria defined by the cmdlet parameters. By default, the cmdlet searches recursively from any provided starting point. In this case, if the location is not explicitly specified, the search includes the root folder and all other inventory items on the root folder level. If the command runs with the -NoRecursion parameter set to $true, and the location is not specified, only the root folder is searched and no datacenters are returned. To specify a server different from the default one, use the -Server parameter.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
NameString[]Specify the names of the datacenters you want to retrieve.falsefalse
ClusterCluster[]Specify clusters to filter the datacenters that contain at least one of them.falsefalse
IdString[]Specify the IDs of the datacenters you want to retrieve.truefalse
LocationVIContainer[]Specify vSphere container objects (such as folders) you want to search for datacenters.falsetrue (ByValue)
NoRecursionSwitchParameterIndicate that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
VMVirtualMachine[]Specify virtual machines to filter the datacenters that contain at least one of them.falsetrue (ByValue)
VMHostVMHost[]Specify hosts to filter the datacenters that contain at least one of them.falsefalse

Return Type

Datacenter

Notes

Examples

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

Get-Datacenter -Name Datacenter*

Retrieves a list of all datacenters on the server, whose names begin with "Datacenter".


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.