Remove JCSystemGroup - TheJumpCloud/support GitHub Wiki
external help file: JumpCloud-help.xml Module Name: JumpCloud online version: https://github.com/TheJumpCloud/support/wiki/Remove-JCSystemGroup schema: 2.0.0
Removes a JumpCloud System Group
Remove-JCSystemGroup [-GroupName] <String> [-force] [<CommonParameters>]
Remove-JCSystemGroup -GroupID <String> [-force] [<CommonParameters>]
Removes a JumpCloud System Group. By default a warning message will be presented to confirm the operation.
PS C:\> Remove-JCSystemGroup -GroupName 'On Prem Systems'
Removes the JumpCloud System Group with the name 'On Prem Systems'. A warning message will be presented to confirm the operation.
PS C:\> Remove-JCSystemGroup -GroupName 'On Prem Systems' -Force
Removes the JumpCloud System Group with the name 'On Prem Systems' using the -Force Parameter. A warning message will not be presented to confirm the operation.
A SwitchParameter which suppresses the warning message when removing a JumpCloud System Group.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The _id of the group which you want to remove. GroupID has an Alias of _id. This means you can leverage the PowerShell pipeline to populate this field automatically.
Type: System.String
Parameter Sets: ByID
Aliases: _id, id
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
The name of the System Group you want to remove.
Type: System.String
Parameter Sets: byName
Aliases: name
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.