CLI Commands
SecureSync features a suite of command-line interface (CLI) commands that can be used to configure parameters and retrieve status information or log files via a remote connection, using the telnet
or ssh
(if enabled) protocol.
This section includes a list of some of the supported commands.
Notes:
- The command “
helpcli
” will provide a list of all available commands and their syntax (Note: Typing “help
” will output bash shell help only and will not provide useful information). - You can scroll up or scroll down through the output by using the Page Up/Page down keys, or the arrow keys.
- Type “
q
” (lower-case) to quit. - Pressing the up/down keys scrolls through previously typed commands.
- Commands need to be typed in all lower-case letters.
- Where
eth0
andeth1
are the base network ports. - User accounts with “user” group permissions can perform “
get
” commands but cannot perform any “set
” commands or change/reset passwords. Only user accounts with “admin” group permissions can perform “set
” commands or change/reset password. Refer to Adding/Deleting/Changing User Accounts for user account setup information.
Command | Description |
---|---|
agnss server | Display AGNSS status ie. enabled or disabled |
agnss server disable | Disable AGNSS server |
agnss server enable | Enable AGNSS server |
agnss server gen |
Display almanac generation configuration. <daily <HH:MM>|interval> Use with arguments to set the almanac generation configuration to either daily with 24hr gen time each day or an interval in s between 10 and 86400 |
agnss server station |
Display AGNSS station <station> Use with arguments to set AGNSS station to a 4-letter station name. |
agnss server record |
Display the time in days the records are kept. <days> Use with argument to set the time the records are kept between 2 and 400 days. |
agnss server all | Display all AGNSS information; combines status, time age and list commands. |
agnss server status | <ephemeris|almanac> Display Ephemeris or Almanac data status. |
agnss server time | <ephemeris|almanac> Display time in seconds until next data set is ready. |
agnss server age | <ephemeris|almanac> Display data age in seconds. |
agnss server list | <GPS|GLO|GAL|BEI> Display list of active satellites for a single, given constellation. |
agnss server rnx | <GPS|GLO|GAL|BEI> Display list of constellations's satellites found in today's RINEX file. |
clean | Restores SecureSync configuration, logs, and stats to factory defaults and reboots |
cleanhalt | Restores SecureSync configuration to factory defaults and halts |
clearcfg | Restores configuration to factory defaults and reboots |
clearlogs | Clears all logs |
clearstats | Clears all statistical data (NTP, and oscillator/disciplining) |
dateget | Displays current date (for example, 15 APR 2015) |
dateset | Used to set the current date |
defcert | Used to create a new Safran self-signed SSL certificate for HTTPS in case of expiration of the original certificate |
dhcp4get | Displays whether DHCP is enabled |
dhcp4set | Used to enable or disable DHCP |
dhcp6get | Displays whether DHCPv6 is enabled |
dhcp6set | Used to enable or disable DHCPv6 |
displaymodeget | Retrieves the display mode setting (either 12-hour or 24-hour time) |
displaymodeset | Sets the system display mode to either 12-hour time or 24-hour time |
dns4cfg | Display the configured IPv4 primary and secondary DNS addresses |
dns4get | Displays the configured DNS servers |
dns4set | Used to configure the DNS servers |
doyget | Used to obtain the current Day of Year |
doyset | Used to set the current Day of Year |
fp_lock | Lock the front panel (admin access required) |
fp_unlock | Unlock the front panel (admin access required) |
gettemp | Displays the temperature of the oscillator, board, or CPU |
gpsdop | Displays GNSS receiver positional accuracy estimates |
gpsdserviceportget | Displays the GPSD service port |
gpsdserviceportset | Sets the GPSD service port |
gpsinfo | Applicable to SAASM-equipped SecureSync units only |
gpsloc | Displays GNSS latitude, longitude and antenna height |
gpsmdl | Displays the GNSS Manufacturer and Model |
gpsreset | Resets the GNSS Position stored in the unit. |
gpssat | Displays GNSS satellites tracked and maximum signal strength being received |
gw4cfg | Display the configured IPv4 gateway |
gw4get | Displays the default IPv4 gateway |
gw4set | Used to configure the IPv4 gateway addresses |
gw6cfg | Display the configured IPv6 gateway. |
gw6get | Displays the default IPv6 gateway address |
gw6set | Used to configure the IPv6 gateway address |
halt | Used to Halt the system for shutdown |
helpcli | Provides list of available commands and syntax |
hostget | Displays the DNS hostname |
hostset | Sets the DNS hostname |
hotstart | Initiate a hot start operation on the SAASM GPS receiver |
ip4cfg | Display the IPv4 static configuration. |
ip4get | Displays IPv4 Ethernet port information (IP address net mask and gateway) |
ip4set | Used to set IPv4 Ethernet port information (IP address net mask and gateway) |
ip6add | Used to add IPv6 Ethernet port information (IP address net mask and gateway) |
ip6cfg | Display the IPv6 static configuration |
ip6del | Used to delete IPv6 IP address |
ip6get | Used to obtain the IPv6 IP address |
iptables | See |
licenses | Displays configured licenses installed (if any) |
list | Outputs a list of commands |
loadconf | Restore a saved configuration and reboot |
locallist | Used to display local clocks |
manifest | See a list of all files |
model | Displays the Serial Number of the unit |
net | Displays network |
netnum | Displays the number of general-purpose network interfaces |
net4 | Displays IPv4 network |
net6 | Displays IPv6 network |
options | Displays configured options installed (if any) |
oscget | Displays the installed system oscillator |
portget | Display whether network port is enabled (for example, "portget ETH2") |
portset | Enable or disable a network port: "portset x on" where "x" is the port number (for example, "ETH2") "portset X off" |
portstate | Display the current state for a network port |
ppsctrl | Enable/disable individual 1PPS output signals |
priorset | Sets the priority of an entry in the reference priority table |
ptpcfgload | Copies specified file to PTP config location. |
ptpifaceset | Enable or disable PTP on a specified interface. |
ptpifacesetcfg | Set the configuration of a specified interface from a file. |
radius setretry | <value> Sets how many radius login retries will be attempted |
radius getretry | <value> Gets the number of radius login retry attempts |
radius server list | Lists radius servers |
radius server add | <host> <port> <key> <timeout> Adds radius server |
radius server del | <id> Deletes radius server number <id> |
reboot | Used to warm-boot the unit without having to disconnect or reconnect power |
reftable | Displays reference priority table |
release4 | Used with DHCP to release the IPv4 address |
release6 | Used with DHCPv6 to release the IPv6 address |
renew4 | Used with DHCP to renew the assigned IPv4 address |
renew6 | Used with DHCPv6 to renew the assigned IPv6 address |
resetpw | Resets the administrator account (spadmin) password back to the default value “admin123 ” |
routes4 | Displays the current IPv4 routing table(s) |
routes6 | Displays the current IPv6 routing table(s) |
rt4add | Adds an IPv4 static route |
rt4del | Deletes an IPv4 static route |
rt4get | Displays the configured IPv4 static routes |
rt6add | Adds an IPv6 static route |
rt6del | Deletes an IPv6 static route |
rt6get | Displays the configured IPv6 static routes |
saveconf | Generate archive of current configuration |
savelog | Generate archive of all log files |
scaleget | Displays configured system timescale |
scaleset | Used to configure the system timescale |
sendnmeaudp | Used to configure, enable and disable the NMEA over UDP feature (see System Time Message for more information) |
sendtrap | Triggers one type of a possible set of alarms. |
sendtrap all | Sends one instance of all alarms |
services | Displays the state of services (enabled/disabled) |
servget | Displays the state of individual services |
servset | Enable or disable specific services |
slaacget | Displays whether SLAAC is enabled |
slaacset | Used to enable or disable SLAAC |
speedget | <iface> Display the speed, the duplex, and the negotiation mode of the specified network interface. |
speedset | <iface> <speed> <duplex> <autoneg> Set the speed, the duplex, and the negotiation mode of the specified network interface. |
stateset | Enable or disable an entry in the reference priority table. index = 0...15. state = 0 (disable), 1 (enable) |
status | Displays information about the oscillator disciplining |
stlgetinfo | Provides STL data |
swupgrade | Performs system upgrade using the update bundle provided |
syncstate | Display timing system synchronization state |
testevent | Generates SNMP events in the enterprise MIB |
tfomget | Displays current estimated system time error (TFOM – Time Figure of Merit) |
timeget | Displays current system time (time is displayed in the configured timescale – See scaleget command to retrieve the configured timescale) |
timeset | Used to manually set the current time (hours, minutes in seconds); time is entered based on the configured timescale – See scaleget command to retrieve the configured timescale |
unrestrict | Used for clearing access control restrictions to SecureSync |
version | Displays the installed main SecureSync and timing system software versions |
vlanadd | Add a VLAN connection |
vlandel | Delete a VLAN connection |
yearget | Displays the current year |
yearset | Used to set the current year |
zeroize | Applicable to SAASM-equipped SecureSync units only |