Command summary EcoNAT Documentation / Command summary
A brief description of the commands shown in the table below.
Descriptions:
Priority – the minimum level of user access rights, in which the command is available.
Mode: C – configuration, C * – context commands of configuration mode, O – operational.
VALUE – entered value of the parameter.
Command | Description | Mode | Priority |
---|---|---|---|
( ) | Clear the edited configuration item – array | C | 4 |
VALUE | Assign the value to the edited configuration item | C | 4 |
( VALUE VALUE ) | Assign the value to the edited configuration item – array | C | 4 |
? | Context help | O/C | 0 |
helpme % | Console output parameter descriptions and tree branches available at the current level | O/C | 0 |
! | Console output branches available at the current level of the configuration tree | O/C | 0 |
{ | Access to the editable item of the configuration tree | O/C | 0 |
} | Exit from the editable item of the configuration tree | O/C | 0 |
+= ( VALUE VALUE ) | Add multiple values to the edited configuration item – array | C | 4 |
+= VALUE | Add value to the edited configuration item – array | C | 4 |
-= ( VALUE VALUE ) | Delete multiple values of editable configuration item – array | C | 4 |
-= VALUE | Delete the value of the edited configuration item – array | C | 4 |
#NAME? | Assign the values to the edited configuration item or array | C | 4 |
add (VALUE VALUE ) | Add more values to the edited configuration item – array | C | 4 |
add VALUE | Add value to the edited configuration item – array | C | 4 |
apply | Configuration applying (unquestionable) | C | 8 |
clear brasinfo all | Erase all subscriber records in BRAS | C | 4 |
clear cgnat errors | Clear cgnat port allocation error counter | C | |
clear config | Clear running config | C | |
clear counters | Reset counters | O/C | 0 |
clear sessions all | Clear the translations table | C | 4 |
cloneacl SRCNAME NEWNAME | Create a copy of ACL containing all the rules, but having a different name | C | 4 |
commit | Confirm the application of the configuration. If the configuration of the network management interface is changed, its settings are applied temporarily and rolled back if the commit command is not called within two minutes. This allows you to not lose the ability to communicate with the device remotely over the network in case of an erroneous configuration | O/C | 1 |
CONFIGITEMNAME | Select the current configuration element | O/C | 0 |
configure | Go to the configuration mode | O | 0 |
copy SRC_PROFILENAME DST_PROFILENAME | Copy the configuration to the specified. Not applicable to the factory and effective | C | 5 |
copy hwinfo URL | Copy hardware information to the specified file on the remote server | O | |
create acl ACLNAME | Create an ACL | C | 4 |
create pool POOLNAME | Create a pool | C | 4 |
create user USERNAME level LEVEL secret SECRETTYPE SECRETSTRING | Create a user | C | 15 |
dir | View the list of configurations | C | 4 |
disable | Disable the configuration object (e.g. pool) | C | 4 |
dpilist | View uploaded URL filtering files lists | O/C | 0 |
dpirun | Update the sites database from downloaded and enabled URL filtering lists | C | 4 |
dropacls | Delete all ACLs | C | 4 |
droppools | Delete all pools | C | 4 |
droppolicies | Delete all policies at once | C | 4 |
dropradius | Delete all RADIUS server settings at once | C | 4 |
dropservices | Delete all services at once | C | 4 |
edit acl ACLNAME edit ACLNAME | Go to the specified ACL in the configuration tree | O/C | 0 |
edit date DATE | Set a new date on the device | C | 14 |
edit datetime DATETIME | Set a new date and time on the device | C | 14 |
edit pool POOLNAME | Go to the specified pool in the configuration tree | O/C | 0 |
edit time TIME | Set time on the device | C | 14 |
enable | Enable the configuration object (e.g. pool) | C | 4 |
end | Exit the configuration mode | C | 0 |
erase PROFILENAME | Delete profile with the specified name. Factory and effective profiles are not removed. If you delete a profile startup, then after loading, the system will wait until the user enters the console and apply any configuration | C | 4 |
exit | Go to an upper level in the configuration or exit from configuration mode (if we are at the root of the configuration tree in configuration mode) | O/C | 0 |
firmware download URL | Download the firmware upgrade from the remote server | C | 15 |
firmware install | Install downloaded firmware upgrade | C | 15 |
firmware revert | Set the reboot with inactive firmware | C | 15 |
firmware rollback | Discard the reboot with inactive firmware | C | 15 |
firmware status | Information about the installed firmwares and its state | C | 15 |
firmware unlock | Reset the blocked process of updating the firmware | C | 15 |
goto pool POOLNAME | Go to the specified pool in the configuration tree | O/C | 0 |
grant USERNAME LEVEL | Change the level of user access rights | C | 15 |
interface IFNAME down | Disable network interface | C | 4 |
interface IFNAME up | Enable network interface | C | 4 |
load effective | Load an effective configuration for editing | C | 4 |
load factory | Load default factory configuration | C | 4 |
load PROFILENAME | Load selected configuration to edit | C | 4 |
load startup | Load startup configuration to edit | C | 4 |
no acl ACLNAME | Delete specified ACL | C | 4 |
no pool POOLNAME | Delete specified pool | C | 4 |
no RULEPRIOIRTY | Delete rule in ACL (contextual command is allowed only within the ACL itself) | C* | 4 |
no use ACLNAME POOLNAME | Unbind pool and ACL | C | 4 |
no user USERNAME | Delete the user | C | 15 |
poweroff | Shut down the power and EcoNAT | C | 8 |
quit | Terminate the console session. Exits from the console (the edited configuration is not saved in the configuration mode) | O/C | 0 |
reboot | Restart EcoNAT | C | 8 |
remove ( VALUE VALUE ) | Delete the specified multiple values from the content of the current configuration item – array | 4 | |
remove VALUE | Delete the specified value from the content of the edited configuration item – array | C | 4 |
renum ACLNAME | The forced numbering of the rules in the ACL. The first rule will be assigned the number 100. The remaining number will be 10 more than the previous | C | 4 |
renum pools | The forced numbering of priorities of all the pools. The first pool (highest priority) will be assigned a priority of 100. The priority of each of the following will be 100 more than the previous | C | 4 |
rollback | Cancel the last applied settings of the control network interface | O/C | 1 |
root | Go to the root of the configuration tree | O/C | 0 |
RULEPRIORITY allow [ip] [src] SRCADDR [dst] DSTADDR | Enter the ACL rule (contextual command is allowed only within the ACL itself) | C* | 4 |
RULEPRIORITY deny [ip] [src] SRCADDR [dst] DSTADDR | Enter the ACL rule (contextual command is allowed only within the ACL itself) | C* | 4 |
safe apply | Apply the configuration. In the case of changing the management interface configuration it will be applied temporary. If there won't be commit command within two minutes it will be rolled back. This allows not to lose the ability to connect to the device remotely in case of an erroneous configuration | C | 8 |
save PROFILENAME | Save currently edited configuration under the specified name. Not applicable to the factory and effective | C | 5 |
save startup | Save currently edited configuration as a startup (not recommended, it is better to apply the configuration using the apply, and if their work is satisfying then set it startup with the write command) | C | 5 |
setlog SUBSYSTEM LEVEL | Setting the logging level. It changes the system configuration. The running configuration won't be changed | C | |
show | Show the configuration tree in depth from the current configuration element | O/C | 0 |
| b STRING | begin STRING | Filter of show command. Throw a strings until it reaches a line containing the specified substring | O/C | 0 |
| count | Filter of show command. It counts the number of strings | O/C | 0 |
| e STRING | exclude STRING | Filter of show command. Print only lines not containing the specified substring | O/C | 0 |
| i STRING | include STRING | Filter of show command. Print only lines containing the specified string (If the substring contains spaces or special characters such as ')', then you should use the quotation marks) | O/C | 0 |
| more | Filter of show command. Print with a stopping through each page | O/C | 0 |
| r STRING | regexp STRING | Filter of show command. Display only the strings that matches the specified regular expression | O/C | 0 |
show acl ACLNAME | Show the rules contained in this ACL | O/C | 0 |
show arp all | Show the ARP information | O/C | 0 |
show bind | Show information about binding local IP addresses to global | O/C | 0 |
show brasinfo IPADDR | Show BRAS information about the specified address | O/C | 0 |
show brasinfo summary | View brief BRAS statistics | O/C | 0 |
show brasstate | Show information about BRAS state | O/C | 0 |
show cairrecords URL | Output CAIR categories for URL | O/C | 0 |
show cgnat errors | Viewing port allocation errors in a CG-NAT pool | O/C | 0 |
show config effective | Show the contents of the effective configuration (editable configuration remains unchanged) | O/C | 0 |
show config file PROFILENAME | Show the contents of the specified configuration (editable configuration remains unchanged) | O/C | 4 |
show config startup | Show the startup configuration (editable configuration remains unchanged) | O/C | 0 |
show counters | Show system counters | O/C | 0 |
show cps | Show current connection establishing speed | O/C | 0 |
show dpistate | Show diagnostic information related to the URL filtering functionality in the Roskomnadzor list | O/C | 0 |
show interface all | Show information about all network interfaces | O/C | 0 |
show interface brief | Show brief information about network interfaces | O/C | 0 |
show interface mng | Show the MGMT interface information | O/C | 0 |
show interface IFNAME | Show information about a specific network interface (IFNAME – interface name, for example, TE7 interface name matches the interface number on the front of the device) | O/C | 0 |
show interface IFNAME counters show interface all counters | View counters on the specified interface | O/C | 0 |
show interface IFNAME traffic show interface all traffic | View incoming/outgoing traffic statistics for a particular interface (IFNAME) or all interfaces since the last system boot or the last counters reset. The Subtotal row shows the total values for all line interfaces, i. e. non-management/non-logging ones | O/C | 0 |
show interface IFNAME traffic monitor show interface all traffic monitor | Real-time interface activity monitoring. Shows incoming/outgoing traffic per second for a particular interface (IFNAME) or all interfaces. The Subtotal row shows the total values for all line interfaces, i. e. non-management/non-logging ones | O/C | 0 |
show interface transceiver IFNAME | Show information about the transceivers | O/C | 0 |
show ipif | Show information about the management interface settings | O/C | 0 |
show memstat | Show memory usage statistics in Megabytes (MiB) | O/C | 0 |
show memstat detail | Show memory usage statistics in bytes | O/C | 0 |
show neighbours IFNAME | Show the information received from neighbors via LLDP protocol | O/C | 0 |
show ntp | Show status of time synchronization via NTP | O/C | 0 |
show pool POOLNAME | Show the contents of the pool configuration | O/C | 0 |
show pool usage | Show information about the usage of pools | O/C | 0 |
show pools | Show the contents of all pools | O/C | 0 |
show pool brief | Show summary of editable pools | O/C | 0 |
show power | Show status of power supplies | O/C | 0 |
show resources | Show resources statistics | O/C | 0 |
show sessions gap ADDR:PORT | Show the sessions for the pair: global address + global port | O/C | 0 |
show sessions global ADDRRANGE | Show the sessions for the specified global address | O/C | 0 |
show sessions gport PORT | Show the sessions for the specified global port | O/C | 0 |
show sessions lap ADDR:PORT | Show the sessions for the pair: a local address + local port | O/C | 0 |
show sessions local ADDRRANGE | Show the sessions for the specified local address | O/C | 0 |
show sessions lport PORT | Show the sessions for the specified local port | O/C | 0 |
show sessions rap ADDR:PORT | Show the sessions for the pair: external address + external port | O/C | 0 |
show sessions remote ADDRRANGE | Show the sessions for the specified external address | O/C | 0 |
show sessions rport PORT | Show the sessions for the specified external port | O/C | 0 |
show statistics | Shows statistics used/unused blocks of ports | O/C | 0 |
show tacacs | Show the information about the connection to the TACACS server | O/C | 0 |
show temperature | Show the temperature information on processor cores | O/C | 0 |
show time | Show the current device time (always in UTC) | O/C | 0 |
show version | Show software version information | O/C | 0 |
show version detail | Show detailed software version information | O/C | 0 |
show xlate gap ADDR:PORT | Show all current translations for the pair: global address + global port | O/C | 0 |
show xlate gastat ADDRRANGE | Show translations statistics for the specified global address | O/C | 0 |
show xlate global ADDRRANGE | Show all current translations to the specified global address | O/C | 0 |
show xlate gport PORT | Show all current translations to the specified global port (regardless of address) | O/C | 0 |
show xlate lap ADDR:PORT | Show all current translations for the pair: local address + local port | O/C | 0 |
show xlate lastat ADDRRANGE | Show translations statistics for the specified local address | O/C | 0 |
show xlate local ADDRRANGE | Show all current translations to the specified local address | O/C | 0 |
show xlate lport PORT | Show all current translations to the specified local port (regardless of address) | O/C | 0 |
show xlate pool POOLNAME | Show translations of the specified pool | O/C | 0 |
start | Start to receive/send packets | C | 15 |
stop | Stop to receive/send packets | C | 15 |
up | Go one level up in the configuration tree | O/C | 0 |
uptime | Show the time of operation of the system | O/C | 0 |
use ACLNAME POOLNAME | Binding pool and ACL | C | 4 |
who | Show authenticated user sessions | O/C | 0 |
whoami | Output to the console information about the current user of the console and its privilege level | O/C | 0 |
write | Save the effective configuration as the startup | O/C | 0 |