Learn about Windows PowerShell
Hey, Scripting Guy! I need to be able to connect to two Group Policy objects (GPOs) in Active Directory and make an offline copy of the GPOs using Windows PowerShell 2.0 so that I can compare the two objects. I know I can do this using the Group Policy Management Console, but I have several hundred GPOs in my domain and I do not have the time to go through the GUI and click-click-click. I would prefer to be able to script this operation using Windows PowerShell, if possible. Ideas?
Microsoft Scripting Guy Ed Wilson here. l am anxious to complete our discussion of the Compare-GPO.ps1 script. As you may recall, yesterday we looked at the portion of the script that determined if the GroupPolicy module was available and loaded, and we also looked at the function that downloaded the two GPOs to be compared. Because the Compare-GPO.ps1 script is more than 125 lines long, I have posted it to our Script Repository rather than pasting it into this post.
Note: This is part two of a two-part article. Part one was posted yesterday.
Note: This is part two of a two-part article. Part one was posted yesterday.
The Compare-XMLGPO function is used to compare two XML reports of GPOs. It accepts an array of strings that point to the two XML files that will be used for comparison. It does not matter if more than two GPO reports are supplied because only the first two will be compared. The two Boolean values, $user and $computer, control which portion of the GPO is compared. If both values are present, both the computer and the user portion of the GPO will be compared. The [xml] type accelerator is used to ensure the contents of the two GPO reports are interpreted as XML. Reading the XML GPO reports is really easy—the Get-Content cmdlet is used. The $xml1 and $xml2 variables contain a system.xml.xmldocument .NET Framework object. This section of the script is shown here:
To effectively parse the GPO XML report, you must know the structure of the XML document. I like to use XML Notepad. As shown in the next image, the path to our GPO policy settings is GPO/User/extensiondata/extension. Each policy setting is a node under the extension folder. This particular GPO setting is in an XML namespace (XMLNS) called q1. Therefore, each policy setting is in a node called q1:Policy. At times you will see an XML namespace called q2 or even something else. But each policy node will have the word policy in it. The breakdown between user and computer in the structure of the XML document corresponds with the Group Policy computer settings and user settings.
To compare the two GPOs, the childnodes property from the System.Xml.XmlElement .NET Framework class is used to obtain a collection of all the policy nodes under the extension element. There are many attributes associated with the policy element, but to make the comparison easier, only two attributes—the name and the state of the GPO—are selected. This selection is made for both the computer GPO and the user GPO from both XML documents. This section of the script is shown here:
It is quite possible; in fact, it is a probability that one or more of the GPOs will not contain both the computer section and the user section of the GPO. An error will occur if you try to compare an empty GPO. Therefore, the if statement is used to determine if there is anything in the computer section or the user section of the GPO. If the variable is not null, a Try/Catch block is used to perform the comparison using the Compare-Object cmdlet. When using the compare-object cmdlet, it is important to specify the property that will form the basis of the comparison. Otherwise, Windows PowerShell will pick a property that may or may not work well for your particular application.
I am interested in GPOs that contain similar settings, and therefore I told the Compare-Object cmdlet to include equal settings that exist in the reference object and the difference object. If you are only looking for duplicate settings that exist in GPOs, you may wish to use the –excludedifferent switch so that your report will only contain duplicate settings. The order in which the GPOs are listed could make a difference depending on what you are looking for. It definitely will impact how you read the report that is generated. This section of the script is shown here:
On the other hand, if one of the portions of the GPO is empty, the settings of the GPO that is not empty are listed on the Windows PowerShell console. This is shown here:
If there are no settings to display from a particular GPO, a message to that effect is displayed on the Windows PowerShell console. This section of the script is shown here:
The same code is repeated for the other computer node:
If a user section of the GPO exists, a Try/Catch is used to attempt to compare the two user portions of the GPO. If an error occurs, the Catch block is used to determine which portion of the GPO is empty, and it will display a message indicating that the GPO is empty. If a GPO has settings, the settings will be displayed. This code, shown here, is nearly the same as that for the computer portion of the script:
When testing the script to ensure it reports accurately the settings in my two GPO files, I used the compare feature in XML Notepad. The compare feature is under View/Compare XML Files. As shown in the following image, the color coding makes it easy to spot modifications, additions, and deletions.
The entry point to the script first determines if the –user or–computer switch has been used. If neither is present, the script displays a message and exits. You could change this behavior and set one or the other as the default. The code to do this is shown here:
The code as it exists in the Compare-GPO.ps1 script is shown here:
The Get-MyModule function is used to load the GroupPolicy module. If the module is not found on the system, the script exits:
Next, the Get-GpoAsXML function is used to retrieve the two GPOs specified in the $gponame variable. The Get-GpoAsXML function returns the path to the two GPOs. This returned array of paths is stored in the $gpoReports variable, as shown here:
When the script runs, output is shown similar to that in the following image. When testing a script that uses switched parameters in the Windows PowerShell ISE, I will set the switched value to $true. This is also seen in the following image.
SV, that is all there is to using Windows PowerShell to compare two XML Group Policy objects. This also concludes Group Policy Week. Join us tomorrow for Weekend Scripter when we will talk about using Windows PowerShell to clean up a CSV file.
We would love for you to Twitter or Facebook. If you have any questions, send email to us at firstname.lastname@example.org, or post your questions on the Official Scripting Guys Forum. See you tomorrow. Until then, peace.
Ed Wilson and Craig Liebendorfer, Scripting Guys
I have an issue with the following lines :
[xml]$xml1 = Get-Content -Path $gpoReports
[xml]$xml2 = Get-Content -Path $gpoReports
I used that syntax also in a different script and found out that it only seems to read the first line. In your script I get as final result that neither computer settings not users settings have been set. From my experiences from my other script I believe the issue comes from the two lines above. If I have the script to show me the content of $xml1 I get the following result:
xml : version="1.0" encoding="utf-16"
GPO : GPO
And that's it. Looking at the XML in Notepad the first line reads like this:
<?xml version="1.0" encoding="utf-16"?>
Are there alternative ways to get the data displayed correctly ?
I am getting the following error...
PS C:\Windows> C:\Scripts\PowerShell\Compare-GPO.ps1
Missing expression after unary operator '-'.
At C:\Scripts\PowerShell\Compare-GPO.ps1:95 char:10
+ - <<<< DifferenceObject $regpolicyUserNodes2 -SyncWindow 5 -IncludeEqual `
+ CategoryInfo : ParserError: (-:String) , ParentContainsErrorRecordException
+ FullyQualifiedErrorId : MissingExpressionAfterOperator
Ok, I got past my previous error, it was an issue with a back tick from the copy and paste. However, it would seem the script is not working still...
PS C:\Users\usera\Documents\WindowsPowerShell> .\Compare-GPO.ps1 -user
Comparing User GPO's C:\fso\TS All Users Policy.xml to C:\fso\TS All Users Policy1.xml
User GPO C:\fso\TS All Users Policy.xml not set
User GPO C:\fso\TS All Users Policy1.xml not set
I am watching the fso folder while the script run and it creates the first xml file, and then the second gets created only after the output above is given. I tried various pauses, but that doesn't seem to help.
Hey Scripting Guy, when I try to run this script, it tells me the '$path' is empty, even though I've filled in the path variable (even if I hadn't changed the script to my path and domain information, it still should not have been empty). I'm running Powershell 4 on Win7. I'm not sure how to resolve this - any suggestions?