Home > Articles > Operating Systems, Server > Microsoft Servers

Using ADSI scripting

📄 Contents

  1. Using ADSI scripting
  2. Summary
In the fifth installment of our seven-part series on scripting in Windows 2000 Active Directory, we will use ADSI to create users and populate properties of their object.

In the fifth installment of our seven-part series on scripting in Windows 2000 Active Directory, we will use ADSI to create users and populate properties of their object.

Using ADSI scripting

by Jim Hudson

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

Active Directory Services Interface (ADSI) is a COM-based interface to the power of the Windows 2000 Active Directory. Because we are using the exact same COM DLLs with ADSI scripts that we use with the Active Directory Users and Computers tool, there is practically no limit to the functionality exposed with ADSI.

In this section, we are going to look at ADSI scripting with the goal of automating some mundane administrator tasks.

NOTE

We can use the ADSI COM interface from both Visual Basic and Visual C++. However, in this book, we are going to use a subset of Visual Basic, VBScript. We will use VBScript in both WSH and ASP.

Windows Script Host

WSH is a scripting host that supports both VBScript and Jscript. Using WSH, you can write logon and logoff scripts for users, write startup and shutdown scripts for computers, and access COM DLLs. It is the capability to touch COM that makes WSH perfect for our needs in this chapter. Also, you may or may not own Visual Basic, but if you own Windows 2000, you have a copy of WSH already installed by default on every Windows 2000 computer in your enterprise. You can create these scripts in Notepad, save them with a .vbs extension, and run them from the command line by executing the filename.

Creating a User

In our example, we are going to create a user. This is a fairly straightforward process that demonstrates the basics of much of ADSI programming. In Listing 1, we see a simple script to create a user in a specified context and assign a password. We will step through this example to view and apply basic concepts of ADSI scripts.

Listing 1

`set error handling
on error resume next

`enable command line arguments
set objargs=wscript.arguments
username=objargs(0)
contextpath=objargs(1)
pwd=objargs(2)

`bind to LDAP server
set context=getobject("LDAP://" & contextpath)

`set up the creation and schema type
set usr=context.create("user", "CN=" & username)

`set mandatory attributes for user object
usr.put "samaccountname",username
usr.put "useraccountcontrol","0020"

`commit the change
usr.setinfo

`error handling and feedback
if err.number=0 then 
        usr.setpassword(pwd)
        wscript.echo "created user: cn=" & username & "," & contextpath
else
        wscript.echo err.number, err.description
end if 

`set error handling

The first two sections are not really ADSI programming, but they simply the code necessary to use command-line parameters with our scripts and an error-handling directive. The on error resume next line allows our script to continue if it encounters errors. This allows our error-handling code to run because otherwise the script would simply exit with a VBScript error. Because some scripts can encounter real errors and still accomplish work, this is critical.

NOTE

Be careful about setting error handling when debugging your code. If you have on error resume next set, your code may run, fail, and never return an error. You can turn this command on and off selectively during the debugging process by commenting it out with a single quote. Make sure that it is a single quote, and not an apostrophe. An apostrophe will cause the VBScript runtime to terminate with an error.

`enable command line arguments

Although we could use input boxes with our scripts, because this is designed to be a command-line tool, we will use the arguments property of the wscript object. This will allow us to execute the command shown in Listing 2 and to create a user named Mike in the Sales organizational unit of the fis.local domain; we also will set his password to qwerty.

Listing 2

C:\>createuser mike ou=sales,dc=fis,dc=local qwerty

`bind to LDAP server

The first event of virtually any ADSI operation is binding to AD. There are several ways to do this, including methods that work with NT domains and Novell NDS, but here we will focus on binding to an LDAP server on whatever domain controller the DNS service returns to us. The contextpath variable in Listing 1 is our LDAP path to the container that we want to create our user in. The command in Listing 2 has set this to the Sales OU of fis.local.

`set up the creation and schema type

The create method prepares AD to create an object of a given type and name. The type must be a valid class in the schema. In our example, we have used class user, but the code could be easily modified to create an instance of class computer or group.

`set mandatory attributes for user object

There are scores of attributes that can be set on a user object, and because the schema is extensible, we could add more. The only two that are required in this scenario are cn and samaccountname. Because we set the cn in our createobject call, we have to set only one other attribute, samaccountname with the put method. However, because the default behavior is for ADSI to create the user with a disabled account, the second put method sets the useraccountcontrol to 0020, which enables the account.

`commit the change

Although we have used the create method, the addition is not persisted to AD until we call setinfo. Then our object is written to the database.

NOTE

If you are curious about what is happening under the hood with any of these examples, run the code snippets on a workstation or member server, and use Network Monitor to capture the packets during code execution. You will quickly see that mainly what we are doing is using COM and VBScript to manipulate LDAP. Because LDAP is responsible for finding, adding, changing and deleting objects in AD, and because it sends many of its commands in clear text over the network, there is much that can be learned here.

`error handling and feedback

This last section of code simply checks to see that there were no errors and then sets the password to the third command-line parameter. It also echoes a message box with the information that the object was created. If there is an error, the error number is sent in a message box also. The successful output message from the command executed in Listing 2 is shown in Figure 1.

Figure 1

WSH messagebox

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