Resource Type: dsc_xwebapppool

Defined in:

lib/puppet/type/dsc_xwebapppool.rb

Providers:

powershell

Overview

The DSC xWebAppPool resource type. Automatically generated from ‘xWebAdministration/DSCResources/MSFT_xWebAppPool/MSFT_xWebAppPool.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_autoshutdownexe

  autoShutdownExe - Indicates an executable to run when the application pool is shut down by rapid-fail protection.

• dsc_autoshutdownparams

  autoShutdownParams - Indicates parameters for the executable that is specified in the autoShutdownExe property.

• dsc_autostart

  autoStart - When set to true, indicates to the World Wide Web Publishing Service (W3SVC) that the application pool should be automatically started when it is created or when IIS is started.

  Supported values:

  • true
  • false
• dsc_clrconfigfile

  CLRConfigFile - Indicates the .NET configuration file for the application pool.

• dsc_cpuaction

  cpuAction - Configures the action that IIS takes when a worker process exceeds its configured CPU limit. The values that are allowed for this property are: NoAction, KillW3wp, Throttle, and ThrottleUnderLoad. Valid values are NoAction, KillW3wp, Throttle, ThrottleUnderLoad.

• dsc_cpulimit

  cpuLimit - Configures the maximum percentage of CPU time (in 1/1000ths of one percent) that the worker processes in the application pool are allowed to consume over a period of time as indicated by the cpuResetInterval property. The value must be a valid integer between 0 and 100000.

• dsc_cpuresetinterval

  cpuResetInterval - Indicates the reset period (in minutes) for CPU monitoring and throttling limits on the application pool. The value must be a string representation of a TimeSpan value. The valid range (in minutes) is 0 to 1440. Setting the value of this property to 0 disables CPU monitoring.

• dsc_cpusmpaffinitized

  cpuSmpAffinitized - Indicates whether a particular worker process assigned to the application pool should also be assigned to a given CPU.

  Supported values:

  • true
  • false
• dsc_cpusmpprocessoraffinitymask

  cpuSmpProcessorAffinityMask - Indicates the hexadecimal processor mask for multi-processor computers, which indicates to which CPU the worker processes in the application pool should be bound. Before this property takes effect, the cpuSmpAffinitized property must be set to true for the application pool. The value must be a valid integer between 0 and 4294967295.

• dsc_cpusmpprocessoraffinitymask2

  cpuSmpProcessorAffinityMask2 - Indicates the high-order DWORD hexadecimal processor mask for 64-bit multi-processor computers, which indicates to which CPU the worker processes in the application pool should be bound. Before this property takes effect, the cpuSmpAffinitized property must be set to true for the application pool. The value must be a valid integer between 0 and 4294967295.

• dsc_credential

  Credential - Indicates the custom account crededentials. This property is only valid when the identityType property is set to SpecificUser.

• dsc_disallowoverlappingrotation

  disallowOverlappingRotation - Indicates whether the W3SVC service should start another worker process to replace the existing worker process while that process is shutting down. If true, the application pool recycle will happen such that the existing worker process exits before another worker process is created.

  Supported values:

  • true
  • false
• dsc_disallowrotationonconfigchange

  disallowRotationOnConfigChange - Indicates whether the W3SVC service should rotate worker processes in the application pool when the configuration has changed. If true, the application pool will not recycle when its configuration is changed.

  Supported values:

  • true
  • false
• dsc_enable32bitapponwin64

  enable32BitAppOnWin64 - When set to true, enables a 32-bit application to run on a computer that runs a 64-bit version of Windows.

  Supported values:

  • true
  • false
• dsc_enableconfigurationoverride

  enableConfigurationOverride - When set to true, indicates that delegated settings in Web.config files will processed for applications within this application pool. When set to false, all settings in Web.config files will be ignored for this application pool.

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - Indicates if the application pool exists. Set this property to Absent to ensure that the application pool does not exist. Setting it to Present (the default value) ensures that the application pool exists. Valid values are Present, Absent.

• dsc_identitytype

  identityType - Indicates the account identity under which the application pool runs. The values that are allowed for this property are: ApplicationPoolIdentity, LocalService, LocalSystem, NetworkService, and SpecificUser. Valid values are ApplicationPoolIdentity, LocalService, LocalSystem, NetworkService, SpecificUser.

• dsc_idletimeout

  idleTimeout - Indicates the amount of time (in minutes) a worker process will remain idle before it shuts down. The value must be a string representation of a TimeSpan value and must be less than the restartTimeLimit property value. The valid range (in minutes) is 0 to 43200.

• dsc_idletimeoutaction

  idleTimeoutAction - Indicates the action to perform when the idle timeout duration has been reached. The values that are allowed for this property are: Terminate, Suspend. Valid values are Terminate, Suspend.

• dsc_loadbalancercapabilities

  loadBalancerCapabilities - Indicates the response behavior of a service when it is unavailable. The values that are allowed for this property are: HttpLevel, TcpLevel. If set to HttpLevel and the application pool is stopped, HTTP.sys will return HTTP 503 error. If set to TcpLevel, HTTP.sys will reset the connection. Valid values are HttpLevel, TcpLevel.

• dsc_loaduserprofile

  loadUserProfile - Indicates whether IIS loads the user profile for the application pool identity.

  Supported values:

  • true
  • false
• dsc_logeventonprocessmodel

  logEventOnProcessModel - Indicates that IIS should generate an event log entry for each occurrence of the specified process model events.

• dsc_logeventonrecycle

  logEventOnRecycle - Indicates that IIS should generate an event log entry for each occurrence of the specified recycling events.

• dsc_logontype

  logonType - Indicates the logon type for the process identity. The values that are allowed for this property are: LogonBatch, LogonService. Valid values are LogonBatch, LogonService.

• dsc_managedpipelinemode

  managedPipelineMode - Indicates the request-processing mode that is used to process requests for managed content. The values that are allowed for this property are: Integrated, Classic. Valid values are Integrated, Classic.

• dsc_managedruntimeloader

  managedRuntimeLoader - Indicates the managed loader to use for pre-loading the application pool.

• dsc_managedruntimeversion

  managedRuntimeVersion - Indicates the CLR version to be used by the application pool. The values that are allowed for this property are: v4.0, v2.0, and ”. Valid values are v4.0, v2.0, .

• dsc_manualgroupmembership

  manualGroupMembership - Indicates whether the IIS_IUSRS group Security Identifier (SID) is added to the worker process token.

  Supported values:

  • true
  • false
• dsc_maxprocesses

  maxProcesses - Indicates the maximum number of worker processes that would be used for the application pool. The value must be a valid integer between 0 and 2147483647.

• dsc_name

  Name - Indicates the application pool name. The value must contain between 1 and 64 characters.

• dsc_orphanactionexe

  orphanActionExe - Indicates an executable to run when a worker process is orphaned.

• dsc_orphanactionparams

  orphanActionParams - Indicates parameters for the executable that is specified in the orphanActionExe property.

• dsc_orphanworkerprocess

  orphanWorkerProcess - Indicates whether to assign a worker process to an orphan state instead of terminating it when the application pool fails. If true, an unresponsive worker process will be orphaned instead of terminated.

  Supported values:

  • true
  • false
• dsc_passanonymoustoken

  passAnonymousToken - When set to true, the Windows Process Activation Service (WAS) creates and passes a token for the built-in IUSR anonymous user account to the Anonymous authentication module. The Anonymous authentication module uses the token to impersonate the built-in account. When this property is set to false, the token will not be passed.

  Supported values:

  • true
  • false
• dsc_pingingenabled

  pingingEnabled - Indicates whether pinging (health monitoring) is enabled for the worker process(es) serving this application pool.

  Supported values:

  • true
  • false
• dsc_pinginterval

  pingInterval - Indicates the period of time (in seconds) between health monitoring pings sent to the worker process(es) serving this application pool. The value must be a string representation of a TimeSpan value. The valid range (in seconds) is 1 to 4294967.

• dsc_pingresponsetime

  pingResponseTime - Indicates the maximum time (in seconds) that a worker process is given to respond to a health monitoring ping. The value must be a string representation of a TimeSpan value. The valid range (in seconds) is 1 to 4294967.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_queuelength

  queueLength - Indicates the maximum number of requests that HTTP.sys will queue for the application pool. The value must be a valid integer between 10 and 65535.

• dsc_rapidfailprotection

  rapidFailProtection - Indicates whether rapid-fail protection is enabled. If true, the application pool is shut down if there are a specified number of worker process crashes within a specified time period.

  Supported values:

  • true
  • false
• dsc_rapidfailprotectioninterval

  rapidFailProtectionInterval - Indicates the time interval (in minutes) during which the specified number of worker process crashes must occur before the application pool is shut down by rapid-fail protection. The value must be a string representation of a TimeSpan value. The valid range (in minutes) is 1 to 144000.

• dsc_rapidfailprotectionmaxcrashes

  rapidFailProtectionMaxCrashes - Indicates the maximum number of worker process crashes permitted before the application pool is shut down by rapid-fail protection. The value must be a valid integer between 0 and 2147483647.

• dsc_restartmemorylimit

  restartMemoryLimit - Indicates the maximum amount of virtual memory (in KB) a worker process can consume before causing the application pool to recycle. The value must be a valid integer between 0 and 4294967295. A value of 0 means there is no limit.

• dsc_restartprivatememorylimit

  restartPrivateMemoryLimit - Indicates the maximum amount of private memory (in KB) a worker process can consume before causing the application pool to recycle. The value must be a valid integer between 0 and 4294967295. A value of 0 means there is no limit.

• dsc_restartrequestslimit

  restartRequestsLimit - Indicates the maximum number of requests the application pool can process before it is recycled. The value must be a valid integer between 0 and 4294967295. A value of 0 means the application pool can process an unlimited number of requests.

• dsc_restartschedule

  restartSchedule - Indicates a set of specific local times, in 24 hour format, when the application pool is recycled. The value must be an array of string representations of TimeSpan values. TimeSpan values must be between 00:00:00 and 23:59:59 seconds inclusive, with a granularity of 60 seconds. Setting the value of this property to ” disables the schedule.

• dsc_restarttimelimit

  restartTimeLimit - Indicates the period of time (in minutes) after which the application pool will recycle. The value must be a string representation of a TimeSpan value. The valid range (in minutes) is 0 to 432000. A value of 0 means the application pool does not recycle on a regular interval.

• dsc_setprofileenvironment

  setProfileEnvironment - Indicates the environment to be set based on the user profile for the new process.

  Supported values:

  • true
  • false
• dsc_shutdowntimelimit

  shutdownTimeLimit - Indicates the period of time (in seconds) a worker process is given to finish processing requests and shut down. The value must be a string representation of a TimeSpan value. The valid range (in seconds) is 1 to 4294967.

• dsc_startmode

  startMode - Indicates the startup type for the application pool. The values that are allowed for this property are: OnDemand, AlwaysRunning. Valid values are OnDemand, AlwaysRunning.

• dsc_startuptimelimit

  startupTimeLimit - Indicates the period of time (in seconds) a worker process is given to start up and initialize. The value must be a string representation of a TimeSpan value. The valid range (in seconds) is 1 to 4294967.

• dsc_state

  State - Indicates the state of the application pool. The values that are allowed for this property are: Started, Stopped. Valid values are Started, Stopped.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xwebapppool` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.