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
[-Name <String[]>]
[-NoRecursion]
[-Server <VIServer[]>]
[-Tag <Tag[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
Folder[] | named |
|
Specifies vSphere container objects (such as folders) you want to search for datacenters. | optional |
|
String[] | named |
|
Specifies the names of the datacenters you want to retrieve. | optional |
|
SwitchParameter | named |
|
Indicates that you want to deactivate the recursive behavior of the command. | optional |
|
VIServer[] | named |
|
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[] | named |
|
Returns only the datacenters that are associated with any of the specified tags. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
String[] | named |
|
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 |
|
VIServer[] | named |
|
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. |
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| required |
|
DatacenterRelatedObjectBase[] | named |
|
Specifies objects to retrieve one or more Datacenter objects that are related to them. This parameter accepts OMResource objects. |
[-Name <String[]>]
[-Server <VIServer[]>]
[-Tag <Tag[]>]
[-VM <VirtualMachine[]>]
[-VMHost <VMHost[]>]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional |
|
Cluster[] | named |
|
Specifies clusters to filter the datacenters that contain at least one of them. | optional |
|
String[] | named |
|
Specifies the names of the datacenters you want to retrieve. | optional |
|
VIServer[] | named |
|
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[] | named |
|
Returns only the datacenters that are associated with any of the specified tags. | optional |
|
VirtualMachine[] | named |
|
Specifies virtual machines to filter the datacenters that contain at least one of them. | optional |
|
VMHost[] | named |
|
Specifies hosts to filter the datacenters that contain at least one of them. |
Output
VMware.VimAutomation.ViCore.Types.V1.Inventory.Datacenter
Examples
Example 1
Retrieves a list of all datacenters on the server, whose names begin with "Datacenter".
Related Commands
