microsoft.iis.page_order module – Configures default document order in IIS

Note

This module is part of the microsoft.iis collection (version 1.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install microsoft.iis.

To use it in a playbook, specify: microsoft.iis.page_order.

New in microsoft.iis 1.3.0

Synopsis

  • Adds or modifies the default document order in IIS.

Parameters

Parameter

Comments

application

string

The name of an application or virtual directory under site to configure.

When omitted the configuration is applied at the site root.

page_order

list / elements=string / required

The ordered list of default document names.

The first entry is served first when a request does not specify a document.

site

string / required

The name of the IIS site to configure, for example Default Web Site.

The module resolves the site to the underlying IIS configuration path automatically.

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target, if not supported the action will be skipped.

diff_mode

Support: full

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode

platform

Platform: windows

Target OS/families that can be operated against

See Also

See also

microsoft.iis.website

Configures an IIS website.

Examples

- name: Configure default document order for a site
  microsoft.iis.page_order:
    site: Default Web Site
    page_order:
      - default.aspx
      - Default.htm
      - Default.asp

- name: Configure default document order for an application under a site
  microsoft.iis.page_order:
    site: Default Web Site
    application: MyApp
    page_order:
      - default.aspx
      - Default.htm

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

target

string

The resolved IIS configuration path the default document order was applied to.

Returned: always

Sample: "IIS:\\Sites\\Default Web Site"

Authors

  • Justin Cook (@ch0nx)