New-GPStarterGPO
New-GPStarterGPO
Creates a new Starter GPO.
Syntax
Parameter Set: Default
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
NewGPO |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
None
This cmdlet does not accept any input.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.GroupPolicy.StarterGpo
New-StarterGPO returns the Starter GPO that was created.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command creates a Starter GPO with the display name StarterSecurity. The Starter GPO is annotated with the specified comment.
C:\PS>New-GPStarterGPO -Name StarterSecurity -Comment "Security Template"