This chapter covers the global commands. A global command is a tool used to change the configuration file. The changes do not affect the ME until you save or update the configuration. While global commands in general are available throughout all levels of the CLI, specific commands may only be available from certain prompts.
Note:
Although it does not affect the configuration file, the help command is also described in this chapter.At any level of the CLI, typing a question mark displays the options available to you from that point in the hierarchy. When at the top-level prompt, the global commands are mixed with the actions available. For example, in the list below, only the bolded config command is a global commands:
NNOS-E> ? --More-- clock set the system time cls clear terminal screen cluster cluster debug commands config configuration commands cpu-monitor Monitor CPU usage; press Esc to cancel csta-moc-commands Various commands related for MOC clients csta-uri-normalization Perform CSTA URI normalization operations --More--
Once you are in config mode, the actions are no longer available and ME only displays the relevant global commands:
config> ?
config configure an object
delete delete an object
dump dump the configuration database
exit exit configuration mode
help display all configuration settings
save save the running configuration
show display configuration data
? -v to show verbose help
Cancels all changes to the open configuration object, restores the prior or default settings, and exits that configuration object.
ACMEPACKET# notify all trace all aug.gzThe following CLI session configures Ethernet interface settings in the box configuration object; the cancel command ignores the new settings and reverts back to the prior or default settings.
config> config box config box> config interface eth0 config interface eth0> set admin disabled config interface eth0> set arp disabled config interface eth0> cancel config box>
Executed from within an object (e.g., from config vsp> but not config>), saves changes from the working config to the running config and moves you to the top-level config prompt. You must still save changes to the saved config for them to be available at the next boot.
This command is the same as the top (config> command.
The following example creates an IP interface, commits the change to the running config, and displays the new interface.
config> config box interface eth1 ip z Creating 'ip z' config ip z> commit config> config box interface eth1 config interface eth1> show box interface eth1 admin enabled mtu 1500 arp enabled speed 1Gb duplex full autoneg enabled ip d ip z
Enters or moves deeper within ME configuration mode. The configuration mode provides access to all objects that configure and manage ME. You must have permissions for CLI access set to normal (standard CLI access) to use config and therefore change the configuration file. When you log into the ME Management System, the system automatically places you in the configuration mode. Note that there are several configuration-related actions as well.
Deletes your settings for the specified object from the running configuration as well as all objects (and their properties) contained within the deleted object. (Use the remove command to remove individual properties from an object in the configuration.) You delete an object from within the parent object. All setting associated with the deleted configuration object return to the system default settings. However, to restore the object and default settings to the configuration, you must enter configuration mode for that object.
Anything that you can config, you can delete. For some services (e.g., NTP, SSH, web, etc.), delete kills the service. For some, delete returns the object to its default settings.
The following example deletes all configured servers.
config enterprise> delete servers
The following CLI session displays the current Telnet settings followed by the delete command. The config telnet command restores the default Telnet settings to the running configuration.
config> config box interface eth0 ip x config ip x> show box interface eth0 ip x admin enabled ip-address dhcp geolocation 0 metric 1 classification-tag security-domain trusted address-scope private filter-intf disabled telnet config ip x> config telnet config telnet> show telnet admin disabled max-sessions 12 idle-timeout 60 seconds port 22 config ip x> delete telnet config ip x> show box interface eth0 ip x admin enabled ip-address dhcp geolocation 0 security-domain trusted metric 1 classification-tag address-scope private filter-intf disabled config ip x> config telnet config telnet> show box interface eth0 ip x telnet admin enabled max-sessions 8 idle-timeout 600 seconds port 23
Displays a detailed summary of all the objects in the configuration database. This output is primarily for use by Technical Support personnel.
The following is an example of the dump command output.
config> dump
object class id obsrvrs hldrs weight
------ ----- -- ------- ----- ------
interface eth0 6 10 0 0 2601
interface eth1 6 33 0 0 1288
interface eth0 6 43 0 0 866
interface eth1 6 50 0 0 574
ip a 7 11 0 1 1149
ip b 7 27 0 1 708
ip c 7 30 0 1 628
ip d 7 34 0 1 750
ip a 7 44 0 1 798
ip b 7 51 0 1 506
ip a 7 55 0 0 1149
ip b 7 71 0 0 708
ip c 7 74 0 0 628
cluster 39 53 5 0 6214
messaging 42 52 0 0 58
messaging 42 70 0 0 58
--More--
Leaves the current configuration mode and/or quits the CLI.
The exit command does the following, depending on where you are in the CLI hierarchy. If entered:
At levels within the configuration hierarchy (config object>), the exit command prompts you to commit changes to the current configuration. Type n (no) to discard all changes not previously saved and return to the top-level prompt. Type y (yes) to commit changes to the running configuration. You are then prompted to save these changes to the startup configuration. If you enter:
No, ME exits configuration mode and returns you to the top-level prompt. Changes are in the running config but not the startup config, and will be lost at the next system boot.
Yes, ME saves changes to the startup config, exits configuration mode, and returns you to the top-level prompt.
At the top level configuration mode (config>), returns you to the NNOS-E> prompt.
At the NNOS-E> prompt, exits the CLI. (This command functions the same as quit).
NNOS-E> config vsp config vsp> set local-identity abcCo.com config vsp> exit Do you want to commit your changes before you exit (y or n)? y Do you want to update the startup configuration (y or n)? y NNOS-E> NNOS-E> config vsp config vsp> set local-identity abcCo.com config vsp> exit Do you want to commit your changes before you exit (y or n)? n NNOS-E> config> exit NNOS-E> NNOS-E> exit
Displays help that is dependent on your position in the hierarchy. From the top-level prompt (NNOS-E> by default):
help provides a list of all available commands and actions, with brief text summaries.
help -v (verbose help) provides the list of commands and actions with their possible settings (as well as text summaries).
From within configuration mode (either config> or config object>):
help lists all possible objects for configuration, and their associated properties, from your current position in the hierarchy.
help -v lists objects and properties from your current position in the hierarchy with brief text summaries.
The following example shows a sample of each form of help.
NNOS-E> help accounting accounting commands announce Insert announcement on active call from a WAV file archive Run the archiving task for a given vsp arena Various arena debugging commands arp manage the ARP cache assign-uri Assign a sip URI to a user --More-- NNOS-E> help -v accounting accounting commands copy copy entries from one database to another database Examine an accounting database contact Contact a server create Create the accounting table on a server count Count the accounting records on a server query Perform a query on a server clear Clear a range of accounting records on a server reset Reset the connections to a server announce Insert announcement on active call from a WAV file archive Run the archiving task for a given vsp specific Archive a specific set of sessions session Archive a single session between Archive a group of sessions between two times --More--
Re-orders an item to a different position in the hierarchy. For some properties, the order determines the sequence in which ME processes the properties. For example, you may want to control the order in which ME checks user access. Initially, the order is determined by the order in which you configured the directories. Use the show command to verify the current order; the output displays an index inside a bracket. This is the number that you use in the move command.
config access> show
vsp
access
users[1]
radius[2]
enterprise[3]
The move command only appears when you have a list of items in which the order matters.
Exits the CLI. The quit command only operates from the top-level of the CLI and has the same functionality as the exit command.
Removes the specified property from the configuration. (Use the delete command to remove objects from the configuration.) You can remove properties that are references to other properties (see Referencing Previously Configured Objects) and properties in a vector. (For properties that fit neither of these descriptions, you simply reset the value.)
For properties that accept multiple values, the system lists each configured value and assigns an index (inside a bracket) to that value. Supply the property name and the index value of the instance you want to remove.
The following example shows an LCS server configuration with three domain aliases specified. (Multiple properties have been left out of the display for clarity). The remove command deletes one of the aliases and changes the index of the following alias.
config lcs test> show vsp enterprise servers lcs test [PROPERTIES] domain-alias[1] abc.com domain-alias[2] lmn.com domain-alias[3] xyz.com --More-- config lcs test> remove domain-alias[2] config lcs test> show vsp enterprise servers lcs test [PROPERTIES] domain-alias[1] abc.com domain-alias[2] xyz.com --More--
Resets all object properties to the original default values. Note that properties also include the properties of all subobjects. For example, resetting the VSP object resets the defaults of the enterprise, servers, and directories properties, as well as the accounting and location service properties and many more. For those objects without default values (those that were created by their configuration), the reset command deletes the object and its subobjects.
The following example resets interface eth4 to its defaults.
config interface eth4> show box interface eth4 admin enabled mtu 1200 arp enabled speed 1Gb duplex half autoneg enabled config interface eth4> reset config interface eth4> show box interface eth4 admin enabled mtu 1500 arp enabled speed 1Gb duplex full autoneg enabled
Moves you up one level in the configuration hierarchy and saves changes from that level to the running config.
The following CLI session configures the administrative status of Ethernet interface eth0. The return command (executed twice) saves the change to the running config and moves back up the hierarchy to the top level configuration mode.
config> config box config box> config interface eth0 config interface eth0> set admin enabled config interface eth0> return config box> return config>
Writes the running configuration to the default configuration file (/cxc/cxc.cfg), or if a path name is supplied, to that file name. You can choose standard, verbose, or XML formats. Standard format only outputs properties with a value different from the default; verbose outputs every property. By default, the configuration is saved in standard format.
You can also save your configuration file in XML format. You can then import this XML file to other ME devices to create a saved configuration. This will save you time if you have identical configuration settings across multiple devices in the cluster. With XML, you can also work on the configuration file offline. In the CLI, XML and ”standard CLI” configuration files are interchangeable, and the default save location, cxc.cfg (i.e., the startup config), is the same. ME creates a numbered backup (cxc.cfg.#) with each execution, creating up to 100 backups. Files are saved in the /cxc/backup directory.
This command works the same as the config save action.
Configures properties of an object. It either sets the value, overwrites a previous or default value, or adds an additional value.
Displays configuration entries and status reports for each system provider. To view a listing of the show commands that are available from a particular point in the command hierarchy, navigate to the command mode and enter:
show ?
To view the filter fields available for specifying an entry to display, enter a question mark after the show argumentName entry. For example:
show dial-plan ?
Using the show command also indicates your command path, because it displays the path from the top of the hierarchy to your position.
See Status Provider Show Commands for a detailed description of use of the show command and a description of each status provider report. See Displaying Help Text for more details on using the help command.
The following examples shows different points from which you can enter the show command and different types of output:
NNOS-E> show ? show commands accounting-database request information for accounting database connections accounting-process General statistics from the accounting process accounting-recent calls recently accounted accounting-server request information for accounting servers accounting-status accounting activity information actions action provider statistics --More-- NNOS-E> show interfaces interface name ip-address op-state type --------- ---- ---------- --------- ----- eth0 a 192.168.215.100/24 up public eth0:1 b 192.168.215.110/24 down public eth0:2 c 192.168.215.120/24 up public eth1 d 192.168.216.100/24 up public NNOS-E> config config> config box config box> config cli config cli> show box cli prompt NNOS-E> banner Shutdown at 12:00 midnight display paged 24
Saves changes from the working config to the running config and moves you to the top-level config (config>) prompt. You must still save changes to the saved config for them to be available at the next boot. This command is only available from within an object.
This command is the same as the commit command.
The following example creates an IP interface, commits the change to the running config, and displays the new interface.
config> config box interface eth1 ip z Creating 'ip z' config ip z> commit config> config box interface eth1 config interface eth1> show box interface eth1 admin enabled mtu 1500 arp enabled speed 1Gb duplex full autoneg enabled ip d ip z
Displays the processes that are top users of a category of system resources. You can select the category to sort on by typing the first letter of the name (except for Process Name, type N). The system resorts the list of processes, in descending order and at two-second intervals, based on their CPU use. Press ESC to exit the display. This command is only available for users with debug permissions.
NNOS-E> top
Procs: 75 Interval: 2 CPUs: 4 Mem: 4053M Swap: 0M Kern: 12% CPU: 0%
-------------------------------------------------------------------------------
PID Process Name CPU % Memory Resident Locked Threads Files
-------------------------------------------------------------------------------
2976 managerl.elf 0.1% 180M 38M 0K 41 69
4232 login 0.0% 1M 352K 0K 1 4
4230 sshd 0.0% 4M 1M 0K 1 9
3928 java 0.0% 581M 108M 0K 35 12
3927 java 0.0% 456M 130M 0K 35 14
3926 authl.elf 0.0% 42M 27M 0K 24 38
3924 java 0.0% 450M 120M 0K 48 13
3864 postmaster 0.0% 15M 4M 0K 1 5
3857 postmaster 0.0% 15M 4M 0K 1 5
-------------------------------------------------------------------------------
Totals: 0.1% 3971M 1745M 0K 494 54