NAME
Remove-DcsHostFromGroup
SYNOPSIS
Removes a client (host) from a host group.
SYNTAX
Remove-DcsHostFromGroup -Client <Object> [ -Connection <String> ] [ -PipelineVariable <String> ] [ -WhatIf] [ -Confirm]
DESCRIPTION
Removes a client (host) from a host group.
PARAMETERS
- -Client<Object>
- ClientHostData object, name, or ID that identifies the client to remove from the host group to which it belongs.
-
- Required: true
- 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 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
-
- -WhatIf<SwitchParameter>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Confirm<SwitchParameter>
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
INPUTS
ClientHostData : Object that identifies and describes the client.
OUTPUTS
NOTES
Also see Add-DcsHostGroup, Add-DcsHostToGroup, Get-DcsHostGroup, Remove-DcsHostGroup, Set-DcsHostGroupProperties.
EXAMPLES
-------------- Example 1 Remove a specified client from the host group --------------
Remove-DcsHostFromGroup -Client "HostVM1"
The client named "HostVM1" is removed from the host group to which it belongs.