A.4 Report Scripts

To write a Visual Basic script or method to generate the GPO Settings report:

1. In Notepad, create the following script:

   dim x
   set x = CreateObject("GPExplorer.PolicyManager.1")
   REM ***** GenerateReport(GPO LDAP path, output file path, options)
   x.GenerateReport("LDAP://DomainController/CN={GUID},CN=Policies, CN=System,DC=DistinguishedDomainName","OutputFile",Options)
   set x = nothing

   or

   Create the following C# method:

   public static void GenerateGPOReportAD()
           {
               string sGPOPath = "LDAP://DomainController/CN={GUID},CN=Policies,CN=System,DC=DistinguishedDomainName";
               string sPath = "OutputFile";
               long sOptions = 0;
               IfaExplorerRoot oEXPRroot = new PolicyManager();
               oEXPRroot.GenerateReport(sGPOPath, sPath, sOptions);
               Console.WriteLine("AD GPO report generated successfully");
               Console.ReadKey();
           }

2. Modify the variables. To obtain the LDAP path of the GPO (“LDAP... DomainName”), use the ADSI Edit tool. If the ADSI Edit tool is not available, substitute the following information:

   DomainController

   Type the name of the primary domain controller of the domain. Provide the full computer name, which has the actual computer name along with the domain to which it belongs. You can find the full name on the Network Identification tab of the Property page of My Computer.

   GUID

   Type the GUID number that corresponds to the GPO you want to report on.

   DistinguishedDomainName

   Type the distinguished name format of the domain to which the GPO belongs.

   OutputFile

   Type the path and the name of the file for the output report.

   Options

   Type 0 to specify the GPO Settings report.

3. When you are finished, your script should look similar to the following example:

   REM ***********************************************************
   dim x
   set x = CreateObject("GPExplorer.PolicyManager.1")
   REM ***** GenerateReport(GPO LDAP path, output file path, options)
   x.GenerateReport "LDAP://devel-child.child-domain.com/CN={31B2F340-016D-11D2-945F-00C04FB984F9}, CN=Policies,CN=System,DC=child-domain,DC=com","E:\GPO Backups\Backup Scripts\Reports\Report.htm",0
   set x = nothing
   Wscript.Echo "Report Generation Completed"
   REM ***********************************************************

   or

   Your C# method should look similar to the following example:

   public static void GenerateGPOReportAD()
           {
               string sGPOPath = "LDAP://MYDOMAIN.LAB/CN={04835D24-7FAC-4B7B-B677-419E598593B0},CN=Policies,CN=System,DC=MYDOMAIN,DC=LAB";
               string sPath = "C://Folder/ADGPOReport.htm";
               long sOptions = 0;
               IfaExplorerRoot oEXPRroot = new PolicyManager();         
               oEXPRroot.GenerateReport(sGPOPath, sPath, sOptions);
               Console.WriteLine("AD GPO Report generated successfully");
               Console.ReadKey();           
           }

4. To generate reports of multiple GPOs, copy the x.GenerateReport line, for Visual Basic scripts, and the sGPOPath line, for C# methods, as many times as necessary, modifying ONLY the GUID for each GPO to include in the report.

5. Save the file with any suitable name, and an extension of .vbs for Visual Basic scripts, to the location of your choice (for example, ReportGPOs.vbs), or compile the solution, then execute the executable build.

To write a Visual Basic script or method to generate the Health Check report:

1. In Notepad, create the following script:

   dim x
   set x = CreateObject("GPExplorer.PolicyManager.1")
   x.ConnectTo ("ConnectionString")
   REM ***** GenerateReport(GPO LDAP path, output file path, options)
   x.GenerateReport("LDAP://DomainController/CN={GUID},CN=Policies, CN=System,DC=DistinguishedDomainName","OutputFile",Options)
   set x = nothing

   or

   Create the following C# method:

   public static void GenerateHealthCheckReport()
           {
               string sGPOPath = "LDAP://DomainController/CN={GUID},CN=Policies,CN=System,DC=DistinguishedDomainName";
               string sPath = "OutputFile";
               long sOptions = 1;
               IfaExplorerRoot oEXPRroot = new PolicyManager();
               oEXPRroot.ConnectTo("ConnectionString");
   oEXPRroot.GenerateReport(sGPOPath, sPath, sOptions);
               Console.WriteLine("Health Check report generated successfully");
               Console.ReadKey();
           }

2. If you are using a script, modify the x.ConnectTo line.

   or

   If you are using a method, modify the oEXPRroot.ConnectTo line.

   For more information about obtaining the ConnectionString, see Section 5.2.1, Connecting to a GP Repository.

3. Modify the variables. To obtain the LDAP path of the GPO (“LDAP... DomainName”), use the ADSI Edit tool. If the ADSI Edit tool is not available, substitute the following information:

   DomainController

   Type the name of the primary domain controller of the domain. Provide the full computer name, which has the actual computer name along with the domain to which it belongs. You can find the full name on the Network Identification tab of the Property page of My Computer.

   GUID

   Type the GUID number that corresponds to the GPO you want to report on.

   DistinguishedDomainName

   Type the distinguished name format of the domain to which the GPO belongs.

   OutputFile

   Type the path and the name of the file for the output report.

   Options

   Type 1 to specify the Health Check report.

4. When you are finished, your script should look similar to the following example:

   REM ***********************************************************
   On Error Resume Next
   set x = CreateObject("GPExplorer.PolicyManager.1")
   x.ConnectTo ("DRIVER={ODBC Driver 13 for SQL Server};SERVER="<SQL Server Instance Name>";Trusted_Connection=Yes;DATABASE=GPO_REPOSITORY;")
   REM ***** GenerateReport(GPO LDAP path, output file path, options)
   x.GenerateReport "LDAP://devel-child.child-domain.com/CN={FA586CE5-9C2C-47BE-86AD-1618E183537D},CN=Policies,CN=System,DC=child-domain,DC=com","E:\GPO backups\Backup Scripts\Reports\HCReport.htm",1
   set x = nothing
   Wscript.Echo "Report Generation Completed"
   REM ***********************************************************

   or

   Your C# method should look similar to the following example:

   public static void GenerateHealthCheckReport()
           {
               string sGPOPath = "LDAP://MYDOMAIN.LAB/CN={04835D24-7FAC-4B7B-B677-419E598593B0},CN=Policies,CN=System,DC=MYDOMAIN,DC=LAB";
               string sPath = "C://Folder/HealthCheckReport.htm";
               long sOptions = 1;
               IfaExplorerRoot oEXPRroot = new PolicyManager();
               oEXPRroot.ConnectTo("Provider=SQLOLEDB.1;Integrated Security=SSPI;Initial Catalog=GPO_REPOSITORY;Data Source=GPA_SERVER;Use Procedure for Prepare=1;Auto Translate=True;Packet Size=4096;Workstation ID=GPA_SERVER;Use Encryption for Data=False;Tag with column collation when possible=False");
   oEXPRroot.GenerateReport(sGPOPath, sPath, sOptions);
               Console.WriteLine("Health Check Report generated successfully");
               Console.ReadKey();
           }

5. To generate reports of multiple GPOs, copy the x.GenerateReport line, for Visual Basic scripts, or the sGPOPath line, for C# methods, as many times as necessary, modifying ONLY the GUID for each GPO to include in the report.

6. Save the file with any suitable name, and an extension of .vbs for Visual Basic scripts, to the location of your choice (for example, HCReport.vbs), or compile the solution, then execute the executable build.