CLI SSH Command Reference

Transcription

1 March 2013

2 Command Overview CLI Command Status commands get wan [n] get s2svpn get clientlist get session get cpuload get ha Description Retrieves each WAN s connection status (Connected, Disconnected, etc.), IP address, additional IP address, default gateway, DNS servers, and MTU. When reporting on cellular WANs, also includes mode (3G, 4G) and signal strength. Retrieves the connection status (Established, Connecting) of PepVPN / SpeedFusion connections. Retrieves the Client List table. Retrieves active sessions. Retrieves current CPU load percentage. Retrieves Balance s HA status (Master, Slave, Disabled), LAN IP address, and virtual IP address (if applicable). CLI Command Description Bandwidth commands get bandwidth Retrieves upload and download volume of each WAN transferred connection since last reboot. get bandwidth Retrieves current aggregated upload and download transfer aggregated rate. get bandwidth wan Retrieves current upload and download transfer rate of WAN n, by protocol. Shows all WANs when n=0. get bandwidth daily Retrieves daily per-user bandwidth report for the specified date. get bandwidth monthly Retrieves monthly per-user bandwidth report for the current month. CLI Command System commands get system get uptime get eventlog system reboot system restore n/a Description Retrieves Balance s model, hardware revision, s/n, and firmware version, plus MAC addresses of LAN, WAN1, WAN2, etc. Retrieves system uptime. Retrieves eventlog in two-column CSV format. Use n to specify number of events. Leave blank to show all events. Reboots device. Confirmation required. Restores device to factory defaults. Confirmation required. Toggles the display of printk messages onto the console port. Shows Debug mode is now on or Debug mode is now off after it is run. The option is saved to the active and temp config on each run. This command is undocumented and does not appear when using the help command Peplink 2 of 9

3 Command Details Notes: 1. <param> is a required parameter. 2. (param) is an optional parameter. 3. The serial output screen is always 80w x 24h. Limiting the output line width to a maximum of 80 characters is suggested. Command Category: Status Command: get wan <n> Parameters: n = WAN interface ID Description: Retrieves each WAN s connection status (Connected, Disconnected, etc.), IP address, additional IP address, default gateway, DNS servers, and MTU. When reporting on cellular WANs, also includes mode (3G, 4G) and signal strength. Sample usage: get wan 2 WAN Connection Name : HGC_8M-8M_DynIP Connection Status : Connected Connection Type : Static IP IP Address : Additional IP Address : Default Gateway : DNS Servers : MTU : 1500 Command: get s2svpn Description: Retrieves the connection status (Established, Connecting) of PepVPN / SpeedFusion connections. Sample usage: get s2svpn Peer Michael Home Patrick Home Status Connecting Established 2013 Peplink 3 of 9

4 Command: get clientlist Description: Retrieves the Client List table, ordered by IP address. Sample usage: get clientlist Status IP Address Name Down/Up (kbps) MAC Address Connected /10 00:26:B9:31:0D:DA Disconnected timmy-b / :13:F7:0F:52:BA Connected timmy-ubuntu 1024/ :13:F7:0F:52:BC Command: get session Description: Retrieves active sessions. Sample usage: get session Outbound Protocol Source IP Address Destination IP Service Interface Idle TCP : :41256 HTTPS/SSL PCCW_2M_DynIP 00:00:01 Inbound No session. Outbound Protocol Src/Dest Service Interface Idle TCP :58995 HTTPS/SSL PCCW_2M-2M_DynIP 00:00: :41256 UDP :33333 Secure IMAP/SSL HGC_8M-8M_DynIP 00:00: :44444 Inbound No session Peplink 4 of 9

5 Command: get cpuload Description: Retrieves current CPU load percentage. Sample usage: get cpuload CPU Load: 45.53% Command: get ha Description: Retrieves Balance s HA status (Master, Slave, Disabled), LAN IP address, and virtual IP address (if applicable). Sample usage: get ha High Availability : Enabled Group Number : 1 Preferred Role : Master Virtual IP : - LAN Administration IP : Subnet Mask : Peplink 5 of 9

6 Command Category: Bandwidth Command: get bandwidth transferred Description: Retrieves upload and download volume of each WAN connection since last reboot. Sample usage: get bandwidth transferred Data transferred since last reboot Interface Downloaded Uploaded Total All WAN Connection MB 4000 MB MB HGC_8M-8M_DynIP MB 2000 MB MB PCCW_2M-2M_DynIP MB 2000 MB MB Command: get bandwidth aggregated Description: Retrieves current aggregated upload and download transfer rate. Sample usage: get bandwidth aggregated Download Upload Total Overall 300 kbps 200 kbps 500 kbps Command: get bandwidth wan Parameters: n (optional): specifies WAN interface ID; shows all when n=0 Description: Retrieves current upload and download transfer rate of WAN n, by protocol. Shows all WANs when n=0. Sample usage: get bandwidth wan 0 Interface Download Upload Total WAN1 20 kbps 40 kbps 60 kbps HGC_8M-8M_DynIP 10 kbps 20 kbps 30 kbps PCCW_2M-2M_DynIP 10 kbps 20 kbps 30 kbps 2013 Peplink 6 of 9

7 Command: get bandwidth daily <date> Parameters: date: target date in yyymmdd format Description: Retrieves daily per-user bandwidth report for the specified date. Sample usage: get bandwidth daily Date Downloaded Uploaded Total MB 2000 MB MB Command: get bandwidth monthly Description: Retrieves monthly per-user bandwidth report for the current month. Sample usage: get bandwidth monthly Date Downloaded Uploaded Total to now MB 2000 MB MB to MB 2000 MB MB to MB 2000 MB MB 2013 Peplink 7 of 9

8 Command Category: System Command: get system Description: Retrieves Balance s model, hardware revision, s/n, and firmware version, plus MAC addresses of LAN, WAN1, WAN2, etc. Sample usage: get system System Information Router Name : Balance_Team Model : Peplink Balance 390 Hardware Revision : 1 Serial Number : Firmware : build 1279 Interface LAN WAN 1 WAN 2 WAN 3 MAC Address 00:11:6E:02:50:CC 00:11:6E:02:50:CD 00:11:6E:02:50:CE 00:11:6E:02:50:CF Command: get uptime Description: Retrieves system uptime. Sample usage: get uptime Uptime: 20 days 13 hours 25 minutes 2013 Peplink 8 of 9

9 Command: get eventlog (n) Parameters: n=number of events to show. No value=show all events. Description: Retrieves eventlog in two-column CSV format. Use n to specify number of events. Leave blank to show all events. Sample usage: get eventlog Time,Message :43:53,WAN: HGC_8M-8M_DynIP Connected :43:52,HGC_8M-8M_DynIP: DDNS domain peplink-max-bond.no-ip.org updated successfully :43:51,S2S VPN: Refused connection made from unknown peer 282F-F :43:50,System: Changes Applied Command: system reboot. Description: Reboots device. Confirmation required. Sample usage: system reboot Continue to reboot [Y/N]? Y Command: system restore. Description: Restores device to factory defaults. Confirmation required. Sample usage: system restore Are you sure want to restore to factory defaults [Y/N]? Y 2013 Peplink 9 of 9