Get-Datacenter Command | Vmware PowerCLI Reference

Get-Datacenter

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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
  • wildcards
 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.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
Get-Datacenter
-RelatedObject < DatacenterRelatedObjectBase[] >
[-ProgressAction < ActionPreference > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 RelatedObject DatacenterRelatedObjectBase[] named
  • pipeline
 Specifies objects to retrieve one or more Datacenter objects that are related to them. This parameter accepts OMResource objects.
optional ProgressAction ActionPreference named
Get-Datacenter
[-Location < Folder[] > ]
[-Name < String[] > ]
[-NoRecursion ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-Tag < Tag[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Location Folder[] named
  • pipeline
  • wildcards
 Specifies vSphere container objects (such as folders) you want to search for datacenters.
optional Name String[] named
  • wildcards
 Specifies the names of the datacenters you want to retrieve.
optional NoRecursion SwitchParameter named
Indicates that you want to deactivate the recursive behavior of the command.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
optional Tag Tag[] named
Returns only the datacenters that are associated with any of the specified tags.
Get-Datacenter
[-Cluster < Cluster[] > ]
[-Name < String[] > ]
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[-Tag < Tag[] > ]
[-VM < VirtualMachine[] > ]
[-VMHost < VMHost[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
optional Cluster Cluster[] named
  • pipeline
  • wildcards
 Specifies clusters to filter the datacenters that contain at least one of them.
optional Name String[] named
  • wildcards
 Specifies the names of the datacenters you want to retrieve.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
optional Tag Tag[] named
Returns only the datacenters that are associated with any of the specified tags.
optional VM VirtualMachine[] named
  • pipeline
  • wildcards
 Specifies virtual machines to filter the datacenters that contain at least one of them.
optional VMHost VMHost[] named
  • pipeline
  • wildcards
 Specifies hosts to filter the datacenters that contain at least one of them.

Output

VMware.VimAutomation.ViCore.Types.V1.Inventory.Datacenter

Examples

Example 1 

Get-Datacenter -Name Datacenter*

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

Related Commands

Datacenter

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

This cmdlet moves a vCenter Server datacenter from one location to another.

This cmdlet creates a new datacenter.

This cmdlet removes the specified datacenters from their locations.

This cmdlet modifies the properties of the specified datacenter.