Microsoft.Web.Administration 사용 방법

서론

IIS 7은 XML 구성 설정 파일을 완벽하게 조작할 수 있고 서버 개체들에 대한 편리한 접근이 가능한, 관리되는 코드로 작성된 포괄적인 관리 응용 프로그램 프로그래밍 인터페이스(API)를 제공해줍니다. 본문에서는 서버의 구성 설정을 수정하고 서버 개체들을 관리하기 위해 새로운 관리 API를 사용하는 방법을 소개해드리고자 합니다.

IIS 7에는 XML 구성 설정 파일들의 완벽한 조작을 통해 구성 설정을 편집할 수 있게 해주고 서버와 서버의 속성 및 상태를 관리하기 위한 편리한 개체들을 제공해주는, 웹 서버를 위한 새로운 관리 API인 Microsoft.Web.Administration이 포함되어 있습니다. 구성 설정 편집 측면에서 볼 때, 이 API는 IIS 구성 설정 파일 계층이나 특정 구성 설정 파일들의 구성 설정 속성들에 대한 프로그래밍적인 접근 방법을 제공해줍니다. 그리고, 개체 관리 측면에서는 서버의 직접적인 관리를 위한 일련의 최상위 관리 개체들을 제공해줍니다. (예: 사이트, 응용 프로그램 풀, 작업자 프로세스 등)

이런 관리 클래스들은 Microsoft.Web.Administration 네임스페이스에 포함되어 있습니다. 이 클래스들은 구성 설정 섹션들과 편리한 개체들에 접근할 수 있는 구성 설정의 특성들에 대응하는 속성들과 (가상 디렉터리의 경로 등) 특정 개체를 대상으로 동작을 수행하는 메서드들을 (응용 프로그램 풀 재생 등) 갖고 있는 약한 유형의 인터페이스를 제공합니다.

전제조건

1. 반드시 IIS가 머신에 설치되어 있어야 합니다. 가령, 인터넷 익스플로러의 주소창에 http://localhost/라고 입력했을 때, "환영합니다." 페이지가 나타나야 합니다. 만약 IIS가 설치되어 있지 않다면 설치 방법에 관한 문서를 참고하여 IIS를 설치합니다.
2. 머신에 대한 관리자 권한을 갖고 있는지 확인하십시오. 만약, 내장된 Administrator 계정 이외의 계정으로 로그온했다면, 비록 해당 계정이 머신의 로컬 Administrators 그룹에 추가되어 있는 계정이라도 기본적으로 관리자 권한을 갖고 있지 않은 것으로 간주됩니다. (이는 LUA라는 Longhorn에서 제공되는 새로운 보안 관련 기능으로, 본문에서 다루고자 하는 범위를 벗어나는 주제입니다.) 내장된 Administrator 계정으로 로그온하거나 "runas" 명령줄 도구를 사용해서 명시적으로 응용 프로그램을 내장된 Administrator 계정의 권한으로 실행하십시오. 가령, notepad.exe를 실행하려면 "runas /user:administrator notepad.exe" 명령어를 실행하면 됩니다. 그러면, Administrator 계정의 비밀번호를 입력할 수 있는 대화 상자가 나타납니다. 또는, "runas /user:administrator cmd.exe" 명령어를 실행해서 미리 관리자 권한을 가진 명령 프롬프트를 실행하는 것도 또 다른 방법입니다. 이 명령 프롬프트에서 실행되는 응용 프로그램들은 모두 관리자 권한으로 실행되며, 명렴 프롬프트에서 "runas" 구문을 사용할 필요가 없습니다.
3. 반드시 마스터 구성 설정 파일을 백업하십시오. 단지 applicationHost.config 파일을 다른 이름으로 복사해 놓기만 하더라도, 나중에 원상태로 복구가 가능합니다. 이 applicationHost.config 파일은 %windir%\system32\inetsrv\config 디렉터리에서 찾을 수 있습니다. 이 작업을 처리하기 위해서는 방금 설명한 관리자 권한이 필요하다는 점에 주의하십시오.
4. 본격적인 작업을 시작하기 전에 시스템이 "깨끗한 상태"가 되도록 하십시오. 이를 위해서, 지금까지 이뤄진 applicationHost.config 파일에 대한 모든 변경 사항들을 원래대로 돌려 놓으십시오. (만약, VPC 이미지를 사용중이라면 가장 손쉬운 방법은 변경된 상태를 저장하지 않고 이미지를 재시작하는 것입니다.)
5. Microsoft.Web.Administration 라이브러리를 사용해서 코딩이 가능하도록, 이 라이브러리를 콘솔 응용 프로그램 프로젝트에 참조 추가해야 합니다. 비주얼 스튜디오에서는 솔루션 탐색기에서 프로젝트를 마우스 오른쪽 버튼으로 클릭한 다음 "참조 추가" 메뉴를 클릭하여 손쉽게 작업을 처리할 수 있습니다. MSWEBADMIN 라이브러리는 %WINDIR%\System32\InetSrv 디렉터리에서 찾을 수 있습니다.
6. 문제점이 발생하면 빨리 대응이 가능하도록 가급적 인터넷 익스플로러의 "HTTP 오류 메시지 표시" 기능을 (도구 > 인터넷 옵션 > 고급) 꺼놓는 것을 권장합니다.
7. 주의 : .html 파일에서 텍스트를 복사하는 경우, 숨겨진 문자들까지 함께 복사됩니다. 따라서, 복사한 텍스트를 비주얼 스튜디오 같은 편집기, 또는 명령 프롬프트에 붙여 넣으면 겉으로 보기에는 정상적으로 복사가 된 것처럼 보이지만, 숨겨진 문자들을 포함하고 있기 때문에 적절하게 동작하지 않습니다. 결과적으로 문제점을 발견해 내기가 매우 어려워집니다. 이 문제를 해결하기 위한 가장 좋은 방법은 복사한 텍스트를 먼저 노트패드에 붙여 넣은 뒤에 노트패드에 복사된 텍스트를 다시 한 번 복사하는 것입니다. 이렇게 하면 숨겨진 문자들이 제거됩니다. 만약 텍스트가 짧다면, 복사해서 붙여 넣는 대신 직접 타이핑해서 입력하는 것이 더 간단할 수도 있습니다.

새로운 사이트 생성

다음 코드는 "Racing Cars Site"라는 이름의 사이트를 루트 응용 프로그램 및 루트 가상 디렉터리와 함께 생성합니다. 이 사이트는 8080 포트를 통해 HTTP 프로토콜을 사용하도록 설정되며 물리적인 경로는 d:\inetput\wwwroot\racing 디렉터리로 정의됩니다.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;

namespace MSWebAdmin_Application
{
    class Program
    {
        static void Main(string[] args)
        {
            ServerManager serverManager = new ServerManager();
            Site mySite = serverManager.Sites.Add("Racing Cars Site", d:\\inetpub\\wwwroot\racing",  8080);
            mySite.ServerAutoStart = true;

            serverManager.CommitChanges();
         }
    }
}

ServerManager 클래스는 강력한 형식으로 사용 가능한 속성들과 메서드들을 갖고 있는 편리한 서버 개체들을 포함하고 있는 팩터리 클래스입니다. 이 클래스는 서버 관리를 위한 가장 중요한 진입점입니다. 물론 서버 관리는 다른 비효율적인 방법을 통해서도 (구성 설정 XML에 직접 접근하거나 상태 APIs를 호출하는 것 같은) 이뤄질 수도 있습니다만, 이런 개체들을 사용하는 것이 서버 관리를 위한 보다 효과적인 방법입니다. ServerManager 클래스를 이용해서 사용 가능한 가장 보편적인 개체들의 집합으로는 응용 프로그램, 가상 디렉터리, 사이트, 작업자 프로세스, 그리고 응용 프로그램 도메인 등이 있습니다.

ServerManager serverManager = new ServerManager();

Sites 컬렉션을 사용하면 특정 사이트의 속성과 응용 프로그램에 접근할 수 있습니다. 이 컬렉션에는 시스템에 사이트를 추가하거나 시스템에 존재하는 모든 사이트들의 갯수를 얻는 등의 작업을 처리하기 위한 메서드들도 존재합니다. Add 메서드는 사이트의 이름과 루트 가상 디렉터리 경로, 그리고 정수형의 포트 번호를 인자로 받습니다. 그리고, 그 실행 결과인 사이트 개체의 인스턴스를 mySite 개체 변수에 리턴하고, 이 개체의 프로퍼티들을 직접 수정해서 새로 생성된 사이트를 대상으로 작업을 수행할 수 있습니다.

Site mySite = serverManager.Sites.Add("Racing Cars Site", d:\\inetpub\\wwwroot\racing",  8080);

이런 편리한 개체들은 속성의 수정을 간단하게 만들어줍니다. 특정 XML 특성이나 항목들의 의미를 모르더라도 mySite 개체의 속성들에 접근해서 사이트의 자동 시작 속성을 직접 "true"로 설정하는 등과 같은 작업이 가능합니다.

mySite.ServerAutoStart = true;

또는, 사이트 개체의 인스턴스를 명시적으로 생성하지 않고 자동 시작 속성을 수정할 수 있는 다른 방법도 존재하는데, 이 경우 사이트 정보를 페치하여 임시 개체를 생성하고 직접 그 속성을 수정하게 됩니다. 관리 개체는 인덱서의 개념을 사용해서 전체 개체 집합의 목록을 가져오기 위한 고비용의 호출을 발생시키지 않으면서도 이름이나 인덱스와 같은 키를 통해서 특정 개체를 조회합니다. 다음의 코드에서는 이름을 사용해서 특정 개체를 얻고, 해당 개체에 대한 작업을 수행하고 있습니다.

serverManager.Sites["Racing Cars Site"].ServerAutoStart = true;

변경 사항을 반영하기 위해서, CommitChanges 메서드를 실행하면 작업 결과가 구성 설정 파일로 직렬화되고, 변경된 사항이 존재하면 디스크에 기록됩니다.

serverManager.CommitChanges();

지금까지 살펴본 코드를 실행시키면 applicationHost.config 파일의 <sites> 섹션에 다음과 같은 결과를 생성하게 됩니다. 구성 설정 XML을 항목이나 특성 수준에서 직접 조작하기 보다는, 웹 서버를 관리하기 위해 서버 관리 개체들이 제공해주는 보다 편리한 방법을 사용하십시오.

<site name="Racing Cars Site" id="2" serverAutoStart="true"> 
  <application path="/"> 
    <virtualDirectory path="/" physicalPath="d:\inetpub\wwwroot\racing" /> 
  </application> 
  <bindings> 
    <binding protocol="http" bindingInformation=":8080:" /> 
  </bindings> 
</site> 

새로운 응용 프로그램 풀 생성

다음 코드는 기존의 "Racing Cars Site"의 이름을 변경하고 물리적인 경로를 d:\inetput\wwwroot\racing로 수정합니다. 그리고, 새로운 응용 프로그램 풀을 생성하고 몇 가지 속성들을 설정한 다음, 사이트가 이 응용 프로그램 풀을 사용하도록 설정하고 최종적으로는 응용 프로그램 풀을 재생시킵니다.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;

namespace MSWebAdmin_Application
{
    class Program
    {
        static void Main(string[] args)
        {
            ServerManager serverManager = new ServerManager();
            Site site = serverManager.Sites["Racing Cars Site"];
            site.Name = "Racing Site";
            site.Applications[0].VirtualDirectories[0].PhysicalPath = "d:\\racing";
            serverManager.ApplicationPools.Add("RacingApplicationPool");
            serverManager.Sites["Racing Site"].Applications[0].ApplicationPoolName = "RacingApplicationPool";
            ApplicationPool apppool = serverManager.ApplicationPools["RacingApplicationPool"];
            apppool.ManagedPipelineMode = ManagedPipelineMode.ISAPI;

            serverManager.CommitChanges();

            apppool.Recycle();
        }
    }
} 

사이트를 페치하기 위해 인덱싱을 하는 대신, 사이트 개체 인스턴스를 생성하고 그 참조를 설정할 수도 있습니다. 일단 참조가 설정되면, 해당 개체의 속성을 참조하거나 메서드를 호출할 수 있고, 이 경우에는 사이트 이름이 그 작업 대상으로서 직접 속성을 사용해서 이름을 변경하고 있습니다.

Site site = serverManager.Sites["Racing Cars Site"];
site.Name = "Racing Site";

다음은 인덱서를 사용하는 또 다른 사례로 루트 응용 프로그램을 얻은 다음 다시 루트 디렉터리를 얻고 그 물리적인 경로를 설정합니다.

site.Applications[0].VirtualDirectories[0].PhysicalPath = "d:\\racing";

사이트 개체 외에도 상태 메서드와 데이터뿐만 아니라 구성 설정 속성들을 편리하게 얻거나 설정할 수 있는 방법을 제공해주는 응용 프로그램 풀 개체를 얻습니다. 다음 코드에서는 새로운 응용 프로그램 풀이 생성되고 그 즉시 사이트가 그 응용 프로그램 풀에 추가됩니다.

serverManager.ApplicationPools.Add("RacingApplicationPool");
serverManager.Sites["Racing Site"].Applications[0].ApplicationPoolName = "RacingApplicationPool";

여러분들은 서버 관리자 사이트 개체를 사용하는 경우와 마찮가지로, 서버 관리자 응용 프로그램 풀 개체를 사용해서 응용 프로그램 풀을 생성하고 참조를 설정할 수 있습니다. 물론 속성들을 얻거나 설정할 수도 있으며 메서드를 호출할 수도 있습니다. 업데이트 호출을 통해 응용 프로그램 풀 구성 설정 데이터가 파일로 직렬화되고 나면, 여러분들은 바로 재생 메서드를 실행시킬 수 있습니다. 이 재생 작업은 필수적인 것은 아니며, 해당 응용 프로그램 풀은 이제 막 생성되었으므로 그다지 필요한 작업은 아닙니다. 그러나, 여기에서는 방금 생성된 개체에 대한 작업은 반드시 그 개체가 디스크로 직렬화되고, 서버가 해당 구성 설정을 페치할 수 있어야만 재생 작업이 실행 가능하다는 점을 보여주고 있습니다.

ApplicationPool apppool = serverManager.ApplicationPools["RacingApplicationPool"];
apppool.ManagedPipelineMode = ManagedPipelineMode.ISAPI;

serverManager.CommitChanges();

apppool.Recycle();

지금까지 살펴본 코드를 실행하면 applicationHost.config 파일의 <sites> 섹션에 다음과 같은 결과를 생성하게 됩니다. 구성 설정 XML을 항목이나 특성 수준에서 직접 조작하기 보다는, 웹 서버를 관리하기 위해 서버 관리 개체들이 제공해주는 보다 편리한 방법을 사용하십시오.

<site name="Racing Site" id="2" serverAutoStart="true"> 
  <application path="/"> 
    <virtualDirectory path="/" physicalPath="d:\racing" /> 
  </application> 
  <bindings> 
    <binding protocol="http" bindingInformation=":8080:" /> 
  </bindings> 
</site> 

또한, <applicationPools> 섹션에는 다음과 같은 항목이 추가됩니다.

<add name="RacingApplicationPool" managedPipelineMode="ISAPI" /> 

사이트 루트 web.config 구성 설정

다음의 코드는 "Default Web Site" 사이트의 <defaultDocument> 섹션의 "enabled" 특성값을 false로 설정합니다.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;

namespace MSWebAdmin_Application
{
    class Program
    {
        static void Main(string[] args)
        {
            ServerManager serverManager = new ServerManager();
            Configuration config = serverManager.GetWebConfiguration("Default Web Site");
            ConfigurationSection section = config.GetSection("system.webServer/defaultDocument");
            ConfigurationAttribute enabled = section.GetAttribute("enabled");
            enabled.Value = true;

            serverManager.CommitChanges();
        }
    }
}

Configuration 클래스는 시스템의 구성 설정 섹션들에 대한 접근을 제공해주는 클래스입니다. 구성 설정을 가져오기 위해 제공되는 다양한 메서드들을 호출해서 applicationHost.config, web.config, administration.config 또는 임의의 다른 구성 설정 파일들에 접근할 수 있습니다. 특히, GetWebConfiguration 메서드를 호출하면 지정한 사이트의 (이 경우에는 Default Web Site) 특정 경로에 대한 (이 경우에는 root) web.config 파일을 얻을 수 있습니다.

Configuration config = serverManager.GetWebConfiguration("Default Web Site");

일단 web.config 파일을 얻고 나면 (파일이 존재하지 않으면 새로 생성됩니다) 섹션을 가져오기 위한 호출이 생성됩니다. 이번 예제 코드에서는 <defaultDocument> 섹션을 비활성화하기 위해 찾고 있습니다. 만약, web.config 파일이 존재하지 않거나, 존재하기는 하지만 파일에 <defaultDocument> 섹션이 명시적으로 설정되어 있지 않다고 하더라도, 여전히 사이트 수준에서 실질적인 구성 설정으로 작용합니다. 이 섹션은 계층적으로 상속되며 재정의 가능한 구성 설정이기 때문입니다.

ConfigurationSection section = config.GetSection("system.webServer/defaultDocument");

섹션 개체의 메서드를 호출해서 enabled 특성을 개체로 가져오고, 이 개체의 Value 속성을 통해서 그 값을 설정할 수 있습니다. 그런 다음, 서버 관리자 개체의 CommitChanges 메서드를 호출하면 변경 사항들이 직렬화되어 디스크에 저장되고, 즉시 서버로 반영됩니다. 만약, 해당 시점에 구성 설정 개체 인스턴스가 여러 개 존재하고 있다면, 서버 관리자 개체의 CommitChanges 메서드 호출은 모든 인스턴스의 변경 사항들을 디스크로 저장하게 됩니다.

ConfigurationAttribute enabled = section.GetAttribute("enabled");
enabled.Value = true;

serverManager.CommitChanges();

또는 인덱서를 사용해서 섹션에서 특성 정보를 읽고 쓸 수도 있습니다. 다음 코드 라인은 먼저 섹션 개체를 얻은 다음, enabled 특성의 값을 설정할 때 사용 가능합니다.

section["enabled"] = true;

결과적으로 지정한 사이트의 web.config 파일에는 해당 구성 설정이 반영됩니다.

사이트 구성 설정을 applicationHost.config에 설정하기

다음 코드는 "Default Web Site" 사이트의 <defaultDocument> 섹션의 "enabled" 특성값을 false로 설정합니다.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.Web.Administration;
    
namespace MSWebAdmin_Application
{
    class Program
    {
        static void Main(string[] args)
        {
            ServerManager serverManager = new ServerManager();
            Configuration config = serverManager.GetApplicationHostConfiguration();
            ConfigurationSection section = config.GetSection("system.webServer/defaultDocument", 
                                                             "Default Web Site");
            ConfigurationAttribute enabled = section.GetAttribute("enabled");
            enabled.Value = false;

            serverManager.CommitChanges();
        }
    }
}

이 코드는 직전의 작업 내용과 사실상 정확하게 같은 작업을 수행하는데, 유일한 차이점은 구성 설정 관리자가 applicationHost.config 파일을 가져오기 위해서 GetApplicationHostconfiguration 메서드를 호출한다는 점 뿐입니다. 섹션을 가져오기 위해 메서드를 호출할 때, 읽고 쓰기 위한 섹션과 해당 섹션의 위치 경로도 함께 지정한다는 점에 주의하십시오.

Configuration config = serverManager.GetApplicationHostConfiguration();

결과적으로 applicationHost.config 파일에는 location 태그를 통해 지정된 사이트에 대한 구성 설정이 반영됩니다.