ApplicationPoolFailureSettings Class1

Article
05/24/2022

Exposes properties that determine the actions to be taken when an application pool or worker process fails.

Syntax

class ApplicationPoolFailureSettings : EmbeddedObject

Methods

This class contains no methods.

Properties

The following table lists the properties exposed by the ApplicationPoolFailureSettings class.

Name	Description
`AutoShutdownExe`	A read/write `string` value that specifies an executable file to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool. The default is `null`. Use the `AutoShutdownParams` property to send parameters to the executable.
`AutoShutdownParams`	A read/write `string` value that contains the command-line parameters for the executable file specified by the `AutoShutdownExe` property. The default is `null`.
`LoadBalancerCapabilities`	A read/write `sint32` value that specifies application pool behavior when a service is unavailable. The possible values are listed later in the Remarks section.
`OrphanActionExe`	A read/write `string` value that specifies an executable file to run when the WWW service orphans a worker process. The default is `null`. Use the `OrphanActionParams` property to send parameters to the executable file.
`OrphanActionParams`	A read/write `string` value that contains the command-line parameters for the executable file specified by the `OrphanActionExe` property. To specify the process ID of the orphaned worker process, use "%1%". The default is `null`.
`OrphanWorkerProcess`	A read/write `boolean` value. `true` if the WWW service orphans a worker process that fails to respond to requests; otherwise, `false`. The default is `false`. When the value is set to `false`, any worker process that fails to respond will be terminated.
`RapidFailProtection`	A read/write `boolean` value. `true` if the WWW service will terminate all applications in an application pool when the number of worker process failures reaches the maximum specified by `RapidFailProtectionMaxCrashes` within the number of seconds specified by `RapidFailProtectionInterval`; otherwise, `false`. The default is `true`.
`RapidFailProtectionInterval`	A read/write `datetime` value that specifies the number of seconds before the failure count for a worker process is reset. The default is 5.
`RapidFailProtectionMaxCrashes`	A read/write `uint32` value that specifies the maximum number of permissible worker process failures. The default is 5.

Subclasses

This class contains no subclasses.

Remarks

Instances of this class are contained in the Failure property of the ApplicationPool class and the ApplicationPoolElementDefaults class.

The following table lists the possible values and the associated keywords and actions for the LoadBalancerCapabilities property. The default is 2 (HttpLevel).

Value	Keyword	Action
1	`TcpLevel`	Terminates the connection.
2	`HttpLevel`	Sends error code 503 (service unavailable).

Inheritance Hierarchy

EmbeddedObject

ApplicationPoolFailureSettings

Requirements

Type	Description
Client	- IIS 7.0 on Windows Vista - IIS 7.5 on Windows 7 - IIS 8.0 on Windows 8 - IIS 10.0 on Windows 10
Server	- IIS 7.0 on Windows Server 2008 - IIS 7.5 on Windows Server 2008 R2 - IIS 8.0 on Windows Server 2012 - IIS 8.5 on Windows Server 2012 R2 - IIS 10.0 on Windows Server 2016
Product	- IIS 7.0, IIS 7.5, IIS 8.0, IIS 8.5, IIS 10.0
MOF file	WebAdministration.mof