Command Line Interface Commands


First you must establish an SSH session to access the TAS and TS CLI Commands listed below.

TAS CLI Commands

TAS CLI Commands Description

tasrun

Starts the TAS Process

tasstop

Stops the TAS Process

tasstop -h

when you execute tasstop with a -h, you will get additional detailed help text:

tasstop - Shutsdown the TAS

Usage:  tasstop [-force]

-force -- Optional, forces the shutdown even if tests are running

tascheck

Determines if the TAS is running

taskill

Forcibly kills the TAS process

schedule-tas-backup

Configure the scheduled TAS backups - Additional details in Scheduled Backup topic.

backup-tas

Backup the TAS database/libraries - Additional details in Backing Up the System topic.

restore-tas

Restore the TAS database/libraries - Additional details in Restoring the System topic.

upgrade-tas

Upgrade / Downgrade the TAS - Additional details in Upgrading the System topic.

upgrade-tas -h

when you execute upgrade-tas with a -h, you will get additional detailed help text:

upgrade-tas Upgrades the TAS

Usage:  upgrade-tas FULL_PATHNAME_UPGRADE_FILE

FULL_PATHNAME_UPGRADE_FILE -- The full absolute path to .upg or.jar file including initial

install-tas-license

Install a license - Additional details in Installing a License topic.

install-tas-license -h

when you execute install-tas-license with a -h, you will get additional detailed help text:

install-tas-license Installs a license in the TAS

Usage:  install-tas-license FULL_PATHNAME_LICENSE_FILE

FULL_PATHNAME_LICENSE_FILE -- The full absolute path to .sql file including initial /

save-tas-logs

Saves the TAS debug logs

chg-mysql-tas-password

Changes the TAS's MySql password. This is an internal password the TAS uses to talk to the DataBase.   

chg-mysql-root-password

Changes the MySql root password. The mysql root password is automatically changed when you change the “sms” user from Landslide Client, they should be one and the same. You only need to use this command, chg-mysql-root-password,  when sms password gets lost / corrupted.   

list-tas-settings

Lists the TAS configuration settings - Additional details in Edit Settings topic.

set-tas-settings

Set or update a TAS configuration setting - Additional details in Edit Settings topic.

remove-tas-settings

Remove a TAS configuration setting - Additional details in Edit Settings topic.

enable-tas

Enables the TAS processes

disable-tas

Disables the TAS processes

sudo reboot

Reboots the system

ipcfg

Set the hostname and IP address

enable-tas-http

Enables the TAS HTTP Service, port 80

disable-tas-http

Disables the TAS HTTP Service, forcing HTTPS only

list-nagios-ts-entries

List the Nagios TS entries - Additional details in Nagios topic.

delete-nagios-ts-entries

Delete Nagios TS entries - Additional details in Nagios topic.

delete-nagios-all-ts-entries

Delete all the Nagios TS entries - Additional details in Nagios topic.

lsrootkey

Displays the key used for root password

display-original-rootkey

Displays the key used for Radius server configuration - Advanced_Security

display-tas-id

Displays the TAS Id / key used for licensing

results-auth-admin

Enables Authentication for the Result Website (Viewing Test Results). results-auth-admin [ on | off | check ]    

##>results-auth-admin

Usage: results-auth-admin [on|off|check]

##>results-auth-admin check

results-auth-admin: on

##>

html-message-admin

Used to add/remove/get custom HTML panels on the Landslide Homepage - Manage Homepage

Usage :
1. Install html message to a specific location <left-top|left-bottom|right-top>
``` sh
html-message-admin install <left-top|left-bottom|right-top> <html_file_name_on_TAS>
```
2. Remove html message from a specific location <left-top|left-bottom|right-top>
```sh
html-message-admin remove <left-top|left-bottom|right-top>
```
3. get installed html message info
```sh
html-message-admin info
```

tas-help

Displays the TAS Command line list

 

Test Server CLI Commands

Test Server CLI Commands Description

enable-ts

Starts the TS Process

disable-ts

Stops the TS Process

restart-ts

Restarts the TSD Process

enable-debug

Switch the Test Server to debug mode

disable-debug

Switch the Test Server to normal mode

trace

Set trace level on Test Server when in debug mode. Additional details in Retrieve Test Server Logs and Debug Trace

get-ts-logs

Bundles all /usr/logs and syslogs

ipcfg

Set the TS hostname and management IP address & set the IP address of NTP server (s)

resync

Poll NTP server (s) and sync to most accurate

editIfPools

Modify TS test port IP address pool info

SetTimeZone

Set the Time Zone

SetDateTime

Set the Date and Time

servicesConfig

Configure LS/OS services (privileged users only) Enable / Disable various services : 1) exit , 2) Telnet , 3) FTP , 4) HTTPS 5) TTY login Enter number associated with service/action:

vpnipaddr

Display the vpn ipaddr if VPN is enabled

lsrootkey

Generate Key used for root password

upgrade-ts

Upgrade TS using full path to .tsu file.

cfguser can scp the TSU into /home/cfguser and start upgrade with this command: 

upgrade-ts /home/cfguser/TSU_NAME

Additional details in Upgrading your Test Servers topic.

backupTs

Backup predetermined TS directories / files

restoreTs

Restore predetermined TS directories / files

display-ts-version

Display the TS tsu version

ps_tsd

Display TS daemon related linux process info

ps_ssesh

Display TS related linux process / thread info

sudo reboot

Reboots the system

activate-ue-teamviewer

Start TeamViewer remote Control

tas-help

Displays the TAS Command line list

ts-help

Displays this TS Command line list

Tas-help command

##>tas-help (List all tas commands)

|----------------------------------------------------------------------------------|

| TAS Commands                                                                     |

|----------------------------------------------------------------------------------|

| tasrun - Starts the TAS process                                                  |

| tasstop - Stops the TAS process                                                  |

| tascheck - Determines if the TAS is running                                      |

| taskill - Forceably kills the TAS process                                        |

|                                                                                  |

| schedule-tas-backup - Configure the scheduled TAS backups                        |

| backup-tas - Backup the TAS database/libraries                                   |

| restore-tas - Restore the TAS database/libraries                                 |

| upgrade-tas - Upgrade/Downgrade the TAS                                          |

| install-tas-license - Install a license                                          |

|                                                                                  |

| save-tas-logs - Saves the TAS debug logs                                         |

| chg-mysql-tas-password - Changes the TAS's MySql password                        |

| chg-mysql-root-password - Changes the MySql root password                        |

|                                                                                  |

| list-tas-settings - list the TAS configuration settings                          |

| set-tas-setting - set or update a TAS configuration setting                      |

| remove-tas-setting - remove a TAS configuration setting                          |

|                                                                                  |

| enable-tas - Enables the TAS processes                                           |

| disable-tas - Disables the TAS processes                                         |

| sudo reboot - Reboots the system                                                 |

| ipcfg - Set the hostname and IP address                                          |

|                                                                                  |

| enable-tas-http - Enables the TAS HTTP                                           |

| disable-tas-http - Disables the TAS HTTP                                         |

|                                                                                  |

| list-nagios-ts-entries - list the Nagios TS entries                              |

| delete-nagios-ts-entries - delete Nagios TS entries                              |

| delete-nagios-all-ts-entries - delete all Nagios TS entries                      |

|                                                                                  |

| lsrootkey - Displays the key used for root password                              |

| display-original-rootkey - Displays the key used for radius server configuration |

| display-tas-id - Displays the TAS id/key used for licensing                      |

|                                                                                  |

| ts-help - Displays the TS help list                                              |

| tas-help - Displays this list                                                    |

|----------------------------------------------------------------------------------|

##>

Test Server Help Command

ts-help (List all ts commands)

|------------------------------------------------------------------|

| Test Server Commands                                             |

|------------------------------------------------------------------|

| enable-ts ------- Starts the TS process                          |

| disable-ts ------ Stops the TS process                           |

| restart-ts ------ Restarts the TSD process                       |

|                                                                  |

| enable-debug ---- Switch TS to debug mode                        |

| disable-debug --- Switch TS to normal mode                       |

| trace ----------- Set trace level on TS when in debug mode       |

| get-ts-logs ----- Bundles all /usr/logs and syslogs              |

|                                                                  |

| ipcfg ----------- Set the TS hostname and management IP address  |

| resync ---------- Poll Ntp server(s) & sync to most accurate     |

| editIfPools ----- Modify TS test port IP address pool info       |

| setTimeZone ----- Set the time zone                              |

| setDateTime ----- Set the date and time                          |

| servicesConfig -- Configure LS/OS services(privileged users only)|

|                                                                  |

| vpnipaddr ------- Display the vpn ipaddr if vpn enabled          |

|                                                                  |

| lsrootkey - Displays the key used for root password              |

|                                                                  |

| upgrade-ts ------ Upgrade TS using full path to .tsu file        |

| backupTs -------- Backup predetermined TS directories/files      |

| restoreTs ------- Restore predetermined TS directories/files     |

| display-ts-version -- Display TS tsu version                     |

| ps_tsd ---------- Display TS daemon related linux process info   |

| ps_ssesh -------- Display TS related linux process/thread info   |

| sudo reboot ---------- Reboots the system                        |

| activate-ue-teamviewer -------- Start Teamviewer remote control  |

|                                                                  |

| tas-help -------- Displays TAS help list                         |

| ts-help --------- Displays this list                             |

|------------------------------------------------------------------|

##>