Add-LocalGroupMember - PowerShell Command - PDQ

PowerShell CommandsAdd-LocalGroupMember Add-LocalGroupMember [-Group*] <LocalGroup> [-Member*] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>] Add-LocalGroupMember [-Name*] <String> [-Member*] <LocalPrincipal[]> [-Confirm] [-WhatIf] [<CommonParameters>] Add-LocalGroupMember [-SID*] <SecurityIdentifier> [-Member*] <LocalPrincipal[]> [-Confirm] [-WhatIf][<CommonParameters>]

The Add-LocalGroupMember cmdlet adds users or groups to a local security group. All the rights and permissions that are assigned to a group are assigned to all members of that group.

Members of the Administrators group on a local computer have Full Control permissions on that computer. Limit the number of users in the Administrators group.

If the computer is joined to a domain, you can add user accounts, computer accounts, and group accounts from that domain and from trusted domains to a local group.

Parameters

-Confirm [<SwitchParameter>]

• Default value is False
• Accepts pipeline input False

Prompts you for confirmation before running the cmdlet.

-Group <LocalGroup>

• This value is required
• Default value is None
• Accepts pipeline input False

Specifies the security group to which this cmdlet adds members.

-Member <LocalPrincipal[]>

• This value is required
• Default value is None
• Accepts pipeline input ByPropertyName

Specifies an array of users or groups that this cmdlet adds to a security group. You can specify users or groups by name, security ID (SID), or LocalPrincipal objects.

-Name <String>

• This value is required
• Default value is None
• Accepts pipeline input False

Specifies the name of the security group to which this cmdlet adds members.

-SID <SecurityIdentifier>

• This value is required
• Default value is None
• Accepts pipeline input False

Specifies the security ID of the security group to which this cmdlet adds members.

-WhatIf [<SwitchParameter>]

• Default value is False
• Accepts pipeline input False

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

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

System.Management.Automation.SecurityAccountsManager.LocalGroup, 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.

Examples

1. Add members to the Administrators group: PS C:\> Add-LocalGroupMember -Group "Administrators" -Member "Admin02", "MicrosoftAccount\[email protected]", "AzureAD\[email protected]", "CONTOSO\Domain Admins"

   This command adds several members to the local Administrators group. The new members 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.

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

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands