This page serves as a reference to all CloudBees CD/RO server settings. Server settings are divided into categories based on their function and control various aspects of CloudBees CD/RO server operation. To access server settings in the CloudBees Software Delivery Automation UI, select from the main menu. From here you can view or edit settings as needed.
| Only CloudBees Software Delivery Automation system administrators have privileges to modify settings. |
Each entry contains:
-
The name as it appears in the Server settings UI.
-
The corresponding property name to use with property management commands to programmatically manage its value. For more information, refer to CloudBees CD/RO APIs.
-
A description.
-
The default value.
-
The license type for which the setting is available. Choices are
-
CloudBees CD/RO: Available for installations with license typeServer. -
CloudBees Software Delivery Automation: Available for installations with license typeSDA.
For example, a setting available only for
CloudBees CD/ROdenotes it is only available on installations with aServerlicense. Learn more about licenses here. -
Agent Settings
| Setting | Property | Description |
|---|---|---|
Agent abort timeout |
|
The number of milliseconds the server waits for responses to the abort agent command. After this timeout has elapsed, the step is force aborted. Default value: Applicable for: CloudBees CD/RO |
Agent connection timeout |
|
The number of milliseconds to wait for connections to agents to open. Default value: Applicable for: CloudBees CD/RO |
Agent heartbeat interval |
|
The number of seconds between pings to all enabled and busy agents. An update of this setting takes effect after server restart. Default value: Applicable for: CloudBees CD/RO |
Agent heartbeat spread |
|
If true, the heartbeat pings to all enabled and busy agents in other zones are spread out over the period of the agent heartbeat interval, rather than all happening at the beginning of the interval. This reduces load spikes in ping traffic through zone gateways, but makes it take longer after a server restart for agents in other zones to pick up on changes to the server. An update of this setting takes effect after server restart. Default value: Applicable for: CloudBees CD/RO |
Agent ping failure max retry interval |
|
When an agent ping fails, the max interval, in seconds, at which the server re-pings the agent until the ping succeeds, the resource is disabled, or the resource is deleted. Default value: Applicable for: CloudBees CD/RO |
Agent socket timeout |
|
The number of milliseconds the server waits for responses to agent commands. Default value: Applicable for: CloudBees CD/RO |
Agent waits for all descendants |
|
Controls how the agent determines step completion. Default value: Applicable for: CloudBees CD/RO |
Default agent host type |
|
Controls the default setting for a agent host type when it is not defined while creating a resource. Valid values are Default value: `` Applicable for: CloudBees CD/RO |
Default agent port |
|
The default port number used by agents. Default value: Applicable for: CloudBees CD/RO |
Idle connection timeout |
|
The number of milliseconds to keep idle connections open. Default value: Applicable for: CloudBees CD/RO |
Maximum agent connections total |
|
Controls how many connections the server will open across all agents. If the connection limit is reached, the server will enqueue additional requests. Default value: Applicable for: CloudBees CD/RO |
Maximum connections per agent |
|
Controls how many connections the server will open to a single agent. If the connection limit is reached, the server will enqueue additional requests. Default value: Applicable for: CloudBees CD/RO |
Artifact Management
| Setting | Property | Description |
|---|---|---|
Artifact Publish from UI |
|
Controls visibility of Publish Artifact button on UI. Default value: Applicable for: CloudBees CD/RO |
Artifact Version name template |
|
The default template used to name new artifactVersions. Default value: Applicable for: CloudBees CD/RO |
Initial delay between retries for Retrieve Artifact |
|
Initial delay (in milliseconds) between retries when doing artifact retrieval. Default value: Applicable for: CloudBees CD/RO |
Maximum delay between retries for Retrieve Artifact |
|
Maximum delay (in milliseconds) between retries when doing artifact retrieval. Default value: Applicable for: CloudBees CD/RO |
Number of retries for Retrieve Artifact |
|
Number of retries when doing artifact retrieval. Default value: Applicable for: CloudBees CD/RO |
Upload Artifact Directory |
|
Upload Artifact Directory. Default value: Applicable for: CloudBees CD/RO |
Compliance Settings
| Setting | Property | Description |
|---|---|---|
Max timeout |
|
The maximum number of minutes the server waits for a response to a compliance request. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Poll frequency |
|
Controls how often, in minutes, a Compliance request is scheduled to be re-run. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Data Retention
| Setting | Property | Description |
|---|---|---|
Data Retention Management |
|
When enabled, the data retention management service is run periodically to archive or purge data based on the defined data retention policies. Default value: Applicable for: CloudBees CD/RO |
Data Retention Management batch size |
|
Number of objects to process as a batch for a given data retention policy in one iteration. Default value: Applicable for: CloudBees CD/RO |
Data Retention Management service frequency in minutes |
|
Controls how often, in minutes, the data retention management service is scheduled to run. Default value: Applicable for: CloudBees CD/RO |
Maximum iterations in a Data Retention Management cycle |
|
Maximum number of iterations performed in a scheduled data retention management cycle. Default value: Applicable for: CloudBees CD/RO |
Maximum number of simultaneously running cleanup jobs |
|
Maximum number of simultaneously running cleanup jobs. If the value is exceeded, the iteration of the retention date will be skipped. Default value: Applicable for: CloudBees CD/RO |
Number of minutes after which archived data maybe purged |
|
Number of minutes after which archived data maybe purged if a data retention policy is setup to purge the data after archiving. Default value: Applicable for: CloudBees CD/RO |
Email Notifications
| Setting | Property | Description |
|---|---|---|
Date and time format for email notifications |
|
Format to use for rendering date and time in email notifications Default value: Applicable for: CloudBees CD/RO |
Date and time timezone for email notifications |
|
Timezone to use for rendering date and time in email notifications Default value: Applicable for: CloudBees CD/RO |
Set the 'From' header when sending email notifications |
|
If true, set the Default value: Applicable for: CloudBees CD/RO |
JavaScript
| Setting | Property | Description |
|---|---|---|
Maximum JavaScript duration |
|
Controls the maximum duration of JavaScript execution, in seconds. Default value: Applicable for: CloudBees CD/RO |
Maximum JavaScript stack depth |
|
Controls the maximum stack depth allowed in JavaScript. Default value: Applicable for: CloudBees CD/RO |
Property Modification in JavaScript |
|
If true, property modification in JavaScript is not allowed. Default value: Applicable for: CloudBees CD/RO |
Name Templates
| Setting | Property | Description |
|---|---|---|
Application process job name template |
|
The default template used to name new jobs created from a application process run. Default value: Applicable for: CloudBees CD/RO |
Flow name template |
|
The default template used to name flow runtimes. Default value: Applicable for: CloudBees CD/RO |
Job name template |
|
The default template used to name new jobs. Default value: Applicable for: CloudBees CD/RO |
Pipeline name template |
|
The default template used to name pipeline runtimes. Default value: Applicable for: CloudBees CD/RO |
Release name template |
|
The default template used to name pipeline runtimes associated with release. Default value: Applicable for: CloudBees CD/RO |
Service process job name template |
|
The default template used to name new jobs created from a service process run. Default value: Applicable for: CloudBees CD/RO |
Workflow name template |
|
The default template used to name new workflows. Default value: Applicable for: CloudBees CD/RO |
Pipeline
| Setting | Property | Description |
|---|---|---|
Enable progress percentage data fix |
|
Flag to indicate if progress percentage for previously completed pipeline or release runs is enabled. Default value: Applicable for: CloudBees CD/RO |
Enable root flowRuntime reference fix |
|
Flag to indicate if fixing up for root flowRuntime references for old flowRuntimeStates is enabled Default value: Applicable for: CloudBees CD/RO |
Maximum number of required approvals |
|
Maximum number of users from a group that should approve a gate rule or a manual task to make it finally approved. Default value: Applicable for: CloudBees CD/RO |
Pipeline task runtime job name template |
|
The default template used to name new jobs created from a pipeline task runtime when running a procedure. Used only if the procedure does not have a jobNameTemplate. Default value: Applicable for: CloudBees CD/RO |
Portfolio View Auto Refresh Threshold |
|
Auto refresh in the Portfolio Views will be disabled when the number of records reaches this threshold. Default value: Applicable for: CloudBees CD/RO |
flowRuntime Hierarchy Data Fix |
|
Flag to indicate if flowRuntime hierarchy data fix is enabled Default value: Applicable for: CloudBees CD/RO |
Scheduler Settings
| Setting | Property | Description |
|---|---|---|
Maximum background delete batch size |
|
Maximum number of objects to delete in a single batch. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum background delete delay |
|
Controls the maximum amount of time between invocations of the background delete thread, in seconds. Default value: Applicable for: CloudBees CD/RO |
Maximum expired sessions delete batch size |
|
Maximum number of expired sessions to delete in a single batch. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum number of job steps to process before resource scheduler commits pending work |
|
Specifies the maximum number of job steps the resource scheduler will process before committing pending work. This setting is considered along with the timeout calculated using Default value: Applicable for: CloudBees CD/RO |
Maximum number of log calls in a scheduler pass |
|
Number of log calls during a scheduler pass after which log output from the scheduler is throttled. Default value: Applicable for: CloudBees CD/RO |
Maximum step retry delay |
|
Maximum delay in milliseconds between retries after a failed attempt to start a job step on a resource. Default value: Applicable for: CloudBees CD/RO |
Maximum time before resource scheduler commits pending work |
|
Specifies the most amount of time in milliseconds that the resource scheduler will continue to look for other schedulable steps before committing pending assignments. Default value: Applicable for: CloudBees CD/RO |
Maximum time in minutes between runs of the resource scheduler (if not otherwise triggered) when operating in a cluster |
|
Specifies the longest amount of time between runs (if not triggered) of the resource scheduler in a cluster. The purpose of this is to ensure that even if a resource scheduler trigger message between nodes is lost due to network problems, the job will not be stalled indefinitely if no other jobs are running. Default value: Applicable for: CloudBees CD/RO |
Minimum time before resource scheduler commits pending work |
|
Specifies the least amount of time in milliseconds that the resource scheduler will continue to look for other schedulable steps before committing pending assignments. Default value: Applicable for: CloudBees CD/RO |
Number of separate threads the resource scheduler attempts to split its work across |
|
Specifies the number of buckets that the step scheduler attempts to divide resources into, and thus the number of threads that it runs to handle these buckets of work. Defaults to 1, minimum 1, maximum 8. An update of this setting takes effect after server restart. Default value: Applicable for: CloudBees CD/RO |
Security Settings
| Setting | Property | Description |
|---|---|---|
Allow ACLs for non existent principals |
|
Specifies whether access control entries are allowed for principals that do not exist in the system. Principal types include users, groups, projects and service accounts. Changing the value from Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Auto register SSO users |
|
Whether users authenticated by the SSO identity providers will be automatically registered, if not available through the configured directory providers. Default value: Applicable for: CloudBees CD/RO |
CRL certificate reload frequency in days |
|
Controls how often (in days) CRL certificates are reloaded. Default value: Applicable for: CloudBees CD/RO |
Credential Password Recovery |
|
Controls the default setting of whether credential password recovery is allowed. If true, then credentials that don’t explicitly override this setting will be recoverable. Default value: Applicable for: CloudBees CD/RO |
Default token timeout |
|
Configure default TTL for tokens which will apply to all users and newly generated tokens. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Enable ACL caching |
|
If true, enable ACL caching. Default value: Applicable for: CloudBees CD/RO |
Enable admin user |
|
If true, enable logins by the admin user. Default value: Applicable for: CloudBees CD/RO |
Enable idle session timeout |
|
If true, enable idle session timeout. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Enable read-only admin user |
|
If true, enable logins by admin-readonly user. The admin user must change the system-generated password for the admin-readonly user when enabling the user for the first time. Default value: Applicable for: CloudBees CD/RO |
Group claim SAML attribute delimiter |
|
Delimiter used in case multiple groups are sent as a single-valued attribute in the SAML response. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Idle session timeout |
|
The number of minutes of inactivity before the session is automatically terminated. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Idle session timeout flush interval |
|
Interval with which the server flushes the session cache to the database to update the session last activity time. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Local Users |
|
If true, enable logins by local users. Default value: Applicable for: CloudBees CD/RO |
Maximum number of user access tokens for a user |
|
Controls the maximum number of user access tokens. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum session duration |
|
Number of minutes before a user session is terminated. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum token timeout |
|
Configure the max TTL for tokens which will apply to all users and to newly generated tokens. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Minimum token timeout |
|
Configure min TTL for tokens which apply to all users and newly generated tokens. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Protocols for SSL connections to the SMTP server |
|
Whitespace-separated list of protocols that will be enabled for SSL connections to the SMTP server. Used to set Default value: Applicable for: CloudBees CD/RO |
System Settings
| Setting | Property | Description |
|---|---|---|
CI polling interval |
|
Controls how often, in seconds, the CloudBees CD/RO server requests data from the CI build. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Default background plugin statistics thread schedule |
|
Default background plugin statistics watchdog thread schedule Default value: Applicable for: CloudBees CD/RO |
Delay between cluster membership change and a resulting change of service leadership |
|
In clustered mode, this specifies the delay in seconds from when a node gets notification of a change in cluster membership that causes it to no longer be the node hash-designated to run a service that it is currently the leader for until when that node resigns from leadership of that service and precipitates a new leadership election. This delay is intended to allow cluster membership to stabilize (e.g. when several nodes are started or stopped together), and to allow time for all nodes to be notified of the changes and for the new hash-designated owner to submit its name for election. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Enable Hibernate statistics logging |
|
If true, enable per-operation Hibernate statistics logging. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Enable sending statds metrics |
|
If true (and a statsd metrics server has been configured), enables sending system metrics to that server. Default value: Applicable for: CloudBees CD/RO |
Enabling/disabling change tracking at a project level |
|
Controls who is allowed to enable/disable change tracking at a project level. Valid values are Default value: Applicable for: CloudBees CD/RO |
Event log retain time |
|
Number of minutes worth of entries to retain in the event log. Zero disables automatic deletion of event log entries. Default value: Applicable for: CloudBees CD/RO |
How often to record cluster diagnostics |
|
Controls how often cluster diagnostics are emitted to the server log, in seconds. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
How often to record memory diagnostics |
|
Controls how often server memory usage diagnostics are emitted to the server log, in seconds. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Job summaries minimum jobs |
|
Minimum number of jobs the getJobSummaries API requests from the database. Default value: Applicable for: CloudBees CD/RO |
Max DSL duration |
|
Controls the maximum duration of DSL execution, in seconds. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Max number of latest trigger errors to keep |
|
Max number of latest errors for every trigger to keep. Other older errors will be removed. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum Number of Records for Change Tracking |
|
Maximum number of records returned by any change tracking query. Cannot exceed and defaults to a value CHANGE_TRACKING_HARD_MAX_RECORDS set in wrapper.conf Default value: Applicable for: CloudBees CD/RO |
Maximum connections to the database |
|
Controls the maximum number of database connections the server can use. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum idle time before a user license expires |
|
Specifies the maximum idle time of a user’s license in seconds before it is returned to the pool of available licenses. Default value: Applicable for: CloudBees CD/RO |
Maximum logged message length |
|
Controls the maximum size of an XML message that the server will log. Messages larger than this will be truncated. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Maximum upload size |
|
Specifies the maximum size of file that the server will accept as an uploaded attachment. Default value: Applicable for: CloudBees CD/RO |
Plugins directory |
|
Specifies the directory where plugins will be installed by the server. If not provided, defaults to ${DATA_DIRECTORY}/plugins. Default value: `` Applicable for: CloudBees CD/RO |
Reservation recurrence interval |
|
Used as default recurrence end time for a reservation when generating time slots Default value: Applicable for: CloudBees CD/RO |
SSL for Stomp |
|
If provided, determines whether the stomp protocol uses SSL. If not provided, the default is to use SSL. The server must be restarted for the setting to take effect. Default value: Applicable for: CloudBees CD/RO |
Select resources in creation order from pools |
|
Controls the order in which pooled resources are selected when other criteria (exclusivity, step count, e.g.) are the same. If true, pre-3.10 behavior is used (creation order). If false, the resource is chosen randomly. Default value: Applicable for: CloudBees CD/RO |
Send Usage Data |
|
This information is used by CloudBees to help make CloudBees CD/RO better and more intuitive to use. Telemetry collects anonymized aggregated information and does not collect any identifying information like user names. For privacy reasons, you can turn off the ability to send telemetry data to CloudBees. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Server IP address |
|
If provided, this property is sent to the agents as the IP address of the server. If not present, the server sends the IP address of its first non-localhost network interface. Default value: `` Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Server status message capacity |
|
The maximum number of server status messages that will be preserved. Older messages will be removed to make room for new ones. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Stomp Client URI |
|
If provided, this property is used as the URI for stomp clients. If not present, a default value is calculated using the server’s host name. The server must be restarted for the setting to take effect. Default value: `` Applicable for: CloudBees CD/RO |
Temporary directory |
|
Specifies the directory where the server should place temporary files that it creates. If a relative path is specified, the directory is considered relative to the Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Tutorials |
|
Controls if the tutorials should be enabled or disabled. Default value: Applicable for: CloudBees CD/RO |
Upload file threshold size |
|
Size at which uploads are spooled to disk instead of being buffered in memory Default value: Applicable for: CloudBees CD/RO |
Use API context for DSL properties |
|
If true, use API context for DSL properties. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Wait time for job which is waiting for reservation |
|
Wait time for job which is waiting for reservation Default value: Applicable for: CloudBees CD/RO |
Web Server Host |
|
Specifies the web server host. This field can be specified as <hostname> or <hostname>:<port>, if port is other than 80. If load balancer is used for web servers, then set value to the load balancer’s host. If this value is not set, then access to this property would return value from /server/hostName. Default value: `` Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Webhook session timeout |
|
Number of minutes before a webhook session is terminated. Default value: Applicable for: CloudBees CD/RO |
UI Settings
| Setting | Property | Description |
|---|---|---|
Auto refresh pause time |
|
Time after which auto-refresh will pause if there is no user activity. By default, this feature is disabled (set to 0). Enabling this feature requires setting a value greater than 0, which represents the pause duration in minutes. Default value: Applicable for: CloudBees CD/RO |
Choose a header color |
|
The header color to display when the Instance header is enabled. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Choose a header icon |
|
The header icon to display when the Instance header is enabled. Default value: Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |
Instance header |
|
When enabled, the UI displays the header using the configured header label, color, and icon. Default value: Applicable for: CloudBees CD/RO |
UI auto-refresh frequency in seconds |
|
Controls how often, in seconds, the UI pages (such as the Pipeline Runs and Releases pages) automatically refresh. This setting is not for other platform pages. Default value: Applicable for: CloudBees CD/RO |
UI header label |
|
The text to display when the Instance header is enabled. You can add links by using the following syntax: Default value: `` Applicable for: CloudBees Software Delivery Automation, CloudBees CD/RO |