vSphere PowerCLI Reference

Get-Datacenter

Synopsis

This cmdlet retrieves the datacenters available on a vCenter Server system.

Syntax

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

Related Commands

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

Detailed Description

This cmdlet retrieves the datacenters available on a vCenter Server system. 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[]Specifies the names of the datacenters you want to retrieve.falsefalse
ClusterCluster[]Specifies clusters to filter the datacenters that contain at least one of them.falsetrue (ByValue)
IdString[]Specifies the IDs of the datacenters you want to retrieve.truefalse
LocationFolder[]Specifies vSphere container objects (such as folders) you want to search for datacenters.falsetrue (ByValue)
NoRecursionSwitchParameterIndicates that you want to disable the recursive behavior of the command.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
TagTag[]Returns only the datacenters that are associated with any of the specified tags.falsefalse
VMVirtualMachine[]Specifies virtual machines to filter the datacenters that contain at least one of them.falsetrue (ByValue)
VMHostVMHost[]Specifies hosts to filter the datacenters that contain at least one of them.falsetrue (ByValue)

Return Type

Zero or more Datacenter objects

Notes

Examples

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

Get-Datacenter -Name Datacenter*

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


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