Home > Articles > Operating Systems, Server > Microsoft Servers

Like this article? We recommend

Like this article? We recommend

IIS Administration Objects

Microsoft provides the IIS Admin Objects to make the task of programmatic administration easier. These objects are automation-enabled and are based on the ADSI. This means that any language that supports automation can access these objects and manipulate them. VBScript and JScript are both automation-enabled, and because both are included with IIS, you already have all the tools you need.

Overview

Using the IIS Admin Objects, you can develop an ASP page or any custom application and manipulate the metabase properties by accessing the correct objects.

Keeping in mind the structure of the metabase as described earlier in this chapter, you can use the IIS Admin Objects to manipulate and set the properties on a server-wide basis or on individual files or services. All you need to do is access the correct object by using the full path to that object starting with the root.

The IIS Admin Objects mirror the metabase object hierarchy, which you can review by looking at Figure 1. You will see how you can gain access to the required object by traversing the hierarchy.

ADSI

Active Directory Service Interfaces (ADSI) provides you a standard syntax for dealing with the IIS Admin Objects. Using this syntax, you can gain access to the necessary configuration data. As mentioned previously, the IIS HTML-based administration tool uses these objects to perform remote configuration.

The metabase path references the IIS Admin Objects. If you want to reference the second Web Server on the computer named websrvone, you would use the full ADSI path, called the AdsPath, like this: IIS://websrvone/W3SVC/2.

ADSI Objects

The IIS Admin Objects implement the IADs interface, which is defined by the ADSI standard. As a result, the following functionality is implemented:

  • A method of retrieving the namespace properties

  • A path to the schema definition of an object

  • Identification information, such as name and type of object

  • A caching system

  • A method of setting and retrieving properties for a specific node of the metabase

  • A way of retrieving the path for an object's parent

  • Binding information for uniquely identifying object instances in a directory tree

ADSI Container Objects

ADSI Container Objects are the IIS Admin Objects that can contain other objects by implementing the IADsContainer interface.

The IIS Admin Objects classed as container objects are the IISComputer and IISWebVirtualDir objects. IISComputer contains IISWebService and IISFtpService as the two objects directly below IISComputer. IISWebVirtualDir can contain an IISWebDirectory object, an IISWebVirtualDir object, and an IISWebFile object.

The IADsContainer interface enables the following procedures to be performed in relation to containers and their objects:

  • Create objects in a container

  • Delete objects from a container

  • Provide a count of the number of objects in a container

  • Access the objects in the container

  • Enumerate the objects

The Create, Delete, and Count methods and the GetObject and _NewEnum properties support these functions, respectively.

An example of how to use each method follows:

  • Create—Set newObj = Object(KeyType, Name)

    newObj
    is used to access the new object in the container.

    Object
    is the name of an IIS object that is normally returned by the GetObject method, as shown in the code example that follows.

    KeyType
    is the type of IIS Admin Object to create.

    Name
    is the name for the new object.

    Example:

    <%
    Dim WebSrvObject, SrvObject
    Set WebSrvObject = GetObject("IIS://celeron/W3SVC")
    Set SrvObject = WebSrvObject.Create("IISWebServer", "5")
    %>


    This code snippet will first return the name of the W3SVC object located on the computer named celeron and assign it to the WebSrvObject variable. The next line of code sets the SrvObject variable to be the newly created IISWebServer object number 5.

  • DeleteObject.Delete KeyType, Name

    Object
    is the IIS Admin Object returned by the GetObject method.

    KeyType
    is the type of IIS Admin Object to delete.

    Name
    is the name of the IIS Admin Object to delete.

    Example:

    <%
    Dim WebSrvObject
    Set WebSrvObject = GetObject("IIS://celeron/W3SVC")
    WebSrvObject.Delete "IISWebServer", "5"
    %>


    This code snippet will delete the object that was created with the Create method used earlier.

  • NOTE

    If the object that you are deleting is a part of an application, the AppDelete method will be called first to remove the application definition before the object is removed. Be sure that this is what you want to do before deleting the object.

  • Count—This is a property of the ADSI Container Object; it returns the number of objects in the container.

  • _NewEnum—This property will return an enumerator object that can be used by VBScript or JScript to retrieve the objects in the container using a For Each loop.

Administrative Tasks

As mentioned before, the metabase stores the configuration properties for IIS. By making use of the IIS Admin Objects, you can manipulate these properties to configure IIS, create new Web and FTP sites, assign permissions, and perform other configuration tasks.

The HTML-based administrative tool is a good example of the use of the IIS Admin Objects. This tool uses a Web browser interface for remotely administering IIS. You can use this tool to become familiar with the various tasks that can be accomplished with the IIS Admin Objects and the metabase properties.

You can create HTML-based applications that run in a Web browser to administer your IIS server in much the same way that IIS's HTML-based administration tool does.

Manipulating the Metabase

In order to gain access to the IIS Admin Objects in the metabase, you need to navigate a hierarchical structure using what is known as the AdsPath. The AdsPath uses a syntax that looks similar to a URL. The general syntax looks like IIS://[path], where path is used to indicate the directory path of the object you are trying to access.

An example of an AdsPath would be IIS://celeron/MSFTPSVC, which would provide access to the FTP service running on my server celeron. This can be considered the root object for the FTP service, and it contains all the other objects that are considered children or subobjects of this root object.

In order to work with the objects in code, you normally use the GetObject method to return the name of the object that you want to work with so that you can use this name in your code.

Listing 14.1  Sample Code for Returning ADSI Object Properties

<%@ LANGUAGE=VBSCript %>
<HTML>
<HEAD><TITLE>    </TITLE></HEAD>
<BODY>
<%
Dim WebSrvObject
Set WebSrvObject = GetObject("IIS://celeron/W3SVC")
%>
<B>Web Service Name</B>....<%= WebSrvObject.Name %> <BR>
<B>ADsPath</B>....<%= WebSrvObject.ADsPath %> <BR>
<B>Class</B>....<%= WebSrvObject.Class %> <BR>
<B>GUID</B>....<%= WebSrvObject.GUID %> <BR>
<B>Parent</B>....<%= WebSrvObject.Parent %> <BR>
<B>Schema</B>....<%= WebSrvObject.Schema %> <BR>
</BODY>
</HTML>

If you place this code into an .asp file and run it on your server, you will see a display similar to that shown in Figure 2.

Figure 2 Internet Explorer showing the six properties of the W3SVC ADSI Object.

As you can see, using the GetObject method returned the object necessary for me to access the properties for the W3SVC. This is a simple .asp file that merely displays the properties that are associated with the W3SVC object that was returned.

The first line of code declares a variable, WebSrvObject, that will be used to hold the object returned by the GetObject method. In this way, we can use the variable name to refer to the object when we access its properties instead of needing to use the full AdsPath every time we need a property.

In order to use the GetObject method or any .asp script that accesses the metabase on your Web server, you will need to access the .asp page using an administrative account. If you attempt to access the file without this, you will receive an error message stating that the server cannot open the page because permission has been denied for the GetObject method.

The easiest way around this is to assign the appropriate permissions to the InetPub directory. For example, I added the group Everyone to the users list in the Security settings for the InetPub directory and allowed full control of the directory. This does have one inherent security risk. If the server is a production server connected to the Internet, you can allow any user from the outside or inside to connect to the InetPub directory and run applications, modify or delete files, and even upload and run Trojan horse programs or viruses. If you decide to do this, try to set up on a test system first. When your scripts are working as you want them to, transfer them to a production server.

Alternatively, you can create a logon page that will require a user to provide a username and password to be authenticated on the server using the NTLM or basic authentication methods. This way, you are protecting your production server from being easily compromised. This will, however, create an extra step that you must go through in order to test your pages using the GetObject method.

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