IIS Provider API

This document provides the details of the public Application Programming Interface (API) for the Internet Information Services (IIS) Provider included with the Microsoft Provisioning System (MPS) for . This document describes the various methods supported by the IIS Provider along with input parameters and return values. For IIS Provider methods, Extensible Markup Language (XML) requests are included as usage examples along with some typical XML responses from the provisioning system that are returned after provisioning tasks are completed.

Developers should use this API document as a reference when creating XML procedures, custom namespaces, or requests that initiate provisioning tasks to manipulate IIS functionality.

Overview

The IIS Provider supports IIS 6.0 and provides backward compatibility to IIS 5.0 with some limitations. The IIS Provider is not backward compatible with the IISSCOv50 provider. The IISSCOv50 provider is deprecated and new designs should use the IIS Provider instead.

The IIS Provider conforms to the design guidelines set forth in the MPF software development kit (SDK). Although NNTP, SMTP, and POP3 objects are supported in the IIS metabase, the creation and management of these components is not supported by the IIS Provider.

You can install the IIS Provider provided with Microsoft Solution for Hosted Messaging and Collaboration version 4.0 .

Purpose

The purpose of the IIS Provider is to provide the means of manipulating the IIS Metabase for IIS versions 5.0 and 6.0 and performing provisioning tasks such as:

Deleting the IIS path object.
Creating a Web or FTP site.
Setting properties that control the running status of a Web or File Transfer Protocol (FTP) site; or NNTP, SMTP, and POP3 services.
Creating a virtual directory for a Web or FTP site.
Creating an application pool.

COM Components

The IIS Provider uses Active Directory® Service Interfaces (ADSI) to bind to remote IIS servers for modifying their metabases. The following is a list of the COM objects used by the IIS Provider:

IADs - Property manipulation and general object binding.
IADsContainer - Creation and deletion of objects such as websites, virtual directories, and application pools.
IISBaseObject - Used to discover and control the inheritance of properties.
IADsClass - Used to discover what properties an object may have.
IADsServiceOperations - Used to start, stop, and pause Web and FTP sites.
IIsApplicationPool - Used to start, stop, and recycle application pools.

Error Codes

This IIS Provider does not return any provider-specific error codes. Instead, it returns the error code of the underlying object failure (such as a metabase object or COM object) along with an error description. This description is harvested by MPF using the GetErrorInfo method and is returned to the caller via standard MPF techniques.

Public Method	Description
IIS Provider::Create (WebSite)	Allows you to create a Web site on a specified server.
IIS Provider::Create (FTPSite)	Allows you to create an FTP site on a specified server.
IIS Provider::Delete	Deletes the object specified by the IIS path plus all of its sub-objects.
IIS Provider::SetProperties (ControlSite)	Allows you to control the running status of a Web site, FTP site, NNTP, SMTP, or POP3 service.
IIS Provider::Create (VirtualDirectory)	Allows you to create a virtual directory for a Web or FTP site.
IIS Provider::Create (AppPool)	Allows you to create an application pool.
IIS Provider::SetProperties (ControlAppPool)	Allows you to control the running status of an application pool.
IIS Provider::SetProperties	Sets one or more properties for a metabase key.
IIS Provider::GetProperties	Allows you to retrieve one or more properties for a metabase key.
IIS Provider::Export	Allows you to retrieve the key and all its children in metabase XML format.
IIS Provider::Import	Allows you to set the key and all its children using data from a previous Export command.

Applies To