Home > Articles > Home & Office Computing > Microsoft Windows Server

Scripting Using IADSTools

  • Print
  • + Share This
In the final installment of our seven-part series on AD scripting, we will look at the functionality provided by a dynamic link library installed by the Windows 2000 Support Tools.

In the final installment of our seven-part series on AD scripting, we will look at the functionality provided by a dynamic link library installed by the Windows 2000 Support Tools.

Scripting Using IADSTools

by Jim Hudson

This article is derived from Special Edition Using Active Directory, by Jim Hudson and Sean Fullerton (Que Publishing, November 2000).

iadstools

If you install the Support Tools from the \support\tools folder of the Windows 2000 CD and then look in \program files\support tools on your local hard drive you will find, among other things, two very interesting files. They are iadstools.dll and iadstools.doc. The DLL hosts the functionality exposed by another Support Tool, replmon.exe, the Active Directory Replication Monitor.

This one DLL exposes an enormous amount of functionality. In this section on Active Directory scripting, we are going to use iadstoools.dll to build a troubleshooting tool for Group Policy and an Active Server Page to list troubleshooting information about replication.

Like the previous section, this is hardly an attempt to exhaustively document the capabilities of this COM object, but simply to give a glimpse of its power and use. The iadstools.doc file is a very detailed look at the properties and methods of the iadstools COM object.

NOTE

The previous section on ADSI assumed only that we were logged on at the console of a Windows 2000 computer as a user with sufficient Active Directory credentials to perform the task. For these scripts to work, iadstools.dll must be registered. This is done automatically when the support tools are installed, or manually by copying the DLL and executing regsvr32 iadstools.dll.

Checking Group Policy Versions

The code in this section checks the version numbers for the Group Policy container and Group Policy template. The container is the information about the Group Policy in Active Directory, and the template is the filesystem objects that actually do the work of a Group Policy. Because we use AD replication to replicate the container, and the File Replication Service to replicate the template, it is possible for these to be out of sync. If that happens, Group Policy can be applied somewhat irregularly. This tool simply identifies any Group Policy objects for a given container and looks to see if the version numbers match. If they do, all is well and the script exits with a success message. If there are Group Policies that are out of sync, the script identifies them by name and returns the respective version numbers.

Listing 1

'instantiate the object
set dcf = createobject("IADsTools.DCFunctions")

'set up arguments and variables
set oArgs = wscript.arguments 
Dim numGpos
Dim ctr 
dim flag

'get number of group policies for container
numGpos = dcf.GetGPOs(CStr(oArgs(0)), CStr(oArgs(1)), 0)

'iterate through group polices
For ctr = 1 To numGpos

'compare version numbers
  if dcf.GPOSysVolVersion(ctr) <> dcf.GPOVersion(ctr) then
    
    'if they don't match echo version status and set flag
wscript.echo dcf.gponame(ctr) & " has a gpoversion of " & dcf.gpoversion(ctr) & " and a sysvol version of " & dcf.gposysvolversion(ctr)
        flag=1
  end if 
Next

'echo success
if flag=0 then wscript.echo "all gpos are in sync"

NOTE

Pay very close attention to wrapping on this script also. Every command needs to be on its own line, regardless of length.

'instantiate the object

Before we can use the properties and methods of iadstools, we must instantiate the object. The createobject function uses the programmatic identifier (iadstools.dcfunctions) to find the GUID of the object in the registry, load it into memory, and get an instance of the object.

'set up arguments and variables

The arguments will again allow us to pass command-line arguments or parameters to the code. Explicitly declaring the variables is not necessary in VBScript, but it is a good habit. There is no reason to set the datatype for the variables because VBScript supports only variant datatypes.

'get number of group policies for container

The getgpos function returns the number of gpos for the container as a long datatype and also enumerates the Group Policies. This allows us to use other methods that require getgpos be run first, before they can be used. Notice that we are using the cstr function to convert the arguments to string datatypes before we pass them to the getgpos function. This is required if we are using VBScript. The arguments are the name of the organizational unit and the LDAP DN of the domain.

'iterate through group polices

This line simply allows us to run through the Group Policies one a time.

'compare version numbers

Here we are checking the version of the Group Policy template (sysvolversion) versus the container (gpoversion).

'if they don't match echo version status and set flag

Here we simply use the properties of the Group Policy to echo the name and respective versions, if they do not match. Because the flag has not explicitly had its value set it is by default 0. Setting it to 1 even once in this loop will cause the success message not to show.

'echo success

If all of the version numbers match, then we can exit with a success message. We use wscript.echo in this example, but could also use writeline to send the output to the command line. Listing 2 shows the command-line use of the script, and Figure 1 shows the success message box.

Listing 2

C:\>gpocheck sales dc=fis,dc=local

Figure 1

Success Messagebox

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020