Edit

Share via

Remove-LocalGroupMember

Module:
Microsoft.PowerShell.LocalAccounts Module

Removes members from a local group.

Syntax

Group 

Remove-LocalGroupMember
    [-Group] <LocalGroup>
    [-Member] <LocalPrincipal[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Default 

Remove-LocalGroupMember
    [-Member] <LocalPrincipal[]>
    [-Name] <String>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SecurityIdentifier 

Remove-LocalGroupMember
    [-Member] <LocalPrincipal[]>
    [-SID] <SecurityIdentifier>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Remove-LocalGroupMember cmdlet removes users or groups from a local group.

Note

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

Examples

Example 1: Remove members from the Administrators group

$members = "Admin02", "MicrosoftAccount\username@Outlook.com", "AzureAD\DavidChew@contoso.com", "CONTOSO\Domain Admins"
Remove-LocalGroupMember -Group "Administrators" -Member $members

This command removes several members from the local Administrators group. The members that this cmdlet removes include a local user account, a Microsoft account, a Microsoft Entra account, and a domain group. This example uses a placeholder value for the user name of an account at Outlook.com.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Group

Specifies the security group from which this cmdlet removes members.

Parameter properties

Type:Microsoft.PowerShell.Commands.LocalGroup
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Group
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Member

Specifies an array of users or groups that this cmdlet removes from a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects. Specify SID strings in S-R-I-S-S . . . format.

Parameter properties

Type:

Microsoft.PowerShell.Commands.LocalPrincipal[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Name

Specifies the name of the security group from which this cmdlet removes members.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Default
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SID

Specifies the security ID of the security group from which this cmdlet removes members.

Parameter properties

Type:SecurityIdentifier
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SecurityIdentifier
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

System.Management.Automation.SecurityAccountsManager.LocalPrincipal

You can pipe a local principal 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-LocalGroupMember:

  • rlgm

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.