< Back
New-LocalGroup
Post
NAME New-LocalGroup
SYNOPSIS
Creates a local security group.
SYNTAX
New-LocalGroup [-Name] <String> [-Confirm] [-Description <String>] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-LocalGroup cmdlet creates a local security group in the Security Account Manager.
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
-Description <String>
Specifies a comment for the group. The maximum length is 48 characters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies a name for the group. The maximum length is 256 characters.
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.String
You can pipe a string to this cmdlet.
OUTPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup
This cmdlet returns a security group.
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: Create a security group
PS C:\\>New-LocalGroup -Name "SecurityGroup04"
This command creates a group named SecurityGroup04.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822515
Get-LocalGroup
Remove-LocalGroup
Rename-LocalGroup
Set-LocalGroup
SYNOPSIS
Creates a local security group.
SYNTAX
New-LocalGroup [-Name] <String> [-Confirm] [-Description <String>] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The New-LocalGroup cmdlet creates a local security group in the Security Account Manager.
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
-Description <String>
Specifies a comment for the group. The maximum length is 48 characters.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies a name for the group. The maximum length is 256 characters.
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.String
You can pipe a string to this cmdlet.
OUTPUTS
System.Management.Automation.SecurityAccountsManager.LocalGroup
This cmdlet returns a security group.
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: Create a security group
PS C:\\>New-LocalGroup -Name "SecurityGroup04"
This command creates a group named SecurityGroup04.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822515
Get-LocalGroup
Remove-LocalGroup
Rename-LocalGroup
Set-LocalGroup