< Back
Get-Datacenter
Post
NAME 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>]
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
-Cluster <Cluster[]>
Specifies clusters to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <Folder[]>
Specifies vSphere container objects (such as folders) you want to search for datacenters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the datacenters you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <DatacenterRelatedObjectBase[]>
Specifies objects to retrieve one or more Datacenter objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the datacenters that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies virtual machines to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies hosts to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Datacenter objects
NOTES
-------------------------- Example 1 --------------------------
Get-Datacenter -Name Datacenter*
Retrieves a list of all datacenters on the server, whose names begin with "Datacenter".
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... enter.html
Move-Datacenter
New-Datacenter
Remove-Datacenter
Set-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>]
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
-Cluster <Cluster[]>
Specifies clusters to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Location <Folder[]>
Specifies vSphere container objects (such as folders) you want to search for datacenters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-Name <String[]>
Specifies the names of the datacenters you want to retrieve.
Required? false
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-NoRecursion [<SwitchParameter>]
Indicates that you want to disable the recursive behavior of the command.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-RelatedObject <DatacenterRelatedObjectBase[]>
Specifies objects to retrieve one or more Datacenter objects that are related to them. This parameter accepts
OMResource objects.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Tag <Tag[]>
Returns only the datacenters that are associated with any of the specified tags.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VM <VirtualMachine[]>
Specifies virtual machines to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-VMHost <VMHost[]>
Specifies hosts to filter the datacenters that contain at least one of them.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Zero or more Datacenter objects
NOTES
-------------------------- Example 1 --------------------------
Get-Datacenter -Name Datacenter*
Retrieves a list of all datacenters on the server, whose names begin with "Datacenter".
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... enter.html
Move-Datacenter
New-Datacenter
Remove-Datacenter
Set-Datacenter