Home > Articles > Programming > Visual Basic

Putting It All Together: Your First WMI/ADSI Script

Visual Basic Scripting (VBScript) and Windows Management Instrumentation (WMI) are vital tools for systems administrators grappling with the increasing complexity of Windows technologies. Ready to put them to use? In this sample book chapter, you'll learn the complete design process for an entirely new script.
This chapter is from the book

IN THIS CHAPTER

It's time to leverage what you've learned about ADSI and WMI scripting. In this chapter, I'll walk you through the entire design and creation process for a new script. In addition to demonstrating a useful new purpose for WMI and ADSI, this chapter will help strengthen your script design skills.

By now, you should have a good idea of what WMI and ADSI can do for you. In this chapter, I'll walk you through the complete design process for an entirely new script. This time, I'll use both WMI and ADSI in the same script. The script's job will be to check in on every computer in an Active Directory or NT domain and query some information about its operating systems. I want the script to output this information to a text file on a file server. The information I want to collect includes operating system version, service pack level, number of processors in the machine, maximum physical memory in the machine, and so forth. This is a useful way to quickly inventory a network and see what machines might need to be upgraded before deploying a new application, or to see what machines don't have the latest service pack applied.

Designing the Script

My script is a reasonably complex undertaking, so it helps to break it down into manageable tasks. I need the script to do three things:

  1. Query a list of computers from the domain.

  2. Query information from each computer.

  3. Write information out to a text file.

The last bit is probably the easiest. I can use the FileSystemObject to open a text file, write information to it, and then close the text file. Something like the following would work.

Dim oFSO, oFile
Set oFSO = CreateObject("Scripting.FileSystemObject")
Set oFile = oFSO.CreateTextFile("output.txt")
oFile.Write "Information"
oFile.Close

For more information on using the FileSystemObject, refer to Chapter 12.

Querying a list of computers from the domain shouldn't be too hard, either. If I want the script to work with both NT and Active Directory domains, I need to use the WinNT ADSI provider, because only that provider works with both domains. I can query all of the objects in the domain, and then use an If…Then construct to work with only the computer objects. Code such as the following should do the trick.

Dim oDomain
Set oDomain = GetObject("WinNT://" & sDomain)
Dim oObject, sComputerName, sDetails
For Each oObject In oDomain

 'is this object a computer?
 If oObject.Class = "Computer" Then

  'yes – do something with it

 End If
Next

For more information on querying domains by using ADSI, see Chapter 14, and see "Querying Domain Information" in Chapter 15.

Pulling the operating system (OS) information is tougher. WMI seems like the way to go, but WMI has about three gazillion classes. Which one do I need? Fortunately, I have a way to cheat. My primary script editor is Sapien Technology's PrimalScript 3.0, and it includes a WMI Script Wizard.

A trial version of PrimalScript 3.0 is included on the CD that accompanies this book.

Running the wizard displays the dialog box shown in Figure 20.1. The left side of the dialog box shows a list of every WMI class that my computer knows about. Scrolling through the list, I find that there's a class named Win32_OperatingSystem. That seems like a good place to start.

20fig01.gifFigure 20.1. The WMI Wizard starts with a list of all available WMI classes.

Clicking the Win32_OperatingSystem class changes the dialog box to look like the one shown in Figure 20.2. Here, the wizard has filled in a sample script capable of querying information from the selected class. I see things like service pack level and operating system version, so this is probably the class I want. The wizard offers an Insert button to immediately insert this code into my script, and a Copy button to copy the code to the clipboard. Listing 20.1 shows the complete wizard code.

20fig02.jpgFigure 20.2. The wizard generates sample code to query the selected class.

I've added line breaks and line continuation characters (_) to Listing 20.1 so that it will fit in this book.

Listing 20.1. WizardCode.vbs. This code queries the Win32_OperatingSystem class and outputs all of the class' attributes and their values.

On Error Resume Next
Dim strComputer
Dim objWMIService
Dim colItems

strComputer = "."
Set objWMIService = GetObject("winmgmts:\\" & _
 strComputer & "\root\cimv2")
Set colItems = objWMIService.ExecQuery( _
 "Select * from Win32_OperatingSystem",,48)
For Each objItem in colItems
      WScript.Echo "BootDevice: " & objItem.BootDevice
      WScript.Echo "BuildNumber: " & objItem.BuildNumber
      WScript.Echo "BuildType: " & objItem.BuildType
      WScript.Echo "Caption: " & objItem.Caption
      WScript.Echo "CodeSet: " & objItem.CodeSet
      WScript.Echo "CountryCode: " & objItem.CountryCode
      WScript.Echo "CreationClassName: " & objItem.CreationClassName
      WScript.Echo "CSCreationClassName: " & _
  objItem.CSCreationClassName
      WScript.Echo "CSDVersion: " & objItem.CSDVersion
      WScript.Echo "CSName: " & objItem.CSName
      WScript.Echo "CurrentTimeZone: " & objItem.CurrentTimeZone
      WScript.Echo "Debug: " & objItem.Debug
      WScript.Echo "Description: " & objItem.Description
      WScript.Echo "Distributed: " & objItem.Distributed
      WScript.Echo "EncryptionLevel: " & objItem.EncryptionLevel
      WScript.Echo "ForegroundApplicationBoost: " & _
  objItem.ForegroundApplicationBoost
      WScript.Echo "FreePhysicalMemory: " & _
  objItem.FreePhysicalMemory
      WScript.Echo "FreeSpaceInPagingFiles: " & _
  objItem.FreeSpaceInPagingFiles
      WScript.Echo "FreeVirtualMemory: " & objItem.FreeVirtualMemory
      WScript.Echo "InstallDate: " & objItem.InstallDate
      WScript.Echo "LargeSystemCache: " & objItem.LargeSystemCache
      WScript.Echo "LastBootUpTime: " & objItem.LastBootUpTime
      WScript.Echo "LocalDateTime: " & objItem.LocalDateTime
      WScript.Echo "Locale: " & objItem.Locale
      WScript.Echo "Manufacturer: " & objItem.Manufacturer
      WScript.Echo "MaxNumberOfProcesses: " & objItem.MaxNumberOfProcesses
      WScript.Echo "MaxProcessMemorySize: " & objItem.MaxProcessMemorySize
      WScript.Echo "Name: " & objItem.Name
      WScript.Echo "NumberOfLicensedUsers: " & objItem.NumberOfLicensedUsers
      WScript.Echo "NumberOfProcesses: " & objItem.NumberOfProcesses
      WScript.Echo "NumberOfUsers: " & objItem.NumberOfUsers
      WScript.Echo "Organization: " & objItem.Organization
      WScript.Echo "OSLanguage: " & objItem.OSLanguage
      WScript.Echo "OSProductSuite: " & objItem.OSProductSuite
      WScript.Echo "OSType: " & objItem.OSType
      WScript.Echo "OtherTypeDescription: " & objItem.OtherTypeDescription
      WScript.Echo "PlusProductID: " & objItem.PlusProductID
      WScript.Echo "PlusVersionNumber: " & objItem.PlusVersionNumber
      WScript.Echo "Primary: " & objItem.Primary
      WScript.Echo "ProductType: " & objItem.ProductType
      WScript.Echo "QuantumLength: " & objItem.QuantumLength
      WScript.Echo "QuantumType: " & objItem.QuantumType
      WScript.Echo "RegisteredUser: " & objItem.RegisteredUser
      WScript.Echo "SerialNumber: " & objItem.SerialNumber
      WScript.Echo "ServicePackMajorVersion: " & _
objItem.ServicePackMajorVersion
      WScript.Echo "ServicePackMinorVersion: " & _
  objItem.ServicePackMinorVersion
      WScript.Echo "SizeStoredInPagingFiles: " & _
  objItem.SizeStoredInPagingFiles
      WScript.Echo "Status: " & objItem.Status
      WScript.Echo "SuiteMask: " & objItem.SuiteMask
      WScript.Echo "SystemDevice: " & objItem.SystemDevice
      WScript.Echo "SystemDirectory: " & objItem.SystemDirectory
      WScript.Echo "SystemDrive: " & objItem.SystemDrive
      WScript.Echo "TotalSwapSpaceSize: " & _
  objItem.TotalSwapSpaceSize
      WScript.Echo "TotalVirtualMemorySize: " & _
  objItem.TotalVirtualMemorySize
      WScript.Echo "TotalVisibleMemorySize: " & _
  objItem.TotalVisibleMemorySize
      WScript.Echo "Version: " & objItem.Version
      WScript.Echo "WindowsDirectory: " & objItem.WindowsDirectory
Next

The wizard's code pulls more information than I want, and it's displaying the information in message boxes, rather than writing them to a file, but the code makes a great place to start. I can easily modify it to meet my needs.

The script is designed! I identified the three major tasks that the script needs to be able to complete, and I've created some prototype code that can be adapted to the script's exact requirements. In short, I now know how to do everything I need; I just need to rearrange it and customize it.

What, No Wizard?

If you're not using PrimalScript, there are some other tools you can use to make WMI scripting easier. In Chapter 18, for example, I introduced Microsoft's Scriptomatic tool, which performs a similar function to the PrimalScript WMI Wizard. You can also dive into the WMI documentation in the MSDN Library (http://msdn.microsoft.com/library), which documents each WMI class and includes some scripting examples.

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