< Back

Remove-LocalGroup

Tue Jan 29, 2019 10:18 pm

NAME Remove-LocalGroup



SYNOPSIS

Deletes local security groups.





SYNTAX

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



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



Remove-LocalGroup [-SID] <SecurityIdentifier[]> [-Confirm] [-WhatIf] [<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.





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



-InputObject <LocalGroup[]>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-Name <String[]>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-SID <SecurityIdentifier[]>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

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.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.



Example 1: Delete a security group



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



This command deletes the group named SecurityGroup04.



RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=822517

Get-LocalGroup

New-LocalGroup

Rename-LocalGroup

Set-LocalGroup