Get-GPStarterGPO
Get-GPStarterGPO
Gets one Starter GPO or all Starter GPOs in a domain.
Syntax
Parameter Set: ByGUID
Get-GPStarterGPO -Guid <Guid> [-All] [-Domain <String> ] [-Server <String> ] [ <CommonParameters>]
Parameter Set: ByName
Get-GPStarterGPO [-Name] <String> [-All] [-Domain <String> ] [-Server <String> ] [ <CommonParameters>]
Parameter Set: GetAll
Get-GPStarterGPO [-All] [-Domain <String> ] [-Server <String> ] [ <CommonParameters>]
Detailed Description
The Get-GPStarterGPO cmdlet gets one Starter GPO or all Starter GPOs in a domain. You can specify the Starter GPO to retrieve either by display name or by GUID, or you can specify the All parameter to get all the Starter GPOs in the domain.
You can use this cmdlet to get information about a StarterGPO, or you can create a new GPO from a specified Starter GPO by piping the output of this cmdlet into the New-GPO cmdlet.
Parameters
-All
Returns all the Starter GPOs in the domain.
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).
For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain.
If you do not specify the Domain parameter, the domain of the user that is running the current session is used. (If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help.
If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer).
You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases.
Aliases |
domainname |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Guid<Guid>
Specifies the Starter GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO.
You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases.
Aliases |
id |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the Starter GPO to retrieve by its display name.
The display name is not guaranteed to be unique in the domain. If another Starter GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a Starter GPO.
You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases.
Aliases |
displayname |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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 is contacted.
You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases.
Aliases |
dc |
Required? |
false |
Position? |
named |
Default Value |
none |
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.
Microsoft.GroupPolicy.StarterGpo
A Starter GPO.
Outputs
The output type is the type of the objects that the cmdlet emits.
Microsoft.GroupPolicy.StarterGpo object
Get-GPStarterGPO returns a Starter GPO object.
Notes
You can use the Domain parameter to explicitly specify the domain for this cmdlet.
If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. This domain is typically the domain of the user that is running the session, for example, the domain of the user who started the session by opening Windows PowerShell® or the domain of a user that is specified in a runas command. However, computer startup and shutdown scripts run under the context of the LocalSystem account. The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command gets the "Windows Vista EC User" Starter GPO.
C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User"
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command creates a GPO named TestGPO from the "Windows Vista EC User" Starter GPO. The Starter GPO is retrieved by the Get-GPStarterGPO command and is then piped into the New-GPO command to create the new GPO.
C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name TestGPO-Comment "Create a GPO by using a Starter GPO"