microsoft.iis.web_app_pool_info module – Get information on IIS Web Application Pools

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Returns information about IIS Web Application Pools.

Requirements

The below requirements are needed on the host that executes this module.

  • IISAdministration PowerShell module

Parameters

Parameter

Comments

name

string

Name of the application pool.

When not specified, information of all existing pools will be fetched.

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: none

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.web_app_pool

Configure IIS Web Application Pools.

Examples

- name: Return information about an existing application pool
  microsoft.iis.web_app_pool_info:
    name: DefaultAppPool
  register: stored_info

- name: Returns information about all application pools that exist on the system
  microsoft.iis.web_app_pool_info:
  register: stored_info_all

Return Values

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

Key

Description

app_pools

list / elements=string

Contains list of dictionaries.

Every dictionary in the list contains name and information of an application pool.

Sample: ["[ { \"attributes\": { \"CLRConfigFile\": \"\"", " \"applicationPoolSid\": \"S-1-5-82-3006700770-424185619-1745488364-794895919-4004696415\"", " \"autoStart\": true", " \"cpu\": { \"action\": \"NoAction\"", " \"limit\": 0", " \"numaNodeAffinityMode\": \"Soft\"", " \"numaNodeAssignment\": \"MostAvailableMemory\"", " \"processorGroup\": 0", " \"resetInterval\": \"00:05:00\"", " \"smpAffinitized\": false", " \"smpProcessorAffinityMask\": 4294967295", " \"smpProcessorAffinityMask2\": 4294967295 }", " \"enable32BitAppOnWin64\": false", " \"enableConfigurationOverride\": true", " \"failure\": { \"autoShutdownExe\": \"\"", " \"autoShutdownParams\": \"\"", " \"loadBalancerCapabilities\": \"HttpLevel\"", " \"orphanActionExe\": \"\"", " \"orphanActionParams\": \"\"", " \"orphanWorkerProcess\": false", " \"rapidFailProtection\": true", " \"rapidFailProtectionInterval\": \"00:05:00\"", " \"rapidFailProtectionMaxCrashes\": 5 }", " \"managedPipelineMode\": \"Integrated\"", " \"managedRuntimeLoader\": \"webengine4.dll\"", " \"managedRuntimeVersion\": \"v4.0\"", " \"name\": \"DefaultAppPool\"", " \"passAnonymousToken\": true", " \"processModel\": { \"identityType\": \"ApplicationPoolIdentity\"", " \"idleTimeout\": \"00:20:00\"", " \"idleTimeoutAction\": \"Terminate\"", " \"loadUserProfile\": false", " \"logEventOnProcessModel\": \"IdleTimeout\"", " \"logonType\": \"LogonBatch\"", " \"manualGroupMembership\": false", " \"maxProcesses\": 1", " \"pingInterval\": \"00:00:30\"", " \"pingResponseTime\": \"00:01:30\"", " \"pingingEnabled\": true", " \"requestQueueDelegatorIdentity\": \"\"", " \"setProfileEnvironment\": true", " \"shutdownTimeLimit\": \"00:01:30\"", " \"startupTimeLimit\": \"00:01:30\"", " \"userName\": \"\" }", " \"queueLength\": 1000", " \"recycling\": { \"disallowOverlappingRotation\": false", " \"disallowRotationOnConfigChange\": false", " \"logEventOnRecycle\": \"Time", "Requests", "Schedule", "Memory", "IsapiUnhealthy", "OnDemand", "ConfigChange", "PrivateMemory\"", " \"periodicRestart\": { \"memory\": 0", " \"privateMemory\": 0", " \"requests\": 0", " \"time\": \"1.05:00:00\" } }", " \"startMode\": \"OnDemand\"", " \"state\": \"Started\" }", " \"name\": \"DefaultAppPool\" } ]"]

attributes

dictionary

Dictionary that hold the information of a specific application pool.

For full list see https://learn.microsoft.com/en-us/iis/configuration/system.applicationhost/applicationpools/add/#attributes.

Returned: success

cpu

dictionary

Key value pairs showing the current Application Pool cpu attributes.

Returned: success

Sample: {"action": "NoAction", "limit": 0, "resetInterval": {"Days": 0, "Hours": 0}}

failure

dictionary

Key value pairs showing the current Application Pool failure attributes.

Returned: success

Sample: {"autoShutdownExe": "", "orphanActionExe": "", "rapidFailProtextionInterval": {"Days": 0, "Hours": 0}}

processModel

dictionary

Key value pairs showing the current Application Pool processModel attributes.

Returned: success

Sample: {"identityType": "ApplicationPoolIdentity", "logonType": "LogonBatch", "pingInterval": {"Days": 0, "Hours": 0}}

recycling

dictionary

Key value pairs showing the current Application Pool recycling attributes.

Returned: success

Sample: {"disallowOverlappingRotation": false, "disallowRotationOnConfigChange": false, "logEventOnRecycle": "Time,Requests,Schedule,Memory,IsapiUnhealthy,OnDemand,ConfigChange,PrivateMemory"}

name

string

Name of the application pool.

Returned: success

Sample: "DefaultAppPool"

exists

boolean

Whether any application pools were found.

Returned: success

Sample: true

Authors

  • Ron Gershburg (@rgershbu)