Chat now with support
Chat with Support

GPOADmin 5.19 - User Guide

Introducing Quest GPOADmin Configuring GPOADmin Using GPOADmin
Connecting to the Version Control system Navigating the GPOADmin console Search folders Accessing the GPMC extension Configuring user preferences Working with the live environment Working with controlled objects (version control root)
Creating a custom container hierarchy Selecting security, levels of approval, and notification options Viewing the differences between objects Copying/pasting objects Proposing the creation of controlled objects Merging GPOs Restoring an object to a previous version Restoring links to a previous version Managing your links with search and replace Linking GPOs to multiple Scopes of Management Managing compliance issues automatically with remediation rules Validating GPOs Managing GPO revisions with lineage Setting the change window for specific actions Working with registered objects Working with available objects Working with checked out objects Working with objects pending approval and deployment
Checking compliance Editing objects Synchronizing GPOs Exporting and importing
Creating Reports Appendix: Windows PowerShell Commands Appendix: GPOADmin Event Log Appendix: GPOADmin Backup and Recovery Procedures Appendix: Customizing your workflow Appendix: GPOADmin Silent Installation Commands Appendix: Configuring Gmail for Notifications Appendix: Registering GPOADmin for Office 365 Exchange Online Appendix: GPOADmin with SQL Replication About Us

GPOADmin PowerShell provider extensions

GPOADmin has extended the following standard PowerShell commands:

•
New-Item and Remove-Item
•
Get-ChildItem and the New-PSDrive
New-Item and Remove-Item

GPOADmin has extended Microsoft’s New-Item and Remove-Item PowerShell commands to add the ability to create and delete items from the GPOADmin version control.

Example: Create a container name HR

new-item -Path VCRoot:\ -Name HR -ItemType Container

Example: Create a GPO name HR_GPO in the HR container

new-item -Path VCRoot:\HR -Name HR_GPO -ItemType GPO -Comment "Set the minimum password length to 8 characters"

Example: Remove the GPO name HR_GPO in the HR container

remove-item -Path vcroot:\HR\HR_GPO

Example: Remove a container name HR

remove-item -Path VCRoot:\HR

Get-ChildItem and the New-PSDrive

The GPOADmin PowerShell provider has extended the Get-ChildItem and the New-PSDrive command to include the following parameters:

 
Table 20. Commands
command
parameters

Get-ChildItem extensions
NOTE: If no parameters are specified, then all objects are enumerated and returned.
•
Container: Returns Version Control containers.
•
Domain: Returns domain scopes of management.
•
GPO: Returns Group Policy Objects.
•
OrganizationalUnit: Returns Organizational Units.
•
Site: Returns site scopes of management.
•
SOM: Returns all scopes of management (domain, Organizational Units, and sites).
•
WMIFilter: Returns WMIFilters.
•
Count: Instructs the provider to return only the number of specified objects.

New-PSDrive extensions
•
Server: Specifies the GPOADmin server service to connect to.
•
Port: Specifies the port to use when connecting to the specified server.

New-Item
•
Path: The fully qualified path to the new item.
•
ItemTypeName: The type of item to create. Valid values are:
•
Version Control Root: CONTAINER, GPO, STARTERGPO, WMIFILTER, SCRIPT, and POWERSHELLSCRIPT.
•
Protected Settings Root: CONTAINER and PROTECTEDSETTINGSPOLICY.
•
Domain: The domain in which the new item belongs.
•
Comment: A comment to associate with the creation of this item.
•
WorkflowDisabled: Creates the item as Workflow Disabled. Valid only with an ItemTypeName of GPO.
•
StarterGPO: The StarterGPOData representing the StarterGPO to use when creating a new GPO. Valid only with an ItemTypeName of GPO.
•
WMIFilter: The VersionControlledData representing the WMIFilter to be linked to this item. Valid only with an ItemTypeName of GPO.
•
Queries: The queries to be associated with this item. Valid only with an ItemTypeName of WMIFILTER
•
Description: The description for this item. Valid only with an ItemTypeName of WMIFILTER.

Remove-Item
•
Comment: A comment to associate with this item.

Using the GPOADmin PowerShell commands (Examples)

The following examples show how to apply PowerShell commands to perform many of the GPOADmin functions. The commands are especially beneficial in environments where repetitive processes are required.

* 
NOTE: All the example commands can be copied word for word and run in the PowerShell window.
* 
NOTE: Some commands may appear more than once in these examples and not all GPOADmin commands are included in the examples in this guide.
* 
NOTE: The examples are based on the commands available in GPOADmin version 5.11 and later. While most of these examples are valid for GPOADmin 5.x, the command names may have changed.

Example commands are included for the following:

•
Loading the GPOADmin modules
•
Extracting help for GPOADmin commands
•
Managing objects
•
Gathering object and GPOADmin information
•
Utility commands
•
Administrative commands
•
Protected Settings commands

The ability to use a command is related to the role and user running it. For example, if the user has the User role then the commands they can run are limited to the actions associated with the s assigned to this role. This ensures that workflow, security, and protection are maintained with the commands.

For details on what is available for each role, see Configuring role-based delegation.

Before you can use the examples, you must ensure that you have registered the commands. See Registering the GPOADmin PowerShell commands .

Loading the GPOADmin modules

Rather than having to remember the module names each time you want to run a command, you can use the following simplify the process.

To load the GPOADmin module
1
On the system where GPOADmin is installed, open PowerShell.
2
To ensure the PowerShell scripts can be run, set the registry value using the following command:
Set-Executionpolicy RemoteSigned
3
Next create a PowerShell profile file, with the following command:
New-Item -path $profile -type file –force
4
Now you are going to put something into the profile file. Enter:

notepad $profile
This opens the profile file in Notepad so you can enter the following commands:
import-module ‘C:\Program Files\Quest\GPOADmin\GPOADmin.psd1’
CD VCRoot:
get-command -module GPOADmin
The first line adds the module, the second changes to the Version Control Root drive used by GPOADmin, and the last one give you a list of all available GPOADmin commands.
5
Save the profile by selecting to save and exit Notepad.
6
Exit or close PowerShell, then open it again.
The profile loads and displays a list of commands.

Extracting help for GPOADmin commands

The following code first gets all the GPOADmin commands, then creates an output file. The Get-Help command is run for each command with the –Full parameter set to return all help information. Finally, the help is written into the file along with a line used to separate the help for each command. This process continues until all the help is read for the commands.

* 
NOTE: You can run this in a script or in the PowerShell window.
To extract the help for the GPOADmin commands
1
On the system where GPOADmin is installed, open a PowerShell window.
2
Copy the following code and paste it into Notepad to remove any hidden characters.
Ensure that you copy everything from the $ (dollar sign) to the last } (closing bracket).
$x = get-command -Module GPOADmin
$file = "c:\PowerShell-Help-GPOADmin.txt"
foreach ($y in $x)
{
$y.Name.ToUpperInvariant() >> $file
"" >> $file
get-help -Full $y.Name >> $file
"" >> $file
 
"************************************************************************************************" >> $file
"" >> $file
}
3
Copy the code from Notepad and paste it into the PowerShell command line, and press Enter.
If you see >>, press Enter again.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating