Setting Fields

The number of seconds between sending the last alert and sending another failure notification email, as long as failover synchronization has not yet occurred.

1: Send a daily email notification to verify that communication is working correctly.
0: No daily communications will be sent.

The list of email addresses to which to send email alerts.

1: The API is enabled.
0: The API is disabled.

1: The API is enabled over HTTP.
0: The API is enabled only over HTTPS.

1: If the primary appliance goes down, automatic failover will occur.
0: If the primary appliance goes down, automatic failover will not occur.

1: Automatic data synchronization between a primary and a backup Secure Remote Access Appliance is enabled.
0: Automatic data synchronization is disabled.

The maximum number of bytes per second that should be used for data synchronization between a primary and a backup Secure Remote Access Appliance.

Given when the failover role is changed to backup by a user.

Given when the failover role is changed to primary by a user.

The list of IP addresses for the backup appliance to use to test network connectivity before failing over.

The type of encryption used for the SMTP email server.

The SMTP server through which to send emails.

Indicates if the password has changed. The actual string is never supplied.

The SMTP server port through which to connect.

The username used to authenticate with the SMTP server.

The URL configured to use in conjunction with the custom link button in the representative console.

1: Show the file store at the /file directory.
0: Do not allow web access to the file store.

IP addresses shared between the primary appliance and the backup appliance.

1: Send an email notification if concurrent license usage reaches a certain threshold level.
0: Do not send license threshold emails.

The list of email addresses to which to send license threshold emails.

The number of hours between the last alert and sending another license threshold email.

The number or percentage of licenses concurrently in use that should trigger a license threshold alert to be sent.

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.

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.

Whether log into the representative console is restricted to allowed networks every time, only the first time, or never.

A list of ports that are allowed to access the /login interface.

A list of ports that are not allowed to access the /login interface.

A list of IP addresses which should be allowed or denied.

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.

The number of seconds between each email retry attempt.

0: Peer-to-peer is disabled.
1: The BeyondTrust hosted peer-to-peer server is being used.
2: The appliance is being used as the peer-to-peer server.

A list of ports that will respond to HTTP traffic.

A list of ports that will respond to HTTPS traffic.

A list of ports that are allowed to access the /appliance interface.

A list of ports that are not allowed to access the /appliance interface.

The port to use when generating a URL that should be viewed over HTTP.

The port to use when generating a URL that should be viewed over HTTPS.

1: The /login prerequisite login agreement has been enabled.
0: The /login prerequisite login agreement has been disabled.

1: Display an orphaned presentation message if no one is available to give the presentation.
0: Do not display an orphaned presentation message if the presenter is unavailable.

1: Display an attendee agreement message before presentations.
0: Do not display an attendee agreement.

1: Display an attendee greeting before presentations.
0: Do not display an attendee greeting.

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.

1: Record a video of presentations.
0: Do not record presentations.

The resolution to which to convert presentation recordings when viewing or downloading.

The number of seconds between the first failure to reach the primary appliance and fail over to the backup appliance.

1: Redirect all visitors to HTTPS.
0: Allow both HTTP and HTTPS traffic.

Generated when failover relationship is broken.

Values:

• this:hostname=hostname where entry is made
• this:port=port used by current host
• peer:hostname=hostname of peer in failover relationship
• peer:port=port of peer in failover_relationship

Generated when failover is established.

Values:

• this:hostname=hostname where entry is made
• this:port=port used by current host
• peer:hostname=hostname of peer in failover relationship
• peer:port=port of peer in failover_relationship

The URL that will appear as a button in the representative console during a support session.

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.

1: A monitoring indicator will appear on the representative's screen when a team lead or team manager is monitoring the representative.
0: No indicator will appear to the representative when a team lead or team manager is monitoring the representative.

1: Allow team managers and team leads to take over and transfer team members’ sessions.
0: Do not allow transferring of team members’ sessions.

1: Allow representatives to send email invitations from the representative console.
0: Do not allow representatives to send email invitations from the representative console.

1: A representative cannot log out or quit the representative console until their personal queue is empty.
0: A representative can log out or quit the representative console with sessions still in their personal queue.

1: Show session information on the session assignment alert dialog.
0: Do not show session information on the session assignment alert.

1: Allow representatives to have the representative console remember their credentials.
0: Do not allow the representative console to remember representatives’ credentials.

An incrementing number indicating when managed representative console settings have been applied to all representatives.

The number of days to keep logging information, expressed as seconds.

syslog: The syslog data format is RFC 5424 compliant.
bsd: The syslog data format is legacy BSD format.
bsd_no_ts: The syslog data format is legacy BSD format without timestamp.
tls: The syslog data format is Syslog over TLS (RFC 5425).

The default number of seconds a generated session key is valid. After that it will expire.

The maximum number of seconds a generated session key can remain valid.

A URL from your ISP or third-party gateway provider giving representatives the option to send session keys via SMS text messages.

1: Validate the SSL certificate chain for security.
0: Do not validate the SSL certificate chain.

disabled: The representative cannot synchronize the clipboards with the customer’s clipboard during a support session.
manual:rep_to_cust: The representative can send the clipboard manually to the customer’s clipboard during a support session.
manual:both_directions: The representative can send the clipboard to the customer’s clipboard during a support session, and the customer can send their clipboard to the representative manually.
auto:both_directions: The clipboard is sent automatically from the representative to the customer, and from the customer to the representative.

If a representative drops a Jump session and no other representatives are in the session:
1: Attempt to transfer the session to the queue from which it was last transferred, then to the queue in which it originally arrived, and then a backup queue; only then terminate the session
.0: Terminate the session immediately.

If a representative drops a normal session and no other representatives are in the session:
1: Attempt to transfer the session to the queue from which it was last transferred, then to the queue in which it originally arrived, and then a backup queue; only then terminate the session.
0: Terminate the session immediately.

The number of seconds with no session activity before a representative is removed from a specific session.

1: The customer client starts minimized for attended sessions.
0: The customer client does not start minimized for attended sessions.

The number of seconds to wait between each Jump Client statistics update.

1: Representatives can attempt to wake up a Jump Client.
0: Representatives cannot attempt to wake up Jump Clients.

The maximum number of Jump Clients whose statistics can be updated simultaneously.

The default client connection type for Jump Clients deployed in a session: active or passive.

The default port that passive Jump Clients use to listen for requests to start a session on the customer systems.

Whether a locally deleted Jump Client is marked as uninstalled in the representative console or is removed from the list.

1: An installed Jump Client can be uninstalled only by an administrator on the remote computer.
0: An installed Jump Client can be uninstalled by any user from the Jump Client context menu.

1: Multiple representatives can access the same Jump Client simultaneously without having to be invited into an existing session.
0: Multiple representatives cannot access the same Jump Client simultaneously unless invited by another representative into an existing session.

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).

The number of seconds to wait between active Jump Client statistics updates.

1: A representative can browse the remote network through a Jumpoint to find the computer they need to access.
0: A representative must enter an IP address or hostname to Jump to a remote computer through a Jumpoint.

1: Representatives are allowed to reboot the remote system using credentials cached by the customer.
0: Representatives are not allowed to reboot the remote system using cached credentials.

1: Record a video of command shells.
0: Do not record command shells.

The resolution selected to convert command shell recordings when viewing or downloading them.

1: Record a video of screen sharing during support sessions.
0: Do not record support sessions.

The resolution to which to convert support session recordings when viewing or downloading.

1: Record a video of Show My Screen sessions.
0: Do not record Show My Screen sessions.

The resolution to which to convert Show My Screen recordings when viewing or downloading.

1:Enable the restriction of customer client control by the rep while screen sharing.
0: Disable the restriction of customer client control by the rep while screen sharing.

1: Allow BeyondTrust client to temporarily disable hardware acceleration during Windows screen sharing if a faulty video driver is detected.
0: Do not allow BeyondTrust client to disable hardware acceleration or detect faulty video driver.

1: Enable thumbnail images for multiple remote displays.
0: Disable thumbnail images for multiple remote displays.

1: Show the built-in special actions in support sessions.
0: Hide the built-in special actions in support sessions.

1: Automatically log the remote computer’s system information at the beginning of a session.
0: Do not log system information.

Standard: Provide standard logging for mobile platforms.
Full: Provide extended logging for mobile platforms. This option is the Extended dropdown option in the user interface.

minute=Every x minutes
hour=Every x hours
day=Every day at x time
week=Once a week at x day and y time.

If sync_interval = week, it denotes the day of the week on which the auto data sync will occur. 1 = Sunday, 7 = Saturday.

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).

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).

The address of the remote syslog server to which to send messages.

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.

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.

The number of days after which an /appliance user's password expires. If 0, the password never expires.

The number of prior passwords that an /appliance user cannot use when changing their password. If 0, there is no restriction.

1: The /appliance prerequisite login agreement has been enabled.

The text of the login agreement that user must accept before accessing the /appliance administrative interface.

The title of the login agreement that user must accept before accessing the /appliance administrative interface.

The time zone in which this Secure Remote Access Appliance renders system times.

The maximum number of seconds a representative console can be idle before that representative will be logged out.

The number of failed login attempts after which the account will be locked out.

1: Require complex passwords.
0: Do not require complex passwords.

The default number of days a password can be used before it expires and must be reset.

The minimum number of characters required for a password.

1: Users can reset forgotten passwords by correctly answering a security question.
0: Users cannot reset forgotten passwords.