API Reference

network

network command returns a list of commands to access networking related subcategories. To see a general overview of networking configurations and status use command status. Options to change configurations can be found within each subcategory.

SynLink> network
---------------------------
SynLink PDU Networking Menu
---------------------------

Usage: network [command] [options...]

Commands:    
   [s]tatus    Print all network status and configurations
   [r]estart   Restart all networking related activity
   [i]p        Print options to show and configure PDU IP
   [w]eb       Print options to show and configure HTTP(S) Webserver
   [ss]h       Print options to show and configure SSH Server
   [t]elnet    Print options to show and configure Telnet Server

network status

SynLink> network status

IP Address Assignment:  Static
-------------------
Static IP Address:      192.168.1.100
Static Gateway IP:      192.168.1.1
Static Subnet Mask:     255.255.255.0
Primary DNS IP:         8.8.8.8
Secondary DNS IP:       8.8.4.4
-------------------
Mac Address: 3A:D2:21:D3:82:45

Webserver
---------------
Current Status:         Currently Running
Availability:           ENABLED
Webserver Port:         80
SSL Security            Enabled

SSH Server
---------------
Current Status:         Not Currently Running
Availability:           ENABLED
SSH Port:               22

network ip restart

Restart all network related processes/services.

SynLink> network ip restart

Successfully restarted Network

network ip status

Show IP settings in human readable format.

SynLink> network ip status

----------------
Network Settings
----------------

IP Assignment       | Static
Static IP Address   | 192.168.1.220
Static Gateway IP   | 192.168.1.1
Static Subnet Mask  | 255.255.255.0
Primary DNS IP      | 8.8.8.8
Secondary DNS IP    | 8.8.4.4
Mac Address         | 3A:D2:21:D3:82:45

network ip set

Show configurations to change for IP related settings.

SynLink> network ip set

-------------------------
Network IP Configurations
-------------------------

Usage: network ip set [key] [value]

  Key            | Values          | Desc 
  ----------------------------------------
  ip_assign      | static, dhcp    |      
  static_ip      | IP_ADDRESS      |      
  subnet_mask    | SUBNET_MASK     |      
  gateway_ip     | GATEWAY_IP_ADDR |      
  primary_dns    | IP_ADDRESS      |      
  secondary_dns  | IP_ADDRESS      |  

network web status

Show web/http(s) settings in human readable format.

SynLink> network web status

-----------------
SynLink Webserver
-----------------

Current Status         | Currently Running
Availability           | ENABLED
Webserver Port         | 80
SSL Security           | ENABLED
Webserver HTTPS Port   | 443
Basic Auth Enabled     | DISABLED
HTTP to HTTPS Redirect | DISABLED

network web set

SynLink> network web set
------------------------
Webserver Configurations
------------------------

Usage: network webserver set [key] [value]

  Key                | Values    | Desc     
  ------------------------------------------
  enabled            | on, off   |          
  http_port          | PORT_NUM  |          
  https_port         | PORT_NUM  |          
  ssl_enabled        | on, off   |          
  basic_auth_enabled | on, off   | Allows passing username/password for API access (Insecure) 
  redirect_http      | on, off   | Redirects http requests to https when applicable 

network ssh status

SynLink> network ssh status

------------------
SynLink SSH Server
------------------
Current Status     | Currently Running
Availability       | ENABLED
SSH Port           | 22
Password Login     | ENABLED
Key Based Login    | ENABLED
Idle Timeout       | No Timeout

network ssh set

SynLink> network ssh set

------------------
SSH Configurations
------------------

Usage: network ssh set [key] [value]

Key          | Values   | Desc           
-----------------------------------------
enabled      | on, off  |                
ssh_port     | PORT_NUM |                
idle_timeout | SECONDS  | 0 - no timeout 
disable_keys | on, off  | While on, key based entry not allowed 
disable_pass | on, off  | While On, password based entry not allowed
  

network telnet status

SynLink> network telnet status

---------------------
SynLink Telnet Server
---------------------
Current Status     | Currently Running
Availability       | ENABLED
Telnet Port        | 23

network telnet set

SynLink> network telnet set

---------------------
Telnet Configurations
---------------------

Usage: network telnet set [key] [value]

Key          | Values   | Desc           
-----------------------------------------
enabled      | on, off  |                
telnet_port  | PORT_NUM |