Edit

Share via

Remove-LocalGroup

  • Reference
Module:
Microsoft.PowerShell.LocalAccounts

Deletes local security groups.

Syntax

Remove-LocalGroup
      [-InputObject] <LocalGroup[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-LocalGroup
      [-Name] <String[]>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
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.

Note

The Microsoft.PowerShell.LocalAccounts module is not available in 32-bit PowerShell on a 64-bit system.

Examples

Example 1: Delete a security group

Remove-LocalGroup -Name "SecurityGroup04"

This command deletes the group named SecurityGroup04.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required: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:Microsoft.PowerShell.Commands.LocalGroup[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-SID

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

Type:SecurityIdentifier[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

System.Management.Automation.SecurityAccountsManager.LocalGroup

You can pipe a security group to this cmdlet.

String

You can pipe a string to this cmdlet.

SecurityIdentifier

You can pipe a SID to this cmdlet.

Outputs

None

This cmdlet returns no output.

Notes

Windows PowerShell includes the following aliases for Remove-LocalGroup:

  • rlg

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
  • Microsoft Entra 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.