NAME
Remove-DcsHostGroup
SYNOPSIS
Removes a host group from the configuration.
SYNTAX
Remove-DcsHostGroup -Group <Object> [ -Yes] [ -Connection <String> ] [ -PipelineVariable <String> ] [ -WhatIf] [ -Confirm]
DESCRIPTION
Removes a host group from the configuration. Warning: Use caution when removing host groups. This cmdlet will remove a host group with Charge Back enabled.
PARAMETERS
- -Group<Object>
- HostGroupData object, name, or ID that identifies the host group to remove.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: true (ByValue)
- Accept wildcard characters: false
-
- -Yes<SwitchParameter>
- Specify this parameter to confirm your intention to remove the host group in order to prevent user interaction during scripted scenarios.
-
- 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
-
- -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
HostGroupData : Object that identifies and describes the group.
OUTPUTS
NOTES
Also see Add-DcsHostGroup, Add-DcsHostToGroup, Get-DcsHostGroup, Remove-DcsHostFromGroup, Set-DcsHostGroupProperties.
EXAMPLES
Remove-DcsHostGroup -Group "HostGroup1"
The host group named "HostGroup1" is removed from the server group of the default connection.
Get-DcsHostGroup -Group "HostGroup1" | Remove-DcsHostGroup
The cmdlet Get-DcsHostGroup is invoked with the Group parameter "HostGroup1". This returns the HostGroupData object for the host group named "HostGroup1". The object is piped to the cmdlet Remove-DcsHostGroup to remove that host group from the server group of the default connection.