batm-manage: the CAS CLI Toolkit
The following commands are available to you (and essential) via the batm-manage script.
The "batm-manage" CAS CLI toolkit is automatically installed with CAS on your server.
Sudo (superuser/root) privileges are required on the server to use batm-manage.
Syntax:
sudo /batm/batm-manage [command]
Commands:
[command] | Description & Notes |
---|---|
info | Displays the status of individual services and other information. |
start master | admin | all | Starts the selected service. |
stop master | admin | all | Stops the selected service. |
log master | admin | Displays the requested log. |
log clear | Deletes all log files. |
server-upgrade BUILDNUM | Downloads BUILDNUM from GB and upgrades your CAS. DOWNGRADING MAY CAUSE DATA LOSS! |
terminal-upgrade BUILDNUM SN | Downloads and triggers a BATM firmware upgrade.
|
dongle version serialno | Downloads and prepares dongle (door sensors) firmware.
|
reboot serialno1 serialno2 | Reboots the specified Terminal(s). |
restore-point serialno1 serialno2 | Creates a “restore point” for the specified Terminal(s) that will be automatically deployed if the Android system detects an issue with the firmware image.
|
vpn-generate serialno1 serialno2 | Generates a VPN certificate for the specified terminal(s).
|
vpn-revoke serialno1 serialno2 | Revokes the VPN key for the specified terminal(s).
|
vpn-clean | Clears and removes any generated VPN configuration. See: Confluence |
vpn-user-generate name email | Generates a VPN certificate and grants CAS VPN access to name @ email |
vpn-user-revoke name | Deletes the VPN certificate and revokes CAS VPN access to name |
terminal-unpair serialno | Force re-authorization of serialno BATM with CAS.
|
terminal-hwconf-clear serialno | clears the stored BATM HW configuration for serialno
|
acceptor billset serialno | Downloads and prepares an acceptor billset update for serialno.
|
send crashlogs | Sends BATM Crash Logs to support when requested.
|
send serverlogs | Sends CAS Server Logs to support when requested.
|
send auditlogs | Sends auditlogs to support.
|
send payment fromaddress toaddress amount [fee] | Sends coin from internal wallet when "stuck".
|
wallet prefix | Generates new wallet with requested prefix.
|
backup | Creates a backup of the server. Optionally you may specify what data to backup. The following options must then be specified in the proper order. Providing no options will backup everything (default). The current backup options are:
Example: backup “data db”
|
restore backupdirbackupdir is required and points to a valid folder containing a backup e.g. | Restores a backup. You may (optionally) specify datatypes to avoid overwriting valid data. They must be specified in the proper order. Specifying no options will restore everything in the folder (default). The current restore options are:
Examples: restore backupdir “db”
restore backupdir “data db”:
|
export terminal serialno1 serialno2 | Export terminals from server
|
import terminal serialno.xml.gz <organizationName> | Import a terminal backup into the server, assigning it to the optional organizationName.
|
export identity organizationName | Exports all Identity data, including images.
|
import identity filename.xml.gz <organizationName> | Imports all Identity data, including images, from an export file (see: export identity).
|
reset-user user | Reset password & 2FA for user Note the following password rules: |
unban-ip ipaddress | Removes any IP login ban. |
unban-user username | Removes the specified username from ban list. |
fg master | admin | Starts the selected service in the foreground.
|
license [newlicense] | Displays the current license, or updates the license key. |
show balances BTC | LTC | Prints out any temporary wallets with non-zero balances.
|
collect-photos [duration] | Collect photos from all Terminals (main cameras).
|
audit-fingerprints | Analyzes any fingerprint files. Reports point quality, enabling poor quality files to be removed from Identity files. |
install-reverse-proxy | Installs the nginx reverse proxy server. |
heap-dump master | admin | Dumps the java heap of the master or admin service
|
sanitize all | old | Removes database records containing sensitive information |
Copyright © 2020-2024 General Bytes USA LLC