Optional setup using TSS Command Line Interface

At this point, the TSS Virtual Appliance is configured with an IP address, a network mask, a default gateway and a redundancy ID. If not, please refer to the Virtual Appliance deployment section.

The Command Line Interface should prompt the following information.

Please note that the TSS has already all the required information to run properly. This section describes how the Command Line Interface (abbreviated CLI) can be used to customize the Virtual Appliance.

First, notice that a help section is available by entering the "?" command. The CLI then prompts you the following information.

ipconfig

This command allows you to change the IP configuration of the TSS. Please note that this command can only be used if replication is disabled.

The switches of this command are:

•/address: allows you to specify the IPv4 or IPv6 address

•/mask: allows you to specify the IPv4 mask. Please note that this parameter is only taken in consideration if an IPv4 address has been provided with the /address switch.

•/gateway: allows you to specify the default gateway. This parameter can take an IPv4 or IPv6 address.

•/dhcp: allows you to enable DHCP and set your IP address automatically.

Once IP address has been changed it is necessary to update value of boot setting 'application.bscg.baseServiceURI'. Go to Console / Device Management /Zones / Edit zone 'System' / Open tab TPO/Turrets Boot Settings / Open tab Advanced mode / Update value of setting 'application.bscg.baseServiceURI' with new server IP address.

dnsconfig:

This command can be used to define the TSS Virtual Appliance DNS configuration.

The following switches can be used with this command:

•/dns1: allows you to specify the primary DNS IPv4 or IPv6 address.

•/adddns: allows you to add a new DNS IPv4 or IPv6 address.

•/removedns: allow you to remove an existing DNS IPv4 or IPv6 address.

•/suffix: allows you to specify the DNS suffix. This information is required if you plan to enable HTTPs and FTPs features on the TSS. Indeed, the DNS suffix is used to build the Fully Qualified Domain Name (FQDN) required by the HTTPs and FTPs features. Please note that this option can only be used when replication is disabled.

•/dhcp: allow you to set the DNS addresses automatically through the DHCP.

tssconfig:

This command can be used to configure the TSS.

The following switch can be used with this command:

•/redundancyid: allows you to specify the  TSS redundancy identity. Accepted values are 1 (for primary) to 6 (2 for secondary/external database, 3 to 6 for external database only).

Please note that this command can only be used if no TSS firmware is installed on the TSS Virtual Appliance and if the replication is disabled. If a redundancy ID  modification is required, all TSS Firmwares installed on the device must be removed and replication disabled in order to use this command.

logconfig:

This command allows you to modify the logging configuration of the TSS Virtual Appliance.

The following switches can be used to do so:

•/level: allows you to define the default logging level. Accepted values are debug2, debug1, info, warn, error, fatal. Any syslog message with a level higher or equivalent to the defined level will be traced to the syslog server and in the local trace file. Please note that the default value is info.

•/server: allows you to define the target syslog server of the TSS Virtual Appliance.

rpcap:

This command allows you to enable or disable the rpcap service and to configure the auto deactivation delay. Such service can be used to remotely capture network traffic on the TSS Virtual Appliance.

The following switch can be used with this command:

•/enable: allows you to enable or disable the rpcap feature. Accepted values are enable and disable.

•/delay: allows you to specify after how many seconds the rpcap service will be automatically disabled when activated via the Component Manager interface. This value in seconds cannot be set to 0 or a negative value. Default value is 600 seconds.

ctcpcongestion:

This command allows you to enable or disable the CTCP congestion provider on the network connection.

The following switch can be used with this command.

•/enable: allows you to enable or disable the CTCP congestion provider. Accepted values are enable and disable.

snmpconfig:

This command allows you to configure the SNMP engine running on the TSS. The following switches can be used with this command.

•/targets: allows you to specify the SNMP traps target(s). This value can be empty, a single target IP address or multiple targets IP addresses separated by a comma.

•/websocketservers: allows you to specify the SNMP WebSocket target(s). This value can be empty, a single target URI or multiple URIs separated by a pipe character ("|"). Example : ws://echo.websocket.org|wss://echo2.websocket.org

•/readcommunity: allows you to define the read community. This value can be a string (no space) or empty.

•/trapcommunity: allows you to define the traps community. This value can be a string (no space) or empty.

iisrestart:

This command restarts the IIS Server. It shall only be used when required by an IP Trade support member in order to solve a potential problem. A confirmation message is displayed when this command is used.

clirestart:

This command restarts the current Command Line Interface. It can be used to refresh the CLI settings which is not necessary in a "normal" scenario. Once again, this command shall only be used when required by an IPTrade support member.

getconfig:

This command allows you to prompt the current TSS Virtual Appliance configuration. This system summary gives you details about IP Configuration and TSS Firmware(s) installed on this Virtual Appliance.

The following example shows you the result of such a command on a TSS Virtual Appliance with a TSS Firmware installed. Please note that TSS Firmwares with replication enabled are displayed with an "*".

reset:

This command can only be used if no TSS firmware is installed on the TSS Virtual Appliance and if replication is disabled. If a reset is required, all the TSS Firmwares installed on the device must be removed and replication disabled in order to use this command. Using this command brings you back to the Initial Configuration Wizard mentioned in the Virtual Appliance deployment section.

This command is not availbale in remote connection.

password:

This command allows the administrator to set or change the current's user password. This command will also enable/disable the remote connection if a password is set or not. If a password is already, your old password will be asked.

lock:

This command allows the administrator to lock the current session

security:

This command allows to manage the security of the TSS. Once this command is executed, a system reboot is required

The following switches can be used with this command:

•/tlsonly {true|false} : Enable or disable specific ciphers protocols used for accessing the TSS. When set to "true", SSLv2, SSLv3, TLSv1.0 are disabled.

time:

This command allows to configure and manage system time synchronization using NTP (Network Time Protocol). It provides options to set servers, define synchronization parameters, and check the synchronization status of the system clock.

The following switches can be used with this command:

/ntpserver

•Sets one or more NTP servers to synchronize with.

•When specifying multiple servers, separate them with a space.

•Running this command multiple times will override the previously configured servers with the new list provided.

•The first server in the list will always be the primary server, while any additional servers will act as fallback servers if the primary is unavailable.

/timezone

•Sets the system's timezone.

•The configured timezone will be displayed in the CLI configuration.

•A list of available timezone values is provided at the end of this document.

/interval

•Sets the synchronization interval (in seconds) for the NTP service to query the configured NTP servers.

/now

•Displays the system's current time.

/clean

•Removes all configured NTP servers.

•Reverts the system to its default, non-configured state.

/checkstatus

•Returns the time synchronization status of the system.

•Includes details of the currently selected active NTP source.

/checkpeers

•Returns a list of all configured NTP peers (servers) and their status.

•Includes synchronization details.

/checkconfiguration

•Lists all configured NTP servers.

•Displays the /interval (specialpollinterval) value currently set for the system.

/resync

•Forces an immediate synchronization of the system clock with the configured NTP server(s).

•This command is useful when the system time is out of sync and an immediate correction is needed.

bootlog:

This command allows to display messages from the TSS Bootstrap about updates/modifications that are currently made

The following switches can be used with this command:

•/enable {true | false}: Allows you to enable/disable the display of messages from the TSS Bootstrap.

•/logscreen {true | false}: Allow you to modify the way the messages are displayed in the CLI.

If you enable the logscreen, the message will be displayed at the top of the CLI.

Otherwise, it'll be displayed inside the CLI.

•/port {port}: Allows you to modify the communication port between the TSS Bootstrap and the CLI.

computername:

This command allows you to change the name of the computer.

The following switch can be used with this command:

•/name {name}: Allows you to change the name of the computer for the value mentioned.