Runtime parameters

Use the --help command to get a list of the available runtime parameters as shown below:

./start.sh --help

The table below describes the supported runtime arguments:

Section Parameter Description Mandatory
Connection -c, --controller-host controller host (no default)
Connection -P, --controller-port controller port (8090 by default)
Connection --use-https, --no-use-https if true, specifies that the agent should use SSL (false by default)
Account --account account name (customer1 by default)
Account -u, --username appd user username (no default)
Account -p, --password appd user password (no default)
Account --use-encoded-credentials, --no-use-encoded-credentials use base64 encoded credentials (false by default)
Proxy --use-proxy, --no-use-proxy use proxy optional argument (false by default)
Proxy --proxy-url proxy url (no default)
Proxy --proxy-port proxy port (no default)
Branding --use-branding, --no-use-branding enable branding (true by default)
Branding --logo-name logo image file name (no default)
Branding --background-name background image file name (no default)
Application -a, --application-name application name (no default)
Application --include-database, --no-include-database include database (false by default)
Application -d, --database-name database name, mandatory if include-database set to true (no default)
Application -s, --include-sim include server visibility (false by default)
Application -b, --configure-bt configure busness transactions (false by default)
Application --overwrite-health-rules overwrite health rules (true by default)
Application --bt-only, --no-bt-only configure business transactions only (false by default)
Application --upload-custom-dashboard upload custom dashboard from existing JSON file (false by default)
Application --upload-default-dashboard upload default dashboard (true by default)
Action Suppression --suppress-action, --no-suppress-action use application action suppression (false by default)
Action Suppression --suppress-start application suppression start date in “yyyy-MM-ddThh:mm:ss+0000” format (GMT) (current datetime by default)
Action Suppression --suppress-duration application suppression duration in minutes (one hour by default)
Action Suppression --suppress-name custom name of the supression action, if none specified name is auto-generated
Action Suppression --suppress-upload-files, --no-suppress-upload-files upload action suppression files from a folder (false by default)
Action Suppression --suppress-delete delete action suppression by passing action name to this parameter (no default)
RBAC --rbac-only configure RBAC (false by default)
RBAC --rbac-action RBAC action to be performed (rbac-saml by default)
RBAC --rbac-role-name RBAC role name (auto-generated by default)
RBAC --rbac-role-description RBAC role description, not mandatory (no default)
RBAC --rbac-saml-group-name RBAC SAML group name (auto-generated by default)
RBAC --rbac-license-rule-name License rule name (auto-generated by default)

You can run the script in debug mode by using --debug flag, in which case the connection and other parameters used will be printed out in the console. We do not recommend using this flag in production, and it is set to false by default.