IISAdministration Module

https://learn.microsoft.com/en-us/powershell/module/iisadministration/
Admin
IISAdministration Module is a PowerShell module that provides cmdlets for managing and configuring...
Tokens:53,056
Snippets:389
Trust Score:10
Update:7 months ago
Show doc for...
Tokens:
Raw
### Start an IIS web site using PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iissite?view=windowsserver2016-ps

Demonstrates how to start a specific IIS website by providing its name to the Start-IISSite cmdlet. This command requires the IISAdministration module to be loaded.

```powershell
Start-IISSite -Name "Default Web Site"
```

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

### Get All Bindings for an IIS Site - PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissitebinding?view=windowsserver2022-ps

This example shows how to retrieve all binding configurations for a given IIS website. It queries the 'Default Web Site' and lists the protocol, binding information, and SSL flags for each binding.

```powershell
Get-IISSiteBinding "Default Web Site"
```

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

### Start-IISSite

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iissite?view=windowsserver2025-ps

Starts an existing IIS website.

```APIDOC
## Start-IISSite

### Description
Starts an existing site on the Internet Information Services (IIS) server.

### Method
POST

### Endpoint
/IISAdministration/Start-IISSite

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **Name** (String) - Required - The name of the IIS web site to start.
- **Passthru** (SwitchParameter) - Optional - Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

### Request Example
```json
{
  "Name": "Default Web Site",
  "Passthru": false
}
```

### Response
#### Success Response (200)
- **Status** (String) - Indicates the success or failure of the operation.
- **Message** (String) - Provides details about the operation's outcome.

#### Response Example
```json
{
  "Status": "Success",
  "Message": "The website 'Default Web Site' has been started successfully."
}
```

### Error Handling
- **400 Bad Request**: Returned if the site name is invalid or the site does not exist.
- **401 Unauthorized**: Returned if the user does not have the necessary permissions to start the site.
- **500 Internal Server Error**: Returned if an unexpected error occurs on the server.
```

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

### Get IIS Configuration Section Example (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigsection?view=windowsserver2019-ps

Demonstrates how to retrieve a specific configuration section object for the 'system.applicationHost/sites' path. This is a common starting point for managing IIS site configurations.

```powershell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"

```

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

### Create IIS Site Bindings

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissitebinding?view=windowsserver2022-ps

Examples demonstrating how to add HTTP and HTTPS bindings to an IIS website. These examples cover basic port configuration, secure certificate assignment, and advanced SSL flag settings.

```PowerShell
# Create a new HTTP binding
New-IISSiteBinding -Name "TestSite" -BindingInformation "*:8080:" -Protocol http

# Create a new HTTPS binding
New-IISSiteBinding -Name "TestSite" -BindingInformation "*:443:" -CertificateThumbPrint "D043B153FCEFD5011B9C28E186A60B9F13103363" -CertStoreLocation "Cert:\LocalMachine\Webhosting" -Protocol https

# Create a new HTTPS binding with SNI and CentralCertStore flags
New-IISSiteBinding -Name "TestSite" "*:443:foo.com" -Protocol https -SslFlag "Sni, CentralCertStore"
```

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

### Get IIS Configuration Element for a Website (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigelement?view=windowsserver2016-ps

This example demonstrates how to retrieve a specific configuration element, 'limits', for the 'Default Web Site' in IIS. It first obtains the site collection, then the specific site element, and finally the 'limits' element, before querying an attribute within it. This process involves chaining multiple IISAdministration cmdlets.

```powershell
PS C:\> $ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
PS C:\> $SitesCollection = Get-IISConfigCollection -ConfigElement $ConfigSection
PS C:\> $Site = Get-IISConfigCollectionElement -ConfigCollection $SitesCollection -ConfigAttribute @{"name" = "Default Web Site"}
PS C:\> $Elem = Get-IISConfigElement -ConfigElement $Site -ChildElementName "limits"
PS C:\> Get-IISConfigAttributeValue -ConfigElement $Elem -AttributeName "MaxUrlSegments"
```

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

### Retrieve IIS Configuration Element Example

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigelement?view=windowsserver2025-ps

Demonstrates how to navigate the IIS configuration hierarchy to retrieve the 'limits' element for the 'Default Web Site' and access a specific attribute value.

```powershell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
$SitesCollection = Get-IISConfigCollection -ConfigElement $ConfigSection
$Site = Get-IISConfigCollectionElement -ConfigCollection $SitesCollection -ConfigAttribute @{"name" = "Default Web Site"}
$Elem = Get-IISConfigElement -ConfigElement $Site -ChildElementName "limits"
Get-IISConfigAttributeValue -ConfigElement $Elem -AttributeName "MaxUrlSegments"
```

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

### Get Specific IIS Site Binding - PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissitebinding?view=windowsserver2022-ps

This example demonstrates how to get specific binding information for an IIS website. It targets the 'Default Web Site' and a particular binding identified by '*:80:'.

```powershell
Get-IISSiteBinding "Default Web Site" "*:80:"
```

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

### Export IIS Configuration and Keys using PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/export-iisconfiguration?view=windowsserver2019-ps

Demonstrates how to export IIS configurations using the Export-IISConfiguration cmdlet. Examples include creating secure strings for encryption passwords and performing exports with or without key encryption.

```PowerShell
$KeyEncryptionPassword = ConvertTo-SecureString -AsPlainText -String "SecurePa$$w0rd" -Force
#Automation scenarios
$KeyEncryptionPassword = Read-Host -AsSecureString
#UI scenarios
Export-IISConfiguration -PhysicalPath "C:\export" -KeyEncryptionPassword $keyEncryptionPassword
Export-IISConfiguration -PhysicalPath "C:\export" -DontExportKeys -Force
```

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

### Set-IISCentralCertProviderCredential Syntax and Usage

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/set-iiscentralcertprovidercredential?view=windowsserver2019-ps

Demonstrates the syntax for the Set-IISCentralCertProviderCredential cmdlet and provides an example of how to update the certificate store user account. The command prompts the user for a password upon execution.

```PowerShell
Set-IISCentralCertProviderCredential
    [-UserName] <String>
    [<CommonParameters>]
```

```PowerShell
Set-IISCentralCertProviderCredential -UserName "IISCertificateAdmin"
```

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

### Get All IIS Sites (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissite?view=windowsserver2025-ps

This snippet shows how to retrieve configuration information for all IIS websites on the server. By calling the Get-IISSite cmdlet without any parameters, it returns a list of all configured websites, including their names, IDs, states, physical paths, and bindings.

```powershell
Get-IISSite
```

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

### Get-IISConfigSection Usage Examples

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigsection?view=windowsserver2022-ps

Demonstrates various ways to use Get-IISConfigSection, including retrieving specific sections, querying collection attributes, and modifying global configuration settings like application pools and default documents.

```powershell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
```

```powershell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
Get-IISConfigCollection $configSection | Get-IISConfigCollectionElement -ConfigAttribute @{"Name"="Default Web Site"} | Get-IISConfigAttributeValue -AttributeName "State"
```

```powershell
Get-IISConfigSection -SectionPath "system.webServer/defaultDocument" | Get-IISConfigCollection -CollectionName "files" | New-IISConfigCollectionElement  -ConfigAttribute @{"Value" = "MyDefDoc.htm"}
```

```powershell
Start-IISCommitDelay
$ConfigSectionCollection = Get-IISConfigSection -SectionPath "system.applicationHost/applicationPools" | Get-IISConfigCollection
New-IISConfigCollectionElement -ConfigCollection $configSectionCollection -ConfigAttribute @{"name"="MyNewSiteAppPool"; "autoStart"=$true; "managedPipelineMode"="Integrated" }
Stop-IISCommitDelay
```

```powershell
$collection = Get-IISConfigSection -SectionPath "appSettings" -Clr 2.0
```

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

### Get All IIS Site Bindings - PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissitebinding?view=windowsserver2025-ps

Retrieves all binding configurations for a specified IIS website. This command uses the 'Name' parameter to identify the website and returns all associated protocol and binding information.

```PowerShell
Get-IISSiteBinding -Name "Default Web Site"
```

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

### Enable IIS Shared Configuration with PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/enable-iissharedconfig?view=windowsserver2019-ps

Demonstrates how to enable shared configuration in IIS using the Enable-IISSharedConfig cmdlet. Includes examples for handling secure strings for passwords in both automated and interactive user scenarios.

```PowerShell
$KeyEncryptionPassword = ConvertTo-SecureString -AsPlainText -String "SecurePa$$w0rd" -Force
$KeyEncryptionPassword = Read-Host -AsSecureString
$Password = Read-Host -AsSecureString
Enable-IISSharedConfig -PhysicalPath "C:\export" -KeyEncryptionPassword $KeyEncryptionPassword -UserName "administrator" -Password $Password
```

```PowerShell
Enable-IISSharedConfig -PhysicalPath "C:\export" -DontCopyRemoteKeys
```

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

### Commit IIS configuration changes using Stop-IISCommitDelay

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/stop-iiscommitdelay?view=windowsserver2019-ps

This example demonstrates how to commit all pending IIS configuration changes by setting the Commit parameter to True. This ensures that changes made since the last Start-IISCommitDelay call are persisted.

```powershell
Stop-IISCommitDelay -Commit $True
```

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

### Get IIS Site Information (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissite?view=windowsserver2025-ps

This snippet demonstrates how to retrieve configuration information for a specific IIS website by its name. It utilizes the Get-IISSite cmdlet and expects the website name as a string argument. The output is an object containing details about the specified site.

```powershell
Get-IISSite "Default Web Site"
```

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

### Start-IISCommitDelay Syntax and Usage

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iiscommitdelay?view=windowsserver2022-ps

Demonstrates the basic syntax and usage of the Start-IISCommitDelay cmdlet to initiate a delay in IIS configuration commits.

```powershell
Start-IISCommitDelay
```

```powershell
PS C:\> Start-IISCommitDelay
```

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

### Get IIS Configuration Element's Default Collection (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigcollection?view=windowsserver2022-ps

Retrieves a configuration element from an IIS configuration section and then gets its default collection. This example shows how to get the default collection of the 'files' element within the 'system.webServer/defaultDocument' section.

```powershell
Get-IISConfigSection -SectionPath "system.webServer/defaultDocument" | Get-IISConfigElement -ChildElementName "files" | Get-IISConfigCollection
```

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

### Get IIS Configuration Collection (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigcollection?view=windowsserver2022-ps

Retrieves a configuration collection from an IIS configuration section or element. This example demonstrates getting the 'files' collection from the 'system.webServer/defaultDocument' section.

```powershell
Get-IISConfigSection -SectionPath "system.webServer/defaultDocument" | Get-IISConfigCollection -CollectionName "files"
```

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

### Start-IISCommitDelay Syntax and Usage

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iiscommitdelay?view=windowsserver2019-ps

This snippet demonstrates the syntax and basic execution of the Start-IISCommitDelay cmdlet. It is used to instruct the IIS configuration system to hold changes in memory until explicitly committed.

```PowerShell
Start-IISCommitDelay
```

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

### Get IIS Application Pool Information (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisapppool?view=windowsserver2019-ps

Retrieves configuration and status information for IIS Application Pools. This cmdlet can fetch details for specific pools by name or for all pools on the server. It requires the IISAdministration Module to be installed.

```powershell
Get-IISAppPool

```

```powershell
Get-IISAppPool -Name "DefaultAppPool","NewAppPool"

```

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

### Get IIS Configuration Attribute Value

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigattributevalue?view=windowsserver2022-ps

Demonstrates how to retrieve specific configuration attributes from IIS elements. The examples show piping site objects or configuration sections into the cmdlet to extract values like 'MaxUrlSegments' or 'ScriptErrorMessage'.

```powershell
Get-IISSite "Default Web Site" | Get-IISConfigElement -ChildElementName "limits" | Get-IISConfigAttributeValue -AttributeName "MaxUrlSegments"
```

```powershell
Get-IISConfigSection "system.webServer/asp" | Get-IISConfigAttributeValue -AttributeName "ScriptErrorMessage"
```

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

### New-IISSite

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration?view=windowsserver2019-ps

Creates a new IIS Website on the server.

```APIDOC
## POST New-IISSite

### Description
Creates a new IIS Website with the specified parameters.

### Method
POST

### Endpoint
New-IISSite

### Parameters
#### Request Body
- **Name** (string) - Required - The name of the new site.
- **PhysicalPath** (string) - Required - The local file system path for the site content.
- **BindingInformation** (string) - Required - The binding information (e.g., *:80:).

### Request Example
New-IISSite -Name "MyNewSite" -PhysicalPath "C:\inetpub\wwwroot\mysite" -BindingInformation "*:8080:"

### Response
#### Success Response (200)
- **Status** (string) - Confirmation of site creation.

#### Response Example
{
  "Status": "Success",
  "SiteName": "MyNewSite"
}
```

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

### Get IIS configuration attribute values

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigattributevalue?view=windowsserver2016-ps

Demonstrates how to retrieve specific configuration attributes from IIS sites and sections using the Get-IISConfigAttributeValue cmdlet. These examples show how to pipe configuration elements into the cmdlet to extract values like 'MaxUrlSegments' or 'ScriptErrorMessage'.

```PowerShell
Get-IISSite "Default Web Site" | Get-IISConfigElement -ChildElementName "limits" | Get-IISConfigAttributeValue -AttributeName "MaxUrlSegments"

Get-IISConfigSection "system.webServer/asp" | Get-IISConfigAttributeValue -AttributeName "ScriptErrorMessage"
```

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

### Start-IISSite Cmdlet

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iissite?view=windowsserver2016-ps

The Start-IISSite cmdlet is used to initiate an existing site on an Internet Information Services (IIS) server.

```APIDOC
## Start-IISSite

### Description
The Start-IISSite cmdlet starts an existing site on the Internet Information Services (IIS) server.

### Method
PowerShell Cmdlet

### Endpoint
N/A (PowerShell Module: IISAdministration)

### Parameters
#### Path Parameters
- **Name** (String) - Required - Specifies the name of the IIS web site.

#### Query Parameters
- **Passthru** (SwitchParameter) - Optional - Returns an object representing the item with which you are working.

### Request Example
Start-IISSite -Name "Default Web Site"

### Response
#### Success Response (200)
- **Site** (Object) - Returns a Site object if -Passthru is specified.

#### Response Example
{ "SiteName": "Default Web Site", "Status": "Started" }
```

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

### Start-IISCommitDelay

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/start-iiscommitdelay?view=windowsserver2019-ps

Instructs the IIS configuration system to delay the commitment of changes. Changes are delayed until the Stop-IISCommitDelay cmdlet is executed.

```APIDOC
## Start-IISCommitDelay

### Description
The **Start-IISCommitDelay** cmdlet instructs the Internet Information Services (IIS) configuration system to delay the commitment of changes. The commitment of changes is delayed until the **Stop-IISCommitDelay** cmdlet is executed.

### Method
POST

### Endpoint
/websites/learn_microsoft_en-us_powershell_module_iisadministration/Start-IISCommitDelay

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```
Start-IISCommitDelay
```

### Response
#### Success Response (200)
Indicates that the commit delay has been successfully started.

#### Response Example
```json
{
  "message": "Commit delay started"
}
```
```

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

### Get IIS Website Runtime State (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigsection?view=windowsserver2025-ps

Fetches the runtime state of a specific IIS website, such as the 'Default Web Site'. This involves getting the site's configuration section, then its collection, and finally retrieving the 'State' attribute.

```powershell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
Get-IISConfigCollection $configSection | Get-IISConfigCollectionElement -ConfigAttribute @{"Name"="Default Web Site"} | Get-IISConfigAttributeValue -AttributeName "State"
```

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

### Create IIS website and set application pool - PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissite?view=windowsserver2025-ps

This PowerShell script creates a new IIS website named 'TestSite' and then assigns a custom application pool named 'TestSiteAppPool' to its default application. It utilizes Start-IISCommitDelay and Stop-IISCommitDelay to manage configuration changes.

```powershell
Start-IISCommitDelay
$TestSite = New-IISSite -Name TestSite -BindingInformation "*:8080:" -PhysicalPath "$env:systemdrive\inetpub\testsite" -Passthru
$TestSite.Applications["/"].ApplicationPoolName = "TestSiteAppPool"
Stop-IISCommitDelay
```

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

### GET Get-IISServerManager

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisservermanager?view=windowsserver2019-ps

Retrieves the Microsoft.Web.Administration.ServerManager object to interact with IIS server configurations.

```APIDOC
## GET Get-IISServerManager

### Description
The Get-IISServerManager cmdlet retrieves the Internet Information Services (IIS) server manager object from Microsoft.Web.Administration, allowing for programmatic management of IIS sites, application pools, and server settings.

### Method
GET

### Endpoint
Get-IISServerManager

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
Get-IISServerManager

### Response
#### Success Response (200)
- **ServerManager** (Object) - The active Microsoft.Web.Administration.ServerManager object.

#### Response Example
$SM = Get-IISServerManager
```

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

### Enable IIS Central Certificate Store

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/enable-iiscentralcertprovider?view=windowsserver2016-ps

Demonstrates how to enable the central certificate store using a UNC path and administrative credentials. The second example includes an optional private key password for scenarios where certificates share a common password.

```PowerShell
Enable-IISCentralCertProvider -CertStoreLocation "\\CertStoreServer\CertStore" -UserName "IISCertificateAdmin" -Password "P@ssw0rd"
```

```PowerShell
Enable-IISCentralCertProvider -CertStoreLocation "\\CertStoreServer\CertStore" -UserName "IISCertificateAdmin" -Password "P@ssw0rd" -PrivateKeyPassword "pa$$W0rd"
```

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

### GET Get-IISCentralCertProvider

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iiscentralcertprovider?view=windowsserver2022-ps

Retrieves the configuration properties for the IIS Central Certificate Provider.

```APIDOC
## GET Get-IISCentralCertProvider

### Description
Retrieves the current configuration settings for the IIS Central Certificate Provider. If no parameters are specified, it returns all property values.

### Method
GET

### Endpoint
Get-IISCentralCertProvider

### Parameters
#### Query Parameters
- **UserName** (SwitchParameter) - Optional - Indicates that the central store user account name will be returned.

### Request Example
Get-IISCentralCertProvider

### Response
#### Success Response (200)
- **Object** (Object) - Returns an object containing the IIS Central Certificate Provider configuration properties.

#### Response Example
{
  "UserName": "IIS_Cert_User",
  "Enabled": true,
  "StorePath": "\\\\Server\\CertStore"
}
```

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

### GET Get-IISSharedConfig

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissharedconfig?view=windowsserver2025-ps

Retrieves the current status and configuration details of the IIS shared configuration feature.

```APIDOC
## GET Get-IISSharedConfig

### Description
The **Get-IISSharedConfig** cmdlet retrieves the current status of the IIS shared configuration feature, including whether it is enabled, the physical path, and the associated username.

### Method
GET

### Endpoint
Get-IISSharedConfig

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
Get-IISSharedConfig

### Response
#### Success Response (200)
- **Enabled** (Boolean) - Indicates if shared configuration is active.
- **Physical Path** (String) - The file system path where the configuration is stored.
- **UserName** (String) - The user account used to access the shared configuration.

#### Response Example
{
	"Enabled": true,
	"Physical Path": "C:\\export",
	"UserName": "administrator"
}
```

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

### New-IISSite

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissite?view=windowsserver2025-ps

Creates a new IIS website with specified physical path and binding information.

```APIDOC
## POST New-IISSite

### Description
The New-IISSite cmdlet creates an Internet Information Services (IIS) website with a specified physical root directory and binding configuration.

### Method
PowerShell Cmdlet

### Endpoint
New-IISSite

### Parameters
#### Required Parameters
- **Name** (String) - Required - The name of the IIS website.
- **PhysicalPath** (String) - Required - The local file system path to the site root.
- **BindingInformation** (String) - Required - Binding string in format IP:Port:Hostname (e.g., *:80:).

#### Optional Parameters
- **Protocol** (String) - Optional - The protocol to use (e.g., http, https).
- **CertificateThumbPrint** (String) - Optional - Thumbprint for HTTPS binding.
- **CertStoreLocation** (String) - Optional - The certificate store path.
- **Force** (Switch) - Optional - Overrides confirmation prompts.
- **Passthru** (Switch) - Optional - Returns the site object.

### Request Example
New-IISSite -Name "TestSite" -BindingInformation "*:8080:" -PhysicalPath "C:\inetpub\testsite"

### Response
#### Success Response (Object)
- **SiteObject** (Object) - Returns the created IIS Site object if -Passthru is specified.

#### Response Example
{ "Name": "TestSite", "PhysicalPath": "C:\\inetpub\\testsite", "State": "Started" }
```

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

### Retrieve IIS Website Information using Get-IISSite

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissite?view=windowsserver2016-ps

Demonstrates how to use the Get-IISSite cmdlet to retrieve configuration details for a specific website, all websites, or specific attributes of a site object.

```powershell
# Get information about a specific IIS website
Get-IISSite "Default Web Site"

# Get information about all IIS websites
Get-IISSite

# Get a specific attribute for an IIS website
$Site = Get-IISSite "Default Web Site"
$Site.Attributes["ServerAutoStart"]
```

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

### GET IIS Configuration Object

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigsection?view=windowsserver2022-ps

Retrieves an IIS configuration object based on specified location and section path parameters.

```APIDOC
## GET /IISAdministration/Configuration

### Description
Retrieves an IIS configuration object. This cmdlet allows targeting specific configuration locations and sections within the IIS hierarchy.

### Method
GET

### Endpoint
/IISAdministration/Configuration

### Parameters
#### Query Parameters
- **Location** (String) - Optional - Specifies the name of the IIS configuration location (corresponds to the <location> tag).
- **SectionPath** (String) - Optional - Specifies the name of the IIS configuration section to retrieve.

### Request Example
GET /IISAdministration/Configuration?Location=DefaultWebSite&SectionPath=system.webServer/defaultDocument

### Response
#### Success Response (200)
- **Object** (Object) - The requested IIS configuration object.

#### Response Example
{
  "status": "success",
  "data": {
    "location": "DefaultWebSite",
    "section": "system.webServer/defaultDocument",
    "enabled": true
  }
}
```

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

### Get IIS Server Manager Object

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisservermanager?view=windowsserver2016-ps

Retrieves the active Microsoft.Web.Administration.ServerManager object. This object is essential for interacting with IIS configuration and management features.

```powershell
Get-IISServerManager
```

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

### New-IISSiteBinding Cmdlet Documentation

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissitebinding?view=windowsserver2016-ps

Documentation for the New-IISSiteBinding cmdlet, detailing its parameters and their properties.

```APIDOC
## New-IISSiteBinding

### Description
Adds a new binding to an IIS website.

### Method
Cmdlet (PowerShell)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This cmdlet does not use a request body in the traditional sense; parameters are passed directly.

### Parameters Details

#### -CertStoreLocation
Specifies the certificate store path of the certificate, which is used to add a new HTTPS binding.
- **Type**: String
- **Default value**: None
- **Accepted values**: Cert:\LocalMachine\My, Cert:\LocalMachine\WebHosting, My, WebHosting
- **Supports wildcards**: False
- **Mandatory**: False

#### -Force
Forces the command to run without asking for user confirmation.
- **Type**: SwitchParameter
- **Default value**: None
- **Supports wildcards**: False
- **Mandatory**: False

#### -Name
Specifies the name of the IIS website.
- **Type**: String
- **Default value**: None
- **Supports wildcards**: False
- **Mandatory**: True

#### -Passthru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
- **Type**: SwitchParameter
- **Default value**: None
- **Supports wildcards**: False
- **Mandatory**: False

#### -Protocol
The protocol for which the binding is configured, usually http, https or ftp.
- **Type**: String
- **Default value**: None
- **Supports wildcards**: False
- **Mandatory**: False

#### -SslFlag
Specifies the SSL Flag(s) of the new binding.
- **Type**: SslFlags
- **Default value**: None
- **Accepted values**: None, Sni, CentralCertStore
- **Supports wildcards**: False
- **Mandatory**: False

### Request Example
```powershell
New-IISSiteBinding -Name "Default Web Site" -Protocol "https" -CertStoreLocation "Cert:\LocalMachine\My"
```

### Response
#### Success Response (Output Object)
- **BindingCollection** (Object) - Represents the newly created site binding.

#### Response Example
```powershell
# Example output object representing a binding
# (Actual output may vary based on parameters used)
```
```

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

### Get-IISSiteBinding

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iissitebinding?view=windowsserver2016-ps

Retrieves information about website bindings on a specified IIS site. This cmdlet is available starting from version 1.1.0.0 of the IISAdministration module.

```APIDOC
## GET /api/sites/{siteName}/bindings

### Description
Retrieves information about website bindings on a specified IIS site. This cmdlet is available starting from version 1.1.0.0 of the IISAdministration module.

### Method
GET

### Endpoint
/api/sites/{siteName}/bindings

### Parameters
#### Path Parameters
- **siteName** (String) - Required - The name of the IIS website.

#### Query Parameters
- **bindingInformation** (String) - Optional - Specifies the binding information string to use for the new site. The binding information is in the form IP:Port:hostname. Fields can be left blank to use a wildcard.
- **protocol** (String) - Optional - The protocol for which the binding is configured (e.g., http, https, ftp).

### Request Example
```json
{
  "example": "GET /api/sites/Default%20Web%20Site/bindings?bindingInformation=*:80:*"
}
```

### Response
#### Success Response (200)
- **protocol** (String) - The protocol of the binding.
- **bindingInformation** (String) - The binding information (IP:Port:Hostname).
- **sslFlags** (String) - The SSL flags for the binding.

#### Response Example
```json
{
  "example": [
    {
      "protocol": "http",
      "bindingInformation": "*:80:",
      "sslFlags": "None"
    },
    {
      "protocol": "http",
      "bindingInformation": "*:1234:",
      "sslFlags": "None"
    }
  ]
}
```
```

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

### Create a new IIS website with HTTP binding - PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissite?view=windowsserver2025-ps

This PowerShell command creates a new IIS website named 'TestSite' on port 8080, using the specified physical path. It demonstrates the basic usage of the New-IISSite cmdlet for HTTP bindings.

```powershell
New-IISSite -Name "TestSite" -BindingInformation "*:8080:" -PhysicalPath "$env:systemdrive\inetpub\testsite"
```

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

### Remove an IIS website using PowerShell

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/remove-iissite?view=windowsserver2016-ps

This example demonstrates how to remove a website named 'TestSite' from an IIS server using the Remove-IISSite cmdlet.

```powershell
Remove-IISSite -Name "TestSite"
```

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

### Create Self-Signed Certificate and HTTPS Binding for Testing

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iissitebinding?view=windowsserver2025-ps

Demonstrates how to create a self-signed certificate, export it, import it into the trusted root store, and then use it to create a new HTTPS binding for testing purposes. This is a common scenario for development and internal testing.

```powershell
$password = "string1"  # put your password on string1
$hostName = "localhost"
$port = "443"
$storeLocation = "Cert:\LocalMachine\My"
$certificate = New-SelfSignedCertificate -DnsName $hostName -CertStoreLocation $storeLocation
$thumbPrint = $certificate.Thumbprint
$bindingInformation = "*:`$port`:$hostName"
$certificatePath = ("cert:\localmachine\my\" + $certificate.Thumbprint)
$securedString = ConvertTo-SecureString -String $password -Force -AsPlainText
Export-PfxCertificate -FilePath "C:\temp\temp.pfx" -Cert $certificatePath -Password $securedString
Import-PfxCertificate -FilePath "C:\temp\temp.pfx" -CertStoreLocation "Cert:\LocalMachine\Root" -Password $securedString
New-IISSiteBinding -Name "TestSite" -BindingInformation $bindingInformation -CertificateThumbPrint $thumbPrint -CertStoreLocation $storeLocation -Protocol https
```

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

### Create IIS Configuration Collection Element

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/new-iisconfigcollectionelement?view=windowsserver2016-ps

Demonstrates how to add a new file name to the default document list in IIS. The first example shows a step-by-step approach using variables, while the second shows a piped command to insert an item at the beginning of the collection.

```PowerShell
# Example 1: Add a new file name to list of default documents
$ConfigSection = Get-IISConfigSection -SectionPath "system.webServer/defaultDocument"
$DefaultDocumentCollection = Get-IISConfigCollection -ConfigElement $ConfigSection -CollectionName "files"
New-IISConfigCollectionElement -ConfigCollection $DefaultDocumentCollection -ConfigAttribute @{"Value" = "MyDefDoc.htm"}

# Example 2: Add a new file name to the top of the list of default documents
Get-IISConfigSection -SectionPath "system.webServer/defaultDocument" | Get-IISConfigCollection -CollectionName "files" | New-IISConfigCollectionElement -ConfigAttribute @{Value = "MyDefDoc.htm"} -AddAt 0
```

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

### Set an IIS configuration attribute value

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/set-iisconfigattributevalue?view=windowsserver2019-ps

An example demonstrating how to retrieve an IIS configuration element and update a specific attribute, such as MaxUrlSegments, to a new value.

```PowerShell
$ConfigSection = Get-IISConfigSection -SectionPath "system.applicationHost/sites"
$SitesCollection = Get-IISConfigCollection -ConfigElement $ConfigSection
$Site = Get-IISConfigCollectionElement -ConfigCollection $SitesCollection -ConfigAttribute @{"name" = "Default Web Site"}
$Elem = Get-IISConfigElement -ConfigElement $Site -ChildElementName "limits"
Set-IISConfigAttributeValue -ConfigElement $Elem -AttributeName "MaxUrlSegments" -AttributeValue 16
```

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

### Get IIS Configuration Element (PowerShell)

Source: https://learn.microsoft.com/en-us/powershell/module/iisadministration/get-iisconfigcollectionelement?view=windowsserver2025-ps

Retrieves a configuration element for the default web site. This can be done by piping the configuration collection or by passing it as a parameter. It requires the IISAdministration module.

```powershell
Get-IISConfigSection -SectionPath "system.applicationHost/sites" | Get-IISConfigCollection | Get-IISConfigCollectionElement -ConfigAttribute @{"name"="Default Web Site"}
```

```powershell
$SiteCollection = Get-IISConfigSection -SectionPath "system.applicationHost/sites" | Get-IISConfigCollection
Get-IISConfigCollectionElement -ConfigCollection $SiteCollection -ConfigAttribute @{"name"="Default Web Site"}
```
Tokens:
Raw