IIS

https://learn.microsoft.com/en-us/iis/
Admin
IIS (Internet Information Services) is a flexible, secure, and manageable web server for Windows...
Tokens:3,117,575
Snippets:19,346
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### VBScript example to start a Web site

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/site-start-method

VBScript example that connects to the WMI WebAdministration namespace, retrieves a site named IISWebSite, and starts it. After calling Start, use the GetState method to check the site's status.

```vbs
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin= GetObject("winmgmts:root\WebAdministration")  
  
' Specify the Web site name.  
Set oSite= oWebAdmin.Get("Site.Name='IISWebSite'")  
  
' Start the Web site.  
oSite.Start  

```

--------------------------------

### Install and start Web Deploy with custom listen URL

Source: https://learn.microsoft.com/en-us/iis/publish/using-web-deploy/use-the-web-deployment-tool

Install Web Deploy with a custom listen URL and port using msiexec, then manually start the remote service. Ensure the configured port is open in the firewall.

```Console
msiexec /i <msi_filename> /passive ADDLOCAL=ALL LISTENURL=http://+:8080/MSDEPLOY2/

```

```Console
net start msdepsvc

```

--------------------------------

### Install IIS 7.0 default features with pkgmgr.exe

Source: https://learn.microsoft.com/en-us/iis/install/installing-iis-7/installing-iis-from-the-command-line

Installs only the default IIS 7.0 features. The entire block is one command. Setup takes 1 to 5 minutes; when the command prompt returns, IIS setup is complete.

```console
start /w pkgmgr /iu:IIS-WebServerRole;WAS-WindowsActivationService;WAS-ProcessModel;

WAS-NetFxEnvironment;WAS-ConfigurationAPI
```

--------------------------------

### Start DefaultAppPool using WMI

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/applicationpool-start-method

Example showing how to connect to the WebAdministration namespace and start the 'DefaultAppPool' application pool.

```vbs
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Specify the application pool.  
Set oAppPool = oWebAdmin.Get("ApplicationPool.Name='DefaultAppPool'")  
  
' Start the application pool.  
oAppPool.Start  
```

--------------------------------

### GET Trace Provider JSON Response

Source: https://learn.microsoft.com/en-us/iis-administration/api/request-tracing

Example JSON response for GET /api/webserver/http-request-tracing/providers/{provider-id}. Shows the structure of a trace provider, including its name, GUID, areas, and link to the parent request tracing configuration.

```json
{
    "name": "ASPNET",
    "id": "{provider-id}",
    "guid": "{aff081fe-0247-4275-9c4e-021f3dc1da35}",
    "areas": [
        "Infrastructure",
        "Module",
        "Page",
        "AppServices"
    ],
    "request_tracing": {
        "id": "{request-tracing-id}",
        "scope": "",
        "_links": {
            "self": {
                "href": "/api/webserver/http-request-tracing/{request-tracing-id}"
            }
        }
    }
}
```

--------------------------------

### Create a New Web Site Example

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/site-create-method

Example demonstrating how to connect to the WebAdministration namespace, define bindings, and invoke the static Create method to provision a new site.

```vbs
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Specify a name and physical path for the new Web site.  
SiteName = "SampleSite"  
PhysicalPath = "C:\inetpub\wwwroot"  
  
' Create a Bindings object by using the WMI SpawnInstance_ method.  
Set SiteBinding = oWebAdmin.Get("BindingElement").SpawnInstance_  
SiteBinding.BindingInformation = "*:80:www.SampleSite.com"  
SiteBinding.Protocol = "http"  
BindingsArray = array(SiteBinding)  
  
' Get the site object definition  
Set SiteDefinition = oWebAdmin.Get("Site")  
  
' Pass the required parameters to the Create method on the Site  
' definition to create the site.  
SiteDefinition.Create SiteName, BindingsArray, PhysicalPath  
```

--------------------------------

### Start WAS service

Source: https://learn.microsoft.com/en-us/iis/extensions/installing-application-request-routing-arr/install-application-request-routing

Starts the Windows Process Activation Service (WAS) after ARR installation is complete.

```console
net start was
```

--------------------------------

### Run first website from default configuration file

Source: https://learn.microsoft.com/en-us/iis/extensions/using-iis-express/running-iis-express-from-the-command-line

Runs the first website defined in the default configuration file. This is the simplest command.

```console
iisexpress

```

--------------------------------

### Start WMSVC service

Source: https://learn.microsoft.com/en-us/iis/extensions/installing-application-request-routing-arr/install-application-request-routing

Starts the Web Management Service (WMSVC) after ARR installation is complete.

```console
net start wmsvc
```

--------------------------------

### Get Cmdlet Usage Examples

Source: https://learn.microsoft.com/en-us/iis/manage/powershell/powershell-snap-in-using-the-task-based-cmdlets-of-the-iis-powershell-snap-in

Use the -example parameter to view specific usage examples for a cmdlet.

```PowerShell
get-help New-Website -example
```

--------------------------------

### Connect to the first FTP site via command line

Source: https://learn.microsoft.com/en-us/iis/publish/using-the-ftp-service/using-ftp-virtual-host-names-in-iis-7

Use the FTP command to initiate a connection to the site configured with the www.example.com virtual host name.

```text
FTP www.example.com
```

--------------------------------

### Site.Start

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/site-class

Starts an existing Web site.

```APIDOC
## Start

### Description
Starts an existing Web site.

### Method
Start

### Parameters
None documented.

### Response
No documented response.
```

--------------------------------

### CreateIISSite command example

Source: https://learn.microsoft.com/en-us/iis/web-hosting/configuring-components/powershell-scripts

Creates a Site with the specified name, physical path, pool name, and ID.

```console
CreateIISSite "DAP1Site1" "C:\Content\DAP1Site1" "DemoAppPool1" 1702121
```

--------------------------------

### Acquiring and Installing a Certificate

Source: https://learn.microsoft.com/en-us/iis/manage/powershell/powershell-snap-in-configuring-ssl-with-the-iis-powershell-snap-in

Part of the three-step SSL setup. This step covers acquiring and installing a certificate for the web-site.

```powershell
Acquiring certificates is a tricky business. The users of your web-site have to trust the certificate and that's why you have to get it from a trusted Certificate Authority. For testing purposes you can make your own certificate.
```

--------------------------------

### CreateIISApplicationOntoSite command example

Source: https://learn.microsoft.com/en-us/iis/web-hosting/configuring-components/powershell-scripts

Creates an Application on a site with the specified physical path, relative path, site name, and pool name.

```console
CreateIISApplicationOntoSite "C:\Content\DAP1Site1\App1" "/App1" "DAP1Site1" "DemoAppPool1"
```

--------------------------------

### Start a website with iisexpress.exe

Source: https://learn.microsoft.com/en-us/iis/extensions/introduction-to-iis-express/iis-80-express-readme

Use this command to launch a specific site from a custom configuration file.

```Console
iisexpress.exe /config:C:\Temp\IISExpress\config\ApplicationHost.config /site:www.fabrikam.com
```

--------------------------------

### VBScript example: Get HTTP errors section for default Web site

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/configuredobject-getsection-method

VBScript example that connects to the WMI WebAdministration namespace, gets the default Web site, retrieves the HttpErrorsSection using GetSection, and displays its array and non-array properties.

```vbs
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
' Get the default Web site.  
Set oSite = oWebAdmin.Get("Site.Name='Default Web Site'")  
  
' Get the HTTP errors section by using the GetSection method.  
oSite.GetSection "HttpErrorsSection", oSection  
  
' Display a heading.  
WScript.Echo "=============================="  
WScript.Echo "Http Errors Section Properties"  
WScript.Echo "=============================="  
  
' Display the HttpErrorsSection non-array properties.  
For Each vProp In oSection.Properties_  
    If (vProp.Name <> "HttpErrors") And _  
        (vProp.Name <> "SectionInformation") Then  
        WScript.Echo vProp.Name & ": " & vProp.Value  
    End If  
Next  
WScript.Echo   
  
' Display the HttpErrorsSection SectionInformation properties.  
WScript.Echo "HttpErrorsSection.SectionInformation"  
WScript.Echo "------------------------------------"  
For Each vProp In oSection.SectionInformation.Properties_  
    WScript.Echo vProp.Name & ": " & vProp.Value  
Next  
WScript.Echo  
  
' Display the contents of the HttpErrors array property.  
WScript.Echo "HttpErrorsSection.HttpErrors"  
WScript.Echo "----------------------------"  
For Each oHttpErrorElement In oSection.HttpErrors  
    For Each vProp In oHttpErrorElement.Properties_  
        WScript.Echo vProp.Name & ": " & vProp.Value  
    Next  
    WScript.Echo  
Next  
  
```

--------------------------------

### Start IIS Site

Source: https://learn.microsoft.com/en-us/iis/manage/powershell/powershell-snap-in-run-time-data

Start a site using Start-WebItem and verify the state change.

```PowerShell
PS IIS:\Sites> Start-WebItem DemoSite
PS IIS:\Sites> Get-WebItemState IIS:\sites\DemoSite
Started
```

--------------------------------

### Example: Set allowLocation for AnonymousAuthenticationSection

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/configurationsection-setallowlocation-method

Complete example that gets the WebAdministration namespace, retrieves the AnonymousAuthenticationSection, and sets the allowLocation attribute. Note: the example uses GetAllowLocation instead of SetAllowLocation.

```vbs
' Get the WebAdministration namespace.  
Set oWebAdmin = GetObject( _  
    "winmgmts:root\WebAdministration")  
  
' Get the AnonymousAuthenticationSection.  
Set oAnonAuth = oWebAdmin.Get( _  
    "AnonymousAuthenticationSection")  
  
' Set the allowLocation attribute.  
oAnonAuth.GetAllowLocation "false"  

```

--------------------------------

### GET /api/webserver/default-documents?scope=

Source: https://learn.microsoft.com/en-us/iis-administration/api/installing-features

Checks whether the default document feature is installed on the web server. A 200 OK response indicates the feature is installed, while a 404 Not Found response indicates it is not installed.

```APIDOC
## GET /api/webserver/default-documents?scope=

### Description
Checks whether the default document feature is installed on the web server. A 200 OK response indicates the feature is installed, while a 404 Not Found response indicates it is not installed.

### Method
GET

### Endpoint
/api/webserver/default-documents?scope=

### Parameters
#### Query Parameters
- **scope** (string) - Required - Specifies the scope of the request. An empty value targets the web server scope.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the feature.
- **enabled** (boolean) - Indicates whether the feature is enabled.
- **scope** (string) - The scope of the feature.
- **metadata** (object) - Metadata about the feature, including is_local, is_locked, override_mode, and override_mode_effective.
- **website** (null) - The associated website, if any.

#### Response Example
```json
{
    "id": "{id}",
    "enabled": "true",
    "scope": "",
    "metadata": {
        "is_local": "true",
        "is_locked": "false",
        "override_mode": "allow",
        "override_mode_effective": "allow"
    },
    "website": null
}
```

#### Error Response (404)
- **title** (string) - Error title.
- **detail** (string) - Error detail.
- **name** (string) - The name of the feature.
- **status** (integer) - HTTP status code.

#### Error Response Example
```json
{
    "title": "Not found",
    "detail": "IIS feature not installed",
    "name": "Default Document",
    "status": "404"
}
```
```

--------------------------------

### Run first website from custom configuration file

Source: https://learn.microsoft.com/en-us/iis/extensions/using-iis-express/running-iis-express-from-the-command-line

Runs the first website in a custom configuration file specified by the /config option.

```console
iisexpress /config:c:\myconfig\applicationhost.config

```

--------------------------------

### Manage Web Farms with Microsoft.Web.Farm

Source: https://learn.microsoft.com/en-us/iis/web-hosting/microsoft-web-farm-framework-20-for-iis-7/web-farm-framework-20-for-iis-code-sample

This example demonstrates creating a web farm, configuring server credentials, adding servers, and deleting a web farm. It requires a reference to Microsoft.Web.Farm.dll and must be executed on a server with the Web Farm Framework 2.0 installed.

```csharp
using System;
using System.Collections.Generic;
using System.Text;
using System.Threading;
using Microsoft.Web.Farm;
namespace WebFarmSample
{
    class Program
    {
        static void CreateWebFarm()
        {
            //WebFarmManager is the class that manages several web farms.
            WebFarmManager webFarmManager = new WebFarmManager();

            //Create a new WebFarm
            WebFarm myWebFarm = webFarmManager.WebFarms.CreateNewWebFarm("MyWebFarm");

            //Provide user name and password for the webfarm. Note that these credentials are
            //used for sync up and load balancing the farm. All the servers in the farms should
            //recognize the credentials.
            myWebFarm.AdminUserName = "Administrator";
            myWebFarm.AdminPassword = "MyPwd";

            //Optionally you can also specify how many number of servers must be online
            //at any given point of time and also how many servers could be stopped at any
            //given point of time.

            //myWebFarm.MinimumServers = 1;
            //myWebFarm.MaximumStoppedServers = 2;

            //This will enable the agent service automatically on the servers
            myWebFarm.AutoEnableAgent = true;

            //Now add a new server to the web farm
            Server srv1 = myWebFarm.Servers.CreateNewServer("MyServer1");

            //Make MyServer1 as Primary server. During the provisioning of application or platform
            //Primary server is used as the primary server from which the application or platforms
            //are provisioned.
            myWebFarm.PrimaryServer = srv1;

            //Add more servers. MyServer2 and MyServer3 acts as secondary servers
            //These two servers gets provisioned before loadbalancing.
            Server srv2 = myWebFarm.Servers.CreateNewServer("MyServer2");
            Server srv3 = myWebFarm.Servers.CreateNewServer("MyServer3");

            //The changes will take effect only after committing the changes.
            //This is a MUST call.
            webFarmManager.CommitChanges();
        }

        static void DeleteWebFarm()
        {
            //WebFarmManager is the class that manages several web farms.
            WebFarmManager webFarmManager = new WebFarmManager();

            //This will delete a web farm and all the connections to
            //the servers in the farm.
            webFarmManager.WebFarms.RemoveWebFarm("MyWebFarm");

            //The changes will take effect only after committing the changes.
            //This is a MUST call.
            webFarmManager.CommitChanges();
        }

        static void Main(string[] args)
        {
            //Create a web farm
            CreateWebFarm();

            //Wait till the users input.
            Console.WriteLine("Watch webfarm being created using your IIS Manager (inetmgr.exe)...");

            string answer = "N";
            Console.WriteLine("Delete Web Farm[Y/N]:");
            while(string.Equals(answer, "N", StringComparison.OrdinalIgnoreCase))
            {
                answer = Console.Read().ToString();
                Thread.Sleep(1000);
            }

            DeleteWebFarm();
        }
    }
}
```

--------------------------------

### Example: Setting allowDefinition for Anonymous Authentication

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/configurationsection-setallowdefinition-method

Complete example that gets the WebAdministration namespace, retrieves the AnonymousAuthenticationSection, and sets the AllowDefinition attribute to 'MachineToApplication'.

```vbs
' Get the WebAdministration namespace.  
Set oWebAdmin = GetObject( _  
    "winmgmts:root\WebAdministration")  
  
' Get the AnonymousAuthenticationSection.  
Set oAnonAuth = oWebAdmin.Get( _  
    "AnonymousAuthenticationSection")  
  
' Set the AllowDefinition attribute.  
oAnonAuth.SetAllowDefinition "MachineToApplication"  
  

```

--------------------------------

### Create a Virtual Directory Example

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/virtualdirectory-create-method

This example demonstrates how to connect to the WebAdministration namespace and create a virtual directory named MyVDir under the MyApp application on the default Web site.

```vbs
' Connect to the WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Define the parameters.  
strVDirPath = "/MyVDir"  
strAppPath = "/MyApp"  
strPhysicalPath = "C:\inetpub\MyVDirFiles"  
strSiteName = "Default Web Site"  
  
' Create the new virtual directory.  
oWebAdmin.Get("VirtualDirectory").Create _  
    strVDirPath, strAppPath, strPhysicalPath, strSiteName  
```

--------------------------------

### VBScript example: Stop DefaultAppPool

Source: https://learn.microsoft.com/en-us/iis/wmi-provider/applicationpool-stop-method

VBScript example that connects to the WMI WebAdministration namespace, gets the ApplicationPool instance named 'DefaultAppPool', and stops it.

```vbs
' Connect to the WMI WebAdministration namespace.  
Set oWebAdmin = GetObject("winmgmts:root\WebAdministration")  
  
' Specify the application pool.  
Set oAppPool = oWebAdmin.Get("ApplicationPool.Name='DefaultAppPool'")  
  
' Stop the application pool.  
oAppPool.Stop  

```

--------------------------------

### GET /api/websites - List of websites response

Source: https://learn.microsoft.com/en-us/iis-administration/api/crud

Example JSON response for a GET request to /api/websites, returning a list of website resources. Each website includes name, id, status, and _links. Note: the example contains a missing comma after the second object, which is a syntax error in the source.

```json
{
    "websites": [
        {
            "name": "Default Web Site",
            "id": "{id}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id}"
                }
            }
        },
        {
            "name": "My Site",
            "id": "{id_1}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_1}"
                }
            }
        }
        {
            "name": "docs",
            "id": "{id_2}",
            "status": "started",
            "_links": {
                "self": {
                    "href": "/api/webserver/websites/{id_2}"
                }
            }
        }
    ]
}
```

--------------------------------

### Install .NET Framework and Full IIS 7.5

Source: https://learn.microsoft.com/en-us/iis/install/installing-iis-7/install-and-configure-iis-on-server-core

Use this command to install the .NET Framework along with the full set of IIS 7.5 feature packages on Server Core.

```Console
CMD /C START /w PKGMGR.EXE /l:log.etw /iu:IIS-WebServerRole;IIS-WebServer;IIS-CommonHttpFeatures;IIS-StaticContent;IIS-DefaultDocument;IIS-DirectoryBrowsing;IIS-HttpErrors;IIS-HttpRedirect;IIS-ApplicationDevelopment;IIS-ASP;IIS-CGI;IIS-ISAPIExtensions;IIS-ISAPIFilter;IIS-ServerSideIncludes;IIS-HealthAndDiagnostics;IIS-HttpLogging;IIS-LoggingLibraries;IIS-RequestMonitor;IIS-HttpTracing;IIS-CustomLogging;IIS-ODBCLogging;IIS-Security;IIS-BasicAuthentication;IIS-WindowsAuthentication;IIS-DigestAuthentication;IIS-ClientCertificateMappingAuthentication;IIS-IISCertificateMappingAuthentication;IIS-URLAuthorization;IIS-RequestFiltering;IIS-IPSecurity;IIS-Performance;IIS-HttpCompressionStatic;IIS-HttpCompressionDynamic;IIS-WebServerManagementTools;IIS-ManagementScriptingTools;IIS-IIS6ManagementCompatibility;IIS-Metabase;IIS-WMICompatibility;IIS-LegacyScripts;WAS-WindowsActivationService;WAS-ProcessModel;IIS-FTPServer;IIS-FTPSvc;IIS-FTPExtensibility;IIS-WebDAV;IIS-ASPNET;IIS-NetFxExtensibility;WAS-NetFxEnvironment;WAS-ConfigurationAPI;IIS-ManagementService;MicrosoftWindowsPowerShell;NetFx2-ServerCore;NetFx2-ServerCore-WOW64
```

--------------------------------

### GET /api/certificates/stores response

Source: https://learn.microsoft.com/en-us/iis-administration/api/certificates

Example response body for a GET request to /api/certificates/stores. Lists the available certificate stores, each with a name, id, and optional _links.

```json
{
    "stores": [
        {
            "name": "My",
            "id": "{store-id}",
            "_links": {
                "self": {
                    "href": "/api/certificates/stores/{store-id}"
                }
            }
        },
        {
            "name": "WebHosting",
            "id": "{store-id}"
            // _links omitted
        },
        {
            "name": "IIS Central Certificate Store",
            "id": "{store-id}"
            // _links omitted
        }
    ]
}
```
Tokens:
Raw