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 B Series Appliance goes down, automatic failover will occur.
0: If the primary B Series Appliance goes down, automatic failover will not occur.

1: Automatic data synchronization between a primary and a backup B Series 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 B Series 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 B Series Appliance to use to test network connectivity before failing over.

The type of authentication used by the SMTP server.

The type of encryption used for the SMTP email server.

The SMTP server through which to send emails.

The OAuth provider ID. Only used with OAuth authentication.

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 access console.

1: An admin has accepted the FedRAMP behavior agreement.
0: The FedRAMP behavior agreement has not been accepted.

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

URL to use when submitting files to an ICAP service during a session file transfer.

IP addresses shared between the primary B Series Appliance and the backup B Series Appliance.

1: The full run as command will be logged.
0: Do not log the full run as command.

A list of IPs which should be allowed or denied access to the /login and /api interfaces. This may also be combined with access 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 B Series Appliance. This may also be combined with access console login restrictions.

Whether log into the access 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 B Series 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 B Series 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.

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

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

1: The rep console will allow use of the CLI tool.
0: Do not allow use of the CLI tool.

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

Whether team managers and leads are disallowed to monitor team members or are allowed to view team members' access consoles..

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

1: Enable team chat history.
0: Disable team chat history.

Hours of team chat history to replay.

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

1: Allow users to have the access console remember their credentials.
0: Do not allow the access console to remember representatives' credentials.

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

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

The default selection for the authentication dropdown in the rep console.

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.

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

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

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

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

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

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

uninstalled: A Jump Client deleted by an end user remains visible in the access console.
remove: A Jump Client deleted by an end user is removed from the access console.

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: The ticket ID is treated as sensitive information.
0: The ticket ID is not treated as sensitive information.

join: Multiple users can Jump to the same Jump Item simultaneously.
disallow: Only one user at a time can Jump to a Jump Item without an invitation from the first user to share the session.

start: Multiple users can Jump to the same RDP Jump Item simultaneously.
disallow: Only one user at a time can Jump to an RDP Jump Item without an invitation from the first user to share the session.

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 sessions.
0: Do not record sessions.

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

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

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 B Series Appliance renders system times.

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

If 1, then protocol tunnel based sessions are considered idle if no tools are connected to the open tunnel.

The length of time in minutes a locked-out user must wait before being allowed to reattempt login. 0 indicates that an admin must unlock the account.

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

1Users can register and log in with FIDO2 authenticators instead of a password.
2 FIDO2 authentication is disabled and cannot be used.

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.