Mushroom Networks Documentation

CLI commands

Mushroom device features and diagnostics can also be accessed using the cli commands. To use the cli interface connect a keyboard and a monitor to Mushroom device. You will see a cli command prompt on your monitor.

command (or “help” for help):

The cli can also be accessed with a serial console with RS232 cable. To access the console you would need
putty software on your windows machine (minicom for linux). These settings would be required to access the console (115200,8N1).

Once you are on the cli command prompt, type ‘list’, whic will display all the available container as shown below:

 

Then you type “list wan” to see the object in the “wan” container. You can then use “list wan/1” to see the contents of each object “1” within wan object.

You can also give the command “help” to see what all operations (like update, change, add, remove etc.) are present. As a quick reference guide, here are the most used commands to work with Mushroom’s CLI.

To change the name of your device

  • update admin/host hostname "mushroom"

To change the type of Wired WAN interfaces

  • change wan/1 DhcpInterface:
  • change wan/1 StaticInterface: ip "192.168.1.10" gateway "192.168.1.1" netmask "255.255.255.0" dns1 "8.8.8.8"
  • change wan/1 PassThroughInterface: ip "firewall_ip" gateway "gateway_addr" netmask "subnetmask" dns1 "8.8.8.8"
  • change wan/1 PppoeInterface: username "test" password "testpass"
  • change wan/1 DisabledInterface:

Note: To keep your lines (DHCP/Static/PPPoe) on standby, also include failover “true” field additionally to the above commands.

To edit DHCP additional settings

  • update dhcpadditionalsettings/1 dnsserverip "8.8.8.8"
  • update dhcpadditionalsettings/1 leaseunits "h"
  • Enter “help dhcpadditionalsettings” for other options.

Adding a bridge alias

  • add alias BridgeAlias: subnet "192.168.248.0/24"
    • update alias/1 subnet "192.168.249.0/24"
    • remove alias/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list alias”

To add Interface groups

  • add interfacegroup/group InterfaceGroupGroupHash:
  • add interfacegroup/group InterfaceGroupGroupRandom: 
    • change interfacegroup/group/1 InterfaceGroupGroupRandom:
    • remove interfacegroup/group/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list interfacegroup/group”

To add Interface group interfaces

  • add interfacegroup/interface InterfaceGroupInterface: group "2" deviceType "cellular" weight "1.0"
    • update interfacegroup/interface/1 deviceType "wan" weight "1.0"
    • remove interfacegroup/interface/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list interfacegroup/interface”
  • Enter “help interfacegroup/interface” for more options

To add Interface group filters

  • add interfacegroup/filter InterfaceGroupFilter: group "1" deviceTypeIn "vll"  deviceIndexIn "test" 
    • update interfacegroup/filter/1 deviceTypeIn "lan" deviceIndexIn "1" 
    • remove interfacegroup/filter/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list interfacegroup/filter”
  • Enter “help interfacegroup/filter” for more options

To add a manual network route

  • add route RouteSimple: deviceType "vll" deviceIndex "test" destinationSubnet "192.168.99.0/24"
  • add route RouteAdvanced: deviceType "wan" deviceIndex "1" sourceSubnet "192.168.254.0/24" 
    • change route/1 RouteAdvanced: deviceType "wan" deviceIndex "1"
    • update route/1 deviceType "cellular"
    • remove route/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list route”
  • Enter “help route” for more options

Adding & removing VoIP+Armor VLL instances

  • add vll/instance VllInstanceClientArmor: username "testname" password "testpass" targets "1.2.3.4"
  • add vll/instance VllInstanceServer: username "testname" password "testpass" pool4 "2" pool6 "1"
    • Then it will ask to re-confirm the password.
  • remove vll/instance/1
  • Enter “help vll/instance” for more options

Adding & removing LB tunnel instances using mush cli commands:

  • Make sure that the experimental mode is enabled.
  • add vll/instance VllInstanceClientTest3: username "lbtunnel" password "lbtunnel" targets "162.50.xx.yy"
  • add vll/instance VllInstanceServer: username "lbtunnel" password "lbtunnel" pool4 "2" pool6 "1"
    • Then it will ask to re-confirm the password.
  • remove vll/instance/1
  • Enter “help vll/instance” for more options

Adding & removing CBR tunnel instances using mushcli commands:

  • Make sure that the experimental mode is enabled.
  • add vll/instance VllInstanceClientTest4: username "cbrtunnel" password "cbrtunnel" targets "162.50.xx.yy"
  • add vll/instance VllInstanceServer: username "cbrtunnel" password "cbrtunnel" pool4 "2" pool6 "1"
    • Then it will ask to re-confirm the password.
  • remove vll/instance/1
  • Enter “help vll/instance” for more options

Adding interface options

  • add interface/option InterfaceOption: deviceType "vll" deviceIndex "test_name" pin "false"
    • remove interface/option/1 
    • update interface/option/1 deviceType "wan" deviceIndex "1"
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list interface/option”

Adding HTTP aggregation weights

  • add splitter/weight SplitterWeight: deviceType "wan" deviceIndex "1" weight "1
    • update splitter/weight/1 deviceType "cellular" deviceIndex "2"
    • remove splitter/weight/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list splitter/weight”
  • Enter “help splitter/weight” for more options

Adding HTTP aggregation exclusion

  • add splitter/reject SplitterReject:
  • add splitter/reject SplitterReject: source "192.168.100.0/24" destination "192.168.1.0/24"
    • update splitter/reject/2 source ""
  • ‘2’ indicates the index of the rule seen from UI.
  • You can also find the index by “list splitter/reject”

Adding firewall rules:

  • add firewall FirewallDrop: destinationSubnet "8.8.4.4"
  • add firewall FirewallReject: sourceSubnet "192.168.254.0/24"
    • update firewall/1 deviceTypeIn "lan" deviceIndexIn "1"
    • update firewall/1 priority "5"
    • change firewall/1 FirewallAccept:
    • remove firewall/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list firewall”
  • Enter “help firewall” for more options

Adding PPTP instance

  • add vpn/pptp Pptp: username "mushroom" password "mushpass"
    • update vpn/pptp/1 username "test" password "test_pass"
    • remove vpn/pptp/1
  • ‘1’ indicates the index of the rule seen from UI.
  • You can also find the index by “list vpn/pptp”
  • Enter “help vpn/pptp” for more options

To upgrade/downgrade the device:

  • list update/available
  • update update/status updateVersion "1.17.1"
  • update update/status finalize "true"
  • update admin/state reboot "true"
  • update admin/state reset "true"

 

Upgrading to some experimental versions, needs the experimental version to be enabled, only then you will see the available experimental versions. This can be done by:

  • update admin/firmware experimental_ "true"
    • update admin/firmware experimental_ "false"

Enable/Disable VLAN flag, under “EXTRA” tab

  • update admin/custom vlanSettingsBypass "true"
  • update admin/custom vlanSettingsBypass "false"

Enable/Disable Maintenance mode:

  • update admin/maintenance enabled "true"
  • update admin/maintenance enabled "false"

Enable/Disable Basic Web Authentication (from 1.19 version only):

  • change admin/authentication DisabledWebAuthentication:
  • change admin/authentication BasicWebAuthentication:

 

© 2004 – 2024 Mushroom Networks Inc. All rights reserved.

Let’s chat. Call us at +1 (858) 452-1031 or fill the form: