Properties

MSBuild

previous page next page

Public Properties

  Name Description
Public property ApplicationPoolName Gets or sets the name of the application pool.
Public property AppPoolAutoStart The AppPoolAutoStart property indicates to the World Wide Web Publishing Service (WWW service) to automatically start an application pool when the application pool is created or when IIS is started, if the value of this property is set to true.
Public property AppPoolIdentityType The AppPoolIdentityType property allows application pools to run as a specific user account: 0 - The application pool runs as NT AUTHORITY\SYSTEM. 1 - The application pool runs as NT AUTHORITY\LOCAL SERVICE. 2 - The application pool runs as NT AUTHORITY\NETWORK SERVICE. 3 - The application pool runs as a specific user account, defined by the WAMUserName property.
Public property AppPoolQueueLength The AppPoolQueueLength property indicates to the Universal Listener how many requests to queue up for an application pool before rejecting future requests. When the limit for this property is exceeded, IIS rejects the additional requests with a 503 error.
Public property AutoShutdownAppPoolExe The AutoShutdownAppPoolExe property specifies an executable to run when the World Wide Web Publishing Service (WWW service) shuts down an application pool for rapid fail protection. You can use the AutoShutdownAppPoolParams property to send parameters to the executable.
Public property AutoShutdownAppPoolParams The AutoShutdownAppPoolParams property specifies any command-line parameters for the executable that is specified in the AutoShutdownAppPoolExe property. You can use these two properties in the following way to send e-mail, for example, when the World Wide Web Publishing Service (WWW service) shuts down an application pool for rapid fail protection: AutoShutdownAppPoolExe = "C:\LogAndSendMail.bat" AutoShutdownAppPoolParams = "-AppPoolName %1%" where %1% represents the application pool name.
Public property BuildEngine Gets or sets the instance of the IBuildEngine object used by the task. (inherited from Task)
Public property CPUAction The CPUAction property configures the action(s) that IIS takes when Microsoft Windows NT ® job objects run. Only one Windows NT job object exists per application pool, therefore the CPUAction property is configured on a per application pool basis. Possible values: 0 - No action is taken except that a warning is written to the event log when the CPU limit is exceeded. 1 - Application pool worker processes that exceed their CPU limit will be forced to shut down.
Public property CPULimit The CPULimit property configures the maximum percentage of CPU resources that worker processes in an application pool are allowed to consume over a period of time, as indicated by the CPUResetInterval property. Set this property by specifying a percentage of CPU usage, multiplied by 1000. For example, if you want the CPU usage limit to be 50%, set CPULimit to 50,000.
Public property CPUResetInterval The CPUResetInterval property specifies the reset period (in minutes) for CPU monitoring and throttling limits on the application pool. When the number of minutes elapsed since the last process accounting reset equals the number specified by this property, IIS will reset the CPU timers for both the logging and limit intervals. Setting the value of this property to 0 disables CPU monitoring.
Public property DisallowOverlappingRotation The DisallowOverlappingRotation property specifies whether or not the World Wide Web Publishing Service (WWW Service) should start up another worker process to replace the existing worker process while it is shutting down.
Public property DisallowRotationOnConfigChange The DisallowRotationOnConfigChange property specifies whether or not the World Wide Web Publishing Service (WWW Service) should rotate worker processes in an application pool when the configuration has changed. This means that the worker processes will not pick up application pool changes to values passed to the worker process, such as IdleTimeout and PeriodicRestartRequests.
Public property HostObject Gets or sets the host object associated with the task. (inherited from Task)
Public property IdleTimeout The IdleTimeout property specifies how long (in minutes) a worker process should run idle if no new requests are received and the worker process is not processing requests. After the allotted time passes, the worker process should request to be shut down by the World Wide Web Publishing Service (WWW Service).
Public property LoadBalancerCapabilities The LoadBalancerCapabilities property specifies behavior when a service is unavailable. A setting of 1 terminates the connection. A setting of 2 sends error code 503.
Public property Log Gets an instance of a TaskLoggingHelper class containing task logging methods. (inherited from Task)
Public property LogEventOnRecycle The LogEventOnRecycle property specifies that IIS should log an event when an application pool is recycled. Application pools recycle for a variety of reasons. In order for IIS to log the event, the LogEventOnRecycle property must have a bit set corresponding to the reason for the recycle.
Public property LogonMethod The LogonMethod property contains an integer that specifies the logon method for cleartext logons. Valid settings are: 0 for interactive logon. 1 for batch logon. 2 for network logon. 3 for cleartext logon.
Public property MaxProcesses The MaxProcesses property determines the maximum number of worker processes an application pool allows to service requests for an application pool. This property cannot be set to 0 because there are no unmanaged pools.
Public property OrphanActionExe The OrphanActionExe property specifies an executable to run when the World Wide Web Publishing Service (WWW service) orphans a worker process. You can use the OrphanActionParams property to send parameters to the executable.
Public property OrphanActionParams The OrphanActionParams property specifies command-line parameters for the executable specified by the OrphanActionExe property.
Public property OrphanWorkerProcess The OrphanWorkerProcess property, when set to true, notifies the World Wide Web Publishing Service (WWW Service) not to terminate a worker process that fails to respond to pings, but to instead orphan the worker process in the application pool if the worker process suffers fatal errors.
Public property Password Gets or sets the password for the account the task will run under. This property is needed if you specified a ServerName for a remote machine. (inherited from WebBase)
Public property PeriodicRestartMemory The PeriodicRestartMemory property specifies the amount of virtual memory (in KB) that a worker process can use before the worker process recycles. The maximum value supported for this property is 4,294,967 KB.
Public property PeriodicRestartPrivateMemory The PeriodicRestartPrivateMemory property specifies the amount of private memory (in KB) that a worker process can use before the worker process recycles. The maximum value supported for this property is 4,294,967 KB.
Public property PeriodicRestartRequests The PeriodicRestartRequests property indicates the number of requests the OOP application should process, after which it is recycled.
Public property PeriodicRestartSchedule The PeriodicRestartSchedule property specifies the time (in 24 hour format) that the application will be rotated. Each time is in local time and is specified in the following format: PeriodicRestartSchedule="hh:mm,hh:mm,hh:mm"
Public property PeriodicRestartTime The PeriodicRestartTime property specifies the period of time, in minutes, after which IIS rotates an isolated OOP application. Setting the value of this property to 0 disables the property. The maximum supported value for this property is 71,582.
Public property PingingEnabled The PingingEnabled property specifies whether the World Wide Web Publishing Service (WWW Service) should periodically monitor the health of a worker process. Setting the value of this property to true indicates to the WWW service to monitor the worker processes to ensure that the they are running and healthy.
Public property PingInterval The PingInterval property specifies the period of time (in seconds) between health-monitoring pings that the World Wide Web Publishing Service (WWW Service) sends to a worker process.
Public property PingResponseTime The PingResponseTime property specifies the amount of time (in seconds) that a worker process is given to respond to a health monitoring ping. After the time limit is exceeded, the World Wide Web Publishing Service (WWW Service) terminates the worker process.
Public property RapidFailProtection Setting the RapidFailProtection property to true instructs the World Wide Web Publishing Service (WWW service) to put all applications in an application pool out of service if the number of worker process crashes has reached the maximum specified by the RapidFailProtectionMaxCrashes property, within the number of minutes specified by the RapidFailProtectionInterval property.
Public property RapidFailProtectionInterval The RapidFailProtectionInterval property specifies the number of minutes before the failure count for a process is reset. See RapidFailProtection.
Public property RapidFailProtectionMaxCrashes The RapidFailProtectionMaxCrashes property specifies the maximum number of failures allowed within the number of minutes specified by the RapidFailProtectionInterval property. See RapidFailProtection.
Public property ServerName Gets or sets the name of the server. The default value is 'localhost'. (inherited from WebBase)
Public property ServerPort Gets or sets the server port. (inherited from WebBase)
Public property ShutdownTimeLimit The ShutdownTimeLimit property specifies the amount of time (in seconds) after a recycle threshold has been reached that IIS waits for all old requests to finish running in a worker process before terminating the worker process.
Public property SMPAffinitized Setting the SMPAffinitized property to true indicates that a particular worker process assigned to an application pool should be assigned to a given CPU. This property is used in conjunction with the SMPProcessorAffinityMask property to configure a particular processor a worker process will be assigned to.
Public property SMPProcessorAffinityMask The SMPProcessorAffinityMask property configures the hexadecimal processor mask. The hexadecimal processor mask indicates to which CPU the worker processes in an application pool should be bound. Before this property takes affect, the SMPAffinitized property must be set to true for the application pool. These properties cannot be set through IIS Manager. Do not set this property to zero. Doing so causes no SMP affinity to be configured, creating an error condition. The default DWORD value is 4294967295 (or -1), which is represented in hexadecimal as 0xFFFFFFFF. A value of 0xFFFFFFFF in SMPProcessorAffinityMask indicates that all processors are enabled.
Public property StartupTimeLimit The value of the StartupTimeLimit property specifies the amount of time (in seconds) that the World Wide Web Publishing Service (WWW Service) should wait for a worker process to finish starting up and reporting to the WWW Service.
Public property Username Gets or sets the username for the account the task will run under. This property is needed if you specified a ServerName for a remote machine. (inherited from WebBase)
Public property WAMUserName The WAMUserName property specifies the account user name that IIS uses by default as the COM+ application identity for newly created IIS out-of-process applications. The values of this property and its companion property, WAMUserPass, are set when IIS is installed, and match the user name and password values in the Microsoft Windows user account, which is established at the same time. Changing the value of this property is not recommended. If you do, change it to a valid Windows user account, and change WAMUserPass to the corresponding password for the new account. Important: Changes to WAMUserName and WAMUserPass may disrupt the operation of existing IIS out-of-process applications. You can synchronize application identities using Component Services to edit the user name and password values, found on the Identity tab of the property sheet for each package. In-process applications are not affected by these property values.
Public property WAMUserPass The WAMUserPass property specifies the password for the account that IIS uses by default as the COM+ application identity for newly created IIS out-of-process applications. The values of this property and its companion property, WAMUserName, are set when IIS is installed, and match the password and user name values in the Microsoft Windows user account (IWAM_ MachineName, where MachineName is the name of the machine on which IIS is installed) established at the same time. Important: Changing the value of this property is not recommended. If you do, you must change the Windows account password to the identical value. You must also synchronize existing IIS out-of-process application identities, using Component Services to edit the user name and password values, which are found on the Identity tab of the property sheet for each package. In-process applications are not affected by these property values.
Top

Protected Properties

  Name Description
Family property HelpKeywordPrefix Gets or sets the prefix used to compose Help keywords from resource names. (inherited from Task)
Family property IISApplicationPath Gets or sets the application path. (inherited from WebBase)
Family property IISAppPoolPath Gets or sets the IIS application pool path. (inherited from WebBase)
Family property IISServerPath Gets or sets the IIS server path. (inherited from WebBase)
Family property TaskResources Gets or sets the culture-specific resources associated with the task. (inherited from Task)
Top

See Also

Syntax based on .NET Framework version 2.0.
Documentation version 1.0.0.0.

previous page start next page