binford2k / puppetlabs-iis

Manage IIS for Windows Server 2008 and above. Maintain application sites, pools, virtual applications, and many other IIS settings.

iis

Table of Contents

1. Description
2. Setup - The basics of getting started with IIS
3. Usage - Configuration options and additional functionality
4. Reference - An under-the-hood peek at what the module is doing and how
   • Facts
   • Types/Providers
     • iis_application_pool
     • iis_site
     • iis_feature
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Description

This module adds a provider to manage IIS sites and application pools.

Setup

Beginning with puppetlabs-iis

This module can both manage and install IIS on your server. For example, a minimal IIS install can be accomplished by ensuring the Web-WebServer & Web-Scripting-Tools Windows Features are present.

Here is an example that installs IIS and creates a web site using the default application pool.

$iis_features = ['Web-WebServer','Web-Scripting-Tools']

iis_feature { $iis_features:
  ensure => present,
} ->

iis_site { 'minimal':
  ensure          => 'started',
  physicalpath    => 'c:\\inetpub\\minimal',
  applicationpool => 'DefaultApplicationPool',
}

Usage

This example will create and configure an IIS web site in the Started state with the physical path set, which makes use of an IIS application pool named minimal_site_app_pool in the Started state.

iis_application_pool { 'minimal_site_app_pool':
  ensure                => 'present',
  managedpipelinemode   => 'Integrated',
  managedruntimeversion => 'v4.0',
  state                 => 'Started'
} ->

iis_site { 'minimal':
  ensure          => 'started',
  physicalpath    => 'c:\\inetpub\\minimal',
  applicationpool => 'minimal_site_app_pool',
}

Reference

Facts

• iis_version - The version of the installed IIS. Empty string if not installed.

Types/Providers

• iis_application_pool
• iis_site
• iis_feature

Here, include a complete list of your module's classes, types, providers, facts, along with the parameters for each. Users refer to this section (thus the name "Reference") to find specific details; most users don't read it per se.

iis_application_pool

Allows creation of a new IIS application pool

ensure

Must be either present or absent. Present will ensure the application pool is created.

name

Name of the application pool.

state

The state of the ApplicationPool. Must be either Started or Stopped

managedpipelinemode

The managedpipelinemode of the ApplicationPool. Must be either Integrated or Classic

managedruntimeversion

The managedruntimeversion of the ApplicationPool.

iis_site

Allows creation of a new IIS website and configuration of various parameters.

Properties/Parameters

ensure

Specifies whether a site should be present or absent. If present is specified, the site will be created but left in the default stopped state. If started is specified, then the site will be created as well as started. If stopped is specified, then the site will be created and kept stopped.

name

The Name of the IIS site. Used for uniqueness. Will set the target to this value if target is unset.

physicalpath

The physical path to the IIS web site folder

applicationpool

The name of an ApplicationPool for this IIS Web Site

enabledprotocols

The protocols enabled for this site. If https is specified, http is implied. If no value is provided, then this setting is disabled

serviceautostart

Enables autostart on the specified website

serviceautostartprovidername

Specifies the provider used for service auto start. Used with :serviceautostartprovidertype. The element specifies a collection of managed assemblies that Windows Process Activation Service (WAS) will load automatically when the startMode attribute of an application pool is set to AlwaysRunning. This collection allows developers to specify assemblies that perform initialization tasks before any HTTP requests are serviced.

Example:

iis_site { 'mysite'
  ...
  serviceautostartprovidername => "MyAutostartProvider",
  serviceautostartprovidertype => "MyAutostartProvider, MyAutostartProvider, version=1.0.0.0, Culture=neutral, PublicKeyToken=426f62526f636b73"
}

serviceautostartprovidertype

Specifies the application type for the provider used for service auto start. Used with :serviceautostartprovider

Example:

iis_site { 'mysite'
  ...
  serviceautostartprovidername => "MyAutostartProvider",
  serviceautostartprovidertype => "MyAutostartProvider, MyAutostartProvider, version=1.0.0.0, Culture=neutral, PublicKeyToken=426f62526f636b73"
}

preloadenabled

Enables loading website automatically without a client request first

defaultpage

Specifies the default page of the site

logformat

Specifies the format for the log file. When set to WSC, it can be used in conjunction with :logflags

logpath

Specifies the physical path to place the log file

logperiod

Specifies how often the log file should rollover

logtruncatesize

Specifies how large the log file should be before truncating it. The value must be in bytes. The value can be any size between '1048576 (1MB)' and '4294967295 (4GB)'.

loglocaltimerollover

Use the system's local time to determine for the log file name as well as when the log file is rolled over

logflags

Specifies what W3C fields are logged in the IIS log file. This is only valid when :logformat is set to W3C.

iis_site

ensure

Specifies whether an IIS feature should be present or absent

name

The name of the IIS feature to install

include_all_subfeatures

Indicates whether to install all sub features of a parent IIS feature. For instance, ASP.NET as well as the IIS Web Server

restart

Indicates whether to allow a restart if the IIS feature installationrequests one

include_management_tools

Indicates whether to automatically install all managment tools for a given IIS feature

source

Optionally include a source path for the installation media for an IIS feature

Limitations

Compatibility

OS Compatibility

This module is compatible only with Windows Server 2008R2, Windows Server 2012, Windows Server 2012R2 & Windows Server 2016.

IIS Compatibility

This module only supports IIS 7.5, IIS 8 or IIS 8.5.

Powershell Compatibility

This module requires Powershell v2 or greater. Works best with PowerShell v3 or above.

Known Issues

N/A

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Check out our the complete module contribution guide or CONTRIBUTING.md.