IIS plugin

Configuration Name

Required. The unique name for the configuration.

IIS IP Address

URL for the IIS server. It must include the protocol (for example, http://192.168.1.100).

IIS Port

Port for the IIS server. This port is used in conjunction with the IP address to conform the URL (for example, 8081). If not provided, CloudBees CD/RO uses the default port 80.

Computer Name (DEPRECATED)

Computer name or IP address without backslashes (for example, server01).

Login as

Configuration name

Provide the name of the configuration that holds connection information for the IIS server. Credentials are only used from the plugin configuration if the Use Credentials parameter is selected.

Use Credentials (Deprecated)

Indicate if credentials must be used. If selected, CloudBees CD/RO uses the username and password from the plugin configuration.

Credential

Username and password for basic authentication.

Link to Check For

URL to check. If not specified, a URL is constructed from the IIS configuration.

Expected Status

3-digit HTTP status to wait for. Default is 200. This can also be a regular expression (for example, 200|201).

Check Unavailable

If selected, the server:port is checked for availability and the URL path and status parameters are ignored. If the server is available, the procedure fails.

Timeout

Connection timeout. Default is 30 seconds.

Retries

Number of retries. This only affects connecting to server, and not the status returned by the server. Default is 1.

Application pool name

Name of the application pool to create (for example, FirstAppPool).

Configures the application pool to load a specific version of the .NET Framework.

Enable 32-bit applications

If selected for an application pool on a 64-bit operating system, the worker processes serving the application pool run in WOW64 (Windows on Windows64) mode. In WOW64 mode, 32-bit processes load only 32-bit applications.

Managed pipeline mode

Configures ASP.NET to run in classic mode as an ISAPI extension or in integrated mode where managed code is integrated into the request-processing pipeline.

Queue length

Maximum number of requests that HTTP.sys queues for the application pool. When the queue is full, new requests receive a 503 "Service Unavailable" response.

Start automatically

If selected, the application pool starts on creation or when IIS starts. Starting an application pool sets this property to True. Stopping an application sets this property to False.

Limit

Configures the maximum percentage of CPU time (in 1/1000ths of a percent) that the worker processes in an application pool are allowed to consume over a period of time, as indicated by the Limit Interval parameter (resetInterval property). If the limit set by this parameter is exceeded, the event is written to the event log and an optional set of events can be triggered or determined by the Limit action parameter (action property). Setting the value to 0 disables the limiting of worker processes to a percentage of CPU time.

Limit action

Specifies the action to take when the specified Limit is exceeded.

Limit interval (minutes)

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 Limit interval, IIS resets the CPU timers for both the logging and limit intervals. Setting the value of Limit interval to 0 disables CPU monitoring.

Processor affinity enabled

If selected, the worker processes serving this application pool are forced to run on specific CPUs. This enables sufficient use of CPU caches on multiprocessor servers.

Processor affinity mask

Hexadecimal mask that forces the worker processes for this application pool to run on a specific CPU. If selected, a value of 0 results in an error condition.

Identity

Configures the application pool to run as a built-in account, such as Network Service (recommended), Local Service, or as a specific user identity.

Idle timeout (minutes)

Amount of time, in minutes, a worker process remains idle before it shuts down. A worker process is idle if it is not processing requests and no new requests are received.

Load user profile

If selected, IIS loads the user profile for the application pool identity. If not selected, IIS 6.0 behavior is used.

Maximum worker processes

Maximum number of worker processes permitted to service requests for the application pool. If this number is greater than 1, the application pool is referred to as a "Web Garden".

Ping enabled

If selected, the worker processes serving this application pool are pinged periodically to ensure that they are still responsive. This process is called health monitoring.

Ping maximum response time (seconds)

Maximum time, in seconds, that a worker process is given to respond to a health monitoring ping. If the worker process does not respond, it is terminated.

Ping period (seconds)

Period of time, in seconds, between health monitoring pings sent to the worker processes serving this application pool.

Shutdown time limit (seconds)

Period of time, in seconds, a worker process is given to finish processing requests and shut down. If the worker process exceeds the shutdown time limit, it is terminated.

Startup time limit (seconds)

Period of time, in seconds, a worker process is given to start up and initialize. If the worker process initialization exceeds the startup time limit, it is terminated.

Application pool process orphaning enabled

If selected, an unresponsive worker process is abandoned (orphaned) instead of terminated. This feature can be used to debug a worker process failure.

Orphan action executable

Executable to run when a worker process is abandoned (orphaned). For example, C:\dbgtools\ntsd.exe invokes NTSD to debug a worker process failure.

Orphan action executable parameters

Parameters for the executable that are run when a worker process is abandoned (orphaned). For example, -g -p %1% is appropriate if the NTSD is the executable invoked for debugging worker process failures.

Service unavailable response type

Rapid fail protection enabled

If selected, the application pool is shut down if there are a specified number of worker process failures (Maximum failures) within a specified period (Failure interval). By default, an application pool is shut down if there are five failures in a five-minute period.

Failure interval (minutes)

The time interval, in minutes, during which the specified number of worker process failures (Maximum failures) must occur before the application pool is shut down by Rapid Fail Protection.

Maximum failures

Maximum number of worker process failures permitted before the application pool is shut down by Rapid Fail Protection.

Shutdown executable

Executable to run when an application pool is shut down by Rapid Fail Protection. This can be used to configure a load balancer to redirect traffic for this application to another server.

Shutdown executable parameters

Parameters for the executable to run when an application pool is shut down by Rapid Fail Protection.

Disable overlapped recycle

If selected, when the application pool recycles, the existing worker process exits before another worker process is created.

Disable recycling for configuration changes

If selected, the application pool does not recycle when its configuration is changed.

Private memory limit (KB)

Maximum amount of private memory, in KB, that a worker process can consume before the application pool is recycled. A value of 0 means there is no limit.

Regular time interval (minutes)

Period of time, in minutes, after which an application pool recycles. A value of 0 means the application pool does not recycle at a regular interval.

Request limit

Maximum number of requests an application pool can process before it is recycled. A value of 0 means the application pool can process an unlimited number of requests.

Specific times

A set of specific local times, in 24-hour format, when the application pool is recycled.

Virtual memory limit (KB)

Maximum amount of virtual memory, in KB, that a worker process can consume before the application pool is recycled. A value of 0 means there is no limit.

Additional parameters

Additional parameters to pass to appcmd.exe.

Application name

The website and virtual path to contain the virtual directory to create (for example, Default Web Site/myapp02).

Virtual path

Virtual path of the virtual directory (for example, /myvirtualdir).

Absolute physical path

The absolute physical path of the Virtual Directory to create (for example, c:/Inetpub/wwwroot/myvdir).

Create Directory?

If selected, the specified directory is created if it does not exist.

Credential

Credentials used to access the site folder. It can be used for network paths.

Website Name

The name of the website to add the application to (for example, Default Web Site).

Virtual Path

Virtual path of the application (for example, /myApplication).

Absolute Physical Path

The absolute physical path of the application to create (for example,c:/Inetpub/wwwroot/myApp).

Create Directory?

If selected, the specified directory is created if it does not already exist.

Credential

Credentials used to access the site folder. It can be used for network paths.

Website name

The name of the website to create.

Website path

If specified, the root application containing a root virtual directory pointing to the specified path is created for this site. If omitted, the site is created without a root application and cannot be started until one is created.

Website ID

ID of the website.

List of bindings

Comma-separated list of bindings that use the friendly form of http://domain:port,…​ or raw form of protocol/bindingInformation,…​.

Create Directory?

If selected, the specified directory is created if it does not already exist.

Credential

Credentials used to access the site folder. It can be used for network paths.

Application Name

The website that contains the application to delete (for example, Default Web Site/ or Site1/myapp).

Strict Mode

If selected, the procedure fails if the specified application does not exist.

Virtual directory name

The website and virtual path that contain the virtual directory to delete (for example, Default Web Site/ or Site1/myapp).

Strict mode

If selected, the procedure fails if the specified virtual directory does not exist.

Website name

The name of the website to delete (for example, Default Web Site/ or Site1/myapp).

Strict mode

If selected, the procedure fails if the specified application does not exist.

Application pool name

The name of the website to delete (for example, Default Web Site/ or Site1/myapp).

Strict mode

If selected, the procedure fails if the specified application pool does not exist.

Destination path

Required. Path to the destination directory. This must be a physical directory, but it may have an IIS virtual directory pointing to it (for example, C:\inetpub\wwwroot\copyTest).

Path to XCOPY

Required. Provide the relative or absolute path to the XCOPY executable.

Source path

Required. Provide the path to the source directory (for example, C:\inetpub\wwwroot\test).

Additional options

Option switches for the XCOPY executable, excluding source and destination directories. The default options are those recommended by Microsoft for ASP.NET and IIS website deployment; exercise caution when changing these options.

MS deploy path

Provide the relative or absolute path to the MSDeploy executable.

Deploy source path

A path to package (for example, application.zip) or to a directory that contains the content to be deployed.

Destination website

Name of the website to be deployed.

Destination application

Name of the application to be deployed. If not provided, the content is placed under the website.

Application pool name

Application pool name. If the application pool does not exist, it is created. If not specified, the application is placed into the default pool, which has the same name as the website.

.NET framework version

The Microsoft® .NET Framework version 3.5 includes all the functionality of earlier versions, introduces new features for the technologies in versions 2.0 and 3.0, and provides additional functionality in the form of new assemblies. To use version 3.5, install the appropriate version of .NET Framework and use the product-specific guidelines.

Enable 32-bit applications

If selected for an application pool on a 64-bit operating system, the worker processes serving the application pool run in WOW64 (Windows on Windows64) mode. In WOW64 mode, 32-bit processes load only 32-bit applications.

Managed pipeline mode

Configures ASP.NET to run in classic mode as an ISAPI extension or in integrated mode where managed code is integrated into the request-processing pipeline.

Queue length

Maximum number of requests that HTTP.sys queues for the application pool. When the queue is full, new requests receive a 503 "Service Unavailable" response.

Start automatically

If selected, the application pool starts on creation or when IIS starts. Starting an application pool sets this property to True. Stopping an application sets this property to False.

Additional settings for application pool

Additional parameters to pass to appcmd.exe for application pool configuration.

Additional Parameters

Additional parameters (for example, -enableRule:AppOffline) to pass to Web Deploy. For the list of available settings, refer to Web Deploy Command Line Reference.

MS deploy path

Relative or absolute path to the MSDeploy executable.

Web site name

Website name to undeploy.

Application name

An application name to undeploy.

Delete virtual directories?

Deletes the specified website or web application, including any virtual directories and their content.

Strict mode

If selected, the procedure fail if the specified website does not exist.

MSDeploy path

Provide the relative or absolute path to the MSDeploy executable.

Verb

Web Deploy operations enable you to gather information from, move, or delete deployment objects like websites and web applications. Web Deploy operations are specified on the command line with the -verb argument. The Web Deploy operations are dump, sync, delete, getDependencies, and getSystemInfo.

Source provider

Provider that processes specific source or destination data for Web Deploy. For example, the contentPath provider determines how to work with directory, file, site, and application paths. On the Web Deploy command line, the provider name is specified immediately after the -source: or -dest: argument.

Source provider object path

Path of the provider object. Some providers require a path and some do not. If required, the type of path depends on the provider.

Source provider settings

Settings to modify a source provider using the general syntax.

Destination provider

Providers process specific source or destination data for Web Deploy. For example, the contentPath provider determines how to work with directory, file, site, and application paths. On the Web Deploy command line, the provider name is specified immediately after the -source: or -dest: argument.

Destination provider object path

Path of the provider object. Some providers require a path and some do not. If required, the kind of path depends on the provider.

Destination provider settings

Settings to modify a destination provider using the general syntax.

Allow untrusted?

If selected, untrusted server certificates are allowed when using SSL.

Pre-sync command

A command to execute before the synchronization on the destination. For instance, net stop [service name].

Post-sync command

A command to execute after the synchronization on the destination. For instance, net start [service name].

Additional options

Additional options to be passed to msdeploy.exe (for example, -retryAttempts=5).

Set param file

Applies parameter settings from an XML file. This can be a file path or file content.

Declare param file

Includes parameter declarations from an XML file. This can be a file path or file content.

Application pool name

The name of the application pool to start (for example, FirstAppPool).

Website name

Provide the descriptive name of the website you want to start (for example, Default Web Site).

Application pool name

The name of the application pool to stop (for example, FirstAppPool).

Website name

Provide the descriptive name of the website you want to stop (for example, Default Web Site).

Application pool name

Name of the application pool to recycle.

Application pool name

Name of the application pool to assign the application (for example, FirstAppPool).

Application name

Name of the application to assign (for example, /test).

Site name

Name of the site that contains the application to assign (for example, Default Web Site).

User-defined criteria

User-defined criteria to search the sites (for example, /bindings:http/*:80:). If not specified, all sites are listed.

Property name

Property to write retrieved data.

Dump format

Format to represent retrieved data. Data can be represented as XML, JSON, raw (only stdout from appcmd.exe) and property sheet (hierarchy).

Site name

Name of the site to search for applications. If not specified, all applications are listed.

Property name

Property to write retrieved data.

Dump format

Choose the format to represent retrieved data. Data can be represented as XML, JSON, raw (only stdout from appcmd.exe) and property sheet (hierarchy).

User-defined criteria

User-defined criteria to search the application pools (for example, /apppool.name:"my pool"). If not specified, all pools are listed.

Property name

Property to write retrieved data.

Dump format

Format to represent retrieved data. Data can be represented as XML, JSON, raw (only stdout from appcmd.exe) and property sheet (hierarchy).

Virtual directory name

Virtual directory name to retrieve. If not provided, all virtual directory names are retrieved.

Property name

Property to write retrieved data.

Dump format

Format to represent retrieved data. Data can be represented as XML, JSON, raw (only stdout from appcmd.exe) and property sheet (hierarchy).

Website Name

The name of the website to add a binding, i.e: Default Web Site. The site should exist on server.

Binding Protocol

Binding protocol to add (for example, http). Typically, the protocol is http or https. For FTP binding, refer to Add a Binding to a Site (IIS 7).

Binding Information

Information of the binding to add, including the host and the port (for example, localhost:443, *:81).

Host Header

Host headers (also known as domain names or host names) that allow you to assign more than one site to a single IP address on a web server (for example, myhost.com).

Absolute location of the IISRESET utility.

Absolute path of the script utility that executes this step. If only iisreset is entered, the IISRESET tool must be located on the system path c:/windows/system32 (for example, iisreset or c:/MyDir/IISFiles/iisreset.exe).

Additional parameters

Additional parameters to pass to the IISRESET utility.

Absolute location of the IISRESET utility.

Absolute path of the script utility that execute this step. If only iisreset is entered, the IISRESET tool must be located on the system path c:/windows/system32 (for example, iisreset or c:/MyDir/IISFiles/iisreset.exe).

Additional parameters

Additional parameters to pass to the IISRESET utility.

Absolute location of the IISRESET utility.

Absolute path of the script utility used to execute this step. If only iisreset is entered, the IISRESET tool must be located on the system path c:/windows/system32 (for example, iisreset or c:/MyDir/IISFiles/iisreset.exe).

Additional parameters

Additional parameters to pass to the IISRESET utility.

IP

IP address for the certificate (for example, 0.0.0.0). Either the IP address or the Hostname parameter hostname must be provided.

Hostname

Hostname for the certificate (for example, mysite.com). Either this hostname or the IP parameter should be provided.

Port

Port to add the SSL certificate to (for example, 443).

Certificate Store

The name of the certificate store (for example, My).

Certificate Hash (Thumbprint)

The certificate hash. The certificate hash can be found on the Server Certificates tab of the IIS console (for example, b4 7c 04 0c 0a 7e fc f5 3f 9e 12 fc df 07 30 ee b1 d6 04 88). Spaces are not required.