NAME

Get-DcsClientPreferredServer

SYNOPSIS

Returns client-preferred server relationships that show which servers are associated with which clients (hosts).

SYNTAX

Get-DcsClientPreferredServer   [ -Client <Object> ]   [ -Server <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsClientPreferredServer   -ClientPreferredServer <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns client-preferred server relationships that show which servers are associated with which clients (hosts). Filtering parameters may be specified to narrow the scope of the data returned. Preferred server data can be returned for a specific client (host), a specific server, or a specific client-preferred server relationship. If no parameters are specified, data for all client-preferred server relationships in the server group is returned.

PARAMETERS

-Client<Object>
ClientHostData object, name, or ID that identifies a client (host). If specified, only data for that client will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<Object>
ServerHostData object, computer name or ID that identifies a server. The computer name must be unique or the name must be fully qualified. If the server is specified, only data for that server will be returned.

Required: false
Position: 2
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 is 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

-ClientPreferredServer<Object>
ClientServerRelationData object, ID, or caption that identifies a client-preferred server relationship. If specified, only data for that relationship will be returned. The caption is the name of the host followed by the name of the preferred server in this format: "HostVM1 | SSVVM01".

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

ClientServerRelationData : Object that identifies the preferred server relationship between a client (host ) and preferred server.

NOTES

A Preferred Server setting of "Auto select" returns no data since no preferred server is specifically set. A host enabled for ALUA with a Preferred Server setting of "ALL" returns no data. In this case, the path policy is Symmetrical, which means that all available paths are utilized equally, therefore no server is preferred.

EXAMPLES


-------------- Example 1 Returns data for a specified client --------------
Get-DcsClientPreferredServer -Client "HostVM1"
		

The cmdlet is invoked to get the preferred server data for the client (host) named "HostVM1". Two ClientServerRelationData objects are returned. The Caption in the objects show that the servers named "SSVVM01" and "SSVVM02" are preferred servers for the specified client.

ClientId:549da3ce079b49cb9f895d884042722a
ServerId:2D78E1A3-FECB-413F-B20F-70340176CF79
Sequencenumber:10914
Id:c303694d-0ee3-4041-898d-6e9e714296dd
Caption:HostVM1 | SSVVM01
ExtendedCaption:HostVM1 | SSVVM01
Internal:False
   
ClientId:549da3ce079b49cb9f895d884042722a
ServerId:991725E0-A887-4CAA-AAA4-D37D972334C8
Sequencenumber:10915
Id:24ba2893-6132-4774-bf5b-0f11fdeacfef
Caption:HostVM1 | SSVVM02
ExtendedCaption:HostVM1 | SSVVM02
Internal:False
   

-------------- Example 2 Returns data for a specified server --------------
Get-DcsServer -Server "SSVVM01" | Get-DcsClientPreferredServer
		

The cmdlet is invoked to get the preferred server data for the server named "SSVVM01". The cmdlet Get-DcsServer is invoked to return the ServerHostData object for the server and the object is piped to the cmdlet Get-DcsClientPreferredServer. Two ClientServerRelationData objects are returned. The Caption in the objects show that the specified server "SSVVM01" is preferred for the Clients (hosts) named "HostVM1" and "HostVM2".

ClientId:f2c26a44d9784647b6168f168b1ad517
ServerId:2D78E1A3-FECB-413F-B20F-70340176CF79
Sequencenumber:10912
Id:1a40c644-4301-4a2c-a890-6dacaa173fd0
Caption:HostVM2 | SSVVM01
ExtendedCaption:HostVM2 | SSVVM01
Internal:False
   
ClientId:549da3ce079b49cb9f895d884042722a
ServerId:2D78E1A3-FECB-413F-B20F-70340176CF79
Sequencenumber:10914
Id:c303694d-0ee3-4041-898d-6e9e714296dd
Caption:HostVM1 | SSVVM01
ExtendedCaption:HostVM1 | SSVVM01
Internal:False
   

-------------- Example 3 Returns data for a specified clientpreferred server relationship --------------
Get-DcsClientPreferredServer -ClientPreferredServer "HostVM1 | SSVVM01"
		

The cmdlet is invoked using the caption of the client-preferred server "HostVM1 | SSVVM01" to return the object that shows the relationship between the client named "HostVM1" and the preferred server named "SSVVM01".

ClientId:549da3ce079b49cb9f895d884042722a
ServerId:2D78E1A3-FECB-413F-B20F-70340176CF79
Sequencenumber:10914
Id:c303694d-0ee3-4041-898d-6e9e714296dd
Caption:HostVM1 | SSVVM01
ExtendedCaption:HostVM1 | SSVVM01
Internal:False