Edit

Share via


New-GPStarterGPO

Creates a Starter GPO.

Syntax

Default (Default)

New-GPStarterGPO
    [-Name] <String>
    [-Comment <String>]
    [-Domain <String>]
    [-Server <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

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.

Examples

Example 1: Create a Starter GPO

New-GPStarterGPO -Name StarterSecurity -Comment "Security Template"

This command creates a Starter GPO with the display name StarterSecurity. The Starter GPO is annotated with the specified comment.

Parameters

-Comment

Specifies a comment for the new Starter GPO. The comment string must be enclosed in double-quotation marks or single-quotation marks and can contain a maximum of 2,047 characters.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Domain

Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain.

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DomainName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisplayName

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Server

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.

If you do not specify the name by using the Server parameter, the primary domain controller (PDC) emulator is contacted.

You can also refer to the Server parameter by its built-in alias, DC. For more information, see about_Aliases.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DC

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

This cmdlet does not accept any input.

Outputs

Microsoft.GroupPolicy.StarterGpo

This cmdlet returns the Starter GPO that was created.