PowerCLI Reference

Get-Datacenter

Synopsis

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

Syntax

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

Get-Datacenter -Id <String[]> [-Server <VIServer[]>] [<CommonParameters>]

Get-Datacenter [[-Name] <String[]>] [-Location <Folder[]>] [-NoRecursion] [-Server <VIServer[]>] [-Tag <Tag[]>] [<CommonParameters>]

Get-Datacenter [-RelatedObject] <DatacenterRelatedObjectBase[]> [<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

Name	Type	Description	Required?	Pipeline Input
Name	String[]	Specifies the names of the datacenters you want to retrieve.	false	False
RelatedObject	DatacenterRelatedObjectBase[]	Specifies objects to retrieve one or more Datacenter objects that are related to them. This parameter accepts OMResource objects.	true	True (ByValue)
Cluster	Cluster[]	Specifies clusters to filter the datacenters that contain at least one of them.	false	True (ByValue)
Id	String[]	Specifies the IDs of the datacenters you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.	true	False
Location	Folder[]	Specifies vSphere container objects (such as folders) you want to search for datacenters.	false	True (ByValue)
NoRecursion	SwitchParameter	Indicates that you want to disable the recursive behavior of the command.	false	False
Server	VIServer[]	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.	false	False
Tag	Tag[]	Returns only the datacenters that are associated with any of the specified tags.	false	False
VM	VirtualMachine[]	Specifies virtual machines to filter the datacenters that contain at least one of them.	false	True (ByValue)
VMHost	VMHost[]	Specifies hosts to filter the datacenters that contain at least one of them.	false	True (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".