Understanding system preferences
You can add or edit preferences for the _system user. The values of these preferences apply systemwide. To add or edit preferences, see Adding-or-changing-system-settings.
You can override some system preferences for an individual user (see Understanding-user-preferences and Setting-or-changing-user-preferences).
The following table describes the system preferences:
Preference | Description |
---|---|
artifact_store_uri | A link to a location where package instances are storedAdd Instance User Info |
api_port | An integer value to be used as a port on which the API service is responding to the incoming commands. Use this value to change the default API socket-based port. |
add_instance_user_info | Adds VL_USER_ID and VL_USER_NAME to Instance logs. Allows you to define whether to autamatically insert user credentials as properties on an instance during creation. |
auto_logout_minutes | Allows you to define the default number of minutes of the idle activity before the user is logged out of the BMC VaraLogix Q Deployment Automation. |
bridge_connect_timeout | Timeout value used when attempting each step in establishing a connection to a server |
bridge_write_timeout | Allows you to define the number of seconds BMC VaraLogix Q Deployment Automation will attempt to perform a write command before timing out. |
bridge_read_timeout | Allows you to define the number of seconds BMC VaraLogix Q Deployment Automation will attempt to perform a read command before timing out. |
case_sensitive_config_expansion | Allows you to ignore a case sensitive name matching during the expansion of the config set variable. |
config_process_keep_time | Reserved for future use |
console_base_url | Allows you to define the base URL of the BMC VaraLogix Q Deployment Automation. |
dashboard | Allows you to define the initial landing page when navigating to the Deploy tab. |
dashboard_instance_age | Allows you to define the timespan measured in days, during which the deployment with a "Route Complete" status will remain on the launchpad. |
date_format | PHP date() format for date strings for the user. (See php.net for details.) If no value is specified, the _system value is used. |
default_domain | The default domain is used to transform the username which you enter in the Destination Email Address field to the full email address, for example yourname@bmc.com (if the default_domain="bmc.com") |
default_user_role | Role associated with a user at logon if the user has not been assigned a role |
default_max_engines | Default maximum number of engines that a single host is allowed to run. This value can be overridden on each host. See Managing-engines-and-engine-hosts. |
deployment_properties_take_precedence | Sets the order of precedence for properties in a deployment process. The default is Y (yes) if not explicitly set, with the following precedence rules:
|
engine_idle_procs | Minimum number of engines available at any time to accept work. If the available free engine count is less than this number, more engines are created until this number is reached. |
engine_life_actions | Number of tasks an engine can run before being recycled. After completing the specified number of tasks, the engine terminates and the system creates a new engine as needed. |
engine_life_hr | Maximum lifespan of an engine in hours. An engine that persists this long finishes its actions and then terminates, assuming that any constraints are satisfied. |
engine_max_idle_procs | Maximum number of engines available at any time to accept work. If the available free engine count exceeds this number, engines are terminated until this number is reached. |
engine_tick_sec | After completing a task, the time in seconds that an engine should wait before checking the work queue for a new task |
engine_zombie_check | Number of seconds to wait between checks for engine processes that have unexpectedly terminated |
ignore_smtp_send_errors | Allows you to define whether BMC VaraLogix Q Deployment Automation will ignore any mail server errors, allowing the processing to continue afterwards. If set to Yes, the Send Email Notification action passes even if there are mail server errors. |
items_page | Number of items to include per page when displaying something that can be paginated |
language | National language of the user. The user value overrides the default _system user value. In this release, eng and eng_VL are the only supported languages. |
ldap_host_url | URL where your LDAP or Microsoft Active Directory (MSAD) server resides, in the form ldap//<hostname>.com |
ldap_query_dn | Distinguished name (DN) of a user who can connect to the LDAP server and perform searches for users |
ldap_query_password | Password for the ldap_query_dn user |
ldap_base_dn, ldap_user_search | Parameters that comprise the search string for locating users in LDAP, after the system connects as the query user:
|
ldap_group_attr | Name of the attribute in a user record that contains the groups where the user is a member. In MSAD, this is member, and the user record "member" attribute is an array of the groups that include the user as a member. |
ldap_roots_dn, ldap_techs_dn | Preferences specifying the distinguished name of an LDAP group, used to map LDAP groups to user roles:
|
license_key | Value containing your license key for licensing your installation. The license key includes an expiration date. When your license expires, you must request a new value from BMC and enter it. An expired or nonexistent license causes servers to return errors for all actions. |
log_date_format | Allows you to define the format in which dates are displayed in BMC VaraLogix Q Deployment Automation application logs. |
lock_timeout | Number of seconds a lock can live in the system. If a data object gets stuck or lost, its lock is automatically released after this time. |
mail_from | The From: header in outgoing emails |
mail_smtp_authpass, mail_smtp_authuser | The user name and password used for authentication when connecting to the SMTP server |
mail_smtp_helo | Preference for the "hello" message returned by your mail server. For example, if your mail server returns a nonstandard hello message when you connect to it, you can change that value by setting this preference. |
mail_smtp_port | The SMTP port |
mail_smtp_server | Host name of the SMTP server |
mail_smtp_timeout | Maximum number of seconds that the system waits for a response from an SMTP server |
schema_version | Version number of the schema in the current installation |
sso_http_header | HTTP request header that contains the authenticated user name on a single-sign-on system |
store_block_size | Preference defining the maximum size of a binary large object (BLOB). When a package is instantiated for deployment, the contents of the URIs are fetched and stored as solids, in the form of BLOBs in the database. Larger values provide more efficient storage, as long as you do not exceed the maximum BLOB size for your database. |
tz | User time zone for date displays. The _system user value is the default, but a user setting can override it. |
verbose_dispatch_logging | This is a non-default preference. This preference can be set to 'y' or 'n', which stands for 'yes' or 'no' respectively. If you add this preference with the 'y' value, it gives you more logging during deployments and instance creations. |