ecconfigure

The ecconfigure tool allows you to update configuration file settings for any locally-installed component using the command line.

The information below applies to traditional installations of CloudBees CD/RO only. For Kubernetes installations, update your configuration values using Helm chart settings for the specific .ecconfigure property. For more information, refer to Configuring Helm charts.

ecconfigure command syntax

ecconfigure [<options>]▼

For Linux platforms, restarting services may be required to apply setting changes. When using ecconfigure to apply changes, if the environment:

Uses systemd service management, and;
ecconfigure is not running as root;

you may receive the following warning when ecconfigure attempts to restart the service:

WARNING: ecconfigure is not run as root user and does not have rights
    to restart the commanderAgent.service service.
    Please run the following command manually to apply the configuration:
    $ sudo systemctl reload-or-restart commanderAgent.service

This is because ecconfigure does not have privileges to start, stop, or restart services. In this case, you must execute the command manually to apply changes. To avoid manual commands, you can also run ecconfigure commands with elevated privileges using sudo ecconfigure.

Agent

Option Description

Option	Description
--agentAcceptQueueSize=max	The maximum number of pending connections the agent will queue up.
--agentArtifactCache=path	The directory containing cached artifactVersions.
--agentCaFile=path	A single file containing multiple CA certificates.
--agentCaPath=path	A directory containing a file for every CA, where each file’s name is the CA subject name hash value.
--agentCertFile=path	Location of the certificate file used by the agent to support SSL connections from the server.
--agentCrlFile=relativepath	Relative path of the file containing the agent’s certificate revocation list for SSL.
--agentDomainName=domain	The domain name that the agent uses for fully-qualified names.
--agentDuplicateDetectionListSize=size	The size of the list of recently seen requests used in duplicate request detection.
--agentEnableProxySettings=<1\|0>	Deprecated. Use `--agentEnableHttpProxySettings`.
--agentEnableHttpProxySettings=<1\|0>	Enable (1) or disable (0) the HTTP proxy server configuration. If enabling for the first time, `--agentHttpProxyHost` and `--agentHttpProxyPort` must be specified.
--agentEnableHttpProxyAuthentication=<1\|0>	Enable (1) or disable (0) authentication for the HTTP proxy server. If enabling for the first time, `--agentHttpProxyUser` and `--agentHttpProxyPassword` must be specified.
--agentEnableHttpsProxyAuthentication=<1\|0>	Enable (1) or disable (0) authentication for the HTTPS proxy server. If enabling for the first time, `--agentHttpsProxyUser` and `--agentHttpsProxyPassword` must be specified.
--agentEnableHttpsProxySettings=<1\|0>	Enable (1) or disable (0) the HTTPS proxy server configuration. If enabling for the first time, `--agentHttpsProxyHost` and `--agentHttpsProxyPort` must be specified.
--agentHttpProxyUser=user	The username for authentication on the HTTP proxy server.
--agentHttpProxyPassword=password	The password for authentication on the HTTP proxy server.
--agentHttpsProxyUser=user	The username for authentication on the HTTPS proxy server.
--agentHttpsProxyPassword=password	The password for authentication on the HTTPS proxy server.
--agentHttpsProxyHost=host	The IP address of the HTTPS proxy server.
--agentHttpsProxyPort=port	The port of the HTTPS proxy server.
--agentProxyHost=host	Deprecated. Use `--agentHttpProxyHost`.
--agentHttpProxyHost=host	The IP address of the HTTP proxy server.
--agentProxyPort=port	Deprecated. Use `--agentHttpProxyPort`.
--agentHttpProxyPort=port	The port of the HTTP proxy server.
--agentIdleConnectionTimeout=milliseconds	Idle connection timeout, in milliseconds.
--agentIdleOutboundConnectionTimeout=seconds	Idle time after which an outbound connection is closed, in seconds.
--agentIdlePostRunnerTimeout=seconds	Idle time after which a PostRunner thread is terminated, in seconds.
--agentIdleServerRequestWorkerTimeout=seconds	Idle time after which a ServerRequestWorker thread is terminated, in seconds.
--agentIdleWorkerTimeout=seconds	Idle time after which a Worker thread is terminated, in seconds.
--agentInitMemory=percent	Initial java heap size as a percentage of the total system memory.
--agentInitMemoryMB=size	Initial java heap size in MB.
--agentKeyFile=path	Location of the key file used by the agent to support SSL connections from the server.
--agentKeystore=path	Location of the keystore file used by the agent to support SSL connections from the server.
--agentKeystorePassword=password	Password used to access the agent’s keystore.
--agentLoadProfile=<true\|yes\|1\|false\|no\|0>	Enable (1) or disable (0) loading the impersonated user’s profile for impersonation steps if on Windows.
--agentLocalPort=port	Port used by the Commander agent for http communication on the localhost network interface.
--agentLogFile=path	Path where the C++ agent log file should be written.
--agentLogLevel=<TRACE\|DEBUG\|INFO\|WARN\|ERROR>	Logging level used by the C++ portion of the agent.
--agentLogMaxFiles=max	Maximum number of log files the C++ agent will accrue.
--agentLogMaxSize=max	Maximum size of each log file from the C++ agent. The value may be suffixed with a unit (MB, KB, B). Without a unit, the value is interpreted as bytes.
--agentMaxConnections=max	Maximum number of network connections for the agent.
--agentMaxConnectionsPerRoute=max	Maximum number of network connections per route for the agent.
--agentMaxHttpThreads=max	Maximum number of threads for handling inbound requests.
--agentMaxLoggedMessageLength=max	Maximum message length, used when logging requests/ responses to/from the CloudBees CD/RO server.
--agentMaxMemory=percent	Maximum java heap size as a percentage of the total system memory.
--agentMaxMemoryMB=size	Maximum java heap size in MB.
--agentNoProxyHosts=hosts	Deprecated. Use `--agentNonProxyHosts`.
--agentNonProxyHosts=hosts	Comma delimited list of hosts that are reached directly, bypassing the HTTP/HTTPS proxy servers.
--agentOutboundConnectTimeout=milliseconds	Timeout for the agent establishing outbound connections, in milliseconds.
--agentOutboundRequestInitialRetryInterval=seconds	Initial delay between retries for sending outbound requests to a server, in seconds.
--agentOutboundRequestMaxRetryInterval=seconds	Maximum delay between retries for sending outbound requests to a server, in seconds.
--agentOutboundRequestTimeout=hours	Timeout after which the agent gives up trying to send a request to a server, in hours.
--agentPluginsDirectory=path	The path used by the agent to get to the plugins directory of the CloudBees CD/RO server where its resource definition lies.
--agentPort=port	Port used by the Commander agent for https communication on any network interface.
--agentProto=<http\|https>	Protocol used internally by the agent.
--agentProtocol=<http\|https>	Protocol used by the agent.
--agentServerConnectTimeout=seconds	Socket connection timeout for outbound requests to a server, in seconds.
--agentServerReadTimeout=seconds	Socket read timeout for responses from a server, in seconds.
--agentServerSessionsFile=relativepath	Relative path to the persisted server sessions file.
--agentTLSEnabledProtocol < protocols >	Comma-delimited list of SSL/TLS protocols that will be allowed for agent connections using HTTPS. The possible values are any combination of `TLSv1`, `TLSv1.1`, `TLSv1.2`, and `SSLv2Hello`. The default security configurations are as follows: First-time CloudBees CD/RO installations: TLSv1, TLSv1.1, and TLSv1.2 are enabled Existing CloudBees CD/RO installations: TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello are enabled CloudBees recommends removing the `SSL 2.0 Client Hello` or `SSLv2Hello` protocol from your security configurations for all components. When you do this, you also need to upgrade older agents to the latest version to avoid security risks. You need to upgrade agents if you are using the following agent versions: Windows: 6.0.3 or older Linux: 6.2 or older Mac OS: 8.4 or older
--agentUnixShellPattern=pattern	Windows-only: ordinarily, the agent creates script-files with CRLF line termination. But some shells on Windows require script files to be LF line-terminated, like Unix. This option sets a regular expression pattern for such shells. Defaults to a pattern that matches sh and bash, which in modern versions of Cygwin require LF-terminated script files.
--agentVerifyPeer=<true\|yes\|1\|false\|no\|0>	Enable (1) or disable (0) verifying the certificate presented by the CloudBees CD/RO server when it connects.
--agentWrapperConsoleFormat=format	Format of output for the agent wrapper console.
--agentWrapperEcwrapperWriteMaxAttempts=max	Workspace write maximum attempts count.
--agentWrapperEcwrapperWriteRetryInterval=milliseconds	Workspace write interval between two attempts, in milliseconds.
--agentWrapperJavaAdditional=nnnnn=value	Set a custom line of the form wrapper.java.additional.nnnnn=value in the agent’s wrapper.conf file. nnnnn must be an integer >= 10000.
--agentWrapperJavaClasspath=n=path	The Java classpath. n must be an integer >= 1.
--agentWrapperJavaLibraryPath=n=path	The Java Library Path (location of Wrapper.DLL or libwrapper.so). n must be an integer >= 1.
--agentWrapperLogfile=path	Log file to use for agent wrapper output logging.
--agentWrapperLogfileFormat=format	Format of output for the agent wrapper log file.
--agentWrapperLogfileLoglevel=loglevel	Log Level for agent wrapper log file output.
--agentWrapperLogfileMaxsize=size	Maximum size that the log file will be allowed to grow to before the log is rolled. Size is specified in bytes, kilobytes with a `k` suffix, or megabytes with an `m` suffix.
--agentWrapperLogfileMaxfiles=max	Maximum number of rolled log files which will be allowed before old files are deleted.
--agentWrapperNtserviceDependency=n=service	NT service dependencies. Add dependencies as needed starting from 1. n must be an integer >= 1.
--agentWrapperNtserviceStarttype=<AUTO_START\|DEMAND_START>	Mode in which the NT service is installed.
--agentWrapperNtserviceInteractive=<true\|false>	Whether to allow the NT service to interact with the desktop.
--agentWrapperPingInterval=seconds	Java virtual machine-wrapper heartbeat interval, in seconds.
--agentWrapperPingTimeout=seconds	Java virtual machine-wrapper heartbeat timeout, in seconds.
--agentWrapperRequestThreadDumpOnFailedJvmExit=<true\|false>	Whether to try to get a thread dump if the Java virtual machine doesn’t exit cleanly.
--agentWrapperShutdownTimeout=seconds	The wrapper’s shutdown timeout, in seconds.
--agentWrapperStartupTimeout=seconds	The wrapper’s startup timeout, in seconds.
--agentWrapperSuccessfulInvocationTime=seconds	The amount of time the agent has to be up before the wrapper considers it a 'successful' invocation. If there are 5 or more consecutive failed invocations, the wrapper will no longer start up the agent.
--agentWrapperSyslogLoglevel=loglevel	Log Level for sys/event agent wrapper log output.

--agentAcceptQueueSize=max

The maximum number of pending connections the agent will queue up.

--agentArtifactCache=path

The directory containing cached artifactVersions.

--agentCaFile=path

A single file containing multiple CA certificates.

--agentCaPath=path

A directory containing a file for every CA, where each file’s name is the CA subject name hash value.

--agentCertFile=path

Location of the certificate file used by the agent to support SSL connections from the server.

--agentCrlFile=relativepath

Relative path of the file containing the agent’s certificate revocation list for SSL.

--agentDomainName=domain

The domain name that the agent uses for fully-qualified names.

--agentDuplicateDetectionListSize=size

The size of the list of recently seen requests used in duplicate request detection.

--agentEnableProxySettings=<1|0>

Deprecated. Use --agentEnableHttpProxySettings.

--agentEnableHttpProxySettings=<1|0>

Enable (1) or disable (0) the HTTP proxy server configuration. If enabling for the first time, --agentHttpProxyHost and --agentHttpProxyPort must be specified.

--agentEnableHttpProxyAuthentication=<1|0>

Enable (1) or disable (0) authentication for the HTTP proxy server. If enabling for the first time, --agentHttpProxyUser and --agentHttpProxyPassword must be specified.

--agentEnableHttpsProxyAuthentication=<1|0>

Enable (1) or disable (0) authentication for the HTTPS proxy server. If enabling for the first time, --agentHttpsProxyUser and --agentHttpsProxyPassword must be specified.

--agentEnableHttpsProxySettings=<1|0>

Enable (1) or disable (0) the HTTPS proxy server configuration. If enabling for the first time, --agentHttpsProxyHost and --agentHttpsProxyPort must be specified.

--agentHttpProxyUser=user

The username for authentication on the HTTP proxy server.

--agentHttpProxyPassword=password

The password for authentication on the HTTP proxy server.

--agentHttpsProxyUser=user

The username for authentication on the HTTPS proxy server.

--agentHttpsProxyPassword=password

The password for authentication on the HTTPS proxy server.

--agentHttpsProxyHost=host

The IP address of the HTTPS proxy server.

--agentHttpsProxyPort=port

The port of the HTTPS proxy server.

--agentProxyHost=host

Deprecated. Use --agentHttpProxyHost.

--agentHttpProxyHost=host

The IP address of the HTTP proxy server.

--agentProxyPort=port

Deprecated. Use --agentHttpProxyPort.

--agentHttpProxyPort=port

The port of the HTTP proxy server.

--agentIdleConnectionTimeout=milliseconds

Idle connection timeout, in milliseconds.

--agentIdleOutboundConnectionTimeout=seconds

Idle time after which an outbound connection is closed, in seconds.

--agentIdlePostRunnerTimeout=seconds

Idle time after which a PostRunner thread is terminated, in seconds.

--agentIdleServerRequestWorkerTimeout=seconds

Idle time after which a ServerRequestWorker thread is terminated, in seconds.

--agentIdleWorkerTimeout=seconds

Idle time after which a Worker thread is terminated, in seconds.

--agentInitMemory=percent

Initial java heap size as a percentage of the total system memory.

--agentInitMemoryMB=size

Initial java heap size in MB.

--agentKeyFile=path

Location of the key file used by the agent to support SSL connections from the server.

--agentKeystore=path

Location of the keystore file used by the agent to support SSL connections from the server.

--agentKeystorePassword=password

Password used to access the agent’s keystore.

--agentLoadProfile=<true|yes|1|false|no|0>

Enable (1) or disable (0) loading the impersonated user’s profile for impersonation steps if on Windows.

--agentLocalPort=port

Port used by the Commander agent for http communication on the localhost network interface.

--agentLogFile=path

Path where the C++ agent log file should be written.

--agentLogLevel=<TRACE|DEBUG|INFO|WARN|ERROR>

Logging level used by the C++ portion of the agent.

--agentLogMaxFiles=max

Maximum number of log files the C++ agent will accrue.

--agentLogMaxSize=max

Maximum size of each log file from the C++ agent. The value may be suffixed with a unit (MB, KB, B). Without a unit, the value is interpreted as bytes.

--agentMaxConnections=max

Maximum number of network connections for the agent.

--agentMaxConnectionsPerRoute=max

Maximum number of network connections per route for the agent.

--agentMaxHttpThreads=max

Maximum number of threads for handling inbound requests.

--agentMaxLoggedMessageLength=max

Maximum message length, used when logging requests/ responses to/from the CloudBees CD/RO server.

--agentMaxMemory=percent

Maximum java heap size as a percentage of the total system memory.

--agentMaxMemoryMB=size

Maximum java heap size in MB.

--agentNoProxyHosts=hosts

Deprecated. Use --agentNonProxyHosts.

--agentNonProxyHosts=hosts

Comma delimited list of hosts that are reached directly, bypassing the HTTP/HTTPS proxy servers.

--agentOutboundConnectTimeout=milliseconds

Timeout for the agent establishing outbound connections, in milliseconds.

--agentOutboundRequestInitialRetryInterval=seconds

Initial delay between retries for sending outbound requests to a server, in seconds.

--agentOutboundRequestMaxRetryInterval=seconds

Maximum delay between retries for sending outbound requests to a server, in seconds.

--agentOutboundRequestTimeout=hours

Timeout after which the agent gives up trying to send a request to a server, in hours.

--agentPluginsDirectory=path

The path used by the agent to get to the plugins directory of the CloudBees CD/RO server where its resource definition lies.

--agentPort=port

Port used by the Commander agent for https communication on any network interface.

--agentProto=<http|https>

Protocol used internally by the agent.

--agentProtocol=<http|https>

Protocol used by the agent.

--agentServerConnectTimeout=seconds

Socket connection timeout for outbound requests to a server, in seconds.

--agentServerReadTimeout=seconds

Socket read timeout for responses from a server, in seconds.

--agentServerSessionsFile=relativepath

Relative path to the persisted server sessions file.

--agentTLSEnabledProtocol < protocols >

Comma-delimited list of SSL/TLS protocols that will be allowed for agent connections using HTTPS. The possible values are any combination of TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello.

The default security configurations are as follows:

First-time CloudBees CD/RO installations: TLSv1, TLSv1.1, and TLSv1.2 are enabled
Existing CloudBees CD/RO installations: TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello are enabled

CloudBees recommends removing the SSL 2.0 Client Hello or SSLv2Hello protocol from your security configurations for all components. When you do this, you also need to upgrade older agents to the latest version to avoid security risks. You need to upgrade agents if you are using the following agent versions:

Windows: 6.0.3 or older
Linux: 6.2 or older
Mac OS: 8.4 or older

--agentUnixShellPattern=pattern

Windows-only: ordinarily, the agent creates script-files with CRLF line termination. But some shells on Windows require script files to be LF line-terminated, like Unix. This option sets a regular expression pattern for such shells. Defaults to a pattern that matches sh and bash, which in modern versions of Cygwin require LF-terminated script files.

--agentVerifyPeer=<true|yes|1|false|no|0>

Enable (1) or disable (0) verifying the certificate presented by the CloudBees CD/RO server when it connects.

--agentWrapperConsoleFormat=format

Format of output for the agent wrapper console.

--agentWrapperEcwrapperWriteMaxAttempts=max

Workspace write maximum attempts count.

--agentWrapperEcwrapperWriteRetryInterval=milliseconds

Workspace write interval between two attempts, in milliseconds.

--agentWrapperJavaAdditional=nnnnn=value

Set a custom line of the form wrapper.java.additional.nnnnn=value in the agent’s wrapper.conf file. nnnnn must be an integer >= 10000.

--agentWrapperJavaClasspath=n=path

The Java classpath. n must be an integer >= 1.

--agentWrapperJavaLibraryPath=n=path

The Java Library Path (location of Wrapper.DLL or libwrapper.so). n must be an integer >= 1.

--agentWrapperLogfile=path

Log file to use for agent wrapper output logging.

--agentWrapperLogfileFormat=format

Format of output for the agent wrapper log file.

--agentWrapperLogfileLoglevel=loglevel

Log Level for agent wrapper log file output.

--agentWrapperLogfileMaxsize=size

Maximum size that the log file will be allowed to grow to before the log is rolled. Size is specified in bytes, kilobytes with a k suffix, or megabytes with an m suffix.

--agentWrapperLogfileMaxfiles=max

Maximum number of rolled log files which will be allowed before old files are deleted.

--agentWrapperNtserviceDependency=n=service

NT service dependencies. Add dependencies as needed starting from 1. n must be an integer >= 1.

--agentWrapperNtserviceStarttype=<AUTO_START|DEMAND_START>

Mode in which the NT service is installed.

--agentWrapperNtserviceInteractive=<true|false>

Whether to allow the NT service to interact with the desktop.

--agentWrapperPingInterval=seconds

Java virtual machine-wrapper heartbeat interval, in seconds.

--agentWrapperPingTimeout=seconds

Java virtual machine-wrapper heartbeat timeout, in seconds.

--agentWrapperRequestThreadDumpOnFailedJvmExit=<true|false>

Whether to try to get a thread dump if the Java virtual machine doesn’t exit cleanly.

--agentWrapperShutdownTimeout=seconds

The wrapper’s shutdown timeout, in seconds.

--agentWrapperStartupTimeout=seconds

The wrapper’s startup timeout, in seconds.

--agentWrapperSuccessfulInvocationTime=seconds

The amount of time the agent has to be up before the wrapper considers it a 'successful' invocation. If there are 5 or more consecutive failed invocations, the wrapper will no longer start up the agent.

--agentWrapperSyslogLoglevel=loglevel

Log Level for sys/event agent wrapper log output.

Web server

Option Description

--skipServiceRestart

Disable the attempt to restart the web server. The CloudBees CD/RO web server can only be started with sudo access. Therefore, you must use sudo to restart it manually afterward or use the --skipServiceRestart option to disable the restart attempt.

--webCorsAllowOriginHosts=host

The host name(s) for the Access-Control-Allow-Origin cross-origin resource sharing (CORS) header. For example:

ecconfigure --webEnableCors false  --webCorsAllowOriginHosts https://<myHostName>▼

--webEnableCors=<true false>

Enable (true) or disable (false) to allow external applications to connect to the CloudBees CD/RO server with CORS requests.

CloudBees does not recommend disabling CORS because it provides open access across domain boundaries.

--webHostName=host

The host name of the current machine in the form that users will typically use in their browser to access the web server.

--webHttpPort=port

The HTTP port of the web server.

--webHttpsPort=port

The HTTPS port of the web server.

--webTargetHostName=host

The host name of the CloudBees CD/RO server to which the web server points.

This argument modifies the CloudBees CD/RO web server configuration and therefore also attempts to restart the CloudBees CD/RO web server. If you used the ecconfigure command without sudo as recommended, the commanderApache service will not start and produces an error. Therefore, you must restart it manually afterward using sudo. You can also use the --skipServiceRestart argument to avoid the ecconfigure command’s restart attempt and the error message.

--webTargetHttpPort=port

The HTTP port of the CloudBees CD/RO server to which the web server points.

--webTargetHttpsPort=port

The HTTPS port of the CloudBees CD/RO server to which the web server points.

--webTimeZone=timezone

The Olson TimeZone format (example: America/Los Angeles) for the php web server.

--webPluginsDirectory=path

The path used by the web server to get to the plugins directory of the CloudBees CD/RO server to which it points.

You must have root privileges to use this option.

--webProxyUrl=url

The IP address and port of the proxy server in the following format. https://<IP_ADDRESS_PROXY>:<PROXY_PORT>

--webServicePrincipalName=name

The Kerberos Service Principal Name that will be used to authorize users. This command changes the KrbServiceName HTTP setting in the DATA_DIR/apache/conf/extra/auth-kerberos.conf file.

--webNoProxyHosts=hosts

Comma delimited list of hosts that should be reached directly, bypassing the proxy server.

--webEnableKerberosConstrainedDelegation=<true|false>

Enable ( true ) or disable ( false ) support for constrained delegation authorization when using the Kerberos SSO protocol. This parameter manages the KrbConstrainedDelegation setting in DATA_DIR/apache/conf/extra/auth-kerberos.conf.

--webEnableKrb5Trace=<1|0>

Enable (1) or disable (0) additional Kerberos protocol logging for the web server. This parameter manages the webEnableKrb5Trace setting in DATA_DIR/apache/conf/extra/auth-kerberos.conf.

--webEnableProxySettings=<1|0>

Enable (1) or disable (0) the proxy server configuration. If enabling for the first time, --webProxyUrl must be specified.

--webEnableSsoKerberos =<true|false>

Enable ( true ) or disable ( false ) authentication using the Kerberos SSO protocol. This command changes the $config["ssoEnabledKerberos"] variable in the INSTALL_DIR/apache/htdocs/commander/config.php file.

--webDisableHttpsRedirection=<1|0>

Disable (1) or enable (0) HTTP → HTTPS web redirection by the web server.

--webCsrfProtection=<true|false>

Enable (true) or disable (false) Cross-Site Request Forgery protection on the web server.

--webPhpConnectTimeout

Determines how many seconds to wait when connecting to the CloudBees CD/RO server. Default value is 10.0 seconds.

--webPhpMemoryLimit

Maximum amount of memory a PHP script may consume. Default value is 100M.

CloudBees CD/RO Server

Option Description

--serverAcceptQueueSize=max

The maximum number of pending connections the CloudBees CD/RO server will queue up.

--serverBatchDbRequestsOverride=<1|0|auto>

Enable (1), disable (0) or let the server decide (auto) for using db request batching.

--serverBindIp=<ip or hostname>

The IP address or host name the CloudBees CD/RO server listen to.

--serverCertFile=relativepath

Relative path of the certificate file used by the CloudBees CD/RO server to support SSL connections.

--serverChangeTrackingHardMaxRecords=number

The maximum number of records for change tracking

--serverCommanderPort=port

The HTTP port of the server.

--serverCommanderHttpsPort=port

The HTTPS port of the server.

--serverCriticalServicesMonitoringEnabled=<true|false>

Enable (true) or disable (false) monitoring for the critical services.

--serverCriticalServicesMonitoringFrequency=seconds

The interval between the critical services checks and the disk space checks, seconds.

--serverCrlFile=relativepath

Relative path of the file containing the CloudBees CD/RO server’s certificate revocation list for SSL.

--serverDatabaseName=name

The name of the database the CloudBees CD/RO server uses for its operation.

--serverDatabaseUsername=name

The user name for the database the CloudBees CD/RO server uses for its operation.

--serverEnableHttpProxySettings=<1|0>

Enable (1) or disable (0) the HTTP proxy server configuration. If enabling for the first time, --serverHttpProxyHost and --serverHttpProxyPort must be specified.

--serverEnableHttpProxyAuthentication=<1|0>

Enable (1) or disable (0) authentication for the HTTP proxy server. If enabling for the first time, --serverHttpProxyUser and --serverHttpProxyPassword must be specified.

--serverEnableHttpsProxyAuthentication=<1|0>

Enable (1) or disable (0) authentication for the HTTPS proxy server. If enabling for the first time, --serverHttpsProxyUser and --serverHttpsProxyPassword must be specified.

--serverHttpProxyPassword=password

The password for authentication on the HTTP proxy server.

--serverHttpProxyUser=user

The username for authentication on the HTTP proxy server.

--serverHttpsProxyPassword=password

The password for authentication on the HTTPS proxy server.

--serverHttpsProxyUser=user

The username for authentication on the HTTPS proxy server.

--serverEnableHttpsProxySettings=<1|0>

Enable (1) or disable (0) the HTTP proxy server configuration. If enabling for the first time, --serverHttpsProxyHost and --serverHttpsProxyPort must be specified.

--serverEnableSystemProxies=<true|false>

Enable or disable the use of the HTTP/HTTPS proxy system settings.

--serverHttpsProxyHost=host

The IP address of the HTTPS proxy server.

--serverHttpsProxyPort=port

The port of the HTTPS proxy server.

--serverFileTransferPort=port

The file transfer port of the server.

--serverForceEnableAdmin=<1|0>

Set to '1' or '0' to override the current value of the 'enableAdminUser' CloudBees CD/RO server setting.

--serverName=host

The name the CloudBees CD/RO server, usually its fully-qualified domain name, or for a cluster the fully-qualified domain name of the load balancer.

--serverHttpPort=port

The HTTP port of the server, default value 8000.

--serverHttpsPort=port

The HTTPS port of the server, default value 8443.

--serverIgnoreServerMismatch=<1|0>

Enable (1) or disable (0) ignoring the CloudBees CD/RO server host name mismatch.

--serverInitMemory=percent

Initial java heap size as a percentage of the total system memory.

--serverMaxMemory=percent

Maximum java heap size as a percentage of the total system memory.

--serverInitMemoryMB=size

Initial java heap size in MB.

--serverMaxMemoryMB=size

Maximum java heap size in MB.

--serverMaxThreadsApi=max

The size for the API thread pool. '0' means let the CloudBees CD/RO server decide.

--serverKeyFile=relativepath

Relative path of the CA key file used by the CloudBees CD/RO server to support SSL connections.

--serverKeystore=path

Relative location of the keystore file used by the CloudBees CD/RO server to support SSL connections.

--serverKeystorePassword=password

Password used to access the CloudBees CD/RO server’s keystore.

--serverLogClusterConnectionProblems=<true|false>

Enable (true) or disable (false) additional logging for the connection problems in the cluster environment.

--serverMaxThreadsDispatch=max

The size for the dispatch thread pool. '0' means let the CloudBees CD/RO server decide.

--serverMaxThreadsHttp=max

The size for the HTTP thread pool. '0' means let the CloudBees CD/RO server decide.

--serverMaxThreadsQuartz=max

The size for the quartz thread pool. '0' means let the CloudBees CD/RO server decide.

--serverMaxThreadsWorkflow=max

The size for the workflow thread pool. '0' means let the CloudBees CD/RO server decide.

--serverMonitoringEnabledDataDirectory=<true|false>

Enable (true) or disable (false) disk space monitoring for the data directory.

--serverMonitoringEnabledLogDirectory=<true|false>

Enable (true) or disable (false) disk space monitoring for the log directory.

--serverMonitoringEnabledMqDirectory=<true|false>

Enable (true) or disable (false) disk space monitoring for the message broker data directory.

--serverMqDataDirectory=path

The directory the CloudBees CD/RO server uses to store message broker data.

In a clustered deployment, this setting will not exactly match the actual directory name but will have a suffix.

--serverMqDiskSpaceLimitHard=size

The limit of the free disk space when CloudBees CD/RO server will be switched in bootstrap mode, in MB.

--serverMqDiskSpaceLimitSoft=size

The limit of the free disk space when CloudBees CD/RO server will start to log warnings, in MB.

--serverMqDiskSpaceMonitoringEnabled=<true|false>

Enable (true) or disable (false) disk space monitoring for the message broker data storage.

--serverMqDiskSpaceMonitoringInClusterOnly=<true|false>

Enable (true) or disable (false) disk space monitoring for the message broker data storage only in cluster environment.

--serverNestedLdapGroupsMaxDepthLimit=max

Maximum allowed depth limit of nested LDAP groups

--serverPasskeyFile=path

Path to the server’s passkey file.

--serverPluginCatalogUrl=url

Plugin catalog URL for the CloudBees CD/RO server

--serverHttpProxyHost=host

The IP address of the HTTP proxy server.

--serverHttpProxyPort=port

The port of the HTTP proxy server.

--serverNonProxyHosts=hosts

Comma delimited list of hosts that are reached directly, bypassing the HTTP/HTTPS proxy servers.

--serverPreserveSessions=<1|0>

Enable (1) or disable (0) preserving sessions even if there is the CloudBees CD/RO server hostname mismatch.

--serverRestPort=port

The port for the REST documentation

--serverRestProtocol=<http|https>

The transfer protocol for the REST documentation.

--serverServicePrincipalName=name

The Kerberos Service Principal Name that will be used to authorize users. This command changes wrapper.java.additional.950 in the DATA_DIR/conf/wrapper.conf file.

--serverStatsdHost=host

The host of the statsd server the CloudBees CD/RO server uses to send data.

--serverStatsdPort=port

The port of the statsd server the CloudBees CD/RO server uses to send data.

--serverStatsdPrefix=string

The prefix the CloudBees CD/RO server uses in the data to the statsd server.

--serverStatsdIncludeHostname=<true|false>

Enable (true) or disable (false) inclusion of the CloudBees CD/RO server host to the prefix of the data sent to the statsd server.

--serverTLSEnabledProtocol < protocols >

Comma-delimited list of cryptographic protocols that will be allowed for CloudBees CD/RO server connections using HTTPS. The possible values are any combination of TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello.

The default security configurations are as follows:

First-time CloudBees CD/RO installations: TLSv1, TLSv1.1, and TLSv1.2 are enabled
Existing CloudBees CD/RO installations: TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello are enabled

Windows: 6.0.3 or older
Linux: 6.2 or older
Mac OS: 8.4 or older

--serverZooKeeperConnection=host:port[,host:port,host:port[,host:port,host:port]]

Comma-separated list of host IP/FQDN and ports for the ZooKeeper servers for a clustered configuration.

--serverEnableClusteredMode=<1|0>

Enable (1) or disable (0) the clustered configuration. If enabling for the first time, --serverZooKeeperConnection must be specified.

--serverWrapperConsoleFormat=format

Format of output for the CloudBees CD/RO server wrapper console.

--serverWrapperJavaClasspath=n=path

The Java classpath. n must be an integer >= 1.

--serverWrapperJavaLibraryPath=n=path

The Java Library Path (location of Wrapper.DLL or libwrapper.so). n must be an integer >= 1.

--serverWrapperLogfile=path

Log file to use for the CloudBees CD/RO server wrapper output logging.

--serverWrapperLogfileFormat=format

Format of output for the CloudBees CD/RO server wrapper log file.

--serverWrapperLogfileLoglevel=loglevel

Log level for the CloudBees CD/RO server wrapper log file output.

--serverWrapperLogfileMaxfiles=max

Maximum number of rolled log files which will be allowed before old files are deleted.

--serverWrapperLogfileMaxsize=size

Maximum size that the log file will be allowed to grow to before the log is rolled. Size is specified in bytes, kilobytes with a k suffix, or megabytes with an m suffix.

--serverWrapperPingInterval=seconds

Java virtual machine-wrapper heartbeat interval, in seconds.

--serverWrapperPingTimeout=seconds

Java virtual machine-wrapper heartbeat timeout, in seconds.

--serverWrapperRequestThreadDumpOnFailedJvmExit=<true|false>

Whether to try to get a thread dump if the Java virtual machine doesn’t exit cleanly.

--serverWrapperStartupTimeout=seconds

The wrapper’s startup timeout, in seconds.

--serverWrapperShutdownTimeout=seconds

The wrapper’s shutdown timeout, in seconds.

--serverWrapperSuccessfulInvocationTime=seconds

The amount of time the CloudBees CD/RO server has to be up before the wrapper considers it a 'successful' invocation. If there are 5 or more consecutive failed invocations, the wrapper will no longer start up the CloudBees CD/RO server.

--serverWrapperSyslogLoglevel=loglevel

Log level for sys/event CloudBees CD/RO server wrapper log output.

--serverXmlReaderStripWhitespaceText=<true|false>

Enable (true) or disable (false) the clipping of the values of the UI-form parameters that contain only spaces.

--wrapperJavaAdditional=nnnnn=value

Set a line wrapper.java.additional=value in the server’s wrapper.conf file. nnnnn must be an integer >= 10000.

Built-in database

Option Description

Option	Description
--databaseEnableService=<1\|0>	Enable (1) or disable (0) the built-in database service.
--databaseMemoryBufferSize=size	Size of the database memory buffer. The value can be suffixed with a unit (K, M, or G). Without a unit, the value is interpreted as bytes. The default size is 256 MB.
--databasePassword=password	Password used to access the database. The default password is `changeme`.
--databasePort=port	Port used by the database. The default port is 8900.

--databaseEnableService=<1|0>

Enable (1) or disable (0) the built-in database service.

--databaseMemoryBufferSize=size

Size of the database memory buffer. The value can be suffixed with a unit (K, M, or G). Without a unit, the value is interpreted as bytes. The default size is 256 MB.

--databasePassword=password

Password used to access the database. The default password is changeme.

--databasePort=port

Port used by the database. The default port is 8900.

Repository server

Option Description

--repositoryAcceptQueueSize=max

The maximum number of pending connections the repository server will queue up.

--repositoryAgentUrl=url

The agent URL to use for proxying server requests

--repositoryPort

The repository server port.

--repositoryIdleConnectionTimeout=milliseconds

The idle connection timeout, in milliseconds.

--repositoryKeystore=path

Location of the keystore file used by the repository server to support SSL connections from the CloudBees CD/RO server.

--repositoryKeystorePassword=password

Password used to access the repository server’s keystore.

--repositoryMaxConnections=max

The maximum number of total connections.

--repositoryMaxConnectionsPerRoute=max

The maximum number of connections to one machine.

--repositoryInitMemory=percent

Initial java heap size as a percentage of the total system memory.

--repositoryMaxMemory=percent

Maximum java heap size as a percentage of the total system memory.

--repositoryInitMemoryMB=size

Initial java heap size in MB.

--repositoryMaxMemoryMB=size

Maximum java heap size in MB.

--repositoryMaxHttpThreads=max

The maximum number of threads for handling inbound requests.

--repositoryStorageDirectory=path

Path to the repository backing store. The artifact repository will use this directory to store artifacts.

The path cannot be a mapped drive path. For example, c:/repository-data is not allowed and will cause artifact publishing to fail. You must use a UNC path such as //10.0.109.72/repo_share/repository-data.

--repositoryTargetHostName=host

The host name of the CloudBees CD/RO server to which the repository server points.

--repositoryTargetHttpPort=port

The HTTP port of the CloudBees CD/RO server to which the repository server points.

--repositoryTargetHttpsPort=port

The HTTPS port of the CloudBees CD/RO server to which the repository server points.

--repositoryTargetProtocol=<http|https>

The protocol that the repository server uses to talk to the CloudBees CD/RO server.

--repositoryTLSEnabledProtocol < protocols >

Comma-delimited list of cryptographic protocols that will be allowed for CloudBees CD/RO repository server connections using HTTPS. The possible values are any combination of TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello.

The default security configurations are as follows:

First-time CloudBees CD/RO installations: TLSv1, TLSv1.1, and TLSv1.2 are enabled
Existing CloudBees CD/RO installations: TLSv1, TLSv1.1, TLSv1.2, and SSLv2Hello are enabled

Windows: 6.0.3 or older
Linux: 6.2 or older
Mac OS: 8.4 or older

--repositoryProtocol

The protocol that the repository server uses to talk to client applications.

--repositoryProxyHost=host

The IP address of the proxy server.

--repositoryProxyPort=port

The port of the proxy server.

--repositoryNonProxyHosts=hosts

Comma delimited list of hosts that are reached directly, bypassing the HTTP/HTTPS proxy servers.

--repositoryEnableProxySettings=<1|0>

Enable (1) or disable (0) the proxy server configuration. If enabling for the first time, --repositoryProxyHost and --repositoryProxyPort must be specified.

--repositoryValidateFromDisk=<1|0>

Enable (1) or disable (0) disk validation.

--repositoryWrapperConsoleFormat=format

Format of output for the repository server wrapper console.

--repositoryWrapperJavaClasspath=n=path

The Java classpath. n must be an integer >= 1.

--repositoryWrapperJavaLibraryPath=n=path

The Java Library Path (location of Wrapper.DLL or libwrapper.so). n must be an integer >= 1.

--repositoryWrapperLogfile=path

Log file to use for the repository server wrapper output logging.

--repositoryWrapperLogfileFormat=format

Format of output for the repository server wrapper log file.

--repositoryWrapperLogfileLoglevel=loglevel

Log level for the repository server wrapper log file output.

--repositoryWrapperLogfileMaxfiles=max

Maximum number of rolled log files which will be allowed before old files are deleted.

--repositoryWrapperLogfileMaxsize=size

Maximum size that the log file will be allowed to grow to before the log is rolled. Size is specified in bytes, kilobytes with a k suffix, or megabytes with an m suffix.

--repositoryWrapperPingInterval=seconds

Java virtual machine-wrapper heartbeat interval, in seconds.

--repositoryWrapperPingTimeout=seconds

Java virtual machine-wrapper heartbeat timeout, in seconds.

--repositoryWrapperRequestThreadDumpOnFailedJvmExit=<true|false>

Whether to try to get a thread dump if the Java virtual machine doesn’t exit cleanly.

--repositoryWrapperStartupTimeout=seconds

The wrapper’s startup timeout, in seconds.

--repositoryWrapperShutdownTimeout=seconds

The wrapper’s shutdown timeout, in seconds.

--repositoryWrapperSuccessfulInvocationTime=seconds

The amount of time the repository server has to be up before the wrapper considers it a 'successful' invocation. If there are 5 or more consecutive failed invocations, the wrapper will no longer start up the repository server.

--repositoryWrapperSyslogLoglevel=loglevel

Log level for sys/event repository server wrapper log output.

General configuration options

Option	Description
-v,--version	Display version information.
-h,--help	Display this information.

Option

Description

-v,--version

Display version information.

-h,--help

Display this information.

Examples

Setting initial and maximum memory settings: For example, to set the CloudBees CD/RO Server initial memory percentage to 21% and the maximum memory percentage to 31%, specify:

ecconfigure --serverInitMemory 21 --serverMaxMemory 31▼

Adjusting proxy settings for servers if your CloudBees CD/RO server, web server, or repository server is deployed behind a proxy server that restricts Internet access

To use the following Perl scripts, remove the brackets ( "< >" ), and replace the bracketed example text with the values you need.

To set CloudBees CD/RO Server proxy settings:

ecconfigure --serverProxyHost <IP_ADDRESS_PROXY> --serverProxyPort <PORT> --serverNoProxyHosts "<HOST1,HOST2>"▼

To set Repository Server proxy settings:

ecconfigure --repositoryProxyHost <IP_ADDRESS_PROXY> --repositoryProxyPort <PORT> --repositoryNonProxyHosts "<HOST1,HOST2>"▼

To set Web Server proxy settings:

ecconfigure --webProxyUrl <\https://IP_ADDRESS:PORT> --webNoProxyHosts <HOST1,HOST2,HOST3>▼

Changing the Apache web server port

Run ecconfigure with --webHttpPort and --webHttpsPort. Your web server port setting is changed appropriately in httpd.conf, ssl.conf, and config.php.

Configuring the backing store location for the artifact repository

ecconfigure --repositoryStorageDirectory <new-path>▼