Unlock-ControlledGpo
Unlocks controlled GPOs.
Syntax
Unlock-ControlledGpo
[[-ControlledGpos] <ControlledGpo[]>]
[-Comment <String>]
[-Domain <String>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Unlock-ControlledGpo cmdlet unlocks controlled Group Policy Objects (GPOs) in an Advanced Group Policy Management (AGPM) archive. You can edit an unlocked GPO. Unlocking a GPO is the equivalent of checking out a GPO.
Examples
Example 1: Unlock all locked GPOs
PS C:\>Get-ControlledGpo | Where {$_.VaultState -eq "CHECKED_IN"} | Unlock-ControlledGpo -Comment "Unlock all GPOs"
This command uses the Get-ControlledGpo cmdlet to get all controlled GPOs in the current domain. The command passes those GPOs to the Where-Object cmdlet. That cmdlet passes any GPOs that have a state of CHECKED_IN to the current cmdlet. This cmdlet unlocks all of those GPOs. The cmdlet includes an explanatory comment.
Parameters
-Comment
Specifies a comment for the change that this cmdlet makes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ControlledGpos
Specifies an array of GPOs to unlock. To obtain controlled GPOs, use the Get-ControlledGpo cmdlet.
Type: | ControlledGpo[] |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Domain
Specifies the fully qualified domain name (FQDN) of a domain. This cmdlet operates on GPOs in the domain that this parameter specifies. If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer.
If you do not specify a domain, this cmdlet uses the domain of the current user.
If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Indicates that this cmdlet returns the controlled GPOs on which the cmdlet operates. If you do not specify this parameter, this cmdlet returns no results.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.Agpm.ControlledGpo
This cmdlet accepts controlled GPOs.
Outputs
Microsoft.Agpm.ControlledGpo
This cmdlet returns controlled GPO objects, if you specify the PassThru parameter.