Setting Fields
These fields apply to the setting_added and setting_changed events.
Field | Value | Explanation |
---|---|---|
alert_interval |
integer |
The number of seconds between sending the last alert and sending another failure notification email, as long as failover synchronization has not yet occurred. |
alerts:daily |
1 or 0 |
1: Send a daily email notification to verify that communication is working correctly.
|
alerts:email |
string |
The list of email addresses to which to send email alerts. |
api |
1 or 0 |
1: The API is enabled.
|
api:http |
1 or 0 |
1: The API is enabled over HTTP.
|
api:real_time_state |
1 or 0 |
1: The real-time state API is enabled. 0: The real-time state API is disabled. |
api:reporting_archives |
1 or 0 |
1: The state archive API is enabled. 0: The state archive API is disabled. |
auto |
1 or 0 |
1: If the primary appliance goes down, automatic failover will occur.
|
backup_enabled |
1 or 0 |
1: Automatic data synchronization between a primary and a backup Secure Remote Access Appliance is enabled.
|
bandwidth |
integer |
The maximum number of bytes per second that should be used for data synchronization between a primary and a backup Secure Remote Access Appliance. |
become_backup |
none |
Given when the failover role is changed to backup by a user. |
become_primary |
none |
Given when the failover role is changed to primary by a user. |
connection_test_ips |
comma- |
The list of IP addresses for the backup appliance to use to test network connectivity before failing over. |
email:encryption |
none
|
The type of encryption used for the SMTP email server. |
email:host |
string |
The SMTP server through which to send emails. |
email:password |
* * * * |
Indicates if the password has changed. The actual string is never supplied. |
email:port |
integer |
The SMTP server port through which to connect. |
email:user |
string |
The username used to authenticate with the SMTP server. |
external_key:crm_url |
string |
The URL configured to use in conjunction with the custom link button in the representative console. |
file_store:listing |
1 or 0 |
1: Show the file store at the /file directory.
|
invitations:client_side_email |
1 or 0 |
1: Client-side emails are enabled for sending support and presentation invitations. 0: Client-side emails are not enabled. |
ips |
comma- |
IP addresses shared between the primary appliance and the backup appliance. |
license:invited_rep_license_pool_id | string | The unique identifier of the license pool to use for invited representatives. |
license:invited_rep_license_pool_type | invitee pool_id |
Whether to use the same license pool as the inviting representative for the invited rep or to use a specified license pool. |
licenses:alerts:login_denied | 1 or 0 | 1: Send an email notification whenever a representative is unable to log into the representative console due to insufficient licenses, insufficient reserved slots, or license pool restrictions. 0: Do not send login denied alerts. |
licenses:chat:warnings:threshold | string | The number or percentage of chat licenses that must be in use for a notification email to be sent. |
licenses:full:warnings:threshold | string | The number or percentage of full support licenses that must be in use for a notification email to be sent. |
licenses:warnings |
1 or 0 |
1: Send an email notification if concurrent license usage reaches a certain threshold level.
|
licenses:warnings:email |
string |
The list of email addresses to which to send license threshold emails. |
licenses:warnings:interval |
integer |
The number of hours between the last alert and sending another license threshold email. |
licenses:warnings:threshold |
string |
The number or percentage of licenses concurrently in use that should trigger a license threshold alert to be sent. |
localization:default_language | string | The default language for the site. |
login_restrictions:list |
string |
A list of IPs which should be allowed or denied access to the /login and /api interfaces. This may also be combined with representative console login restrictions. |
login_restrictions:list_type |
allow_all |
Whether to allow all IP addresses, to allow only specified IP addresses, or to deny specified IP addresses access to the /login and /api interfaces of the Secure Remote Access Appliance. This may also be combined with representative console login restrictions. |
login_restrictions:rep |
always |
Whether log into the representative console is restricted to allowed networks every time, only the first time, or never. |
login_restrictions:web |
always |
Whether access to /login, /api, and the representative console is restricted or not. This is combined with the other login restriction messages above. |
login_restrictions:web:ports:allow |
string |
A list of ports that are allowed to access the /login interface. |
login_restrictions:web:ports:deny |
string |
A list of ports that are not allowed to access the /login interface. |
networks:list |
string |
A list of IP addresses which should be allowed or denied. |
networks:type |
allow_all
|
Whether to allow all IP addresses, to allow only specified IP addresses, or to deny specified IP addresses access to the /appliance administrative interface of the Secure Remote Access Appliance. |
outbound_event:email_retry_duration |
integer |
The number of seconds between each email retry attempt. |
p2p | 1 or 0 | 1: Peer-to-peer connections are enabled. 0: Peer-to-peer connections are disabled. |
p2p_stunserver_address |
stun.bomgar.com
|
If the BeyondTrust hosted peer-to-peer server is used, the value is stun.bomgar.com. If the appliance is used, the value is undefined. |
p2p_ui_state | 0, 1, or 2 |
0: Peer-to-peer is disabled. |
ports:http |
comma-delimited list |
A list of ports that will respond to HTTP traffic. |
ports:https |
comma-delimited list |
A list of ports that will respond to HTTPS traffic. |
ports:management:allowed |
comma-delimited list |
A list of ports that are allowed to access the /appliance interface. |
ports:management:denied |
comma-delimited list |
A list of ports that are not allowed to access the /appliance interface. |
ports:management:http |
integer |
The port to use when generating a URL that should be viewed over HTTP. |
ports:management:https |
integer |
The port to use when generating a URL that should be viewed over HTTPS. |
pre_login_agreement:enabled |
1 or 0 |
1: The /login prerequisite login agreement has been enabled. |
presentation:show_hostname_in_window_title |
1 or 0 |
1: Show the public site hostname in the presentation attendee window title. 0: Do not show the hostname in the window title. |
presentations:abandoned |
1 or 0 |
1: Display an orphaned presentation message if no one is available to give the presentation.
|
presentations:agreement |
1 or 0 |
1: Display an attendee agreement message before presentations.
|
presentations:greeting |
1 or 0 |
1: Display an attendee greeting before presentations.
|
presentations:max_absent_time |
integer |
The maximum number of seconds a presentation can remain open without a presenter, whether the presenter never joined the presentation or joined and then left the presentation. |
presentations:recordings:screen_sharing |
1 or 0 |
1: Record a video of presentations.
|
presentations:recordings:screen_sharing:resolution |
320x240 |
The resolution to which to convert presentation recordings when viewing or downloading. |
probe:max_timeout |
integer |
The number of seconds between the first failure to reach the primary appliance and fail over to the backup appliance. |
public_site:force_ssl |
1 or 0 |
1: Redirect all visitors to HTTPS.
|
relationship_broken |
array of semicolon separated values |
Generated when failover relationship is broken. Values:
|
relationship_established |
array of semicolon separated values |
Generated when failover is established. Values:
|
rep:custom_link |
string |
The URL that will appear as a button in the representative console during a support session. |
rep:dashboard:monitor |
disabled |
Whether team managers and leads are disallowed to monitor team members, are allowed to view team members' representative consoles only, or are allowed to view team members' entire desktops. |
rep:dashboard:monitor_indicator |
1 or 0 |
1: A monitoring indicator will appear on the representative's screen when a team lead or team manager is monitoring the representative. |
rep:dashboard:transfer |
1 or 0 |
1: Allow team managers and team leads to take over and transfer team members’ sessions.
|
rep:email_controls |
1 or 0 |
1: Allow representatives to send email invitations from the representative console.
|
rep:mobile |
1 or 0 |
1: Mobile representative consoles are allowed to connect. 0: Mobile representative consoles are not allowed to connect. |
rep:private_queue_exit_check |
1 or 0 |
1: A representative cannot log out or quit the representative console until their personal queue is empty. |
rep:routing:alert:session_info |
1 or 0 |
1: Show session information on the session assignment alert dialog. |
rep:saved_logins |
1 or 0 |
1: Allow representatives to have the representative console remember their credentials.
|
rep_console_settings_applied |
integer |
An incrementing number indicating when managed representative console settings have been applied to all representatives. |
reporting:history_limit |
integer |
The number of days to keep logging information, expressed as seconds. |
service.syslog.remote.format |
syslog |
syslog: The syslog data format is RFC 5424 compliant. |
session_keys:timeout |
integer |
The default number of seconds a generated session key is valid. After that it will expire. |
session_keys:timeout:maximum |
integer |
The maximum number of seconds a generated session key can remain valid. |
sms:gateway_url |
string |
A URL from your ISP or third-party gateway provider giving representatives the option to send session keys via SMS text messages. |
ssl:certificate_verify |
1 or 0 |
1: Validate the SSL certificate chain for security.
|
support:clipboard_sync_mode |
disabled |
disabled: The representative cannot synchronize the clipboards with the customer’s clipboard during a support session.
|
support:fallback:jump_clients |
1 or 0 |
If a representative drops a Jump session and no other representatives are in the session:
|
support:fallback:normal |
1 or 0 |
If a representative drops a normal session and no other representatives are in the session:
|
support:inactive_rep:timeout |
integer |
The number of seconds with no session activity before a representative is removed from a specific session. |
support:invitations:server_side_email |
1 or 0 |
1: Client-side emails are enabled for sending support and presentation invitations. 0: Client-side emails are not enabled. |
support:jump:minimize_ui |
1 or 0 |
1: The customer client starts minimized for attended sessions. |
support:jump_client:active_interval |
integer |
The number of seconds to wait between each Jump Client statistics update. |
support:jump_client:allow_wake_on_lan |
1 or 0 |
1: Representatives can attempt to wake up a Jump Client. |
support:jump_client:concurrent_upgrades |
integer |
The maximum number of Jump Clients whose statistics can be updated simultaneously. |
support:jump_client:connection_type |
active |
The default client connection type for Jump Clients deployed in a session: active or passive. |
support:jump_client:listening_port |
integer |
The default port that passive Jump Clients use to listen for requests to start a session on the customer systems. |
support:jump_client:removal_behavior |
uninstalled |
Whether a locally deleted Jump Client is marked as uninstalled in the representative console or is removed from the list. |
support:jump_client:restrict_uninstall |
1 or 0 |
1: An installed Jump Client can be uninstalled only by an administrator on the remote computer. |
support:jump_client:simultaneous_rep_access |
1 or 0 |
1: Multiple representatives can access the same Jump Client simultaneously without having to be invited into an existing session.
|
support:jump_client:stats |
comma- |
The statistics to collect from each Jump Client. Currently recognized statistics include pss_os (operating system), pss_ut (uptime), pss_cpu (central processing unit usage), pss_cu (console user), pss_fd (disk usage), and pss_tn (screen thumbnail image). |
support:jump_client:stats:active_interval |
integer |
The number of seconds to wait between active Jump Client statistics updates. |
support:jumpoint:browse |
1 or 0 |
1: A representative can browse the remote network through a Jumpoint to find the computer they need to access. |
support:reboot:cache_credentials |
1 or 0 |
1: Representatives are allowed to reboot the remote system using credentials cached by the customer.
|
support:recordings:command_shell |
1 or 0 |
1: Record a video of command shells.
|
support:recordings:command_shell:resolution |
320x240
|
The resolution selected to convert command shell recordings when viewing or downloading them. |
support:recordings:screen_sharing |
1 or 0 |
1: Record a video of screen sharing during support sessions. |
support:recordings:screen_sharing:resolution |
320x240
|
The resolution to which to convert support session recordings when viewing or downloading. |
support:recordings:show_my_screen |
1 or 0 |
1: Record a video of Show My Screen sessions. |
support:recordings:show_my_screen:resolution |
320x240
|
The resolution to which to convert Show My Screen recordings when viewing or downloading. |
support:screen_sharing:customer_client_control |
1 or 0 |
1:Enable the restriction of customer client control by the rep while screen sharing.
|
support:screen_sharing:detect_faulty_video_driver |
1 or 0 |
1: Allow BeyondTrust client to temporarily disable hardware acceleration during Windows screen sharing if a faulty video driver is detected.
|
support:screen_sharing:multi-display_thumbnail |
1 or 0 |
1: Enable thumbnail images for multiple remote displays. |
support:screen_sharing:remote_screenshot |
1 or 0 |
1: From the representative console, representatives are allowed to take a screenshot of the remote screen. 0: Representatives are not allowed to take a screenshot of the remote screen. |
support:special_actions:builtins |
1 or 0 |
1: Show the built-in special actions in support sessions. |
support:streamlined_session_start |
1 or 0 |
1: Streamlined session start is enabled. 0: Streamlined session start is disabled. |
support:system_info:auto_log |
1 or 0 |
1: Automatically log the remote computer’s system information at the beginning of a session.
|
support:system_info:auto_log:mobile |
Standard
|
Standard: Provide standard logging for mobile platforms. |
sync_interval |
minute |
minute=Every x minutes |
sync_interval:days |
integer from 1 to 7 |
If sync_interval = week, it denotes the day of the week on which the auto data sync will occur. 1 = Sunday, 7 = Saturday. |
sync_interval:hours |
integer from 1 to 24 |
If sync_interval = week or day, then this value tells the hour of the day that the data sync will run. If sync_interval = hour, then it tells how many hours will be between every data sync (Every x hours). |
sync_interval:minutes |
integer from 1 to 60 |
If sync_interval = week or day, then this value tells the minute of the hour that the data sync will run. If sync_interval = minute, then it tells how many minutes will be between every data sync (Every x minutes). |
syslog |
string |
The address of the remote syslog server to which to send messages. |
system.auth.local.failed-login-lockout-duration |
integer |
The number of minutes an /appliance account is locked out after the maximum number of failed logins is exceeded. If 0, the account is locked out until an administrator unlocks the account. |
system.auth.local.failed-login-lockout-threshold |
integer |
The number of failed login attempts after which the /appliance user will be locked out of their account. If 0, the user will never be locked out. |
system.auth.local.password-expire-duration |
integer |
The number of days after which an /appliance user's password expires. If 0, the password never expires. |
system.auth.local.password-history-count |
integer |
The number of prior passwords that an /appliance user cannot use when changing their password. If 0, there is no restriction. |
system.pre-login-agreement.enabled |
1 or blank |
1: The /appliance prerequisite login agreement has been enabled. |
system.pre-login-agreement.text |
string |
The text of the login agreement that user must accept before accessing the /appliance administrative interface. |
system.pre-login-agreement.title |
string |
The title of the login agreement that user must accept before accessing the /appliance administrative interface. |
timezone |
string |
The time zone in which this Secure Remote Access Appliance renders system times. |
users:idle_timeout |
integer |
The maximum number of seconds a representative console can be idle before that representative will be logged out. |
users:max_failed_logins |
integer |
The number of failed login attempts after which the account will be locked out. |
users:passwords:complex |
1 or 0 |
1: Require complex passwords. |
users:passwords:default_expiration |
integer |
The default number of days a password can be used before it expires and must be reset. |
users:passwords:minimum_length |
integer |
The minimum number of characters required for a password. |
users:passwords:reset |
1 or 0 |
1: Users can reset forgotten passwords by correctly answering a security question. |
users:terminate_if_user_logged_in |
1 or 0 |
If a representative attempts to log into the representative console using an account that is already in use in another representative console:
|