NAME

Get-DcsClient

SYNOPSIS

Returns data for clients (hosts).

SYNTAX

Get-DcsClient   [ -Client <Object> ]   [ -Group <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for clients (hosts). Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all clients associated with the default connection will be returned.

PARAMETERS

-Client<Object>

ClientHostData object, name, or ID that identifies a client. If specified, only data for that client will be returned.

Required: false

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Group<Object>

HostGroupData, Id or name of the host group. Use this parameter to return data for client hosts that belong to a specific host group.

Required: false

Position: named

Default value:

Accept pipeline input: false

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

INPUTS

ClientHostData or HostGroupData : Object that identifies and describes the client or host group.

OUTPUTS

ClientHostData : Object that identifies and describes the client.

NOTES

Also see Remove-DcsClient, Remove-DcsClientPort, Register-DcsClientPort, Set-DcsClientProperties, Set-DcsPortProperties.

EXAMPLES

Get-DcsClient -Client "Host VM1"