New-GPStarterGPO
New-GPStarterGPO
Creates a new Starter GPO.
Syntax
New-GPStarterGPO [-Name] <string> [-Comment <string>] [-Domain <string>] [-Server <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Detailed Description
The New-GPStarterGPO cmdlet creates a Starter GPO with the specified name. If the Starter GPOs folder does not exist in the SYSVOL when the New-GPStarterGPO cmdlet is called, it is created and populated with the eight Starter GPOs that ship with Group Policy.
Parameters
-Comment <string>
Includes a comment for the new Starter GPO. The comment string must be enclosed in double-quoatation marks or single-quotation marks and can contain 2,047 characters.
Attributes
Name | Value |
---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Domain <string>
Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com).
Note: Cross-domain creation of Starter GPOs is not supported. If you specify a domain that is different from the domain of the user that is running the current session, an error occurs.
If you do not specify the Domain parameter, the domain of the user that is running the current session is used.
You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases.
Attributes
Name | Value |
---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Name <string>
Specifies the display name for the new Starter GPO.
If another Starter GPO with the same display name exists in the domain, an error occurs.
You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases.
Attributes
Name | Value |
---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
1 |
-Server <string>
Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. For example:
FQDN: DomainController1.SalesDomain.Contoso.com
Host Name: DomainController1
If you do not specify the name by using the Server parameter, the PDC emulator will be contacted.
You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases.
Attributes
Name | Value |
---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Confirm <SwitchParameter>
Prompts you for confirmation before executing the command.
Attributes
Name | Value |
---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without actually executing the command.
Attributes
Name | Value |
---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Input Type |
None. This cmdlet does not accept any input. |
Return Type |
Microsoft.GroupPolicy.StarterGpo. New-StarterGPO returns the Starter GPO that was created. |
Notes
Examples
EXAMPLE 1
C:\PS>
New-GPStarterGPO -Name StarterSecurity -Comment "Security Template"
Description
-----------
This command creates a Starter GPO with the display name StarterSecurity. The Starter GPO is annotated with the specified comment.