C# - IIS: List Websites



A while ago the company I work for started migrating some of their client websites, to a new (more robust) server.

What we needed (to save time etc) was the ability to retrieve/perform certain IIS actions programmatically using C#.

Now there is numerous ways to achieve this, one method we're going to look at involves ADSI (Active Directory Service Interfaces) - you will find a few seriously handy classes under the System.DirectoryServices namespace.

These classes provide us with a simple way to access Active Directory service providers e.g. LDAP, NDS, WinNT and IIS.

In this post (as the title suggests) the aim is to retrieve a list of websites on an IIS server, along with their physical paths and site status etc.

The idea is to retrieve the data displayed in the following rows (see image below) - visible in our IIS Management tool:



Firstly create some class for storing the retrieved details from IIS, like this:
 
public class Website
{
    public Int32 Identity
    {
        get;
        set;
    }
 
    public String Name
    {
        get;
        set;
    }
 
    public String PhysicalPath
    {
        get;
        set;
    }
 
    public ServerState Status
    {
        get;
        set;
    }
}
 

We're going to create an enum that lists possible states the websites can/might be in.
 
public enum ServerState
{
    Starting = 1,
    Started = 2,
    Stopping = 3,
    Stopped = 4,
    Pausing = 5,
    Paused = 6,
    Continuing = 7
}
 

Next we need to connect to the IIS WWW publishing service (W3SVC) using the DirectoryEntry class.
 
public static void Main()
{
	foreach (Website site in GetSites("IIS://localhost/W3SVC"))
	{
		Console.WriteLine(String.Concat
		(
			site.Name, " , ", 
			site.Identity, " , ", 
			site.Status, " , ", 
			site.PhysicalPath
		));
	}
}
 
static IEnumerable<Website> GetSites(String Path)
{
    DirectoryEntry IIsEntities = new DirectoryEntry(Path);
 
    foreach (DirectoryEntry IIsEntity in IIsEntities.Children)
    {
        if (IIsEntity.SchemaClassName == "IIsWebServer")
        {
            yield return new Website
            (
                Convert.ToInt32(IIsEntity.Name),
                IIsEntity.Properties["ServerComment"].Value.ToString(),
                GetPath(IIsEntity),
                (ServerState)IIsEntity.Properties["ServerState"].Value
            );
        }
    }
}
 
static String GetPath(DirectoryEntry IIsWebServer)
{
    foreach (DirectoryEntry IIsEntity in IIsWebServer.Children)
    {
        if (IIsEntity.SchemaClassName == "IIsWebVirtualDir")
            return IIsEntity.Properties["Path"].Value.ToString();
    }
    return null;
}
 
// Alternatively we can rewrite the preceding snippet using a linq statement
/*static IEnumerable<Website> GetSites(String Path)
{
    DirectoryEntry IIsEntities = new DirectoryEntry(Path);
 
    return (from s in IIsEntities.Children.OfType<DirectoryEntry>()
            where s.SchemaClassName == "IIsWebServer"
            select new Website
            {
                Identity = Convert.ToInt32(s.Name),
                Name = s.Properties["ServerComment"].Value.ToString(),
                PhysicalPath = (from p in s.Children.OfType<DirectoryEntry>()
                                where p.SchemaClassName == "IIsWebVirtualDir"
                                select p.Properties["Path"].Value.ToString()).Single(),
                Status = (ServerState)s.Properties["ServerState"].Value
            });
 
}*/
 

Once you run the snippet (if you've got the appropriate rights), you will notice something like the following window (if all goes according to plan)



Chances are (especially if you're using IIS 7) that you got an exception along the lines of "Unhandled Exception: System.Runtime.InteropServices.COMException (0x80005000): Unknown error (0x80005000)".

Which means its likely that you don't have the IIS 6 Management Compatibility installed (programs and features).



But surely there must be an IIS 7 alternative - why would we need to install compatibility tools etc for IIS 6 in order to manage IIS 7?

Microsoft did indeed provide an IIS 7 alternative, you'll need to include a reference to the Microsoft.Web.Administration assembly which is located within your inetsrv folder under system32.

Using the following snippet we're able to retrieve the websites via the ServerManager class.
 
ServerManager IIS = new ServerManager();
 
foreach (Site site in IIS.Sites)
{
    Console.WriteLine(String.Concat
    (
        site.Name, " , ",
        site.Id, " , ",
        site.State, " , ",
        site.Applications["/"].VirtualDirectories[0].PhysicalPath
    ));
}
 

And thats it, this should give you a basic starting point, if you're looking at other alternatives WMI seems to be another option worth looking into - which also seems to be an IIS 6.0 based solution.







Comments



Needs rights

Hi Hernaldo The user/account accessing iis needs to have rights in order to manage websites.


remote don't work

if i use a remote access: System.DirectoryServices.DirectoryEntry iisServer; iisServer = new System.DirectoryServices.DirectoryEntry("IIS://remote-server/W3SVC/1"); System.DirectoryServices.DirectoryEntry rootFolder = iisServer.Children.Find("Root", "IIsWebVirtualDir"); //exception here its give error: An unhandled exception of type 'System.Runtime.InteropServices.COMException' occurred in System.DirectoryServices.dll Additional information: Access is denied.


Helpful

Nice! and thanks for sharing..


Thanks

This Code is working, the linq statement is working for me thanks nikhilsreeni sry to tell, Security Code in this forum is very bad


Dankie! Hierdie het my baie gehelp


Super Post

Awesome share dude ! Keep it coming. Thanks n regards, Yasser Shaikh


content not working can u send me the source code for mail .I would list out all iis site


Post comment

Name *
Email
Title
Body *
Security Code
*
* Required fields

Latest Posts

MS SQL: Parameter Sniffing


2012-05-21 22:38:48

Be the best stalker you can be


2011-12-13 22:33:54

Top 5 posts

Moving items between listboxes in ASP.net/PHP example


Move items between two listboxes in ASP.net(C#, VB.NET) and PHP
2008-06-12 17:07:43

Simple WYSIWYG Editor


Creating a WYSIWYG textbox for your website is actually quite simple.
2007-02-01 12:00:00

C# YouTube : Google API


Post on how to integrate with YouTube using the Google Data API
2011-03-12 08:37:51

Populate a TreeView Control C#


Populate a TreeView control in a windows application.
2009-08-27 16:01:03

Cross Browser Issues: Firefox Word Wrapping


Firefox word wrapping issues
2008-06-09 09:51:21