Table of contents
ISE
TOC
Collapse the table of content
Expand the table of content

Remove-LocalGroup

JuanPablo Jofre|Last Updated: 12/17/2016
|
3 Contributors

SYNOPSIS

Deletes local security groups.

SYNTAX

InputObject

Remove-LocalGroup [-InputObject] <LocalGroup[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Default

Remove-LocalGroup [-Name] <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

SecurityIdentifier

Remove-LocalGroup [-SID] <SecurityIdentifier[]> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

The Remove-LocalGroup cmdlet deletes local security groups. This cmdlet deletes only a local group. It does not delete the user accounts, computer accounts, or group accounts that belong to that group. You cannot recover a deleted group.

If you delete a group and then create another group that has the same group name, you must set new permissions for the new group. The new group does not inherit the permissions that were assigned to the group.

EXAMPLES

Example 1: Delete a security group

PS C:\> Remove-LocalGroup -Name "SecurityGroup04"

This command deletes the group named SecurityGroup04.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-InputObject

Specifies an array of security groups that this cmdlet deletes. To obtain groups, use the Get-LocalGroup cmdlet.

Type: LocalGroup[]
Parameter Sets: InputObject
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Name

Specifies an array of names of the security groups that this cmdlet deletes.

Type: String[]
Parameter Sets: Default
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-SID

Specifies an array of security IDs (SIDs) of security groups that this cmdlet deletes.

Type: SecurityIdentifier[]
Parameter Sets: SecurityIdentifier
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.Management.Automation.SecurityAccountsManager.LocalGroup, System.String, System.Security.Principal.SecurityIdentifier

You can pipe a security group, a string, or a SID to this cmdlet.

OUTPUTS

None

This cmdlet does not generate any output.

NOTES

  • This cmdlet cannot delete the following default groups:

  • Administrators

  • Backup Operators
  • Cryptographic Operators
  • Distributed COM Users
  • Event Log Readers
  • Guests
  • Hyper-V Administrators
  • IIS_IUSRS
  • Network Configuration Operators
  • Performance Log Users
  • Performance Monitor Users
  • Power Users
  • Remote Desktop Users
  • Remote Management Users
  • Replicator
  • Users
  • WinRMRemoteWMIUsers__
  • The PrincipalSource property is a property on LocalUser, LocalGroup, and LocalPrincipal objects that describes the source of the object. The possible sources are as follows:

  • Local

  • Active Directory
  • Azure Active Directory group
  • Microsoft Account

PrincipalSource is supported only by Windows 10, Windows Server 2016, and later versions of the Windows operating system. For earlier versions, the property is blank.

Get-LocalGroup

New-LocalGroup

Rename-LocalGroup

Set-LocalGroup

© 2017 Microsoft