VTYSH extensions. Various services

Preliminary version.

30.08.2023

Changelog

17.07.2023 — Added and documented commands «show ipsec information», «show uptime information», «show hardware information», «show build information», «upgrade», «backup config to» and «load config from».
02.08.2023 — Added «start vrrp», «no start vrrp» and «start nhrp», «no start nhrp» commands. Contents page has been added.
23.08.2023 — Added <show l2 neighbor information> and <show ip/ipv6 firewall rules> commands.
24.08.2023 — Added <show wireless hardware (1-4)>.
28.08.2023 — Added <set checkpoint interval> coomand.
30.08.2023 — Added <show ip | ipv6 kernel routes> command.

Debug / Informational commands

** show syslog **
Show system log entries. Command is in enable mode.  Requires privilege level at least 10.

** show time sources **
Show all time sources.  Requires privilege level at least 10.

** show uptime information **
Displays current uptime.

** show hardware information **
Displays hardware boot and event log. Requires privilege level at least 10.

** show build information **
Displays firmware build time and some software components information. Requires privilege level at least 10.

** show ipsec information **
Displays current ipsec tunnels and policies states. Requires privilege level at least 10.

** show current nameservers **
Displays current using namesevers. Requires privilege level at least 10.

** show l2 neighbor information **
Displays current ARP and NHRP/tunneling endpoints state. Requires privilege level at least 10.

** show wireless hardware (1-4) **
Displays capabilities of radio hardware. Requires privilege level at least 10.

** show <ip | IPv6> kernel routes **
Displays current lernel installed routes list. Requires privilege level 10 at least.

Configuration commands

System log management

** set syslog location WORD **
Set system log location (Path to file or address of remote server).

** no set syslog location **
Undo system log location changes.

** set syslog <level|buffer|port> (1-65535) **
Set system log Level or buffer size or port of remote syslog server Value (e.g. 514).

** no set syslog <level|buffer|port> **
Undo setting system log Level or buffer size or port of remote syslog server.

Time management

** time source <A.B.C.D|X:X::X:X|FQDN> [port (1-65535)] **
Setup new time source as server IPv4 address or hostname with port number.

** no time source <A.B.C.D|X:X::X:X|FQDN> **
 Time service Source Server IPv4 address "Server IPv6 address "Server hostname.

** time zone WORD **
Setup time zone name (e.g. GMT0).

** no time zone **
Undo time zone name.

** start timeserver **
Start built-in timeserver.

** no start timeserver **
Stop (and do not start in a future) built-in timeserver.

Overall wireless settings

** wlan country WORD **
Setup wLAN country code Value (e.g. US).

** no wlan country **
Undo WLAN country code.

** wlan rssi threshold <good|poor> (0-255) **
Setup WLAN RSSI Threshold value for «Good level» and «Poor level» in dBi. Usefull for reporting deviations to NMS.

** no wlan rssi threshold <good|poor> **
Undo WLAN RSSI Threshold settings for «Good level» and «Poor level».

IPv6 over IPv4 service

** start ipv6-to-ipv4 **
Start IPv4 to IPv6 tunneling.

** no start ipv6-to-ipv4 **
Stop IPv4 to IPv6 tunneling.

Telnet, SSH and WebUI

** start telnet [port (1-65535)] **
Start telnet server on port (e.g. 23).

** no start telnet **
Stop telnet server.

** start ssh [port (1-65535)] **
Start SSH server on port (e.g. 22) 

** no start ssh **
Stop SSH. server

** start http [port (1-65535)] **
Start WebUI on port (e.g. 443).

** no start http **
Stop WebUI.

Routing subsystem

** start bgp **
Start BGP router subsystem.

** no start bgp **
Stop BGP router.

** start isis **
Start ISIS router (if exists in firmware).

** no start isis **
Stop ISIS router.

** start pbr **
Start policy based routing subsystem.

** no start pbr **
Stop Policy based routing.

** start eigrp **
Start EIGRP router (if exists).

** no start eigrp **
Stop EIGRP router.

** start ospf **
Start OSPFv2 router.

** no start ospf **
Stop OSPFv2 router.

** start ospf6 **
Start OSPFv3 router.

** no start ospf6 **
Stop OSPFv3 router.

** start ldp **
Start LDP router subststem (if exists in firmware).

** no start ldp **
Stop LDP router.

** start bfd **
Start BFD sunsystem.

** no start bfd **
Stop BFD subsystem.

** start rip **
Start RIP router.

** no start rip **
Stop RIP router.

** start ripng **
Start RIP-NG (RIP for IPv6) router.

** no start ripng **
Stop RIP-NG router.

** start pim **
Start Multicast routing.

** no start pim **
Stop Multicast routing.

** start vrrp **
Start VRRP component.

** no start vrrp **
Stop VRRP component.

Various commands

** reboot **
Reboot device. Command is in enable mode.

** clear config <all | cli | webui> **
Reset whole device configuration to default <all> or only part of configuration made from <cli> or <webui>. Command is in configure mode and hidden.

** upgrade WORD **
Download firmware file from specified location and make upgrade. WORD should have full URL to firmware file. E.g. http://dl.stasoft.net/share/s/test/NETSHe-7.0-x86-sysupgrade.bin . Command is available in enable mode but requires privilege level 15.

** backup config to WORD **
Backup copy of current config to specified location. WORD should have full URL to destination and resulted config file. Command is available in enable mode but requires privilege level 15.
Note. Command is not functional yet.

** load config from WORD **
Doanload a copy of config from specified location and install this one as a current configuration. WORD should have full URL to destination and resulted config file. Command is available in enable mode but requires privilege level 15.
Note. Command is not functional yet.

** set checkpoint interval (0-300) **
Set interval in seconds between checkpoint tracks. Zero values resets interval to default 300 seconds. We are nastly recommend to use checkpoint interval not less than 15 seconds.

Notes for configuration modes

Provided extensions enables full-fledged comman line interface (CLI) for device. CLI is PRIMARY configuration mode. 
Any changes have been made in CLI will OVERWRITE WebUI settings. Not any changes have been made in WebUI will OVERWRITE CLI settings.
Due to this specific, we recommend to use one of configuration inteface and do not mix using. E.g. use CLI only or use WebUI only.
We are working for full synchronization between CLI and WebUI but it is not reached at this moment.

To simplify synchronization between two tools of configuration, we provide command like
«clear config cli» and «clear config webui». Such commands reset CLI- or WebUI- made part of overall configuration.