HelpCache/Microsoft.GroupPolicy.Commands.dll-Help.xml
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Backup-GPO</command:name><maml:description><maml:para>Backs up one GPO or all the GPOs in a domain.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Backup</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Backup-GPO cmdlet backs up a specified GPO or all the GPOs in a domain to a backup directory. The backup directory and GPO must already exist. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Backup-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the backed-up GPO. The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Backup-GPO cmdlet, the GPO to back up must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to backup by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory; for example, "C:\Backups" or "\\MyServer\Backups". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Specifies that all the GPOs in the domain are backed up. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the backed-up GPO. The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Backup-GPO cmdlet, the GPO to back up must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory; for example, "C:\Backups" or "\\MyServer\Backups". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Backup-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to backup by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the backed-up GPO. The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Backup-GPO cmdlet, the GPO to back up must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory; for example, "C:\Backups" or "\\MyServer\Backups". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Specifies that all the GPOs in the domain are backed up. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the backed-up GPO. The comment string must be enclosed in double-quotation or single-quotation marks and can contain 2,047 characters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Backup-GPO cmdlet, the GPO to back up must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to backup by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to backup by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory; for example, "C:\Backups" or "\\MyServer\Backups". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO to be backed up. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.GpoBackup</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Backup-GPO returns an object that represents the file that holds the settings of the backed-up GPO. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Backup-Gpo -Name TestGPO -Path C:\GpoBackups -Comment "Weekly Backup" DisplayName : TestGPO GpoId : 35c12ab3-956c-45d5-973b-46b17d225f47 Id : 2b509d4e-40f5-4337-82f7-458584555d0c BackupDirectory : C:\GpoBackups CreationTime : 2/25/2009 8:48:19 PM DomainName : contoso.com Comment : Weekly Backup </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command backs up the "TestGPO" GPO to the C:\GpoBackups directory. The specified comment is included in the GPO backup. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Backup-Gpo -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Domain contoso.com -Server DC1 -Path \\Server1\GpoBackups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command backs up the GPO with the specified GUID in the contoso.com domain to the \\Server1\GpoBackups directory. The domain controller at DC1.contoso.com is contacted to complete the operation. </maml:para><maml:para>If the domain of the user running the session (or, for startup and shutdown scripts, the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Backup-Gpo -All -Path \\Server1\GpoBackups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command backs up all the GPOs in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) to the \\Server1\GpoBackups directory. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287712</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Import-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Restore-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Copy-GPO</command:name><maml:description><maml:para>Copies a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Copy</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Copy-GPO cmdlet creates a (destination) GPO and copies the settings from the source GPO to the new GPO. The cmdlet can be used to copy a GPO from one domain to another domain within the same forest. You can specify a migration table to map security principals and paths when copying across domains. You can also specify whether to copy the access control list (ACL) from the source GPO to the destination GPO. </maml:para><maml:para>Note: Copy-GPO will not copy the source GPO if a GPO with the specified (target) display name already exists in the destination domain. In this case, an error occurs and the GPO is not copied. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Copy-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CopyAcl</maml:name><maml:description><maml:para>Copies the Access Control List (ACL) of the source GPO to the destination (target) GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the location of the migration table to use for the command. You must specify the full path to the file; for example, "\\Server1\MigrationTables\TestToSalesTable.migtable". If you supply a migration table, security principals and UNC paths are mapped to the destination GPO when you copy a GPO across domains. If you do not supply a migration table, security principals and UNC paths are not modified in the destination GPO. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomain</maml:name><maml:description><maml:para>Specifies the domain of the source GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the SourceDomain 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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the SourceDomain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the source domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the SourceDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomain</maml:name><maml:description><maml:para>Specifies the domain to which you want to copy the GPO (the destination domain). You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the TargetDomain 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. </maml:para><maml:para>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). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the destination domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the TargetDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>SourceGuid</maml:name><maml:description><maml:para>Specifies the source GPO by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the SourceGuid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name for the destination GPO. If another GPO with the same display name exists in the destination (target) domain, an error occurs. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Copy-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>SourceName</maml:name><maml:description><maml:para>Specifies the source GPO by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the SourceGuid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the SourceName parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CopyAcl</maml:name><maml:description><maml:para>Copies the Access Control List (ACL) of the source GPO to the destination (target) GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the location of the migration table to use for the command. You must specify the full path to the file; for example, "\\Server1\MigrationTables\TestToSalesTable.migtable". If you supply a migration table, security principals and UNC paths are mapped to the destination GPO when you copy a GPO across domains. If you do not supply a migration table, security principals and UNC paths are not modified in the destination GPO. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomain</maml:name><maml:description><maml:para>Specifies the domain of the source GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the SourceDomain 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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the SourceDomain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the source domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the SourceDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomain</maml:name><maml:description><maml:para>Specifies the domain to which you want to copy the GPO (the destination domain). You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the TargetDomain 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. </maml:para><maml:para>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). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the destination domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the TargetDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name for the destination GPO. If another GPO with the same display name exists in the destination (target) domain, an error occurs. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CopyAcl</maml:name><maml:description><maml:para>Copies the Access Control List (ACL) of the source GPO to the destination (target) GPO. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>False</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the location of the migration table to use for the command. You must specify the full path to the file; for example, "\\Server1\MigrationTables\TestToSalesTable.migtable". If you supply a migration table, security principals and UNC paths are mapped to the destination GPO when you copy a GPO across domains. If you do not supply a migration table, security principals and UNC paths are not modified in the destination GPO. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomain</maml:name><maml:description><maml:para>Specifies the domain of the source GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the SourceDomain 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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the SourceDomain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>SourceDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the source domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the SourceDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>SourceGuid</maml:name><maml:description><maml:para>Specifies the source GPO by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the SourceGuid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>SourceName</maml:name><maml:description><maml:para>Specifies the source GPO by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the SourceGuid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the SourceName parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomain</maml:name><maml:description><maml:para>Specifies the domain to which you want to copy the GPO (the destination domain). You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>If you do not specify the TargetDomain 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. </maml:para><maml:para>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). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetDomainController</maml:name><maml:description><maml:para>Specifies the name of the domain controller that this cmdlet contacts for the destination domain. You can specify either the fully qualified domain name (FQDN) or the host name. For example: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the TargetDomainController parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name for the destination GPO. If another GPO with the same display name exists in the destination (target) domain, an error occurs. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The cmdlet takes a GPO as input. GPO objects that are piped into the cmdlet are used as the source GPO. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet outputs a copy of the specified GPO. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Copy-GPO cmdlet to copy a GPO within a domain or from one domain to another within the same forest. </maml:para><maml:para>You can use the SourceDomain and TargetDomain parameters to explicitly specify the source domain or the target domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Copy-GPO -SourceName TestGpo1 -TargetName TestGpo2 DisplayName : TestGpo2 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 37eeb072-cc31-42bb-8c3a-446c2b6ddd3f GpoStatus : AllSettingsEnabled Description : CreationTime : 2/25/2009 9:12:05 PM ModificationTime : 2/25/2009 9:12:05 PM UserVersion : AD Version: 1, SysVol Version: 1 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command copies the "TestGpo1" GPO to a GPO named "TestGpo2". The GPOs exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Copy-GPO -SourceName TestGpo1 -SourceDomain test.contoso.com TargetName TestGpo1 -TargetDomain sales.contoso.com </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command copies the "TestGpo1" GPO from the test.contoso.com domain to a GPO named TestGpo1 in the sales.contoso.com domain. </maml:para><maml:para>A trust relationship must exist between the source domain and the destination domain. In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session (or, for startup and shutdown scripts, the computer), a trust must exist between that domain and the domain of the user (or the computer). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>get-gpo -all -domain sales1.contoso.com | foreach-object {$_ | copy-gpo -targetName ($_.DisplayName) -targetdomain sales2.contoso.com -copyacl -migrationtable c:\tables\MigrationTable.migtable} </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command copies all the GPOs in the sales1.contoso.com domain to the sales2.contoso.com domain. </maml:para><maml:para>First, all the GPOs in the source domain are retrieved by using the Get-GPO cmdlet with the All parameter. The output of Get-GPO is piped into the foreach-object command. When each GPO is evaluated, it is piped into Copy-GPO and its display name is specified for the TargetName parameter "-targetName ($_.DisplayName)". The CopyACL parameter is specified to copy the ACLs for each GPO to the destination domain. The MigrationTable parameter specifies a migration table to use to migrate Security principals and UNC paths to the destination domain. Both the CopyACL and the MigrationTable parameters are optional. </maml:para><maml:para>If a GPO with the same display name as a source GPO already exists in the destination domain, an error occurs when this command attempts to copy the source GPO. Because this command copies all GPOs in the source domain, errors occur for default GPOs; for example, the "Default Domain Policy" GPO and the "Default Domain Controllers Policy" GPO. These GPOs are not copied. You can suppress these error messages by supplying the ErrorAction parameter with a value of SilentlyContinue to Copy-GPO. For more information about the ErrorAction parameter, see about_CommonParameters. </maml:para><maml:para>The (destination) GPOs that were successfully copied are returned by this command. By default, they are printed to the display, but you can add commands to the end of the pipeline to further configure these GPOs. For example you can add a Set-GPLinks cmdlet to the end of the pipeline to link all the destination GPOs to a site, domain, or organizational unit. </maml:para><maml:para>A trust relationship must exist between the source domain and the destination domain. In addition, if the source domain or the destination domain (or both) is different than the domain of the user that is running the session (or, for startup and shutdown scripts, the computer), a trust must exist between that domain and the domain of the user (or the computer). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287713</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Import-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Restore-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPInheritance</command:name><maml:description><maml:para>Retrieves Group Policy inheritance information for a specified domain or OU.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPInheritance</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPInheritance cmdlet returns information about Group Policy inheritance for a specified domain or OU. </maml:para><maml:para>This information includes the following: -- A list of GPOs that are linked directly to the location (the GpoLinks property). -- A list of GPOs that are applied to the location when Group Policy is processed on a client (the InheritedGpoLinks property). -- Whether inheritance is blocked for the location (the GpoInheritanceBlocked property). </maml:para><maml:para>Note: The InheritedGpoLinks property contains a list of the GPOs are applied to the OU or domain when Group Policy is processed on a client;. The GPOs are listed according to the order of precedence with which they are applied. This list includes (in the following order): -- Inherited GPOs that are linked, enabled, and enforced at higher levels of the Group Policy hierarchy (for example, a site). -- GPOs that are linked and enabled directly at the specified location. -- If inheritance is not blocked for the specified location, inherited GPOs that are linked and enabled -- but not enforced -- at higher levels of the Group Policy hierarchy. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPInheritance</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the domain or the OU for which to retrieve the Group Policy inheritance information by its LDAP distinguished name. For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". </maml:para><maml:para>You can also refer to the Target parameter by its built-in alias, "path". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPInheritance cmdlet, this is typically the domain of the container (domain or OU) for which you want to retrieve inheritance information. If the specified domain is different than the domain of the container, a trust must exist between the two domains. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to Server by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPInheritance cmdlet, this is typically the domain of the container (domain or OU) for which you want to retrieve inheritance information. If the specified domain is different than the domain of the container, a trust must exist between the two domains. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to Server by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the domain or the OU for which to retrieve the Group Policy inheritance information by its LDAP distinguished name. For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". </maml:para><maml:para>You can also refer to the Target parameter by its built-in alias, "path". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Som</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>An object that represents a domain or an OU. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Som</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPInheritance returns an object that represents the domain or OU. The GpoInheritanceBlocked property indicates whether inheritance is blocked. You can modify inheritance for the domain or OU by using the Set-GPInheritance cmdlet. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPInheritance -target "ou=MyOU,dc=contoso,dc=com" ContainerName : myou ContainerType : OU Path : ou=myou,dc=contoso,dc=com GpoInheritanceBlocked : No GpoLinks : {TestGPO-0, TestGPO-1, TestGPO-2, TestGPO-3...} InheritedGpoLinks : {TestGPO-2, TestGPO-3, Default Domain Policy} </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves Group Policy inheritance information for the OU named 'MyOU' in the contoso.com domain. </maml:para><maml:para>The GpoLinks property contains a list of all the GPOs that are linked directly to the GPO, whether their links are enabled or not. </maml:para><maml:para>The InheritedGpoLinks property contains a list of all the GPOs that are applied when Group Policy is processed on the client. TestGPO-2 and TestGPO-3 appear in this list because their links are enabled. </maml:para><maml:para>The "Default Domain Policy" GPO is inherited from the contoso.com domain. If inheritance is blocked, it does not appear in the InheritedGpoLinks property unless its link is enforced (at the domain). If its link is enforced, it appears first in the list. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPInheritance -Target "dc=contoso,dc=com" -Domain contoso.com -Server DomainController1 Name : contoso.com ContainerType : Domain Path : dc=contoso,dc=com GpoInheritanceBlocked : No GpoLinks : {Default Domain Policy} InheritedGpoLinks : {Default Domain Policy} </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves Group Policy inheritance information for the contoso.com domain. The domain controller with the host name DomainController1 is contacted to complete the operation. </maml:para><maml:para>Note: The domain does not have to be explicitly specified (by using the Domain parameter) in this example. If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is the same as the target domain, or a trust exists between it and the target domain, you do not have to specify the Domain parameter. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | foreach-object { Get-GPO -Name ($_.DisplayName)} DisplayName : TestGPO-3 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/27/2009 2:59:51 PM ModificationTime : 2/27/2009 4:00:44 PM UserVersion : AD Version: 13, SysVol Version: 13 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : DisplayName : TestGPO-2 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/26/2009 11:28:08 PM ModificationTime : 3/1/2009 11:07:30 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command evaluates the SOM object (Microsoft.GroupPolicy.SOM) returned by Get-GPInheritance and returns the GPOs that are linked to the "MyOU" organizational unit. You can use this command to set properties of the GPOs by piping its output into other cmdlets. For example, you can pipe the output to the Set-GPPermissions command to delegate permissions to administrators of the OU for each of the GPOs linked to the OU. </maml:para><maml:para>The GpoLinks property of the SOM object contains a list of all the GPO links for the OU. Each object in this list is of type Microsoft.GroupPolicy.GpoLink. The following shows one such object: </maml:para><maml:para>GpoId : d02126d4-82e8-4e87-b4a0-2d44b6891411 DisplayName : TestGPO-3 Enabled : True Enforced : False Target : ou=myou,dc=contoso,dc=com Order : 1 </maml:para><maml:para>The collection is piped into a foreach-object command, which retrieves each GPO by using the DisplayName property of the GpoLink object. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287714</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPInheritance</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPO</command:name><maml:description><maml:para>Gets one GPO or all the GPOs in a domain.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPO cmdlet gets one GPO or all the GPOs in a domain. You can specify a GPO by its display name or by its globally unique identifier (GUID) to get a single GPO, or you can get all the GPOs in the domain by specifying the All parameter. </maml:para><maml:para>The Get-GPO cmdlet returns one or more objects that represent the requested GPOs. By default, properties of the requested GPOs are printed to the display; however, you can also pipe the output of the Get-GPO cmdlet to other Group Policy cmdlets. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPO cmdlet, the GPO (or GPOs) to retrieve must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Retrieves all the GPOs in the domain. </maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPO cmdlet, the GPO (or GPOs) to retrieve must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Retrieves all the GPOs in the domain. </maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to retrieve by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPO cmdlet, the GPO (or GPOs) to retrieve must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Retrieves all the GPOs in the domain. </maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Retrieves all the GPOs in the domain. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPO cmdlet, the GPO (or GPOs) to retrieve must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to retrieve by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO for which to get information. You can pipe GPO objects into this cmdlet to display information about the GPOs. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPO returns an object that represents the requested GPO. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para><maml:para>Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. (This is because "domainname" is a built-in alias for the Domain parameter, and the Domain parameter can take its value by property name from the pipeline.) A non-terminating error occurs for any GPOs in the collection that are not in this domain. If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -name "Group Policy Test" DisplayName : Group Policy Test DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 31a09564-cd4a-4520-98fa-446a2af23b4b GpoStatus : AllSettingsEnabled Description : CreationTime : 2/26/2009 12:15:42 AM ModificationTime : 2/26/2009 12:15:42 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves the "Group Policy Test" GPO. The GPO must exist in the domain of the user that is running the session (or, for startup and shutdown scripts, the computer). The command retrieves the GPO information by contacting the primary domain controller (PDC). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -Guid 31a09564-cd4a-4520-98fa-446a2af23b4b -Domain sales.contoso.com DisplayName : Group Policy Test DomainName : sales.contoso.com Owner : SALES\Domain Admins Id : 31a09564-cd4a-4520-98fa-446a2af23b4b GpoStatus : AllSettingsEnabled Description : CreationTime : 2/26/2009 12:15:42 AM ModificationTime : 2/26/2009 12:15:42 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves the GPO that has the ID (GUID) 331a09564-cd4a-4520-98fa-446a2af23b4b in the sales.contoso.com domain. If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different that sales.contoso.com, a trust must exist between the two domains. The command retrieves the GPO information by contacting the PDC (in the sales.contoso.com domain). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -All -Domain sales.contoso.com </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves all the GPOs in the sales.contoso.com domain. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287715</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPOReport</command:name><maml:description><maml:para>Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPOReport</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPOReport cmdlet generates a report in either XML or HTML format that describes properties and policy settings for a specified GPO or for all GPOs in a domain. The information that is reported for each GPO includes: details, links, security filtering, WMI filtering, delegation, and computer and user configurations. </maml:para><maml:para>You can specify the All parameter to generate a report for every GPO in the domain, or you can specify either the Name or Guid parameter to generate a report for a single GPO. You can also pipe GPO objects into this cmdlet. If you specify a file by using the Path parameter, the report is written to a file; otherwise, it is printed to the display. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPOReport</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpoReport.xml. If no path is specified, the report is printed to the display. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPOReport cmdlet: -- If a single GPO is specified, it must exist in this domain. -- If the All parameter is specified, a report is generated for each GPO in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPOReport</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpoReport.xml. If no path is specified, the report is printed to the display. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPOReport cmdlet: -- If a single GPO is specified, it must exist in this domain. -- If the All parameter is specified, a report is generated for each GPO in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""><maml:name>All</maml:name><maml:description><maml:para>If present, a report is generated for all GPOs in the domain. </maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPOReport</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to generate the report by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpoReport.xml. If no path is specified, the report is printed to the display. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPOReport cmdlet: -- If a single GPO is specified, it must exist in this domain. -- If the All parameter is specified, a report is generated for each GPO in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="6" aliases=""><maml:name>All</maml:name><maml:description><maml:para>If present, a report is generated for all GPOs in the domain. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPOReport cmdlet: -- If a single GPO is specified, it must exist in this domain. -- If the All parameter is specified, a report is generated for each GPO in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to generate the report by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>NewGPO</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="3" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpoReport.xml. If no path is specified, the report is printed to the display. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue><dev:type><maml:name>ReportType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>An object that represents a GPO. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet does not generate any output. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para><maml:para>Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet. (This is because "domainname" is a built-in alias for the Domain parameter, and the Domain parameter can take its value by property name from the pipeline.) A non-terminating error occurs for any GPOs in the collection that are not in this domain. If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPOReport -Name TestGPO1 -ReportType HTML -Path C:\GPOReports\GPOReport1.html </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report in HTML format for the GPO TestGPO1 and writes it to the file C:\GPOReports\GPOReport1.html </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPOReport -All -Domain sales.contoso.com -Server DC1 -ReportType XML -Path C:\GPOReports\GPOReportsAll.xml </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report in XML format for each GPO in the sales.contoso.com domain and writes it to the file C:\GPOReports\GPOReportsAll.xml. The DC1.sales.contoso.com domain controller is contacted to complete the operation. </maml:para><maml:para>If the domain of the user account (or, for startup and shutdown scripts, the computer account) is different from sales.contoso2.com, a trust must exist between the two domains. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report in XML format for the GPO with the specified GUID. Because no path parameter is supplied, the report is written to the display. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287716</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPPermission</command:name><maml:description><maml:para>Gets the permission level for one or more security principals on a specified GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPPermission</command:noun><dev:version /></command:details><maml:description><maml:para>Gets the permission level for one or more security principals on the specified GPO. You can use the TargetName and TargetType parameters to specify a user, security group, or computer for which to retrieve the permission level. You can use the All parameter to retrieve the permission level for each security principal (user, security group, or computer) that has permissions on the GPO. You can specify the GPO by its display name or by its GUID. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPPermission</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Gets the permission level for each user, group, or computer that has permissions on the GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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-GPPermission cmdlet, the GPO for which to get the permission level 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to retrieve the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to retrieve the permission level. You must specify Computer, User, or Group. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPPermission</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the permission level by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Gets the permission level for each user, group, or computer that has permissions on the GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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-GPPermission cmdlet, the GPO for which to get the permission level 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to retrieve the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to retrieve the permission level. You must specify Computer, User, or Group. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Gets the permission level for each user, group, or computer that has permissions on the GPO. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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-GPPermission cmdlet, the GPO for which to get the permission level 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the permission level by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to retrieve the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to retrieve the permission level. You must specify Computer, User, or Group. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue><dev:type><maml:name>PermissionTrusteeType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO for which to retrieve the permission level. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPPermission returns an object that represents permissions for the specified security principal (user, group, or computer) on the GPO. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the DomainName parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>If you do not explicitly specify the domain, the cmdlet uses the 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group Trustee : Domain Users TrusteeType : Group PermissionLevel : GpoRead Inherited : False </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command gets the permission level for the "Domain Users" group on the GPO named TestGpo. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPPermission -Domain sales.contoso.com -Server DC1 -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -TargetName "Domain Admins" -TargetType Group </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command gets the permission level for the "Domain Admins" group on the GPO with the GUID fa4a9473-6e2a-4b78-175e68d97bde in the Sales.Contoso.com domain. The DC1.sales.contoso.com domain controller is contacted to complete the operation. </maml:para><maml:para>If the domain of the user that is running the session (or, for startup and shutdown scripts, the computer) is different from the sales.contoso.com domain, a trust must exist between the two domains, or the command fails. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPPermission -Name TestGPO -All Trustee : Authenticated Users TrusteeType : WellKnownGroup Permission : GpoApply Inherited : False Trustee : Domain Admins TrusteeType : Group Permission : GpoEditDeleteModifySecurity Inherited : False Trustee : Enterprise Admins TrusteeType : Group Permission : GpoEditDeleteModifySecurity Inherited : False Trustee : ENTERPRISE DOMAIN CONTROLLERS TrusteeType : WellKnownGroup Permission : GpoRead Inherited : False Trustee : SYSTEM TrusteeType : WellKnownGroup Permission : GpoEditDeleteModifySecurity Inherited : False </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command gets the permission level for each security principal that has permissions on the GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "contoso\Domain Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_.DisplayName}} Default Domain Policy TestGPO-1 TestGPO-2 Default Domain Controllers Policy Internet Security TestGPO </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command lists the display name of each GPO (in the domain) on which the specified security principal has permissions. </maml:para><maml:para>First, Get-GPO is used to retrieve all the GPOs in the domain (Get-GPO -All). Then, the collection is piped into the foreach-object command. As each GPO is evaluated, it is piped into Get-GPPermissions. If a permission level is returned, the DisplayName property of the GPO is printed ($_.DisplayName). </maml:para><maml:para>Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed for GPOS on which the security principal does not have permissions. For more information about the ErrorAction parameter, see about_CommonParameters. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287717</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPPermission</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPPrefRegistryValue</command:name><maml:description><maml:para>Retrieves one or more Registry preference items under either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPPrefRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPPrefRegistryValue cmdlet retrieves one or more Registry preference items under either Computer Configuration or User Configuration in a GPO. You must specify the Context parameter (User or Computer) to indicate whether to retrieve the Registry preference item from Computer Configuration or User Configuration. . You can specify the GPO by its display name or by its GUID. </maml:para><maml:para>You can retrieve Registry preference items for a specific registry value, or for a key and any of its first-level registry values: -- To retrieve any Registry preference items that configure a specific registry value, specify both the Key and the ValueName parameters. -- To retrieve all the Registry preference items that configure a registry key and any (first-level) registry values directly under the key, specify the Key parameter without the ValueName parameter. </maml:para><maml:para>If you specify only a key, the cmdlet also returns its first-level subkeys for which there are Registry preference items that configure the subkey, its values, or any of its subkeys (at any level) or their values. You can use this information to browse for Registry preference items. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPPrefRegistryValue</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPPrefRegistryValue cmdlet, the GPO for which to retrieve the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is applied, relative to the other Registry preference items in the GPO, on a client. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve all Registry preference items. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you want to retrieve Registry preference items for a registry key and all its first-level values, do not specify this parameter. When you want to retrieve Registry preference items only for a specific registry value, specify this parameter together with the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is retrieved from User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item to retrieve; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are retrieved. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are retrieved. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPPrefRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPPrefRegistryValue cmdlet, the GPO for which to retrieve the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is applied, relative to the other Registry preference items in the GPO, on a client. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve all Registry preference items. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you want to retrieve Registry preference items for a registry key and all its first-level values, do not specify this parameter. When you want to retrieve Registry preference items only for a specific registry value, specify this parameter together with the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is retrieved from User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item to retrieve; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are retrieved. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are retrieved. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is retrieved from User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue><dev:type><maml:name>GpoConfiguration</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPPrefRegistryValue cmdlet, the GPO for which to retrieve the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item to retrieve; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are retrieved. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are retrieved. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is applied, relative to the other Registry preference items in the GPO, on a client. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve all Registry preference items. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you want to retrieve Registry preference items for a registry key and all its first-level values, do not specify this parameter. When you want to retrieve Registry preference items only for a specific registry value, specify this parameter together with the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet takes a GPO as input. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.PreferenceRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet returns PreferenceRegistrySetting objects. You can pipe these objects to the following cmdlets: Set-GPPrefRegistryValue Remove-GPPrefRegistryValue </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>If a Registry preference item for the specified registry key or value is not found, a non-terminating error occurs. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey -valuename valueone KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine Action : Create Order : 1 DisabledDirectly : False DisabledByAncestor : False Value : NewData1 Type : String ValueName : ValueOne HasValue : True </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves the Registry preference item that is configured for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine Action : Create Order : 1 DisabledDirectly : False DisabledByAncestor : False Value : NewData1 Type : String ValueName : ValueOne HasValue : True KeyPath : SOFTWARE\Microsoft\ExampleKey FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey Hive : LocalMachine Action : Create Order : 2 DisabledDirectly : False DisabledByAncestor : False Value : NewData2 Type : String ValueName : Valuetwo HasValue : True KeyPath : SOFTWARE\Microsoft\ExampleKey\Subkey1 FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\Subkey1 Hive : LocalMachine KeyPath : SOFTWARE\Microsoft\ExampleKey\SubKey2 FullKeyPath : HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\SubKey2 Hive : LocalMachine </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves all the Registry preference items that are configured for the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" and any of its first-level values from User Configuration in the "TestGPO" GPO. </maml:para><maml:para>In this example, Registry preference items that configure the following two first-level values of the registry key are returned: ValueOne and ValueTwo. Two subkeys of the key are also returned. This is because there are Registry preference items in User Configuration associated with each subkey. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287718</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPRegistryValue</command:name><maml:description><maml:para>Retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPRegistryValue cmdlet retrieves one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO. </maml:para><maml:para>You can retrieve registry-based policy settings for a specific registry value, or for all the registry values under a key: -- To retrieve the registry-based policy setting that configures a specific registry value, specify both the Key and the ValueName parameters. -- To retrieve all the registry-based policy settings that configure values directly under a registry key, specify the Key parameter without the ValueName parameter. </maml:para><maml:para>If you specify only a key, in addition to the policy settings that configure values under the key, the following first-level subkeys of the key are returned: -- first-level subkeys that have a policy setting that configures a value. -- first-level subkeys that have a subkey (at any level) with a policy setting that configures a value. You can use this information to browse for registry-based policy settings. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPRegistryValue</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPRegistryValue cmdlet, the GPO for which to retrieve registry-based policy settings must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a value with the following name: UseDomainNameDevolution. For the default value of a registry key, specify "(default)" or an empty string (""). </maml:para><maml:para>You must also specify the Key parameter with this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for which to retrieve the registry-based policy setting (or settings). For example: "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can specify: -- The Key parameter without the ValueName parameter to retrieve all the registry-based policy settings that configure values directly under that key. -- The Key parameter together with the ValueName parameter to retrieve the registry-based policy setting that configures a specific registry value. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPRegistryValue cmdlet, the GPO for which to retrieve registry-based policy settings must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a value with the following name: UseDomainNameDevolution. For the default value of a registry key, specify "(default)" or an empty string (""). </maml:para><maml:para>You must also specify the Key parameter with this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for which to retrieve the registry-based policy setting (or settings). For example: "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can specify: -- The Key parameter without the ValueName parameter to retrieve all the registry-based policy settings that configure values directly under that key. -- The Key parameter together with the ValueName parameter to retrieve the registry-based policy setting that configures a specific registry value. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPRegistryValue cmdlet, the GPO for which to retrieve registry-based policy settings must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="FullKeyPath"><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for which to retrieve the registry-based policy setting (or settings). For example: "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can specify: -- The Key parameter without the ValueName parameter to retrieve all the registry-based policy settings that configure values directly under that key. -- The Key parameter together with the ValueName parameter to retrieve the registry-based policy setting that configures a specific registry value. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to retrieve the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to retrieve the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a value with the following name: UseDomainNameDevolution. For the default value of a registry key, specify "(default)" or an empty string (""). </maml:para><maml:para>You must also specify the Key parameter with this parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO for which to retrieve registry-based policy settings. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.PolicyRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPRegistryValue returns PolicyRegistrySetting objects that represent registry-based policy settings. These objects can be piped into the following cmdlets: Set-GPRegistryValue Remove-GPRegistryValue </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>The hive of the registry key that you specify (HKLM or HKCU) indicates whether the registry-based policy setting is retrieved from Computer Configuration or User Configuration. </maml:para><maml:para>If the specified registry key cannot be located in policy (the registry key is not configured), a corresponding error message is displayed. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey -ValueName ValueOne KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser PolicyState : Set Value : DataString 1 Type : String ValueName : ValueOne HasValue : True </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves the registry-based policy setting that configures the registry value "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser PolicyState : Set Value : DataString 1 Type : String ValueName : ValueOne HasValue : True KeyPath : Software\Policies\Microsoft\ExampleKey FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey Hive : CurrentUser PolicyState : Delete Value : Type : String ValueName : ValueTwo HasValue : True KeyPath : Software\Policies\Microsoft\ExampleKey\Subkey1 FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\Subkey1 Hive : CurrentUser KeyPath : Software\Policies\Microsoft\ExampleKey\SubKey2 FullKeyPath : HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey\SubKey2 Hive : CurrentUser </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command retrieves all the registry-based policy settings that configure registry values under the key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" from User Configuration in the "TestGPO" GPO. Subkeys (of this key) that have registry-based policy settings, are also returned. The second registry-based policy setting (ValueTwo) is disabled (its PolicyState property is set to Delete). </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287719</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPResultantSetOfPolicy</command:name><maml:description><maml:para>Outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPResultantSetOfPolicy</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-GPResultantSetofPolicy cmdlet outputs the Resultant Set of Policy (RSoP) information for a user, a computer, or both to a file. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPResultantSetOfPolicy</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Computer</maml:name><maml:description><maml:para>Specifies the name of the computer for which to generate the report. You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. -- NetBIOS domain name\computer name; for example, sales\computer-01. -- Computer name (host name): for example, computer-01. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>User</maml:name><maml:description><maml:para>Specifies the user name of the user for which to generate the report. You can specify the user name in one of the following formats: -- Fully qualified domain name (FQDN)\user name; for example, sales.contoso.com\someuser. -- NetBIOS domain name\user name; for example, sales\someuser. -- User name: for example, someuser. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpRsopReport.xml. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "filepath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the RSoP report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Computer</maml:name><maml:description><maml:para>Specifies the name of the computer for which to generate the report. You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. -- NetBIOS domain name\computer name; for example, sales\computer-01. -- Computer name (host name): for example, computer-01. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the report file; for example, c:\Reports\GpRsopReport.xml. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "filepath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ReportType</maml:name><maml:description><maml:para>Specifies the format of the RSoP report. You must specify either Html (for HTML format) or Xml (for XML format). These values are not case sensitive. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">ReportType</command:parameterValue><dev:type><maml:name>ReportType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>User</maml:name><maml:description><maml:para>Specifies the user name of the user for which to generate the report. You can specify the user name in one of the following formats: -- Fully qualified domain name (FQDN)\user name; for example, sales.contoso.com\someuser. -- NetBIOS domain name\user name; for example, sales\someuser. -- User name: for example, someuser. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet does not take any object as input. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.GPRsop</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPResultantSetOfPolicy returns an RSoP object. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>The Get-GPResultantSetofPolicy cmdlet provides only the logging results for a specified computer and user. You must use the GPMC to generate RSoP modeling information. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>get-gpresultantsetofpolicy -reporttype xml -path c:\reports\LocalUserAndComputerReport.xml RsopMode : Logging Namespace : \\COMPUTER-02-PC\Root\Rsop\NS2BBE3F29_794F_4EAE_B9DB_0A2310622534 LoggingComputer : COMPUTER-02 LoggingUser : CONTOSO\someuser LoggingMode : UserAndComputer </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report for the user (CONTOSO\someuser) that is running the session and the computer (COMPUTER-02) on which the session is running. The report is generated in XML format, and is written to the specified file. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPResultantSetOfPolicy -reporttype xml -computer computer-08.contso.com -path c:\reports\computer-08.xml RsopMode : Logging Namespace : \\computer-08.contoso.com\Root\Rsop\NS643B2E66_8F54_4407_A813_7D47173B0922 LoggingComputer : computer-08.contoso.com LoggingUser : CONTOSO\Administrator LoggingMode : Computer </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report for the specified computer. The computer is specified by its fully qualified domain name (FQDN), computer-08.contoso.com. The report is generated in XML format, and is written to the specified file. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPResultantSetofPolicy -user contoso\someuser -reporttype html -path c:\reports\UserReport.html RsopMode : Logging Namespace : \\COMPUTER-02\Root\Rsop\NS78355E76_C754_41B5_8F5E_B61551837A62 LoggingComputer : COMPUTER-02 LoggingUser : contoso\someuser LoggingMode : User </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report for the specified user (contoso\someuser) in HTML format and saves it to the specified file. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPResultantSetOfPolicy -user someuser -computer contoso.com\computer-08 -reporttype html -path c:\reports\UserAndComputerReport.html RsopMode : Logging Namespace : \\computer-08\Root\Rsop\NS72116C25_6570_4586_9B79_FC4F71372E57 LoggingComputer : contoso.com\computer-08 LoggingUser : someuser LoggingMode : UserAndComputer </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command generates a report for the specified computer (contoso.com\computer-08) and user (someuser) in HTML format and saves it to the specified file. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287720</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-GPStarterGPO</command:name><maml:description><maml:para>Gets one Starter GPO or all Starter GPOs in a domain.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>GPStarterGPO</command:noun><dev:version /></command:details><maml:description><maml:para>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. </maml:para><maml:para>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. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-GPStarterGPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns all the Starter GPOs in the domain. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the Starter GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPStarterGPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns all the Starter GPOs in the domain. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-GPStarterGPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the Starter GPO to retrieve by its display name. </maml:para><maml:para>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. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns all the Starter GPOs in the domain. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Returns all the Starter GPOs in the domain. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Get-GPStarterGPO cmdlet, the Starter GPO must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the Starter GPO to retrieve by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the Starter GPO to retrieve by its display name. </maml:para><maml:para>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. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.StarterGpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A Starter GPO. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.StarterGpo object</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Get-GPStarterGPO returns a Starter GPO object. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User" DisplayName : Windows Vista EC User Id : 8780588e-ef91-442b-bd5f-2d50de7abf76 Owner : BUILTIN\Administrators Created : 9/10/2008 12:18:46 PM Modified : 4/26/2008 3:25:52 PM UserVersion : ComputerVersion : StarterGpoVersion : 0 StarterGpoType : System Author : Microsoft Description : This Starter GPO contains the user Group Policy settings recommended for the Enterprise Client (EC) environment described in the Windows Vista security guide. For more information about each of these settings, see the Windows Vista Security Guide (http://go. microsoft.com/fwlink/?LinkID=121852). </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command gets the "Windows Vista EC User" Starter GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPStarterGPO -Name "Windows Vista EC User" | New-GPO -Name TestGPO-Comment "Create a GPO by using a Starter GPO" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins GpoId : f2828b5c-363a-41f6-afb1-5fa111df715f GpoStatus : AllSettingsEnabled Description : Create a GPO by using a Starter GPO CreatedTime : 2/5/2009 6:46:04 PM LastModified : 2/5/2009 6:46:04 PM UserVersion : AD Version: 1, SysVol Version: 1 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>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. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287721</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPStarterGPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Import-GPO</command:name><maml:description><maml:para>Imports the Group Policy settings from a backed-up GPO into a specified GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Import</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Import-GPO cmdlet imports the settings from a GPO backup into a specified target GPO. The target GPO can be in a different domain or forest than that from which the backup was made and it does not have to exist prior to the operation. </maml:para><maml:para>Use the Path parameter to specify the location of the backup and then use the BackupGpoName parameter to specify the GPO name of the backup to use, or the BackupId parameter to specify the backup ID (GUID) of the backup to use. </maml:para><maml:para>Note that if you specify a GPO name, the cmdlet imports the most recent backup. To import an earlier version of a GPO backup, you must use the BackupID parameter to specify the unique backup ID for the particular version. This is the GUID that uniquely identifies the backup within its backup directory. </maml:para><maml:para>Use the TargetName parameter or the TargetGuid parameter to specify the target GPO into which the settings should be imported. Use the optional MigrationTable parameter to map security principals and UNC paths across domains. Use the CreateIfNeeded parameter to create a new GPO if the specified target GPO does not exist. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Import-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CreateIfNeeded</maml:name><maml:description><maml:para>Specifies that a new GPO is created from the backup if the specified target GPO does not exist. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Import-GPO cmdlet, this is the domain into which you want to import the GPO. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the path to a migration table file. You can use a migration table to map security principals and UNC paths across domains. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetGuid</maml:name><maml:description><maml:para>Specifies the GUID of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>BackupId</maml:name><maml:description><maml:para>Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. </maml:para><maml:para>Note: The backup ID is different from the ID of the GPO that was backed up. </maml:para><maml:para>You can also refer to the BackupId parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="backuplocation"><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in aliases: "backuplocation" or "backupdirectory". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Import-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CreateIfNeeded</maml:name><maml:description><maml:para>Specifies that a new GPO is created from the backup if the specified target GPO does not exist. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Import-GPO cmdlet, this is the domain into which you want to import the GPO. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the path to a migration table file. You can use a migration table to map security principals and UNC paths across domains. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetGuid</maml:name><maml:description><maml:para>Specifies the GUID of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="displayname"><maml:name>BackupGpoName</maml:name><maml:description><maml:para>Specifies the display name of the backed-up GPO from which to import the settings. The most recent backup of the GPO is used. You can use the BackupId parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. </maml:para><maml:para>You can also refer to the BackupGpoName parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="backuplocation"><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in aliases: "backuplocation" or "backupdirectory". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="named" aliases="displayname"><maml:name>BackupGpoName</maml:name><maml:description><maml:para>Specifies the display name of the backed-up GPO from which to import the settings. The most recent backup of the GPO is used. You can use the BackupId parameter to specify a particular version to use when multiple backups of the same GPO exist in the backup directory. </maml:para><maml:para>You can also refer to the BackupGpoName parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>BackupId</maml:name><maml:description><maml:para>Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. </maml:para><maml:para>Note: The backup ID is different from the ID of the GPO that was backed up. </maml:para><maml:para>You can also refer to the BackupId parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>CreateIfNeeded</maml:name><maml:description><maml:para>Specifies that a new GPO is created from the backup if the specified target GPO does not exist. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="domainname"><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Import-GPO cmdlet, this is the domain into which you want to import the GPO. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>MigrationTable</maml:name><maml:description><maml:para>Specifies the path to a migration table file. You can use a migration table to map security principals and UNC paths across domains. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="backuplocation"><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in aliases: "backuplocation" or "backupdirectory". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetGuid</maml:name><maml:description><maml:para>Specifies the GUID of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the display name of the GPO into which the settings are to be imported. Use the CreateIfNeeded switch to force the GPO to be created if it does not already exist in the domain. </maml:para><maml:para>You must specify either the TargetGuid parameter or the TargetName parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.GpoBackup</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>An object that represents a GPO backup on the file system. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Import-GPO returns an object that represents the GPO after the settings have been imported. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Import-GPO to copy settings from a GPO backup in one domain to the same domain or another domain in the same or different forest. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>import-gpo -BackupGpoName TestGPO -TargetName TestGPO -path c:\backups DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb GpoStatus : AllSettingsEnabled Description : CreationTime : 3/3/2009 1:03:28 PM ModificationTime : 3/6/2009 5:03:29 PM UserVersion : AD Version: 9, SysVol Version: 9 ComputerVersion : AD Version: 5, SysVol Version: 5 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command imports the settings from the most recent backup of the GPO named TestGPO in the c:\backups directory into a GPO of the same name in the current domain. If a GPO named TestGPO does not exist in the current domain, the command fails because the CreateIfNeeded parameter is not specified. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>import-gpo -BackupId A491D730-F3ED-464C-B8C9-F50562C536AA -TargetName TestGPO -path c:\backups -CreateIfNeeded DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb GpoStatus : AllSettingsEnabled Description : CreationTime : 3/3/2009 1:03:28 PM ModificationTime : 3/6/2009 5:11:49 PM UserVersion : AD Version: 10, SysVol Version: 10 ComputerVersion : AD Version: 6, SysVol Version: 6 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command imports the settings from the specified backup in the c:\backups directory into a GPO that is named TestGPO in the current domain. The BackupId parameter is used to specify the GUID of the GPO backup to use. Because the CreateIfNeeded parameter is specified, if a GPO named TestGPO does not exist in the current domain, one is created before the settings are imported. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Import-GPO -BackupGpoName TestGPO -Path D:\Backups -TargetName NewTestGPO -MigrationTable D:\Tables\Migtable1.migtable -CreateIfNeeded DisplayName : NewTestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 87d38d82-cc2d-4bf7-ad9f-4083a60316eb GpoStatus : AllSettingsEnabled Description : CreationTime : 3/3/2009 1:03:28 PM ModificationTime : 3/6/2009 5:11:49 PM UserVersion : AD Version: 1, SysVol Version: 1 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command imports the settings from the most recent backup of the GPO named TestGPO from the d:\backups directory to a GPO named NewTestGPO in the current domain. The specified migration table is used to migrate security principals and UNC paths to the new GPO. Because the CreateIfNeeded parameter is specified, the GPO is created if it does not already exist. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287722</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Backup-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Restore-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Invoke-GPUpdate</command:name><maml:description><maml:para>Schedule a remote Group Policy refresh (gpupdate) on the specified computer.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Invoke</command:verb><command:noun>GPUpdate</command:noun><dev:version /></command:details><maml:description><maml:para>The Invoke-GPUpdate cmdlet refreshes Group Policy settings, including security settings that are set on remote computers by scheduling the running of the Gpupdate command on a remote computer. You can combine this cmdlet in a scripted fashion to schedule the Gpupdate command on a group of computers. </maml:para><maml:para>The refresh can be scheduled to immediately start a refresh of policy settings or wait for a specified period of time, up to a maximum of 31 days. To avoid putting a load on the network, the refresh times will be offset by a random delay.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Invoke-GPUpdate</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Computer</maml:name><maml:description><maml:para>Specifies the name of the computer for which to schedule a Group Policy refresh. You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. -- NetBIOS domain name\computer name; for example, sales\computer-01. -- Computer name (host name): for example, computer-01. </maml:para><maml:para>If the computer name is not specified the computer, on which the Invoke-GPUpdate cmdlet was run, will have the Group Policy settings refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>RandomDelayInMinutes</maml:name><maml:description><maml:para>Specifies the delay, in minutes that Task Scheduler will wait, with a random factor added to lower the network load, before running a scheduled Group Policy refresh. </maml:para><maml:para>You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): -- A value of 0 will cause the Group Policy refresh to run as soon as the gpupdate task has been scheduled. —A value in the range of 1 to the maximum value of 44640 minutes cause the Group Policy refresh to delay the specified number of minutes plus a random offset before starting the Group Policy refresh. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Boot</maml:name><maml:description><maml:para>Causes a computer restart after the Group Policy settings are applied. This is required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a background update cycle, but do process Group Policy at computer startup, for example, per-computer Software Installation policy settings. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a restart.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Reapplies all policy settings. By default, Group Policy is only refreshed when policy settings have changed.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LogOff</maml:name><maml:description><maml:para>Causes a logoff after the policy settings have been updated. This is required for those Group Policy client-side extensions (CSEs) that do not process Group Policy on a background update cycle but do process Group Policy when a user logs on. Examples include per-user Software Installation policy settings and the Folder Redirection extension. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a logoff.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies that only user or computer policy settings are refreshed. By default, both user and computer policy settings are refreshed. You can specify one of two allowable values for this parameter: -- User -- Computer </maml:para><maml:para>If the target parameter is not specified both user and computer policy settings will be refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Invoke-GPUpdate</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Computer</maml:name><maml:description><maml:para>Specifies the name of the computer for which to schedule a Group Policy refresh. You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. -- NetBIOS domain name\computer name; for example, sales\computer-01. -- Computer name (host name): for example, computer-01. </maml:para><maml:para>If the computer name is not specified the computer, on which the Invoke-GPUpdate cmdlet was run, will have the Group Policy settings refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>RandomDelayInMinutes</maml:name><maml:description><maml:para>Specifies the delay, in minutes that Task Scheduler will wait, with a random factor added to lower the network load, before running a scheduled Group Policy refresh. </maml:para><maml:para>You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): -- A value of 0 will cause the Group Policy refresh to run as soon as the gpupdate task has been scheduled. —A value in the range of 1 to the maximum value of 44640 minutes cause the Group Policy refresh to delay the specified number of minutes plus a random offset before starting the Group Policy refresh. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Boot</maml:name><maml:description><maml:para>Causes a computer restart after the Group Policy settings are applied. This is required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a background update cycle, but do process Group Policy at computer startup, for example, per-computer Software Installation policy settings. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a restart.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LogOff</maml:name><maml:description><maml:para>Causes a logoff after the policy settings have been updated. This is required for those Group Policy client-side extensions (CSEs) that do not process Group Policy on a background update cycle but do process Group Policy when a user logs on. Examples include per-user Software Installation policy settings and the Folder Redirection extension. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a logoff.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Sync</maml:name><maml:description><maml:para>Causes the next foreground Group Policy application to be done synchronously. Foreground Group Policy applications occur at computer startup and user logon. You can specify this for the user, computer or both using the Target parameter. </maml:para><maml:para>On a client computer, by default, Group Policy processes synchronously at computer startup and asynchronously at user logon. </maml:para><maml:para>On a server, by default Group Policy processes synchronously at computer startup and at user logon.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies that only user or computer policy settings are refreshed. By default, both user and computer policy settings are refreshed. You can specify one of two allowable values for this parameter: -- User -- Computer </maml:para><maml:para>If the target parameter is not specified both user and computer policy settings will be refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Boot</maml:name><maml:description><maml:para>Causes a computer restart after the Group Policy settings are applied. This is required for those Group Policy client side extensions (CSEs) that do not process Group Policy on a background update cycle, but do process Group Policy at computer startup, for example, per-computer Software Installation policy settings. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a restart.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Computer</maml:name><maml:description><maml:para>Specifies the name of the computer for which to schedule a Group Policy refresh. You can specify the computer name in one of the following formats: -- Full computer name (FQDN computer name); for example, computer-01.sales.contoso.com. -- Fully qualified domain name (FQDN)\computer name; for example, sales.contoso.com\computer-01. -- NetBIOS domain name\computer name; for example, sales\computer-01. -- Computer name (host name): for example, computer-01. </maml:para><maml:para>If the computer name is not specified the computer, on which the Invoke-GPUpdate cmdlet was run, will have the Group Policy settings refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Force</maml:name><maml:description><maml:para>Reapplies all policy settings. By default, Group Policy is only refreshed when policy settings have changed.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LogOff</maml:name><maml:description><maml:para>Causes a logoff after the policy settings have been updated. This is required for those Group Policy client-side extensions (CSEs) that do not process Group Policy on a background update cycle but do process Group Policy when a user logs on. Examples include per-user Software Installation policy settings and the Folder Redirection extension. </maml:para><maml:para>This parameter has no effect if there are no CSEs called that require a logoff.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="2" aliases=""><maml:name>RandomDelayInMinutes</maml:name><maml:description><maml:para>Specifies the delay, in minutes that Task Scheduler will wait, with a random factor added to lower the network load, before running a scheduled Group Policy refresh. </maml:para><maml:para>You can specify a delay in from 0 minutes to a maximum of 44640 minutes (31 days): -- A value of 0 will cause the Group Policy refresh to run as soon as the gpupdate task has been scheduled. —A value in the range of 1 to the maximum value of 44640 minutes cause the Group Policy refresh to delay the specified number of minutes plus a random offset before starting the Group Policy refresh. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Sync</maml:name><maml:description><maml:para>Causes the next foreground Group Policy application to be done synchronously. Foreground Group Policy applications occur at computer startup and user logon. You can specify this for the user, computer or both using the Target parameter. </maml:para><maml:para>On a client computer, by default, Group Policy processes synchronously at computer startup and asynchronously at user logon. </maml:para><maml:para>On a server, by default Group Policy processes synchronously at computer startup and at user logon.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies that only user or computer policy settings are refreshed. By default, both user and computer policy settings are refreshed. You can specify one of two allowable values for this parameter: -- User -- Computer </maml:para><maml:para>If the target parameter is not specified both user and computer policy settings will be refreshed.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet does not take any object as input.</maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Invoke-GPUpdate does not return an object.</maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>The Invoke-GPUpdate cmdlet does not support scheduling a Group Policy refresh for computers running Windows XP or earlier. </maml:para></maml:alert><maml:alert><maml:para>In order to successfully schedule a Group Policy refresh for computers using the Invoke-GPUpdate cmdlet, the following Firewall rules must be set on each client computer to allow the following connections: </maml:para><maml:para>--Remote Scheduled Tasks Management (RPC) </maml:para><maml:para>--Remote Scheduled Tasks Management (RPC-ERMAP) </maml:para><maml:para>--Windows Management Instrumentation (WMI-IN) </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Invoke-GPUpdate </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command schedules a Group Policy refresh on the computer on which you are running the Invoke-GPUpdate cmdlet. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Invoke-GPUpdate -computer COMPUTER-02 -Target user -Sync </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command schedules a Group Policy refresh on a remote computer (CONTOSO\COMPUTER-02) which will only schedule to update the user policy settings in synchronous mode. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287723</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>New-GPLink</command:name><maml:description><maml:para>Links a GPO to a site, domain, or organizational unit (OU).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>New</command:verb><command:noun>GPLink</command:noun><dev:version /></command:details><maml:description><maml:para>The New-GPLink cmdlet links a GPO to a site, domain, or OU. By default, the link is enabled, which means that the settings of the GPO are applied at the level of the target Active Directory container (site, domain, or OU) according to the rules of inheritance and precedence when Group Policy is processed. </maml:para><maml:para>You can specify the GPO by either its display name or its GUID; or the GPO can be piped into the cmdlet. You specify the site, domain, or OU to link to by its LDAP distinguished name. You can use other parameters to specify whether the link is enabled, whether the link is enforced, and the order in which it is applied at the site, domain, or OU. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>New-GPLink</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the New-GPLink cmdlet: -- The GPO to link from must exist in this domain. -- The Active Directory container to link to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. You can change the link order of a GPO link with the Set-GPLink cmdlet. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO in the domain. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>New-GPLink</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the New-GPLink cmdlet: -- The GPO to link from must exist in this domain. -- The Active Directory container to link to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. You can change the link order of a GPO link with the Set-GPLink cmdlet. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the New-GPLink cmdlet: -- The GPO to link from must exist in this domain. -- The Active Directory container to link to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue><dev:type><maml:name>EnforceLink</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO in the domain. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue><dev:type><maml:name>EnableLink</maml:name><maml:uri /></dev:type><dev:defaultValue>disabled</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. You can change the link order of a GPO link with the Set-GPLink cmdlet. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU to which to link the GPO. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO to be linked to an Active Directory container. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.GpoLink</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>New-GPLink returns an object that represents the link between the GPO and the site, domain, or OU. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>To link a GPO to a site, domain, or OU, you must have Link GPOs permission on that site, domain, or OU. By default, only domain administrators and enterprise administrators have this privilege for domains and OUs. Enterprise administrators and domain administrators of the forest root domain have this privilege for sites. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>New-GPO -Name "MyGPO" | New-GPLink -target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : MyGPO Enabled : True Enforced : False Target : OU=MyOU,DC=contoso,DC=com Order : 1 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates the "MyGPO" GPO in the domain of the user (or, for a startup or shutdown script, the computer) and links it to the "MyOU" organizational unit in the contoso.com domain. If the domain of the user (or the computer) is different than contoso.com, a trust relationship must exist between the two domains. </maml:para><maml:para>Because New-GPLink can take a GPO as input, you can insert any command that returns a GPO between New-GPO and New-GPLink to configure the GPO. For example, you can insert Set-GPPermissions commands to set permissions on the GPO, Set-GPRegistryValue commands to configure one or more registry-based policy settings for the GPO, or Set-GPPrefRegistryValue commands to configure one or more Registry preference items for the GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>new-gplink -name testgpo -target "dc=contoso,dc=com" GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True Enforced : False Target : DC=contoso,DC=com Order : 2 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command links the "TestGPO" GPO in the domain of the user (or, for a startup or shutdown script, the computer) to the contoso.com domain. If the domain of the user (or the computer) is different than contoso.com, a trust relationship must exist between the two domains. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>new-gplink -name testgpo -target "test-site" -enforced yes GpoId : d5a3b4e7-e37a-4070-846c-568689eaa838 DisplayName : TestGPO Enabled : True Enforced : True Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com Order : 1 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command links the "TestGPO" GPO to the "test-site" site and sets the link to enforced. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287724</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPLink</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPLink</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>New-GPO</command:name><maml:description><maml:para>Creates a new GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>New</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The New-GPO cmdlet creates a new GPO with a specified name. By default, the newly created GPO is not linked to a site, domain, or organizational unit (OU). </maml:para><maml:para>You can use this cmdlet to create a GPO that is based on a starter GPO by specifying the GUID or the display name of the Starter GPO, or by piping a StarterGpo object into the cmdlet. </maml:para><maml:para>The cmdlet returns a GPO object, which represents the newly created GPO, that you can pipe to other Group Policy cmdlets. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>New-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Assigns a display name to the new GPO. </maml:para><maml:para>If another GPO with the same display name exists in the domain an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the new GPO. The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. </maml:para><maml:para>Use the comment to document the GPO and its implementation in your environment. Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>For the New-GPO cmdlet: -- The new GPO is created in this domain. -- If a Starter GPO is specified, it must exist in this domain. </maml:para><maml:para>If you do not specify the Domain parameter, then the domain of the user 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. </maml:para><maml:para>If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user (or computer). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>New-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Assigns a display name to the new GPO. </maml:para><maml:para>If another GPO with the same display name exists in the domain an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the new GPO. The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. </maml:para><maml:para>Use the comment to document the GPO and its implementation in your environment. Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>For the New-GPO cmdlet: -- The new GPO is created in this domain. -- If a Starter GPO is specified, it must exist in this domain. </maml:para><maml:para>If you do not specify the Domain parameter, then the domain of the user 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. </maml:para><maml:para>If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user (or computer). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StarterGpoName</maml:name><maml:description><maml:para>Specifies a Starter GPO by its display name. The name can contain 255 characters. If the name includes blank characters, enclose the name in double-quotation marks or single-quotation marks. If a Starter GPO is specified, the GPO is created with its settings. </maml:para><maml:para>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 StarterGpoGuid parameter to uniquely identify a Starter GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>New-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Assigns a display name to the new GPO. </maml:para><maml:para>If another GPO with the same display name exists in the domain an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the new GPO. The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. </maml:para><maml:para>Use the comment to document the GPO and its implementation in your environment. Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>For the New-GPO cmdlet: -- The new GPO is created in this domain. -- If a Starter GPO is specified, it must exist in this domain. </maml:para><maml:para>If you do not specify the Domain parameter, then the domain of the user 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. </maml:para><maml:para>If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user (or computer). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>StarterGpoGuid</maml:name><maml:description><maml:para>Specifies a Starter GPO by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. If a Starter GPO is specified, the GPO is created with its settings. </maml:para><maml:para>You can also refer to the StarterGpoGuid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>Includes a comment for the new GPO. The comment string must be enclosed in double- or single-quotation marks and can contain 2,047 characters. </maml:para><maml:para>Use the comment to document the GPO and its implementation in your environment. Or, if you insert keywords in the comment, you can use the keyword filter to find GPOs that have matching keywords. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>For the New-GPO cmdlet: -- The new GPO is created in this domain. -- If a Starter GPO is specified, it must exist in this domain. </maml:para><maml:para>If you do not specify the Domain parameter, then the domain of the user 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. </maml:para><maml:para>If you specify a domain that is different from the domain of the user running the current session (or the computer for a startup or shutdown script), then a trust must exist between that domain and the domain of the user (or computer). </maml:para><maml:para>You can also refer to Domain by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>Current domain</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Assigns a display name to the new GPO. </maml:para><maml:para>If another GPO with the same display name exists in the domain an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>StarterGpoGuid</maml:name><maml:description><maml:para>Specifies a Starter GPO by its globally unique identifier (GUID). The GUID uniquely identifies the Starter GPO. If a Starter GPO is specified, the GPO is created with its settings. </maml:para><maml:para>You can also refer to the StarterGpoGuid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>StarterGpoName</maml:name><maml:description><maml:para>Specifies a Starter GPO by its display name. The name can contain 255 characters. If the name includes blank characters, enclose the name in double-quotation marks or single-quotation marks. If a Starter GPO is specified, the GPO is created with its settings. </maml:para><maml:para>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 StarterGpoGuid parameter to uniquely identify a Starter GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.StarterGpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A Starter GPO that has predefined settings. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>New-GPO returns the GPO that was created. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>Only domain administrators, enterprise administrators, and members of the Group Policy creator owners group can create GPOs. These users must run Windows PowerShell in an elevated state. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>New-GPO -Name TestGPO -comment "This is a test GPO." DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : b8c1f2c2-fbd3-4a1f-94e1-3e156a65a29a GpoStatus : AllSettingsEnabled Description : This is a test GPO. CreationTime : 3/2/2009 3:37:23 AM ModificationTime : 3/2/2009 3:37:22 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates a GPO in the domain of the user. The GPO is created with the specified comment. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>New-GPO -Name FromStarterGPO -StarterGPOName "Windows Vista EC Computer Starter GPO" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates a GPO in the domain of the user. The GPO is pre-populated with the settings of the Starter GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>new-gpo -name TestGPO | new-gplink -target "ou=marketing,dc=contoso,dc=com" | set-gppermissions -permissionlevel gpoedit -targetname "Marketing Admins" -targettype group DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : b8c1f2c2-fbd3-4a1f-94e1-3e156a65a29a GpoStatus : AllSettingsEnabled Description : CreationTime : 3/2/2009 3:37:23 AM ModificationTime : 3/2/2009 3:37:22 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates a new GPO ("TestGPO"), links it to the "Marketing" OU in the contoso.com domain, and grants the "Marketing Admins" security group permissions to edit the GPO. </maml:para><maml:para>A GPO object is returned by the command, so you could continue to configure the new GPO by piping the output to other cmdlets. For example, you could set Registry preference items or registry-based policy settings by piping the output to Set-GPPrefRegistryValue or to Set-GPRegistryValue. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287725</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>New-GPStarterGPO</command:name><maml:description><maml:para>Creates a new Starter GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>New</command:verb><command:noun>GPStarterGPO</command:noun><dev:version /></command:details><maml:description><maml:para>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. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>New-GPStarterGPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the display name for the new Starter GPO. </maml:para><maml:para>If another Starter GPO with the same display name exists in the domain, an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>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. </maml:para><maml:para>If you do not specify the Domain parameter, the domain of the user that is running the current session is used. </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator will be contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Comment</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>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. </maml:para><maml:para>If you do not specify the Domain parameter, the domain of the user that is running the current session is used. </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the display name for the new Starter GPO. </maml:para><maml:para>If another Starter GPO with the same display name exists in the domain, an error occurs. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>NewGPO</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.SalesDomain.Contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator will be contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet does not accept any input. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.StarterGpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>New-StarterGPO returns the Starter GPO that was created. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>New-GPStarterGPO -Name StarterSecurity -Comment "Security Template" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates a Starter GPO with the display name StarterSecurity. The Starter GPO is annotated with the specified comment. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287726</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPStarterGPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Remove-GPLink</command:name><maml:description><maml:para>Removes a GPO link from a site, domain or OU.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Remove</command:verb><command:noun>GPLink</command:noun><dev:version /></command:details><maml:description><maml:para>The Remove-GPLink cmdlet deletes the link between a GPO and a specified site, domain, or OU. This cmdlet does not delete the actual GPO or any other links between the specified GPO and other sites, domains, or OUs. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Remove-GPLink</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPLink cmdlet: -- The GPO that is linked must exist in this domain. -- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to remove the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in aliases, "id" and "gpoid". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU from which to remove the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Remove-GPLink</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to remove the link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPLink cmdlet: -- The GPO that is linked must exist in this domain. -- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU from which to remove the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPLink cmdlet: -- The GPO that is linked must exist in this domain. -- The Active Directory container (site, domain, or OU) that is linked must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to remove the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in aliases, "id" and "gpoid". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to remove the link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU from which to remove the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.GpoLink</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>An object that represents the link between a GPO and a site, domain, or OU. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Remove-GPLink returns the GPO for which the link has been removed. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPLink -Name "MyGPO" -Target "ou=MyOU,dc=contoso,dc=com" DisplayName : MyGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/26/2009 11:28:08 PM ModificationTime : 3/5/2009 3:36:34 PM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes the link between the "MyGPO" GPO and the "MyOU" organizational unit in the contoso.com domain. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPLink -Name "MyGPO" -Target "Default-First-Site-Name" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes the link between the "MyGPO" GPO and the default site. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>(Get-GPInheritance -Target "ou=myou,dc=contoso,dc=com").GpoLinks | Rem ove-GPLink DisplayName : TestGPO-3 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : d02126d4-82e8-4e87-b4a0-2d44b6891411 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/27/2009 2:59:51 PM ModificationTime : 3/5/2009 3:36:37 PM UserVersion : AD Version: 13, SysVol Version: 13 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : DisplayName : TestGPO-2 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 375865b2-3b5f-480f-8f56-2a994ea6e725 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/26/2009 11:28:08 PM ModificationTime : 3/5/2009 3:36:34 PM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes the links for all the GPOs that are linked to the "MyOU" organizational unit in the contoso.com domain. </maml:para><maml:para>Get-GPInheritance is used to get a Microsoft.GroupPolicy.Som object for the OU. The GpoLinks property of the SOM object contains all the GPO links for GPOs that are linked to the OU (links that are inherited from higher-level containers are not included). This collection is piped into Remove-GPLink. The GPOs for which links have been removed are returned. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287727</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPLink</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPLink</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Remove-GPO</command:name><maml:description><maml:para>Deletes a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Remove</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Remove-GPO cmdlet removes the GPO container and data from the directory service and the system volume folder (SysVol). </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Remove-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>If you do not specify the Domain parameter, the domain of the computer that you are logged on to is used. </maml:para><maml:para>If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>KeepLinks</maml:name><maml:description><maml:para>Preserves the links to the GPO in the specified domain (including OUs) and all sites when the GPO is removed. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to delete by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Remove-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to delete by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>If you do not specify the Domain parameter, the domain of the computer that you are logged on to is used. </maml:para><maml:para>If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>KeepLinks</maml:name><maml:description><maml:para>Preserves the links to the GPO in the specified domain (including OUs) and all sites when the GPO is removed. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com). </maml:para><maml:para>If you do not specify the Domain parameter, the domain of the computer that you are logged on to is used. </maml:para><maml:para>If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to delete by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>KeepLinks</maml:name><maml:description><maml:para>Preserves the links to the GPO in the specified domain (including OUs) and all sites when the GPO is removed. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to delete by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO to be deleted. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet does not output any objects. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>When you delete a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To delete a link to a GPO, you must have permission to link Group Policy Objects for the organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but the link remains. Links from other domains and sites are not deleted. The link to a deleted GPO appears in the GPMC as Not Found. To delete Not Found links, you must either have permission on the site, domain, or organizational unit containing the link, or ask someone with sufficient rights to delete it. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPO -guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain contoso.com -KeepLinks </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>Removes the GPO that has the GUID 50cc3e45-0b14-46dd-8b4d-afa012bc331c from the contoso.com domain. Because the KeepLinks parameter is specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are preserved. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPO -Name TestGPO </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>Removes the "TestGPO" GPO from the domain of the user that is running the session (or, for startup and shutdown scripts, the domain of the computer). Because the KeepLinks parameter is not specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are deleted. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287728</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Remove-GPPrefRegistryValue</command:name><maml:description><maml:para>Removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Remove</command:verb><command:noun>GPPrefRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>The Remove-GPPrefRegistryValue cmdlet removes one or more Registry preference items from either Computer Configuration or User Configuration in a GPO. You must specify the Context parameter (User or Computer) to indicate whether to remove the Registry preference item from Computer Configuration or User Configuration. . You can specify the GPO by its display name or by its GUID. </maml:para><maml:para>You can specify either a key or a value: --If you specify a key, all Registry preference items that configure that registry key or any of its (first-level) values are removed from the specified configuration in the GPO. Registry preference items that configure subkeys of that key (or their values) are not affected. For a key, specify the Key parameter without the ValueName parameter. --If you specify a value, all Registry preference items that configure that registry value are removed from the specified configuration in the GPO. For a value, specify the Key parameter without the ValueName parameter. </maml:para><maml:para>This cmdlet can take input from the pipeline: --You can pipe GPO objects to this cmdlet to remove a specified Registry preference item from one or more GPOs. --You can pipe PreferencRegistrySetting objects to this cmdlet to remove one or more Registry preference items from a specified GPO. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Remove-GPPrefRegistryValue</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPPrefRegistryValue cmdlet, the GPO from which to remove the Registry preference item (or items) must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which a Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to remove all Registry preference items. If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item (or items) are removed from Computer Configuration or User Configuration in the specified GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more Registry preference items; for example, "HKCU\Control Panel\Colors". </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are removed. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are removed. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Remove-GPPrefRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPPrefRegistryValue cmdlet, the GPO from which to remove the Registry preference item (or items) must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which a Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to remove all Registry preference items. If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item (or items) are removed from Computer Configuration or User Configuration in the specified GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more Registry preference items; for example, "HKCU\Control Panel\Colors". </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are removed. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are removed. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item (or items) are removed from Computer Configuration or User Configuration in the specified GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue><dev:type><maml:name>GpoConfiguration</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPPrefRegistryValue cmdlet, the GPO from which to remove the Registry preference item (or items) must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more Registry preference items; for example, "HKCU\Control Panel\Colors". </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, all Registry preference items that configure the registry value are removed. --If the ValueName parameter is not specified, all Registry preference items that configure the registry key and any of its (first-level) values are removed. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which a Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="7" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of a registry value for which to remove all Registry preference items. If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet takes a GPO or a PreferenceRegistrySetting object as input. You can pipe in one or more PreferenceRegistrySetting objects (for example, from Get-GPPrefRegistryValue) to remove one or more Registry preference items from a specified GPO. You can pipe in one or more GPO objects (for example, from Get-GPO) to remove a specified Registry preference item from each GPO. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Remove-GPPrefRegistryValue returns the GPO from which the Registry preference item (or items) has been removed. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 92f79f6c-61ce-47d9-8dc6-f78c5cea93ac GpoStatus : AllSettingsEnabled Description : CreationTime : 2/28/2009 5:15:04 PM ModificationTime : 2/28/2009 5:15:32 PM UserVersion : AD Version: 5, SysVol Version: 5 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes all Registry preference items that configure the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration in the "TestGPO" GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context Computer -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 92f79f6c-61ce-47d9-8dc6-f78c5cea93ac GpoStatus : AllSettingsEnabled Description : CreationTime : 2/28/2009 5:15:04 PM ModificationTime : 2/28/2009 5:15:32 PM UserVersion : AD Version: 5, SysVol Version: 5 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes Registry preference items that configure any (first-level) values under the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" or the key itself from Computer Configuration in the "TestGPO" GPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -ErrorAction SilentlyContinue DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : a83ad1da-9fd4-4005-96b1-7e98042d04de GpoStatus : AllSettingsEnabled Description : CreationTime : 2/28/2009 5:21:05 PM ModificationTime : 2/28/2009 5:21:17 PM UserVersion : AD Version: 5, SysVol Version: 5 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : DisplayName : TestGPO-1 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 277eafe8-5dbf-4e3f-86dc-557eee14d0a4 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/28/2009 2:35:24 PM ModificationTime : 2/28/2009 5:21:17 PM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes any Registry preference items that configure the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" from User Configuration for all GPOs in the domain. It returns each GPO from which at least one Registry preference item is removed. </maml:para><maml:para>Note: The Remove-GPPrefRegistryValue returns a non-terminating error for each GPO that does not have a Registry preference item associated with the specified registry value. In this command, these error messages are suppressed by setting the ErrorAction parameter to SilentlyContinue (-ErrorAction SilentlyContinue). For more information about the ErrorAction parameter, see about_CommonParameters. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287729</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Remove-GPRegistryValue</command:name><maml:description><maml:para>Removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Remove</command:verb><command:noun>GPRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>The Remove-GPRegistryValue cmdlet removes one or more registry-based policy settings from either Computer Configuration or User Configuration in a GPO. You can specify the GPO by its display name or by its GUID. </maml:para><maml:para>You can specify either a key or a value: --If you specify a key, registry-based policy settings that configure any of its (first-level) values are removed. However, if there are registry-based policy settings that configure any subkeys or their values, an error occurs and no policy settings are removed (including those for first-level values of the key). For a key, specify the Key parameter without the ValueName parameter. --If you specify a value, the registry-based policy setting that configures that registry value is removed. For a value, specify the Key parameter without the ValueName parameter. </maml:para><maml:para>This cmdlet can take input from the pipeline: --You can pipe GPO objects to this cmdlet to remove a specified registry-based policy setting from one or more GPOs. --You can pipe PolicyRegistrySetting objects to this cmdlet to remove one or more registry-based policy settings from a specified GPO. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Remove-GPRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more registry-based policy settings (for example: HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution). </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, the registry-based policy setting that configures that registry value is removed. --If the ValueName parameter is not specified, all registry-based policy settings that configure any of the (first-level) values of the registry key are removed. If there are registry-based policy settings that configure any subkeys or their values, an error occurs. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of the registry value for which to remove the registry-based policy setting (for example: UseDomainNameDevolution). If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPRegistryValue cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Remove-GPRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more registry-based policy settings (for example: HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution). </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, the registry-based policy setting that configures that registry value is removed. --If the ValueName parameter is not specified, all registry-based policy settings that configure any of the (first-level) values of the registry key are removed. If there are registry-based policy settings that configure any subkeys or their values, an error occurs. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of the registry value for which to remove the registry-based policy setting (for example: UseDomainNameDevolution). If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPRegistryValue cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="4" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Remove-GPRegistryValue cmdlet, the GPO from which to remove the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="1" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="2" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies a registry key for which to remove one or more registry-based policy settings (for example: HKLM\Software\Policies\Microsoft\WindowsNT\DNSClient\UseDomainNameDevolution). </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>The Key parameter can be specified with or without the ValueName parameter: --If the ValueName parameter is specified, the registry-based policy setting that configures that registry value is removed. --If the ValueName parameter is not specified, all registry-based policy settings that configure any of the (first-level) values of the registry key are removed. If there are registry-based policy settings that configure any subkeys or their values, an error occurs. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO from which to remove the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="5" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="3" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the name of the registry value for which to remove the registry-based policy setting (for example: UseDomainNameDevolution). If you specify the ValueName parameter, you must also specify the Key parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PolicyRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO (from which to remove a registry-based policy setting), or a PolicyRegistrySetting object that represents a registry-based policy setting (to remove from a specified GPO). Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Remove-GPRegistryValue returns the GPO from which the registry-based policy setting (or settings) has been removed. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>The hive of the registry key that you specify -- HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU) indicates whether the registry-based policy setting is removed from Computer Configuration or User Configuration. </maml:para><maml:para>If a value for the registry key cannot be located (the registry key is not configured) or if subkeys are present, an error occurs and a corresponding error message is displayed. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName ScreenSaveTimeOut DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 35c12ab3-956c-45d5-973b-46b17d225f47 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/24/2009 4:41:03 PM ModificationTime : 2/25/2009 12:45:52 PM UserVersion : AD Version: 4, SysVol Version: 4 ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes the registry-based policy setting for the registry value "HKEY_CURRENT_USER\Software\Policies\Microsoft\Windows\Control Panel\Desktop ScreenSaveTimeout" from the "TestGPO" GPO. The registry value is no longer modified when the GPO is applied on a client. Removing a policy setting does not delete the registry value on a client. To delete the registry value when the GPO is applied on a client, you must disable the policy setting by using the Set-GPRegistryValue cmdlet. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPRegistryValue -Name TestGPO -Key HKCU\Software\Policies\Microsoft\ExampleKey </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command removes all the registry-based policy settings that configure (first-level) registry values under the key "HKEY_CURRENT_USER\Software\Policies\Microsoft\ExampleKey" from User Configuration in the "TestGPO" GPO. If there are registry-based policy settings in User Configuration that configure registry values for any subkeys of this key, an error occurs and no (first-level) policy settings are removed. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287730</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Set-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Rename-GPO</command:name><maml:description><maml:para>Assigns a new display name to a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Rename</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Rename-GPO cmdlet assigns a different, non-null display name to a GPO. This cmdlet has no effect on the GUID of the GPO. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Rename-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Rename-GPO cmdlet, this is the domain of the GPO that you want to rename. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to rename by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the new display name of the GPO. Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Rename-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to rename by its current display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Rename-GPO cmdlet, this is the domain of the GPO that you want to rename. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the new display name of the GPO. Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Rename-GPO cmdlet, this is the domain of the GPO that you want to rename. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to rename by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to rename by its current display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>Specifies the new display name of the GPO. Because the display name may not be unique, an error is returned if another GPO in the domain has the same display name. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>The GPO to rename. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Rename-GPO returns the GPO (with the new display name). </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>rename-gpo -name sampleGPO -targetname securityGPO DisplayName : securityGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 2c08f9b5-32c3-43fa-af8f-f1939b1ac8a0 GpoStatus : AllSettingsEnabled Description : CreationTime : 3/6/2009 4:20:25 PM ModificationTime : 3/6/2009 4:20:24 PM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command renames the GPO named sampleGPO to securityGPO. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287731</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Copy-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPO</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Restore-GPO</command:name><maml:description><maml:para>Restores one GPO or all GPOs in a domain from one or more GPO backup files.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Restore</command:verb><command:noun>GPO</command:noun><dev:version /></command:details><maml:description><maml:para>The Restore-GPO cmdlet restores a GPO backup to the original domain from which it was saved. If the original domain is not available, or if the GPO no longer exists in the domain, the cmdlet fails. </maml:para><maml:para>You can: -- Use the Guid parameter or the Name parameter to restore a GPO from its most recent backup. -- Use the All parameter to restore all GPOs in the domain from their most recent backups. -- Use the BackupId parameter to restore a GPO from a specific backup. This parameter enables you to restore a GPO from a backup prior to the most recent one. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Restore-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>BackupId</maml:name><maml:description><maml:para>Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. </maml:para><maml:para>Note: The backup ID is different from the ID of the GPO that was backed up (specified by the Guid parameter). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "backuplocation". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Restore-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Restores all GPOs in the domain that have backups in the backup directory. Each GPO is restored from its most recent backup in the directory. </maml:para></maml:description></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "backuplocation". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Restore-GPO</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to restore by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the BackupId parameter. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "backuplocation". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Restore-GPO</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to restore by its display name. The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the BackupId parameter. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "backuplocation". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Restores all GPOs in the domain that have backups in the backup directory. Each GPO is restored from its most recent backup in the directory. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>BackupId</maml:name><maml:description><maml:para>Specifies the backup ID of a GPO backup. The backup ID is a globally unique identifier (GUID) that uniquely identifies the backup. You can use this parameter to specify a particular version of a backed-up GPO in the backup directory. </maml:para><maml:para>Note: The backup ID is different from the ID of the GPO that was backed up (specified by the Guid parameter). </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Restore-GPO cmdlet, this is the domain in which you want to restore the GPO. This must be the domain from which the GPO was backed up. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO to restore by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the BackupId parameter. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO to restore by its display name. The GPO is restored from its most recent backup in the backup directory. To specify a different backup than the most recent backup, use the BackupId parameter. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Path</maml:name><maml:description><maml:para>Specifies the path to the backup directory. </maml:para><maml:para>You can also refer to the Path parameter by its built-in alias, "backuplocation". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.BackupGpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO backup, a separate file that holds the settings of a GPO that can be imported elsewhere to recreate the GPO. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Restore-GPO returns the restored GPO. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Restore-GPO -Name "TestGPO" -Path \\Server1\Backups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command restores the GPO named TestGpo from the \\Server1\Backups directory. The most recent backup is restored. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Restore-GPO -GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde -Path \\Server1\Backups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command restores the GPO with the GUID fa4a9473-6e2a-4b87-ab78-175e68d97bde from the \\Server1\Backups directory. The most recent backup is restored. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Restore-GPO -All -Domain contoso.com -Path \\Server1\Backups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command restores all of the GPOs in the contoso.com domain previously backed up to \\Server1\Backup. Each GPO is restored using its most recent backup. </maml:para><maml:para>If the domain of user that is running the session (or, for a startup or shutdown script, the domain of the computer) is different from the contoso.com domain, a trust must exist between the two domains or the command fails. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Restore-GPO -BackupId 0fc29b3c-fb83-4076-babb-6194c1b4fc26 -Path \\Server1\Backups </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command restores a GPO from the backup specified by the BackupId parameter. The BackupId parameter can be used to restore a GPO from a backup prior to the most recent backup. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287732</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Backup-GPO</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-GPInheritance</command:name><maml:description><maml:para>Blocks or unblocks inheritance for a specified domain or organizational unit (OU).</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>GPInheritance</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-GPInheritance cmdlet blocks or unblocks inheritance for a specified domain or organizational unit (OU). </maml:para><maml:para>GPOs are applied according to the Group Policy hierarchy in the following order: local GPO, GPOs linked to the site, GPOs linked to the domain, GPOs linked to OUs. By default, an Active Directory container inherits settings from GPOs that are applied at the next higher level in the hierarchy. Blocking inheritance prevents the settings in GPOs that are linked to higher-level sites, domains, or organizational units from being automatically inherited by the specified domain or OU, unless the link (at the higher-level container) for a GPO is enforced. </maml:para><maml:para>You use the Target parameter to specify the LDAP distinguished name of the domain or OU, and use the IsBlocked parameter to specify whether to block or unblock inheritance. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-GPInheritance</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished name. For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". </maml:para><maml:para>You can also refer to the Target parameter by its built-in alias, "path". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPInheritance cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IsBlocked</maml:name><maml:description><maml:para>Specifies whether to block inheritance for the domain or OU. You must specify Yes or No. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">BlockInheritance</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPInheritance cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>IsBlocked</maml:name><maml:description><maml:para>Specifies whether to block inheritance for the domain or OU. You must specify Yes or No. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">BlockInheritance</command:parameterValue><dev:type><maml:name>BlockInheritance</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished name. For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com". </maml:para><maml:para>You can also refer to the Target parameter by its built-in alias, "path". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Som</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>This cmdlet takes an object that represents a domain or an OU as input. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Som</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Set-GPInheritance returns an object that represents the domain or OU after the operation is applied. The properties of this object that are displayed by default describe the Group Policy inheritance information for the domain or OU. The GpoInheritanceBlocked property indicates whether inheritance is blocked. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPinheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes Name : myou ContainerType : OU Path : ou=myou,dc=contoso,dc=com GpoInheritanceBlocked : Yes GpoLinks : {TestGPO-1, TestGPO-2} InheritedGpoLinks : {TestGPO-1, TestGPO-2} </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command blocks inheritance for the "MyOU" OU in the contoso.com domain. GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU are not applied (unless their links are enforced) when Group Policy is processed for the OU on the client. </maml:para><maml:para>Because inheritance is blocked, only GPOs that are linked directly to the "MyOU" OU (and those that are enforced at higher-level containers) appear in the InheritedGpoLinks list. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPinheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command unblocks inheritance for the northwest.contoso.com domain. GPOs linked to higher-level sites or domains are applied to this domain when Group Policy is processed on the client. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPinheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No Name : myou ContainerType : OU Path : ou=myou,dc=contoso,dc=com GpoInheritanceBlocked : No GpoLinks : {TestGPO-1, TestGPO-2} InheritedGpoLinks : {TestGPO-1, TestGPO-2, Default Domain Policy} </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command blocks inheritance for the "MyOU" OU in the contoso.com domain. GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU, are applied when Group Policy is processed for the OU on the client. </maml:para><maml:para>Because inheritance is not blocked, GPOs that are inherited from higher-level containers appear in the InheritedGpoLinks list (together with GPOs that are linked directly to the OU). For example, the "Default Domain Policy" GPO is linked at the domain level. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287733</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPInheritance</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-GPLink</command:name><maml:description><maml:para>Sets the properties of the specified GPO link.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>GPLink</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-GPLink cmdlet sets the properties of a GPO link. </maml:para><maml:para>You can set the following properties: -- Enabled. If the GPO link is enabled, the settings of the GPO are applied when Group Policy is processed for the site, domain or OU. -- Enforced. If the GPO link is enforced, it cannot be blocked at a lower-level (in the Group Policy processing hierarchy) container. -- Order. The order specifies the precedence that the settings of the GPO take over conflicting settings in other GPOs that are linked (and enabled) to the same site, domain, or OU. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-GPLink</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPLink cmdlet: -- The GPO that is linked from must exist in this domain. -- The Active Directory container that is linked to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO of the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU of the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-GPLink</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO of the link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPLink cmdlet: -- The GPO that is linked from must exist in this domain. -- The Active Directory container that is linked to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU of the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPLink cmdlet: -- The GPO that is linked from must exist in this domain. -- The Active Directory container that is linked to must exist in a domain that has a trust relationship with this domain. </maml:para><maml:para>Note: To specify a domain to link to, use the Target parameter. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Enforced</maml:name><maml:description><maml:para>Specifies whether the GPO link is enforced. You can specify Yes or No. By default, GPO links are not enforced. </maml:para><maml:para>By setting the GPO link to enforced, you ensure the following: -- That the settings of the GPO cannot be blocked (by blocking inheritance) at a lower-level Active Directory container. -- That the settings of the GPO always take precedence over conflicting settings in GPOs that are linked to lower-level containers. </maml:para><maml:para>This option should be used sparingly. Casual use of this option complicates troubleshooting. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnforceLink</command:parameterValue><dev:type><maml:name>EnforceLink</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO of the link by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>LinkEnabled</maml:name><maml:description><maml:para>Specifies whether the GPO link is enabled. You can specify Yes or No. </maml:para><maml:para>By default, Group Policy processing is enabled for all GPO links. You can completely block the application of a GPO for a specific site, domain, or OU by disabling the GPO link for that site, domain, or OU. Disabling a GPO link does not disable the GPO itself. If the GPO is linked to other sites, domains, or OUs, Group Policy continues to process the GPO for each link that is enabled. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">EnableLink</command:parameterValue><dev:type><maml:name>EnableLink</maml:name><maml:uri /></dev:type><dev:defaultValue>enabled</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO of the link by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the link order for the GPO link. You can specify a number that is between one and the current number of GPO links to the target site, domain, or OU, plus one. </maml:para><maml:para>The link order specifies the order of precedence with which GPOs linked to the same Active Directory container are applied. When Group Policy is processed, GPOs with a higher link order number are processed before GPOs with a lower link order number. Therefore, when two GPOs contain conflicting settings, the settings in the GPO with the lower link order number, because it is processed last, overwrites those of the GPO with the higher link order number. A lower number indicates higher precedence. </maml:para><maml:para>By default, the GPO link is added at the lowest precedence (with a link order equal to the number of GPO links to the container, plus one). Link order is a dynamic value because the value may change as GPO links are added and deleted from the container. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Target</maml:name><maml:description><maml:para>Specifies the LDAP distinguished name of the site, domain, or OU of the link. For example, for the "MyOU" organizational unit in the contoso.com domain, the LDAP distinguished name is "ou=MyOU,dc=contoso,dc=com". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.GpoLink</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO link between a GPO and a site, domain, or OU. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.GpoLink</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Set-GPLink returns the GPO link after the change has been applied. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPLink -Name TestGPO -Target "ou=MyOU,dc=contoso,dc=com" -LinkEnabled Yes GpoId : c25daa3e-5d05-43b3-87ca-0a237882fd63 DisplayName : Test2GPO Enabled : True Enforced : False Target : OU=MyOU,DC=contoso,DC=com Order : 1 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command enables the link between the "TestGPO" GPO and the MyOU organizational unit in the contoso.com domain. The Enforced and Order properties are not changed. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPLink -Name TestGPO -Domain north.contoso.com -Target "dc=south, dc=contoso, dc=com" -LinkEnabeled Yes -Enforced Yes -Order 1 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command enables the link between the "TestGPO" GPO in the north.contoso.com domain and the south.contoso.com domain. The link is set to enforced, so it cannot be blocked at lower-level containers (for example OUs in the south.contoso.com domain). Because the order is set to 1, the settings of the "testGPO" GPO will be applied with the highest precedence (except for enforced links) when Group policy is processed for the south.contoso.com domain container. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>set-gplink -guid 77c5285d-952e-4559-94ef-a02f5c107799 -target "test-site" -enforced yes GpoId : 77c5285d-952e-4559-94ef-a02f5c107799 DisplayName : TestGPO Enabled : True Enforced : True Target : CN=test-site,cn=Sites,CN=Configuration,DC=contoso,DC=com Order : 1 </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command sets the enforced property of the link between the GPO that has ID 77c5285d-952e-4559-94ef-a02f5c107799 and the test site. Inheritance cannot be blocked for this link at containers that are at lower-levels of the Group Policy hierarchy. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287734</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>New-GPLink</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPLink</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-GPPermission</command:name><maml:description><maml:para>Grants a level of permissions to a security principal for one GPO or all the GPOs in a domain.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>GPPermission</command:noun><dev:version /></command:details><maml:description><maml:para>Grants a level of permissions to a security principal (user, security group, or computer) for one GPO or all the GPOs in a domain. You use the TargetName and TargetType parameters to specify a user, security group, or computer for which to set the permission level. You can use the Name or the Guid parameter to set the permission level for the security principal on a single GPO, or you can use the All parameter to set the permission level for the security principal on all GPOs in the domain. </maml:para><maml:para>By default, if the security principal already has a higher permission level than the specified permission level, the change is not applied. You can specify the Replace parameter, to remove the existing permission level from the GPO before the new permission level is set. This ensures that the existing permission level is replaced by the new permission level. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-GPPermission</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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 Set-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. If you do not specify the DomainName 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Replace</maml:name><maml:description><maml:para>Specifies that the existing permission level for the group or user is removed before the new permission level is set. If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the Replace parameter, no change is made. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to set the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PermissionLevel</maml:name><maml:description><maml:para>Specifies the permission level to set for the security principal. The valid permission levels are: GpoRead, GpoApply, GpoEdit, GpoEditDeleteModifySecurity or None. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GPPermissionType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to set the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to set the permission level. You must specify User, Group, or Computer. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-GPPermission</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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 Set-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. If you do not specify the DomainName 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Replace</maml:name><maml:description><maml:para>Specifies that the existing permission level for the group or user is removed before the new permission level is set. If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the Replace parameter, no change is made. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Specifies that the permission level is set for the specified security principal for all GPOs in the domain. </maml:para></maml:description></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PermissionLevel</maml:name><maml:description><maml:para>Specifies the permission level to set for the security principal. The valid permission levels are: GpoRead, GpoApply, GpoEdit, GpoEditDeleteModifySecurity or None. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GPPermissionType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to set the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to set the permission level. You must specify User, Group, or Computer. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-GPPermission</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to set the permission level by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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 Set-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. If you do not specify the DomainName 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Replace</maml:name><maml:description><maml:para>Specifies that the existing permission level for the group or user is removed before the new permission level is set. If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the Replace parameter, no change is made. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PermissionLevel</maml:name><maml:description><maml:para>Specifies the permission level to set for the security principal. The valid permission levels are: GpoRead, GpoApply, GpoEdit, GpoEditDeleteModifySecurity or None. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GPPermissionType</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to set the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to set the permission level. You must specify User, Group, or Computer. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>All</maml:name><maml:description><maml:para>Specifies that the permission level is set for the specified security principal for all GPOs in the domain. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="domain"><maml:name>DomainName</maml:name><maml:description><maml:para>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 Set-GPPermission cmdlet, the GPO for which to get the permission level must exist in this domain. If you do not specify the DomainName 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).</maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "domain". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases="id"><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO for which to set the permission level by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue, ByPropertyName)" position="1" aliases="displayname"><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO for which to set the permission level by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>PermissionLevel</maml:name><maml:description><maml:para>Specifies the permission level to set for the security principal. The valid permission levels are: GpoRead, GpoApply, GpoEdit, GpoEditDeleteModifySecurity or None. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GPPermissionType</command:parameterValue><dev:type><maml:name>GPPermissionType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Replace</maml:name><maml:description><maml:para>Specifies that the existing permission level for the group or user is removed before the new permission level is set. If a security principal is already granted a permission level that is higher than the specified permission level and you do not use the Replace parameter, no change is made. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="dc"><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetName</maml:name><maml:description><maml:para>The name of the security principal for which to set the permission level. You can specify a user, a security group, or a computer. You can use either the domain-qualified name of the security principal (domain\account) or just its name. </maml:para><maml:para>For example, in the contoso.com domain, to specify: -- The user "someuser", use "contoso\someuser" or "someuser". -- The Domain Admins security group, use "contoso\Domain Admins" or "Domain Admins". -- The computer "computer-01", use "contoso\computer-01" or "computer-01". </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>TargetType</maml:name><maml:description><maml:para>The type of security principal for which to set the permission level. You must specify User, Group, or Computer. </maml:para><maml:para>The following values are permitted for this object type. -- Computer -- User -- Group</maml:para></maml:description><command:parameterValue required="true" variableLength="false">PermissionTrusteeType</command:parameterValue><dev:type><maml:name>PermissionTrusteeType</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>An object that represents a GPO. Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Set-GPPermission returns an object that represents the GPO for which the permission level was set. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the DomainName parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPPermission -Name TestGpo -TargetName "Domain Users" -TargetType Group -PermissionLevel GpoRead </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command sets the permission level for the "Domain Users" security group to GpoRead for the GPO named "TestGpo". Because the Replace parameter is not specified, if the group already has a permission level higher than GpoRead, such as GpoEdit, no action is taken. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPPermission -All -TargetName "Marketing Admins" -TargetType Group -PermissionLevel GpoEdit -Replace </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command sets the permission level for the "Marketing Admins" security group to GpoEdit on all GPOs in the domain. This includes GPOs that are not linked to any site, domain, or OU. Because the Replace parameter is specified, the new permission level overwrites the existing permissions set for the group. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -All | foreach-object { if($_ | Get-GPPermission -TargetName "Marketing Admins" -TargetType Group -ErrorAction SilentlyContinue) {$_ | Set-GPPermission -Replace -PermissionLevel GpoApply -TargetName "Marketing Admins" -TargetType group }} DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 24f217d4-1403-4d43-9247-d17eeedb22f0 GpoStatus : AllSettingsEnabled Description : CreationTime : 3/1/2009 10:51:34 PM ModificationTime : 3/2/2009 12:53:40 AM UserVersion : AD Version: 8, SysVol Version: 8 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : DisplayName : TestGPO-1 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : fe2f7402-101b-4b3c-87e4-85d3f47735cb GpoStatus : AllSettingsEnabled Description : CreationTime : 3/1/2009 7:22:03 PM ModificationTime : 3/2/2009 12:53:54 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 0, SysVol Version: 0 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command replaces the current permission level of the "Marketing Admins" security group with GpoApply for all GPOs on which the group has permissions. The command returns each GPO for which the new permission level is set. </maml:para><maml:para>First, Get-GPO is used to retrieve all the GPOs in the domain (Get-GPO -All). Then, the collection is piped into the foreach-object command. As each GPO is evaluated, it is piped into Get-GPPermissions. If a permission level for the "Marketing Admins" group is returned, the GPO is piped into Set-gppermission to set the permission level for the group. The Replace parameter is specified to make sure that the previous permission level is overwritten. </maml:para><maml:para>Note: The ErrorAction parameter is set to SilentlyContinue for Get-GPPermissions. This is because a non-terminating error occurs if the specified security principal does not have permissions on the GPO. Specifying the ErrorAction as SilentlyContinue prevents the error messages from being printed for GPOS on which the security principal does not have permissions. For more information about the ErrorAction parameter, see about_CommonParameters. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287735</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPPermission</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-GPPrefRegistryValue</command:name><maml:description><maml:para>Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>GPPrefRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>Configures a Registry preference item under either Computer Configuration or User Configuration in a GPO. </maml:para><maml:para>You can configure the Registry preference item for either a registry key or a registry value: -- For a registry key, specify the Key parameter, but do not specify the ValueName, Type, or Value parameters. -- For a registry value, specify the Key parameter together with the ValueName, Type, and Value parameters. (All these parameters must be specified.) </maml:para><maml:para>You must specify the Context parameter (User or Computer) to indicate whether to configure the Registry preference item in Computer Configuration or User Configuration. You must also specify the Action parameter to set the action that should be applied on the client. You can specify the GPO by its display name or its GUID. You can specify the Disable parameter to create a Registry preference item that is disabled. </maml:para><maml:para>Note: This cmdlet configures new Registry preference items. It does not modify existing Registry preference items. </maml:para><maml:para>This cmdlet can take input from the pipeline: --You can pipe GPO objects to this cmdlet to set a specified Registry preference item on one or more GPOs. --You can pipe PreferenceRegistrySetting objects to this cmdlet to set one or more Registry preference items on a specified GPO. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-GPPrefRegistryValue</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>If specified, the Registry preference item is configured as disabled. A disabled Registry preference item is not applied when Group Policy is processed on the client, and, therefore, does not modify any existing registry keys or values on the client. </maml:para><maml:para>This parameter does not disable an existing Registry preference item in the GPO, rather, it creates a new Registry preference item that is disabled. (Any existing Registry preference items that configure the same key or value will still be applied when the GPO is processed on a client.) This behavior is different than disabling an existing Registry preference item using the GPMC. </maml:para><maml:para>You can use the Remove-GPPrefRegistryValue cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPPrefRegistryValue cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. If two Registry preference items in the GPO change the same registry value, the one that has the highest order is the last to modify the value on the client. </maml:para><maml:para>By default, if the Order parameter is not specified, the order is set to one plus the current number of Registry preference items in the GPO. You can specify any value greater than zero. If you specify a value larger than the default value, the order is set to the default. </maml:para><maml:para>The order of a setting can change as Registry preference items are added or removed from the GPO. For example, if the GPO has five Registry preference items, and you add another one and specify an order of 4, the Registry preference items that previously were at order 4 and 5, are at order 5 and 6 after the change. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type of the registry value for the Registry preference item. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, ExpandString, and Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Value parameters. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data of the registry value for the Registry preference item. For example, the registry value "HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle" can have the following (value) data: 10 36 106. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the value name of the registry value for the Registry preference item. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Action</maml:name><maml:description><maml:para>Specifies the action for the Registry preference item. You must specify one of the following actions: Create, Update, Replace, or Delete. </maml:para><maml:para>The action specifies how the Registry preference item is applied to the registry key or registry value on the client when Group Policy is processed. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PreferenceAction</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is configured under User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>You can configure a preference registry setting for a registry key or a registry value. -- To configure a setting for a registry key, specify the Key parameter without the ValueName, Value, or Type parameters. -- To configure a setting for a registry value, specify the Key parameter together with the ValueName, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-GPPrefRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>If specified, the Registry preference item is configured as disabled. A disabled Registry preference item is not applied when Group Policy is processed on the client, and, therefore, does not modify any existing registry keys or values on the client. </maml:para><maml:para>This parameter does not disable an existing Registry preference item in the GPO, rather, it creates a new Registry preference item that is disabled. (Any existing Registry preference items that configure the same key or value will still be applied when the GPO is processed on a client.) This behavior is different than disabling an existing Registry preference item using the GPMC. </maml:para><maml:para>You can use the Remove-GPPrefRegistryValue cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPPrefRegistryValue cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. If two Registry preference items in the GPO change the same registry value, the one that has the highest order is the last to modify the value on the client. </maml:para><maml:para>By default, if the Order parameter is not specified, the order is set to one plus the current number of Registry preference items in the GPO. You can specify any value greater than zero. If you specify a value larger than the default value, the order is set to the default. </maml:para><maml:para>The order of a setting can change as Registry preference items are added or removed from the GPO. For example, if the GPO has five Registry preference items, and you add another one and specify an order of 4, the Registry preference items that previously were at order 4 and 5, are at order 5 and 6 after the change. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type of the registry value for the Registry preference item. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, ExpandString, and Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Value parameters. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data of the registry value for the Registry preference item. For example, the registry value "HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle" can have the following (value) data: 10 36 106. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the value name of the registry value for the Registry preference item. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Action</maml:name><maml:description><maml:para>Specifies the action for the Registry preference item. You must specify one of the following actions: Create, Update, Replace, or Delete. </maml:para><maml:para>The action specifies how the Registry preference item is applied to the registry key or registry value on the client when Group Policy is processed. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PreferenceAction</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is configured under User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>You can configure a preference registry setting for a registry key or a registry value. -- To configure a setting for a registry key, specify the Key parameter without the ValueName, Value, or Type parameters. -- To configure a setting for a registry value, specify the Key parameter together with the ValueName, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Action</maml:name><maml:description><maml:para>Specifies the action for the Registry preference item. You must specify one of the following actions: Create, Update, Replace, or Delete. </maml:para><maml:para>The action specifies how the Registry preference item is applied to the registry key or registry value on the client when Group Policy is processed. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PreferenceAction</command:parameterValue><dev:type><maml:name>PreferenceAction</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Context</maml:name><maml:description><maml:para>Specifies whether the Registry preference item is configured under User Configuration or Computer Configuration in the GPO. You must specify either User or Computer. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">GpoConfiguration</command:parameterValue><dev:type><maml:name>GpoConfiguration</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>If specified, the Registry preference item is configured as disabled. A disabled Registry preference item is not applied when Group Policy is processed on the client, and, therefore, does not modify any existing registry keys or values on the client. </maml:para><maml:para>This parameter does not disable an existing Registry preference item in the GPO, rather, it creates a new Registry preference item that is disabled. (Any existing Registry preference items that configure the same key or value will still be applied when the GPO is processed on a client.) This behavior is different than disabling an existing Registry preference item using the GPMC. </maml:para><maml:para>You can use the Remove-GPPrefRegistryValue cmdlet to remove any existing Registry preference items associated with the specified key or value from the appropriate configuration (User or Computer) in the GPO before you create the new disabled Registry preference item. This ensures that after you create the disabled Registry preference item, it will be the only Registry preference item associated with the key or value in the specified configuration in the GPO. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPPrefRegistryValue cmdlet, the GPO for which to configure the Registry preference item must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>Current Domain</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the Registry preference item by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the Registry preference item; for example: HKEY_CURRENT_USER\Control Panel\Colors. </maml:para><maml:para>You can specify any of the following registry hives: HKEY_CLASSES_ROOT (HKCR), HKEY_CURRENT_USER (HKCU), HKEY_LOCAL_MACHINE (HKLM), HKEY_USERS (HKU), and HKEY_CURRENT_CONFIG (HKCC). Any of these hives can be specified for Registry preference items in both Computer Configuration and User Configuration. </maml:para><maml:para>You can configure a preference registry setting for a registry key or a registry value. -- To configure a setting for a registry key, specify the Key parameter without the ValueName, Value, or Type parameters. -- To configure a setting for a registry value, specify the Key parameter together with the ValueName, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the Registry preference item by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Order</maml:name><maml:description><maml:para>Specifies the order in which the Registry preference item is processed relative to other Registry preference items in the GPO when the GPO is applied on a client computer. If two Registry preference items in the GPO change the same registry value, the one that has the highest order is the last to modify the value on the client. </maml:para><maml:para>By default, if the Order parameter is not specified, the order is set to one plus the current number of Registry preference items in the GPO. You can specify any value greater than zero. If you specify a value larger than the default value, the order is set to the default. </maml:para><maml:para>The order of a setting can change as Registry preference items are added or removed from the GPO. For example, if the GPO has five Registry preference items, and you add another one and specify an order of 4, the Registry preference items that previously were at order 4 and 5, are at order 5 and 6 after the change. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type of the registry value for the Registry preference item. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, ExpandString, and Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Value parameters. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue><dev:type><maml:name>RegistryValueKind</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data of the registry value for the Registry preference item. For example, the registry value "HKEY_CURRENT_USER\Control Panel\Colors ActiveTitle" can have the following (value) data: 10 36 106. </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, ValueName, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue><dev:type><maml:name>PSObject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies the value name of the registry value for the Registry preference item. For example, the registry key "HKEY_CURRENT_USER\Control Panel\Colors" can have a value with the following name: ActiveTitle. For the default value of a registry key, specify either "(default)" or an empty string (""). </maml:para><maml:para>When you configure a Registry preference item for a registry key, do not specify this parameter. When you configure a Registry preference item for a registry value, specify this parameter together with the Key, Value, and Type parameters. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>Confirm</maml:name><maml:description><maml:para>Prompts you for confirmation before running the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named"><maml:name>WhatIf</maml:name><maml:description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue>false</dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo, Microsoft.GroupPolicy.PreferenceRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO (in which to configure a specified preference registry setting), or a PreferenceRegistrySetting object (to configure in a specified GPO). Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Set-GPPrefRegistryValue returns the GPO in which the Registry preference item was configured. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKCU\Software\Policies\Microsoft\Windows\Control Panel" -ValueName ScreenSaveIsSecure -Value "1" -Type String -Action Update DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 35c12ab3-956c-45d5-973b-46b17d225f47 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/24/2009 4:41:03 PM ModificationTime : 2/25/2009 12:16:28 PM UserVersion : AD Version: 1, SysVol Version: 1 ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a Registry preference item for the registry value "HKCU\Software\Policies\Microsoft\Windows\Control Panel\ ScreenSaveIsSecure" in User Configuration for the "TestGPO" GPO. When the GPO is applied on a client, the registry value is updated with a data type of String (REG_SZ) and value data "1". </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPPrefRegistryValue -Name TestGPO -Context User -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value NewData -Type String </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a Registry preference item for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" in User Configuration for the "TestGPO" GPO. When the GPO is applied on a client, the registry value is created with a data type of String (REG_SZ) and value data "NewData". </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPPrefRegistryValue -Guid 35c12ab3-956c-45d5-973b-46b17d225f47 -Context computer -Action Create -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a Registry preference item for the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey\ExampleKey2" in Computer Configuration in the GPO that has ID 35c12ab3-956c-45d5-973b-46b17d225f47. When the GPO is applied on a client, the registry key is created. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Remove-GPPrefRegistryValue -Name TestGPO -Context User -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne | Set-GPPrefRegistryValue -Context User -Action Create -Disable -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value SomeData -Type String </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command creates a disabled Registry preference item for the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" in User Configuration in the "TestGPO" GPO. First the Remove-GPPrefRegistryValue command removes any Registry preference items that configure the value from User Configuration. Then, the GPO ("TestGPO") returned by the Remove-GPPrefRegistryValue is piped into Set-GPPrefRegistryValue to configure the disabled Registry preference item. After this command completes, the disabled Registry preference item is the only Registry preference item associated with the registry value in User Configuration. </maml:para><maml:para>If the "TestGPO" GPO does not initially have a Registry preference item configured for the specified registry value, a non-terminating error occurs. You can suppress the error message by supplying the ErrorAction parameter to Remove-GPPrefRegistryValue and setting its value to SilentlyContinue (-ErrorAction SilentlyContinue). For more information about the ErrorAction parameter, see about_commonparameters. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Get-GPO -All | Remove-GPPrefRegistryValue -Context User -Key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -ErrorAction SilentlyContinue | Set-GPPrefRegistryValue -Context User -Action Update -Key "HKLM\SOFTWARE\Microsoft\ExampleKey" -ValueName ValueOne -Value SomeData -Type String </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a Registry preference item to update the registry value "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey ValueOne" for every GPO in the domain that previously had a Registry preference item configured for that value in User Configuration. </maml:para><maml:para>First the Get-GPO cmdlet is invoked with the All parameter to get all the GPOs in the domain. These GPOs are piped into the Remove-GPPrefRegistryValue cmdlet. If the GPO contains any Registry preference items configured for the specified key, they are removed. Remove-GPPrefRegistryValue only outputs a GPO to the pipeline if it removes a Registry preference item from a GPO. Finally, these GPOs are piped to the Set-GPPrefRegistryValue to configure the Registry preference item to update the registry value. </maml:para><maml:para>If a GPO passed to Remove-GPPrefRegistryValue does not have a Registry preference item configured for the specified value, an non-terminating error occurs. The ErrorAction parameter is set to SilentlyContinue (-ErrorAction SilentlyContinue) to suppress the error message. For more information about the ErrorAction parameter, see about_commonparameters. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 6 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>get-gpprefregistryvalue -name testgpo -context user -key hklm\software\microsoft\examplekey | set-gpprefregistryvalue -name testgpo-1 -context computer -order 1 -erroraction silentlycontinue DisplayName : TestGPO-1 DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : ef4d0f7e-1a1a-4fd1-b735-0bc6620e7f51 GpoStatus : AllSettingsEnabled Description : CreationTime : 3/1/2009 11:14:06 AM ModificationTime : 3/1/2009 11:15:16 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 1, SysVol Version: 1 WmiFilter : DisplayName : TestGPO-1 DomainName : contoso.microsoft.com Owner : CONTOSO\Domain Admins Id : ef4d0f7e-1a1a-4fd1-b735-0bc6620e7f51 GpoStatus : AllSettingsEnabled Description : CreationTime : 3/1/2009 11:14:06 AM ModificationTime : 3/1/2009 11:15:16 AM UserVersion : AD Version: 0, SysVol Version: 0 ComputerVersion : AD Version: 2, SysVol Version: 2 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command copies all Registry preference items that configure (first-level) values under the registry key "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\ExampleKey" from User Configuration in a source GPO (TestGPO) to Computer Configuration in destination GPO (TestGPO-1). A copy of the destination GPO (TestGPO-1) is returned for each Registration preference item set (in this examlpe, 2). </maml:para><maml:para>The Get-GPPrefRegistryValue command gets all the Registry preference items that configure values under User Configuration in the source GPO. This command also returns all first level subkeys that have values configured (though not the Registry preference items for the values themselves). These Registry preference items (and the subkeys) are then piped into the Set-GPPrefRegistryValue command. </maml:para><maml:para>The Set-GPPrefRegistryValue command configures the Registry preference items for the registry values in the destination GPO. -- The subkeys returned by Get-GPPrefRegistryValue do not have an Action property, and so a non-terminating error occurs for each subkey. The ErrorAction parameter is specified (-ErrorAction SilentlyContinue) to suppress these error messages. For more information about the ErrorAction parameter, see about_commonparameters. -- It is a good practice to specify an order of one (-Order 1) in Set-GPPrefRegistryValue when it accepts input from the pipeline. This is because Registry preference items passed on the pipeline have an Order property. If the Order property of a Registry preference item passed on the pipeline is greater than the number of Registry preference items currently configured in the destination GPO, an out of range error occurs and the Registry preference item is not configured in the destination GPO. By specifying the order as one in the Set-GPPrefRegistryValue command, you override the Order property of the source Registry preference item, and prevent such errors from occurring. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287736</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPPrefRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Set-GPRegistryValue</command:name><maml:description><maml:para>Configures one or more registry-based policy settings under either Computer Configuration or User Configuration in a GPO.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Set</command:verb><command:noun>GPRegistryValue</command:noun><dev:version /></command:details><maml:description><maml:para>The Set-GPRegistryValue cmdlet configures a registry-based policy setting under either Computer Configuration or User Configuration in a GPO. The policy setting configures keys or values in the registry on the client computer when the GPO is applied. </maml:para><maml:para>You can specify the GPO by name or by its GUID, or you can pipe a GPO object to the cmdlet. You can also pipe a PolicyRegistrySetting object (for example, one returned by Get-GPRegistryValue) to the cmdlet. </maml:para><maml:para>You can configure registry-based policy settings for: -- One or more registry values by passing the Key, ValueName, Value, and Type parameters. For multiple registry values, pass a comma-separated list for both the ValueName and Value parameters. When you specify multiple registry values, only the String and ExpandString data types are supported. -- A list of one or more registry values that share the same name prefix by passing the Key and Type parameters, and a single value or a comma-separated list for the Value parameter. You can optionally specify the value name prefix by using the ValuePrefix parameter. Only the String and ExpandString data types are supported for lists. </maml:para><maml:para>You can use the Additive parameter to ensure that existing registry values for the key are not overwritten by the new policy setting when the GPO is applied. </maml:para><maml:para>You can also delete registry values on a client when the GPO is applied by disabling a policy setting with the Disable parameter. You can disable: -- All the registry values under a specified registry key by passing the Key parameter. No subkeys (or their values) will be deleted on the client. -- A single registry value by passing the Key parameter and the ValueName parameter. -- Multiple registry values by passing the Key parameter and a comma-separated list for the ValueName parameter. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Set-GPRegistryValue</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Additive</maml:name><maml:description><maml:para>Specifies that registry values should be appended to existing values under the key when the GPO is applied on a client. </maml:para><maml:para>By default, when Group Policy is processed on a client, existing values under a registry key are deleted before any new values are written to the registry. By using the Additive parameter for a registry-based policy setting, you can specify that the new value should be added to the registry key without deleting the existing values. </maml:para><maml:para>You cannot specify the Disable parameter with this parameter. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>Specifies that the registry-based policy setting should be disabled. </maml:para><maml:para>You can disable a policy setting for a registry key or value: -- For a registry key, specify the Key parameter without the ValueName parameter. When the GPO is applied on the client, all of the values directly under the key are removed from the registry. The key itself is not removed from the registry, nor are any of its subkeys (or their values) removed. -- For a registry value, specify the Key parameter together with the ValueName parameter. When the GPO is applied on the client, only the specified value is removed from the registry. </maml:para><maml:para>To remove a policy setting from a GPO without affecting existing registry keys or values on a client when Group Policy is processed, use the Remove-GPRegistryValue cmdlet. </maml:para><maml:para>You cannot specify the Additive, Type, Value, or ValuePrefix parameters with the Disable parameter. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPRegistryValue cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type for the registry-based policy setting. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, or Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>Only the following data types are supported for list values: String and ExpandString. </maml:para><maml:para>You must specify this parameter when you configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data for the registry-based policy setting. You can specify a single value or an array of values. Use a comma-separated list to specify more than one value. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>At a minimum, you must specify this parameter together with the Type and Key parameters to configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies a value name or an array of value names for the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a registry value with the following value name: UseDomainNameDevolution. Use a comma-separated list to specify more than one value name. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>You cannot specify this parameter with the ValuePrefix parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValuePrefix</maml:name><maml:description><maml:para>Specifies a value name prefix for a registry-based policy setting for a list of registry values. For example, the following command: </maml:para><maml:para>Set-GPRegistryValue -Key "HKLM\SOFTWARE\Policies\ExampleKey" -ValuePrefix "ExValue" -Type String - Value 100,200,300 </maml:para><maml:para>Configures a policy setting that creates the following registry values when Group Policy is applied on the client: </maml:para><maml:para>"HKLM\SOFTWARE\Policies\ExampleKey ExValue1" 100 "HKLM\SOFTWARE\Policies\ExampleKey ExValue2" 200 "HKLM\SOFTWARE\Policies\ExampleKey ExValue3" 300 </maml:para><maml:para>Only the String and ExpandString data types are supported with the ValuePrefix parameter. </maml:para><maml:para>You cannot specify this parameter with the ValueName parameter or the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the registry-based policy setting; for example, "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Set-GPRegistryValue</maml:name><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Additive</maml:name><maml:description><maml:para>Specifies that registry values should be appended to existing values under the key when the GPO is applied on a client. </maml:para><maml:para>By default, when Group Policy is processed on a client, existing values under a registry key are deleted before any new values are written to the registry. By using the Additive parameter for a registry-based policy setting, you can specify that the new value should be added to the registry key without deleting the existing values. </maml:para><maml:para>You cannot specify the Disable parameter with this parameter. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>Specifies that the registry-based policy setting should be disabled. </maml:para><maml:para>You can disable a policy setting for a registry key or value: -- For a registry key, specify the Key parameter without the ValueName parameter. When the GPO is applied on the client, all of the values directly under the key are removed from the registry. The key itself is not removed from the registry, nor are any of its subkeys (or their values) removed. -- For a registry value, specify the Key parameter together with the ValueName parameter. When the GPO is applied on the client, only the specified value is removed from the registry. </maml:para><maml:para>To remove a policy setting from a GPO without affecting existing registry keys or values on a client when Group Policy is processed, use the Remove-GPRegistryValue cmdlet. </maml:para><maml:para>You cannot specify the Additive, Type, Value, or ValuePrefix parameters with the Disable parameter. </maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPRegistryValue cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type for the registry-based policy setting. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, or Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>Only the following data types are supported for list values: String and ExpandString. </maml:para><maml:para>You must specify this parameter when you configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data for the registry-based policy setting. You can specify a single value or an array of values. Use a comma-separated list to specify more than one value. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>At a minimum, you must specify this parameter together with the Type and Key parameters to configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies a value name or an array of value names for the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a registry value with the following value name: UseDomainNameDevolution. Use a comma-separated list to specify more than one value name. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>You cannot specify this parameter with the ValuePrefix parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValuePrefix</maml:name><maml:description><maml:para>Specifies a value name prefix for a registry-based policy setting for a list of registry values. For example, the following command: </maml:para><maml:para>Set-GPRegistryValue -Key "HKLM\SOFTWARE\Policies\ExampleKey" -ValuePrefix "ExValue" -Type String - Value 100,200,300 </maml:para><maml:para>Configures a policy setting that creates the following registry values when Group Policy is applied on the client: </maml:para><maml:para>"HKLM\SOFTWARE\Policies\ExampleKey ExValue1" 100 "HKLM\SOFTWARE\Policies\ExampleKey ExValue2" 200 "HKLM\SOFTWARE\Policies\ExampleKey ExValue3" 300 </maml:para><maml:para>Only the String and ExpandString data types are supported with the ValuePrefix parameter. </maml:para><maml:para>You cannot specify this parameter with the ValueName parameter or the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the registry-based policy setting; for example, "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Additive</maml:name><maml:description><maml:para>Specifies that registry values should be appended to existing values under the key when the GPO is applied on a client. </maml:para><maml:para>By default, when Group Policy is processed on a client, existing values under a registry key are deleted before any new values are written to the registry. By using the Additive parameter for a registry-based policy setting, you can specify that the new value should be added to the registry key without deleting the existing values. </maml:para><maml:para>You cannot specify the Disable parameter with this parameter. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Disable</maml:name><maml:description><maml:para>Specifies that the registry-based policy setting should be disabled. </maml:para><maml:para>You can disable a policy setting for a registry key or value: -- For a registry key, specify the Key parameter without the ValueName parameter. When the GPO is applied on the client, all of the values directly under the key are removed from the registry. The key itself is not removed from the registry, nor are any of its subkeys (or their values) removed. -- For a registry value, specify the Key parameter together with the ValueName parameter. When the GPO is applied on the client, only the specified value is removed from the registry. </maml:para><maml:para>To remove a policy setting from a GPO without affecting existing registry keys or values on a client when Group Policy is processed, use the Remove-GPRegistryValue cmdlet. </maml:para><maml:para>You cannot specify the Additive, Type, Value, or ValuePrefix parameters with the Disable parameter. </maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Domain</maml:name><maml:description><maml:para>Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com). </maml:para><maml:para>For the Set-GPRegistryValue cmdlet, the GPO in which to configure the registry-based policy setting must exist in this domain. </maml:para><maml:para>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. </maml:para><maml:para>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). </maml:para><maml:para>You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue>Current Domain</dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Guid</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the registry-based policy setting by its globally unique identifier (GUID). The GUID uniquely identifies the GPO. </maml:para><maml:para>You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">Guid</command:parameterValue><dev:type><maml:name>Guid</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Key</maml:name><maml:description><maml:para>Specifies the registry key for the registry-based policy setting; for example, "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient". </maml:para><maml:para>The key must be in one of the two following registry hives: -- HKEY_LOCAL_MACHINE (HKLM) for a registry-based policy setting in Computer Configuration. -- HKEY_CURRENT_USER (HKCU) for a registry-based policy setting in User Configuration. </maml:para><maml:para>You can also refer to the Key parameter by its built-in alias, "FullKeyPath". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="1" aliases=""><maml:name>Name</maml:name><maml:description><maml:para>Specifies the GPO in which to configure the registry-based policy setting by its display name. </maml:para><maml:para>The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain, an error occurs. You can use the Guid parameter to uniquely identify a GPO. </maml:para><maml:para>You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Server</maml:name><maml:description><maml:para>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: </maml:para><maml:para>FQDN: DomainController1.sales.contoso.com Host Name: DomainController1 </maml:para><maml:para>If you do not specify the name by using the Server parameter, the PDC emulator is contacted. </maml:para><maml:para>You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Type</maml:name><maml:description><maml:para>Specifies the data type for the registry-based policy setting. You can specify one of the following data types: String, ExpandString, Binary, DWord, MultiString, or Qword. For more information about these data types, see "Microsoft.Win32.RegistryValueKind Enumeration" in the MSDN library at http://go.microsoft.com/fwlink/?LinkID=143266. </maml:para><maml:para>Only the following data types are supported for list values: String and ExpandString. </maml:para><maml:para>You must specify this parameter when you configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para><maml:para>The following values are permitted for this object type. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">RegistryValueKind</command:parameterValue><dev:type><maml:name>RegistryValueKind</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>Value</maml:name><maml:description><maml:para>Specifies the value data for the registry-based policy setting. You can specify a single value or an array of values. Use a comma-separated list to specify more than one value. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>At a minimum, you must specify this parameter together with the Type and Key parameters to configure a policy setting to set a registry value. You cannot specify this parameter with the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue><dev:type><maml:name>PSObject</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named" aliases=""><maml:name>ValueName</maml:name><maml:description><maml:para>Specifies a value name or an array of value names for the registry-based policy setting. For example, the registry key "HKLM\Software\Policies\Microsoft\Windows NT\DNSClient" can have a registry value with the following value name: UseDomainNameDevolution. Use a comma-separated list to specify more than one value name. Only the String and ExpandString data types are supported for an array of values. </maml:para><maml:para>You cannot specify this parameter with the ValuePrefix parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">String[]</command:parameterValue><dev:type><maml:name>String[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ValuePrefix</maml:name><maml:description><maml:para>Specifies a value name prefix for a registry-based policy setting for a list of registry values. For example, the following command: </maml:para><maml:para>Set-GPRegistryValue -Key "HKLM\SOFTWARE\Policies\ExampleKey" -ValuePrefix "ExValue" -Type String - Value 100,200,300 </maml:para><maml:para>Configures a policy setting that creates the following registry values when Group Policy is applied on the client: </maml:para><maml:para>"HKLM\SOFTWARE\Policies\ExampleKey ExValue1" 100 "HKLM\SOFTWARE\Policies\ExampleKey ExValue2" 200 "HKLM\SOFTWARE\Policies\ExampleKey ExValue3" 300 </maml:para><maml:para>Only the String and ExpandString data types are supported with the ValuePrefix parameter. </maml:para><maml:para>You cannot specify this parameter with the ValueName parameter or the Disable parameter. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>Microsoft.GroupPolicy.Gpo or Microsoft.GroupPolicy.PolicyRegistrySetting</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>A GPO (in which to configure a registry-based policy setting), or a PolicyRegistrySetting object that represents a registry-based policy setting (to configure in a specified GPO). Collections that contain GPOs from different domains are not supported. </maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.GroupPolicy.Gpo</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>Set-GPRegistryValue returns the GPO in which the registry-based policy setting has been configured. </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><maml:alertSet><maml:title /><maml:alert><maml:para>The hive of the registry key that you specify, HKEY_LOCAL_MACHINE (HKLM) or HKEY_CURRENT_USER (HKCU), determines whether the registry-based policy setting is in Computer Configuration or User Configuration. </maml:para><maml:para>You can use the Domain parameter to explicitly specify the domain for this cmdlet. </maml:para><maml:para>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 from the Program Files menu, 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. </maml:para></maml:alert></maml:alertSet><command:examples><command:example><maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\Windows\Control Panel\Desktop" -ValueName ScreenSaveTimeOut -Type DWORD -value 900 DisplayName : TestGPO DomainName : contoso.com Owner : CONTOSO\Domain Admins Id : 35c12ab3-956c-45d5-973b-46b17d225f47 GpoStatus : AllSettingsEnabled Description : CreationTime : 2/24/2009 4:41:03 PM ModificationTime : 2/25/2009 12:42:00 PM UserVersion : AD Version: 3, SysVol Version: 3 ComputerVersion : AD Version: 34, SysVol Version: 34 WmiFilter : </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a registry-based policy setting for the registry value "HKCU\Software\Policies\Microsoft\Windows\Control ScreenSaverTimeOut" with a value of 900 and a data type of DWord. This policy setting sets the Screen Saver timeout to 900 seconds (15 minutes) when Group Policy is applied on the client. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" -Type String -Value "String 1", "String 2", "String 3" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures registry-based policy settings to set three registry values. The policy settings are configured in the User Configuration section of the GPO. When the GPO is applied on the client, the following registry values are set: </maml:para><maml:para>"HKCU\Software\Policies\Microsoft\ExampleKey ValueOne" "String 1" "HKCU\Software\Policies\Microsoft\ExampleKey ValueTwo" "String 2" "HKCU\Software\Policies\Microsoft\ExampleKey ValueThree" "String 3" </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 3 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPRegistryValue -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValuePrefix "MyValue" -Type String -Value "String 1", "String 2", "String 3" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command configures a registry-based policy setting to set a list of three registry values. The policy settings are configured in the Computer Configuration section of the GPO. Because the Additive parameter is not specified, when the GPO is applied on the client any list values under the key are deleted -- then, the following registry values are set: </maml:para><maml:para>"HKCU\Software\Policies\Microsoft\ExampleKey MyValue1" "String 1" "HKCU\Software\Policies\Microsoft\ExampleKey MyValue2" "String 2" "HKCU\Software\Policies\Microsoft\ExampleKey MyValue3" "String 3" </maml:para><maml:para>If you specify the Additive parameter, the list values are added to the existing list values on the client when the GPO is applied. (Note: the actual value names assigned to the list values will depend on the number of existing list values on the client.) </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 4 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPRegistryValue -Disable -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" -ValueName "ValueOne", "ValueTwo", "ValueThree" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command disables the registry-based policy settings (in the User Configuration section) for the specified registry values. When the GPO is applied on the client, the registry values are deleted from the registry on the client. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>-------------------------- EXAMPLE 5 --------------------------</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>C:\PS>Set-GPRegistryValue -Disable -Name "TestGPO" -key "HKCU\Software\Policies\Microsoft\ExampleKey" </dev:code><dev:remarks><maml:para>Description </maml:para><maml:para>----------- </maml:para><maml:para>This command disables the registry-based policy setting (in the User Configuration section) for the specified registry key. When the GPO is applied on the client, all first level values will be deleted from the registry key. Subkeys and their values will not be modified. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/?linkid=287737</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Remove-GPRegistryValue</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |