< Back
Remove-LocalGroupMember
Post
NAME Remove-LocalGroupMember
SYNOPSIS
Removes members from a local group.
SYNTAX
Remove-LocalGroupMember [-Group] <LocalGroup> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-LocalGroupMember [-Name] <String> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-LocalGroupMember [-SID] <SecurityIdentifier> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-LocalGroupMember cmdlet removes users or groups from a local group.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Group <LocalGroup>
Specifies the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Member <LocalPrincipal[]>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID of the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalPrincipal, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local principal, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
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.
Example 1: Remove members from the Administrators group
PS C:\\>Remove-LocalGroupMember -Group "Administrators" -Member "Admin02", "MicrosoftAccount\\username@Outlook.com",
"AzureAD\\DavidChew@contoso.com", "CONTOSO\\Domain Admins"
This command removes several members from the local Administrators group. The members that this cmdlet removes include a local user account, a
Microsoft account, an Azure Active Directory account, and a domain group. This example uses a placeholder value for the user name of an account at
Outlook.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822518
Add-LocalGroupMember
Get-LocalGroupMember
New-LocalGroup
SYNOPSIS
Removes members from a local group.
SYNTAX
Remove-LocalGroupMember [-Group] <LocalGroup> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-LocalGroupMember [-Name] <String> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-LocalGroupMember [-SID] <SecurityIdentifier> [-Member] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Remove-LocalGroupMember cmdlet removes users or groups from a local group.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-Group <LocalGroup>
Specifies the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Member <LocalPrincipal[]>
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.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Name <String>
Specifies the name of the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SID <SecurityIdentifier>
Specifies the security ID of the security group from which this cmdlet removes members.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.Management.Automation.SecurityAccountsManager.LocalPrincipal, System.String, System.Security.Principal.SecurityIdentifier
You can pipe a local principal, a string, or a SID to this cmdlet.
OUTPUTS
None
This cmdlet does not generate any output.
NOTES
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.
Example 1: Remove members from the Administrators group
PS C:\\>Remove-LocalGroupMember -Group "Administrators" -Member "Admin02", "MicrosoftAccount\\username@Outlook.com",
"AzureAD\\DavidChew@contoso.com", "CONTOSO\\Domain Admins"
This command removes several members from the local Administrators group. The members that this cmdlet removes include a local user account, a
Microsoft account, an Azure Active Directory account, and a domain group. This example uses a placeholder value for the user name of an account at
Outlook.com.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822518
Add-LocalGroupMember
Get-LocalGroupMember
New-LocalGroup