NAME
Get-DcsServerLocality
SYNOPSIS
Returns data for a particular server locality or all server localities.
SYNTAX
Get-DcsServerLocality [-ServerLocality <Object>] [-Connection <String>] [-PipelineVariable <String>] [<CommonParameters>]
DESCRIPTION
Returns data for a particular server locality or all server localities. If no parameters are specified, data for all server localities configured for the server group in the default connection will be returned.
PARAMETERS
- -ServerLocality<Object>
- ServerLocalityData object, name (alias), or ID that identifies a server locality. If specified only data for that locality will be returned.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -Connection<String>
- Alias of the connection to the server group. If not specified, the default connection will be used.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -PipelineVariable<String>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
ServerLocalityDataObject that identifies and describes the server locality.
OUTPUTS
ServerLocalityDataObject that identifies and describes the server locality.
NOTES
Also see Set-DcsServerLocality, Add-DcsServerLocality, Remove-DcsServerLocality, and Update-DcsServerLocality.
EXAMPLES
C:\PS>Get-DcsServerLocality
The cmdlet is invoked without parameters to get data for all server localities.
Alias | : | Locality-68405c |
Description | : | Monitors the configuration state of virtual disks. |
Sequencenumber | : | 34350 |
Id | : | E84B65FF-B69A-4EF1-B79E-71D3DC29E867 |
Caption | : | Locality-68405c |
ExtendedCaption | : | Locality-68405c - Server Locality |
Internal | : | False |
Alias | : | Lab 1 |
Description | : | Located at Lab 1 |
Sequencenumber | : | 34351 |
Id | : | A122B0E3-7D32-4783-BDE4-619049C936C9 |
Caption | : | Lab1 |
ExtendedCaption | : | Lab1 - Server Locality |
Internal | : | False |
Alias | : | Lab 2 |
Description | : | Located at Lab 2 |
Sequencenumber | : | 34352 |
Id | : | 100469DF-0BE1-40DA-874E-9F1DA5A259E3 |
Caption | : | Lab2 |
ExtendedCaption | : | Lab2 - Server Locality |
Internal | : | False |
C:\PS>Get-DcsServerLocality -ServerLocality Lab1
The cmdlet is invoked with the ServerLocality specified as "Lab1", resulting in the return of that data object.
Alias | : | Lab 1 |
Description | : | Located at Lab 1 |
Sequencenumber | : | 34350 |
Id | : | E84B65FF-B69A-4EF1-B79E-71D3DC29E867 |
Caption | : | Lab1 |
ExtendedCaption | : | Lab1 - Server Locality |
Internal | : | False |