Table Of Contents
Cisco Application eXtension Platform 1.1 Command Reference
Entering and Exiting the Command Environment
Entering the Command Environment
Exiting the Command Environment
copy syslog-server logs bundle
show app-service status-monitor
syslog-server limit file-rotation
Cisco Application eXtension Platform 1.1 Command Reference
Last updated: 9/30/08Text Part Number: OL-15872-02This guide contains the following sections:
•
Entering and Exiting the Command Environment
Entering and Exiting the Command Environment
This section describes the procedures for entering and exiting the command environment where
Cisco AXP configuration commands are executed, and consists of the following sections:•
•
EXEC and Configuration Modes
The Cisco AXP EXEC and Cisco AXP configuration command modes are similar to the EXEC and configuration modes for Cisco IOS CLI commands.
•
se-Module>•
se-Module> app-service application-nameExample:
se-Module> app-service helloworldse-Module(exec-helloworld)>•
se-Module> configure terminalse-Module(config)>•
Example:
se-Module(config)> app-service helloworldse-Module(config-helloworld)>•
Example:
se-Module(config)> app SYSLOG_APP1se-Module(config-SYSLOG_APP1)>•
Example:
se-Module (config-interface)> ip route table 10Entering the Command Environment
After the Cisco AXP is installed and active, use this procedure to enter the command environment.
Prerequisites
The following information is required to enter the command environment:
•
•
•
SUMMARY STEPS
1.
2.
3.
4.
5.
DETAILED STEPS
Exiting the Command Environment
To leave the Cisco AXP command environment and return to the Cisco ISR 2800 command environment, use the exit command.
Example:
se-Module> exitRouter#Cisco AXP 1.1 Commands
•
•
•
•
app-service (config)
To configure the Cisco AXP application hosting environment for a specific application, use the app-service command in Cisco AXP configuration mode.
app-service app-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP Configuration Mode.
Command History
Examples
In the following example, the configuration mode for application "helloworld" is entered.
se-Module(config)> app-service helloworldse-Module(config-helloworld)>se-Module(config-helloworld)> ?<cr>bind Device Bindingexit Leave app-service configuration modehostname Set the system nameip IP configurationlimit Limit resource usagelog System event messagesshutdown stop or start the hosting environmentstatus-monitor Application Status MonitorRelated Commands
app-service (EXEC)
To configure the Cisco AXP application hosting environment for a specific application, use the app-service command in Cisco AXP EXEC mode.
app-service app-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC Mode.
Command History
Examples
In the following example, the EXEC mode for application "helloworld" is entered.
se-Module(exec-helloworld)> ?<cr>clear Reset functionsconnect Cross connect to hosting environmentcopy Copy data from one location to anotherend Leave app-service exec modereset Reset the hosting environmentshow Show running system informationRelated Commands
bind interface
To attach a networking device to the application environment, use the bind interface command in Cisco AXP application service configuration mode. To detach a networking device from the application environment, use the no form of this command.
bind interface network-interface-name
no bind interface network-interface-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command attaches or detaches a networking device to or from the application environment. The network-interface-name is the interface name defined in the host, for example, the Ethernet device-name defined in the interface command.
The interface is immediately available to the virtual instance with the execution of a new bind command.
Removing an interface binding with the no prefix displays the following warning messages:
WARNING!!! Reset the hosting environment
WARNING!!! For binding to be removed
Note
ipaddr in the /etc/hosts file is modified when you enter the bind interface command (eth0 is the default).
Examples
In the following example, the Cisco AXP application service EXEC mode for application "helloworld" is entered, then the bind command attaches pre-defined interface eth0 to the application.
se-Module(config)> app-service helloworldse-Module (config-helloworld)> bind interface eth0Related Commands
bind serial
To attach or bind the serial device to the application environment, use the bind serial command in Cisco AXP application service configuration mode. To unattach the serial device to the application environment, use the no form of the command.
bind serial device-id [device-id on hosting environment]
no bind serial device-id [device-id on hosting environment]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command typically follows the app-service <application name> command.The application being a serial application.
Examples
In the following example, the Cisco AXP application service configuration mode for the serial device "serialapp" is entered. Then the serial device is bound to a Cisco IOS side device id of "vtty000".
se-Module(config)> app-service serialappse-Module(config-serialapp)> bind serial vtty000 modemRelated Commands
app-service
Enters Cisco AXP application hosting environment for a specific application.
show device serial
Displays the device ID.
clear core
To clear one specific core file of an application, use the clear core command in Cisco AXP application service EXEC mode.
clear core name core-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Command History
Examples
In the following example, the helloworld-test-core-file is cleared from the application:
se-Module(exec-helloworld)> clear core name helloworld-test-core-fileRelated Commands
clear cores
To clear all of an application's core files, use the clear cores command in Cisco AXP application service EXEC mode.
clear cores
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Command History
Examples
In the following example, clear the core files of a Cisco AXP application in Cisco AXP application service EXEC mode:
se-Module(exec-helloworld)> clear coresRelated Commands
clear counters interfaces
To clear the statistical counters, use the clear counters interfaces command in Cisco AXP EXEC mode.
clear counters interfaces {gigabitEthernet unit-number | ide 0}
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the interface counter of the GigabitEthernet unit number 0 is cleared:
se-Module> clear counters interfaces gigabitethernet 0se-Module>Related Commands
clear crashbuffer
To clear the kernel crash buffer, use the clear crashbuffer command in Cisco AXP EXEC mode.
clear crashbuffer
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the kernel crash buffer is cleared:
se-Module> clear crashbufferse-Module>Related Commands
clear history
To clear the command-line interface (CLI) history records, use the clear history command in Cisco AXP EXEC mode.
clear history app-service [record-number] | config [record-number] | exec [record-number]}
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the 10th CLI history record of the IOSAPI application service are cleared:
se-Module> clear history iosapi 10se-Module>Related Commands
clear log
In Cisco AXP application service EXEC mode, use the clear log command to clear the content of a specific log file of the application.
In Cisco AXP EXEC mode, use the clear log command to clear the content of a specific host log file.
clear log name log-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
Usage Guidelines
Depending on the mode, use this command to either clear the contents of a specific host log file (Cisco AXP EXEC mode) or clear the contents of a specific application log file (Cisco AXP application service EXEC mode).
Note
Examples
In the following example, the log file messages.log is cleared in Cisco AXP application service EXEC mode:
se-Module(exec-helloworld)> clear log name messages.logIn the following example, the log file sshd.log is cleared in Cisco AXP EXEC mode:
se-Module> clear log name sshd.logRelated Commands
clear logs
In Cisco AXP application service EXEC mode, use the clear logs command to clear the content of all log files of the application.
In Cisco AXP EXEC mode, use the clear logs command to clear the content of all host log files.
clear logs
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
Usage Guidelines
Depending on the mode, the command either clears the contents of all host log files (Cisco AXP EXEC mode) or clears the contents of the application log files (Cisco AXP application service EXEC mode).
Note
Examples
In the following example, the log files are cleared in Cisco AXP application service EXEC mode:
se-Module(exec-helloworld)> clear logsIn the following example, the log files are cleared in Cisco AXP EXEC mode:
se-Module> clear logsRelated Commands
clear netconf session
To clear the network configuration management system session identifier, use the clear netconf session command in Cisco AXP EXEC mode.
clear netconf session session-id [ | ]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the kernel crash buffer is cleared:
se-Module> clear netconf session 23se-Module>Related Commands
clear syslog-server logs
To clear the content of all syslog files in the /var/remote directory, use the clear syslog-server logs command in Cisco AXP EXEC mode.
clear syslog-server logs
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the content of all syslog files in the /var/remote directory is cleared:
se-Module> clear syslog-server logsRelated Commands
clear syslog-server log name
To clear the contents of a specific syslog server file, use the clear syslog-server log-name command in Cisco AXP EXEC mode.
clear syslog-server log name log-name
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the contents of a specific syslog server file are cleared:
se-Module> clear syslog-server log name remote_messages.logRelated Commands
clock timezone
To set the time zone for the Cisco AXP service module, use the clock timezone command in Cisco AXP configuration mode.
To remove the time zone configuration, use the no form of this command .
clock timezone [time-zone]
no clock timezone [time-zone]
Syntax Description
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
The configured NTP server provides the date-stamp system and application functions. The clock timezone command specifies the local time zone where Cisco AXP is installed.
If you know the phrase for the time-zone, enter it for the time-zone value. For example, to directly configure the time zone for UTC in Cisco AXP 1.1, use the clock timezone UTC command. For Cisco AXP releases prior to 1.1, use clock timezone Etc/UTC.
If you do not know the time zone phrase, leave the time-zone value blank and a series of menus appear to guide you through the time zone selection process. Press ctrl-c any time to exit this menu.
Bash Shell
To select the time zone in the Bash shell, use the tzselect command and click <Enter> for a series of menus to guide you through your selection.
Examples
In the following example, the United States Pacific Time is selected from the timezone menu:
se-10-0-0-0> config tEnter configuration commands, one per line. End with CNTL/Z.se-10-0-0-0(config)> clock timezonePress ctrl-c at any time to exit this menuPlease identify a location so that time zone rules can be set correctly.Please select a continent or ocean.1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean2) Americas 5) Asia 8) Europe3) Antarctica 6) Atlantic Ocean 9) Indian Ocean#? 2Please select a country.1) Anguilla 27) Honduras2) Antigua & Barbuda 28) Jamaica3) Argentina 29) Martinique4) Aruba 30) Mexico5) Bahamas 31) Montserrat6) Barbados 32) Netherlands Antilles7) Belize 33) Nicaragua8) Bolivia 34) Panama9) Brazil 35) Paraguay10) Canada 36) Peru11) Cayman Islands 37) Puerto Rico12) Chile 38) St Barthelemy13) Colombia 39) St Kitts & Nevis14) Costa Rica 40) St Lucia15) Cuba 41) St Martin (French part)16) Dominica 42) St Pierre & Miquelon17) Dominican Republic 43) St Vincent18) Ecuador 44) Suriname19) El Salvador 45) Trinidad & Tobago20) French Guiana 46) Turks & Caicos Is21) Greenland 47) United States22) Grenada 48) Uruguay23) Guadeloupe 49) Venezuela24) Guatemala 50) Virgin Islands (UK)25) Guyana 51) Virgin Islands (US)26) Haiti#? 47Please select one of the following time zone regions.1) Eastern Time2) Eastern Time - Michigan - most locations3) Eastern Time - Kentucky - Louisville area4) Eastern Time - Kentucky - Wayne County5) Eastern Time - Indiana - most locations6) Eastern Time - Indiana - Daviess, Dubois, Knox & Martin Counties7) Eastern Time - Indiana - Starke County8) Eastern Time - Indiana - Pulaski County9) Eastern Time - Indiana - Crawford County10) Eastern Time - Indiana - Switzerland County11) Central Time12) Central Time - Indiana - Perry County13) Central Time - Indiana - Pike County14) Central Time - Michigan - Dickinson, Gogebic, Iron & Menominee Counties15) Central Time - North Dakota - Oliver County16) Central Time - North Dakota - Morton County (except Mandan area)17) Mountain Time18) Mountain Time - south Idaho & east Oregon19) Mountain Time - Navajo20) Mountain Standard Time - Arizona21) Pacific Time22) Alaska Time23) Alaska Time - Alaska panhandle24) Alaska Time - Alaska panhandle neck25) Alaska Time - west Alaska26) Aleutian Islands27) Hawaii#? 21The following information has been given:United StatesPacific TimeTherefore TZ='America/Los_Angeles' will be used.Is the above information OK?1) Yes2) No#? 1se-Module(config)>To select United States Pacific Time using the timezone name:
se-Module> config tse-Module(config)> clock timezone Americas/Los_AngelesRelated Commands
ntp server
Specifies the NTP server.
show clock detail
Displays the clock details.
connect console
To allow third-party applications to integrate their commands to the console shell, use the
connect console command in Cisco AXP application service EXEC mode.connect console
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Command History
Usage Guidelines
This command allows a third party to integrate their own application commands to the console shell. On initiating the command, /bin/console is executed. The third party application must provide its own console file in binary or a script (telnet to their CLI), to cross connect to its CLI shell.
If the application does not provide a console file, the following message appears:
Unable to start console
Examples
In the following example, the shell of an application's virtual instance is entered:
se-Module(exec-tcptrace)> connect console <enter>bash-2.05b#Related Commands
copy core
To copy a core file to another location, use the copy core command in Cisco AXP EXEC mode.
copy core core-name url ftp/http url
Syntax Description
core-name
Filename used to identify the core.
url
Destination Universal Resource Location (URL).
ftp/http url
FTP or HTTP URL destination location to which the core file is to be copied.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy a core file, the copy core command becomes interactive and prompts you for the necessary file destination URL information. Use the show core command to view the core.
The standard FTP URL format is supported:
ftp://[user-id:ftp-password@]ftp-server-address[/directory]
Examples
In the following example, the file mping-test-file2 is copied to remote URL http://example.net.
se-Module(exec-helloworld)> copy core mping-test-file2 http://example.netRelated Commands
copy ftp
To copy a new configuration from an FTP server to another location, use the copy ftp command in Cisco AXP EXEC mode.
copy ftp {nvram:startup-config | running-config | startup-config | system:running-config}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy from the FTP server, the copy ftp command becomes interactive and prompts you for the necessary information.
Add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be:ftp-server-address/directory.
If you do not specify a directory value, the software uses the default FTP directory.
Examples
The following example shows copying the configuration file named start from the FTP server in the default directory to the startup configuration in NVRAM:
se-Module> copy ftp nvram:startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name or remote host? admin:voice@10.3.61.16Source filename? startIn the following example, the file named start in the FTP server configs directory is copied to the startup configuration:
se-Module> copy ftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name or remote host? admin:voice@10.3.61.16/configsSource filename? startRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy ldap
To copy the current LDAP information stored in the local database to an FTP server, use the copy ldap command in Cisco AXP EXEC mode.
copy ldap url ftps://[user-id:ftp-password@]ftp-server-address[/directory]/filename
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
If you do not specify a directory value, the software uses the default FTP directory.
Examples
The following example shows copying the LDAP data to the default directory on the FTP server and saving the data in the file ldapinfo.
se-Module# copy ldap url ftps://admin:cue@10.10.67.163/ldapinfose-Module#Related Commands
copy log
To copy an application log file to a remote URL, use the copy log command in Cisco AXP application service EXEC mode.
To copy a Cisco AXP host operating system log file to a remote URL, use the copy log command in Cisco AXP EXEC mode.
copy log log-name url ftp/http url
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
Usage Guidelines
Use this command, in Cisco AXP application service EXEC mode, to copy syslog, trace and custom application log files for a specific application to a remote URL. The standard ftp URL format is supported:
ftp://[user-id:ftp-password@]ftp-server-address[/directory]
The log filename (in both command modes) may contain wildcards * allowing the copying of more than one log file at a time.
Examples
In the following example, the copy log command copies log file install.log from application "mping" to a remote server:
se-Module(exec-mping)> copy log install.log url ftp://admin:mpg@10.10.67.163/lnstallinfoRelated Commands
copy logs bundle
To copy a tar file containing syslog files and custom application log files on the guest operating system to a remote URL, use the copy logs bundle command in Cisco AXP application service EXEC mode.
To copy a tar file containing syslog files and custom application log files on the guest and host operating systems to a remote URL, use the copy logs bundle command in Cisco AXP EXEC mode.
copy logs bundle destfilename.tar url url
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
Usage Guidelines
If you are in In Cisco AXP EXEC mode, this command does not copy remote syslog server log files.
Examples
In the following example, a tar file is copied to a remote server:
se-Module(exec-mping)> copy logs bundle mpg.tar url http://lab:mpg@10.10.67.163/appinfoRelated Commands
copy nvram:startup-config
To copy the NVRAM startup configuration to another destination, use the copy nvram:startup-config command in Cisco AXP EXEC mode.
copy nvram:startup-config {ftp: | tftp: | url ftps/https-url username username password password}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy nvram:startup-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
When you copy to an FTPS or HTTPS secure URL destination location, enter your username and password for a secure connection.
Examples
In the following example, the NVRAM startup configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The NVRAM startup configuration is copied to the configs directory as file saved_start.
se-Module# copy nvram:startup-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the NVRAM startup configuration being copied to the TFTP server as filename temp_start:
se-Module# copy nvram:startup-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startThe following example shows the NVRAM startup configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy nvram:startup-config url ftps://lyons/tigers/bears username wizard password ozRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy running-config
To copy the current running configuration to another destination, use the copy running-config command in Cisco AXP EXEC mode.
copy running-config {ftp: | nvram:startup-config filename | startup-config | tftp: | url ftps/https-url username username password password}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy running-config command becomes interactive and prompts you for the necessary information. Add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
Examples
In the following example, the running configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The running configuration is copied to the configs directory as file saved_start.
se-Module# copy running-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the running configuration copied to the NVRAM saved configuration as filename startup:
se-Module# copy running-config nvram:startup-config startupThe following example shows the running configuration copied to the startup configuration as filename start:
se-Module# copy running-config startup-config startThe following example shows the running configuration copied to the TFTP server as filename temp_start:
se-Module# copy running-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startThe following example shows the running configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy running-config url ftps://lyons/tigers/bears username wizard password ozRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy startup-config
To copy the startup configuration to another destination, use the copy startup-config command in Cisco AXP EXEC mode.
copy startup-config {ftp: | tftp: | url ftps/https-url username username password password}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy startup-config command becomes interactive and prompts you for the necessary information. You may add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
When you copy to an FTPS or HTTPS secure URL destination location, enter your username and password for a secure connection.
Examples
In the following example, the startup configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The startup configuration is copied to the configs directory as file saved_start.
se-Module# copy startup-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the startup configuration being copied to the TFTP server as filename temp_start:
se-Module# copy startup-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startThe following example shows the startup configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy startup-config url ftps://lyons/tigers/bears username wizard password ozRelated Commands
copy sysdb
To copy the system database to another destination, use the copy sysdb command in Cisco AXP EXEC mode.
copy sysdb url ftps/https-url username username password password
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy to an FTPS or HTTPS secure URL destination location, enter your username and password for a secure connection.
Examples
The following example shows the startup configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy startup-config url ftps://lyons/tigers/bears username wizard password ozRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy syslog-server log name
To copy a specific syslog server log file, use the copy syslog-server log name command in
Cisco AXP EXEC mode.copy syslog-server log name log-name url ftp/http-url
Syntax Description
log-name
Syslog server log filename.
url
Destination Universal Resource Location (URL).
ftp/http-url
FTP or HTTP URL destination location to which the log file is to be copied.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Usage Guidelines
The standard FTP URL format is supported:
ftp://[user-id:ftp-password@]ftp-server-address[/directory]
A wildcard * may be used to copy more than one log file at a time.
Related Commands
copy syslog-server logs bundle
To bundle all the syslog server log files into a gzip file and copy them to a remote URL, use the
copy syslog-server logs bundle command in Cisco AXP EXEC mode.copy syslog-server logs bundle destination-filename.gz url ftp/http-url
Syntax Description
destination-filename
gzip filename
url
Destination Universal Resource Location (URL).
ftp/http-url
FTP or HTTP URL destination location to which the log file is to be copied.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the syslog server log files are bundled into a gzip file and copied to a remote URL:
se-Module> copy syslog-server logs bundle myappslogs.gz url http://testfiles.company.comRelated Commands
copy system:running-config
To copy the current system running configuration to another destination, use the
copy system:running-config command in Cisco AXP EXEC mode.copy system:running-config {ftp: | nvram:startup-config filename | startup-config | tftp: | url ftps/https-url username username password password}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
When you copy to an FTP or TFTP server, the copy system:running-config command becomes interactive and prompts you for the necessary information. Add a username and password to the server IP address if your server is not configured to accept anonymous FTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default FTP directory.
Examples
In the following example, the system running configuration is copied to the FTP server, which requires a user ID and password and has an IP address of 172.16.231.193. The system running configuration is copied to the configs directory as file saved_start.
se-Module# copy system:running-config ftp:Address or name of remote host? admin:voice@172.16.231.193/configsSource filename? saved_startThe following example shows the system running configuration copied to the NVRAM saved configuration as filename startup:
se-Module# copy system:running-config nvram:startup-config startupThe following example shows the system running configuration copied to the startup configuration as filename start:
se-Module# copy system:running-config startup-config startThe following example shows the system running configuration copied to the TFTP server as filename temp_start:
se-Module# copy system:running-config tftp:Address or name of remote host? 172.16.231.190Source filename? temp_startThe following example shows the system running configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy system:running-config url ftps://lyons/tigers/bears username wizard password ozRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy tftp
To copy the network TFTP server information to another destination, use the copy tftp command in Cisco AXP EXEC mode.
copy tftp: {nvram:startup-config | running-config | startup-config | system:running-config}
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
The copy tftp command is an interactive command and prompts you for the necessary information. Add a username and password to the server IP address if your server is not configured to accept anonymous TFTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default TFTP directory.
Copying a startup configuration from the TFTP server to the startup configuration overwrites the startup configuration. A warning appears, asking you to confirm the overwrite.
Examples
The following example shows a TFTP server with the IP address 10.3.61.16. The TFTP server data in the source filename start is copied to the running configuration.
se-Module# copy tftp: running-configAddress or name of remote host? 10.3.61.16Source filename? startIn the following example, the TFTP server has the IP address 10.3.61.16. The file start in directory configs on the TFTP server is copied to the startup configuration.
se-Module# copy tftp: startup-config!!!WARNING!!! This operation will overwrite your startup configuration.Do you wish to continue[y]? yAddress or name of remote host? 10.3.61.16/configsSource filename? startRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
copy url
To copy the network configuration information to a secure URL, use the copy url command in Cisco AXP EXEC mode.
copy url ftps/https-url {nvram:startup-config | running-config | startup-config | system:running-config} username username password password
Syntax Description
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
The copy url command is an interactive command and prompts you for the necessary information. Add a username and password to the server IP address if your server is not configured to accept anonymous TFTP input. The format would be: userid:password@ftp-server-address/directory. If you do not specify a directory value, the software uses the default directory.
Examples
The following example shows the system running configuration being copied to a secure URL, where the server hostname is lyons, the directory is tigers, and the filename is bears:
se-Module# copy url ftps://lyons/tigers/bears system:running-config username wizard password ozRelated Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
erase startup-config
To erase the startup configuration in memory, use the erase startup-config command in
Cisco AXP EXEC mode.erase startup-config
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Usage Guidelines
Before using this command, make sure that your startup configuration has been backed up.
Related Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
hostname
To configure a hostname for the application that is different from the name used for the host, use the hostname command in Cisco AXP application service configuration mode.
To disable the hostname for the application, use the no form of this command.
hostname name
no hostname name
Syntax Description
Defaults
Hostname configured on the host side.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command configures the hostname for the application, if it is different from the hostname configured for the Cisco AXP host. The hostname is limited to 32 characters.
If more than 32 characters are entered, the following error message appears:
hostname size greater than 32
This command modifies configuration directives in file /etc/hosts. The command updates the hostname of the hostname: IP mapping entry.
If the file does not exist, the command creates the /etc/hosts file, and adds an entry to the file.
If the file exists, (for example, if an application package has already bundled its own /etc/hosts file), the new entries are appended to the existing entries and the original entries remain intact.
Examples
In the following example, the initial contents of file etc/hosts are:
etc/hosts:127.0.0.1 localhost.localdomain localhost ## added by cliipaddr hostname.domain hostname ## added by cliFor example, the following commands set the hostname to "myhostname". The original hostname is the hostname of the host (after installing the application, the hostname for the vserver is the same as for the host.)
configure terminalapp-service myapphostname myhostnameThe hostname in the second line of the /etc/hosts file above, (ipaddr hostname.domain hostname) is changed to myhostname.
The /etc/hosts file is created by Cisco AXP if it is not packaged by the user. An /etc/hosts file that is created by the user must contain the first line shown above (starting with "127.0.0.1"). Lines following the first line of the file are created by Cisco AXP.
The IP address, ipaddr in the /etc/hosts file is modified using the bind interface command.
The first binding of the interface provides ipaddr, which is normally eth0. The interface eth0 is bound to each virtual instance by default. Use the bind interface command for multiple bindings.
Related Commands
interface
To configure external network interfaces and enter interface configuration mode, use the interface command in Cisco AXP interface configuration mode.
To disable the AXP module interface configuration, use the no form of this command.
interface {eth0 | eth1} [exit | ip {address ip-address ip-mask | route table table-num} | shutdown]
no interface {eth0 | eth1}
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP interface configuration.
Command History
Usage Guidelines
The device name can be eth0 or eth1 for a built-in physical interface, eth0:1 for a virtual interface, or eth0.1 for a VLAN interface.
The virtual or VLAN interfaces can be configured only if these interfaces are not bound to the virtual hosting environment. If the interfaces are bound, an error message with the specific device name appears. For example, for eth0.1, the following error message appears:
Error Message eth0.1 still bound to hosting environment(s), unbind first.Do not remove a built-in physical interface. On removal, an error message appears:
Error Message Can not remove the built-in interface eth0/1.Examples
In the following example, the command interface eth0 configures the external network interface eth0, by entering interface configuration mode.
se-Module (config)> interface eth0se-Module(config-interface)> ip 10.0.0.0 255.255.255.0se-Module(config-interface)> route table 126Related Commands
show interfaces
Displays all the interfaces of the Cisco AXP module.
bind interface
Attaches or detaches a networking device to or from the application environment.
ip access-list standard
To configure a predefined, standard access list (ACL) for the application, use the ip access-list standard command in Cisco AXP configuration mode.
To remove the IP ACL, use the no form of this command.
ip access-list standard {acl-name | acl-num}
no ip access-list standard
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
Use this command to create an access list for source-based route configurations.
To create an entry that specifies the type of packets that you want for further processing, use the permit command in standard ACL subcommand mode (config-std-nacl) to specify the type of packets that must be accepted for further processing.
Include at least one permit entry to create a valid access list.
Cisco AXP 1.0 allows only a single IP address in the access list to be specified.
Examples
In the following example, an access list is created for source-based route configuration.
se-Module (config)> ip access-list standard testRelated Commands
ip address
To configure the IP address for a network interface, use the ip address command in Cisco AXP interface configuration mode.
To remove the IP address interface configuration, use the no form of this command.
ip address ip-address network-mask
no ip address
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP interface configuration.
Command History
Usage Guidelines
Use this command to configure the IP address and network mask for the specified network interface. Changing the IP address for a bound interface results in a message warning the user that the application is bound to the interface. To remove the old IP configuration, reset the virtual instance.
Examples
In the following example, the IP address of an interface in Cisco AXP interface configuration mode is specified:
se-Module (config-interface)> ip address 209.165.201.1 255.255.255.224Related Commands
ip domain-name
To configure the domain name for the application, use the ip domain-name command in Cisco AXP application configuration mode.
To disable the domain name, use the no form of this command.
ip domain-name dns-server-domain-name
no ip domain-name
Syntax Description
Defaults
No domain name is configured.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
The domain-name is limited to 64 characters.
If you enter more than 64 characters, the following error message appears:
Error Message domain size greater than 64This command modifies configuration directives in /etc/hosts and /etc/resolv.conf files where the domain name is relevant, and also modifies the search list for hostname lookup and domain directives for local domain name in the /etc/resolv.conf file.
For the /etc/hosts file, this command updates the domain name of the hostname-ip mapping entry.
Example:
/etc/resolv.conf:search cisco.com ## added by clidomain cisco.com ## added by clinameserver x.x.x.x ## added by cli/etc/hosts:10.100.50.10 appre.cisco.com appreUse this command with the ip name-server command to configure the DNS server. The host commands
ip domain-name and ip name-server populate the /etc/resolv.conf file in each installed virtual instance. Changing the configuration results in the updating of host results in the /etc/resolv.conf file.When these commands are used to configure a new name-server and domain-name for a virtual instance (in app-service mode), the /etc/resolv.conf file in that virtual instance is overridden with the new server name and domain name.
The /etc/resolv.conf file in that virtual instance reverts to the host configuration whenever the virtual instance does not have a name-server or domain-name configured.
Configuring the name-server and domain-server in a virtual instance always takes precedence over configuration in the host.
Examples
In the following example, the domain name of the application is changed from mping to mycompany.com:
SE-Module> config tse-Module(config-mping)> ip domain-name mycompany.comse-Module(config-mping)> ip name-server 10.0.61.1Related Commands
ip local policy route-map
To configure a route map for policy routing, use the ip local policy route-map command in Cisco AXP configuration mode.
To remove the IP local policy configuration, use the no form of this command.
ip local policy route-map map-tag
no ip local policy route-map
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
The route map name must match the map-tag in the route-map command.
Examples
In the following example, the route map is configured for policy routing with map-tag=10:
se-Module(config)> ip local policy route-map 10Related Commands
ip name-server
To configure the IP address of the domain name server (DNS) of the application, use the ip name-server command in Cisco AXP application service configuration mode.
To disable the name server, use the no form of this command.
ip name-server ip-address
no ip name-server
Syntax Description
Defaults
No name server is configured.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
Use this command with the ip domain-name command to configure the DNS server. A maximum of two DNS servers can be defined. In a Linux environment, the /etc/resolv.conf file typically contains the IP addresses of name servers (DNS name resolvers) that attempt to translate names into addresses for any node available on the network.
The ip domain-name and ip name-server commands in the host populate the /etc/resolv.conf file in each installed virtual instance. Using this command to change the configuration in the host results in the /etc/resolv.conf file being updated.
When these commands are used to configure a new name-server and domain-name for a virtual instance (in app-service mode), the /etc/resolv.conf file in that virtual instance is overridden with the new server name and domain name.
The /etc/resolv.conf file in that virtual instance reverts back to the host configuration whenever the virtual instance does not have a name-server or domain-name configured. Configuring the name-server and domain-server in a virtual instance always takes precedence over configuration in the host.
If an application package has already bundled its own /etc/resolv.conf file, the new entries will be appended to the existing ones and will leave the original ones intact.
Example:
search localdomain ## added by clidomain localdomain ## added by clinameserver x.x.x.x ## added by cliExamples
In the following example, the IP name server of the application is changed from mping to 10.10.61.16:
se-Module> config tse-Module(config-mping)> ip name-server 10.10.61.16se-Module(config-mping)> ip domain-name mycompany.comRelated Commands
ip route
To configure a static IP route, use the ip route command in Cisco AXP configuration mode.
To remove the static IP route configuration, use the no form of this command.
ip route {dest-prefix dest-mask forwarding-address | table dest-prefix dest-mask forwarding-address}
no ip route {dest-prefix dest-mask forwarding-address | table table-num dest-prefix dest-mask forwarding-address}
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
Use this command to configure an IP static route or table for a connected route.
Examples
In the following example, the static IP route is configured using the destination prefix 10.0.0.0, destination prefix mask 255.255.255.0, and the forwarding router's address 172.16.0.0:
se-Module (config)> ip route 10.0.0.0 255.255.255.0 172.16.0.0Related Commands
ip route table
To configure the IP route table for a connected route, use the ip route table command in Cisco AXP interface configuration mode.
To remove the route table, use the no form of this command.
ip route table table-num
no ip route table table-num
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP interface configuration.
Command History
Usage Guidelines
Use this command to configure the route table for a connected route for source-based routing.
Examples
In the following example, the route table number 10 is configured:
se-Module (config-interface)> ip route table 10Related Commands
interface
Configures the interface device.
ip address
Configures the IP address for the specified network interface.
ip ssh interface
To enable the interface on which the sshd daemon (SSH) listens for an incoming connection, use the
ip ssh interface command in Cisco AXP configuration mode.To remove the SSH interface configuration, use the no form of this command; the sshd process then listens ro all interfaces.
ip ssh interface
no ip ssh interface interface
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
This command specifies the interface on which the sshd process listens for an incoming connection.
If you do not specify this command, the sshd process listens on all interfaces.Related Commands
ip ssh server
To enable the IP SSH service, use the ip ssh server command in Cisco AXP application configuration mode.
To disable the service, use the no form of this command.
ip ssh server
no ip ssh server
Syntax Description
This command has no arguments or keywords.
Defaults
Port number 22.
Command Default
Enabled.
Command Modes
Cisco AXP syslog application service configuration.
Command History
Usage Guidelines
Use this command to start or stop the SSH server. The default port number is 22.
Error messages: Table
Examples
In the first of the following examples, the IP SSH server is enabled.
se-Module(config)> ip ssh serverThe second example disables the IP SSH server.
se-Module(config)> no ip ssh serverRelated Commands
ip ssh interface
Interface on which the sshd daemon listens for an incoming connection.
ip ssh username
To specify an unencrypted or hidden password for SSH tunneling, use the ip ssh username command in Cisco AXP syslog application configuration mode.
To disable tunneling, use the no form of the command.
ip ssh username [tunnel_root | tunnel_user] password clear-password-string
no ip ssh username [tunnel_root | tunnel_user] password clear-password-string
Syntax Description
Defaults
None.
Command Default
None.
Command Modes
Cisco AXP syslog application service configuration.
Command History
Usage Guidelines
For a tunnel user, the startup script decides on the level of access a user can have to perform specific operations.
Related Commands
ip ssh interface
Specifies the interface on which the sshd daemon listens for an incoming connection.
limit cpu utilization
To configure the CPU resource usage limits, use the limit cpu utilization command in Cisco AXP application service configuration mode.
To disable setting CPU utilization limits, use the no form of this command.
limit cpu utilization index
no limit cpu utilization index
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command modifies the CPU utilization limit when the application is installed. It becomes effective when the application instance restarts.
The CPU utilization range varies between the minimum and maximum limits specified by the package. The specified CPU utilization maximum for a Cisco AXP service module is based on a platform CPU index.
The platform CPU index is specified relative to a value of 10000 assigned to the following configuration:
1.0 GHz Celeron M CPU on the application runtime engine of an NME_APPRE_302-K9 network module. For example, the CPU utilization limit for the AIM_APPRE 102 blade is 3000.Examples
In the following example, the CPU utilization limit is set to 3000, (typical for an AIM_APPRE 102 blade):
se-Module(config-helloworld)> limit cpu utilization 3000Related Commands
show resource limits
Displays the resource limits configured for the application.
limit disk utilization
To modify the disk utilization setup during installation, use the limit disk utilization command in Cisco AXP application service configuration mode.
To disable setting of disk utilization limits, use the no form of the command.
limit disk utilization amount
no limit disk utilization amount
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command limits the disk space utilization in a virtual instance. The disk utilization range varies between the minimum limit specified by the package to the maximum limit available to the system.
Examples
In the following example, the disk utilization is set to 100 MB during installation:
se-Module(config-myapp1)> limit disk utilization 100Related Commands
show resource limits
Displays the resource limits configured for the application.
limit log-file size
To configure the log file size, use the limit log-file size command in Cisco AXP application service configuration mode.
To disable log file size configuration, use the no form of this command.
limit log-file size size
no limit log-file size size
Syntax Description
Defaults
Default value is 5 MB.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command sets the maximum size of the log file /var/log/messages.log. Each virtual instance writes a syslog to its own file /var/log/messages.log. When this file reaches the limit specified by this command, its contents are moved to a backup log file messages.log.prev and a new messages.log file is started. The range is 0-40 MB with a default size of 5 MB for two files.
megabytes: The range of the log file size from 0-40 MB.
When the value is out of range, the following message appears:
%Invalid input detected at `^' markerIf the log file size configuration is disabled (no limit log-file size), the maximum size of the log file reverts to the default value of 5 MB.
If the maximum size of the log file is set to 0 MB, the minimum file size is 10 KB.
Examples
In the following example, the size of the log file is changed to 10 MB.
se-Module(config-helloworld)> limit log-file size 10Related Commands
show logs
Lists logs in the application environment that reside in the /var/log directory.
limit memory utilization
To modify the memory utilization setup during installation, use the limit memory utilization command in Cisco AXP application service configuration mode.
To disable settings of memory utilization limits, use the no form of the command.
limit memory utilization nn
no limit memory utilization nn
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command limits the memory utilization in a virtual instance. The disk utilization range varies between the minimum limit specified by the package to the maximum limit available to the system.
Examples
In the following example, the memory utilization is set to 100 MB during installation:
se-Module(config-demo)> limit memory utilization 100Related Commands
show resource limits
Displays the resource limits configured for the application.
log console
To configure the types of messages to be displayed on the console, use the log console command in Cisco AXP configuration mode. To stop messages from displaying, use the no form of this command.
log console {errors | info | notice | warning}
no log console {errors | info | notice | warning}
Caution
Syntax Description
Defaults
Only fatal error messages are displayed.
Command Modes
CiscoAXP configuration
Command History
Usage Guidelines
The messages on the console display are also saved in the messages.log file. These messages can be used for debugging purposes.
Examples
The following example configures error messages to be displayed on the console:
se-Module> config tse-Module(config)> log console errorsse-Module(config)> exitRelated Commands
log console monitor
To display system messages on the console, use the log console monitor command in Cisco AXP EXEC mode. To stop messages from displaying, use the no form of this command.
log console monitor {module | entity | activity}
no log console monitor {module | entity | activity}
Caution
Syntax Description
Defaults
Only fatal error messages are displayed.
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
The messages on the console monitor are also saved in the messages.log file. These messages can be used for debugging purposes.
Examples
The following example displays messages for results of the database entity in the networking module:
se-Module> log console monitor networking database resultsRelated Commands
log trace boot
To save the trace configuration upon rebooting, use the log trace boot command in Cisco AXP EXEC mode.
log trace boot
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
To ensure that the current trace configuration is saved when the Cisco AXP service module is rebooted, use the log trace boot command.
Examples
The following example illustrates the log trace boot command:
se-Module>log trace bootRelated Commands
log trace buffer save
To save the current trace information, use the log trace buffer save command in Cisco AXP EXEC mode.
log trace buffer save
Syntax Description
This command has no arguments or keywords.
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Current trace information stored in the memory buffer can be saved to a file.
Examples
The following example illustrates the log trace buffer save command:
se-Module>log trace buffer saveRelated Commands
show logs
Displays a list of the trace logs.
show trace buffer
Displays the modules and entities being traced.
log trace local enable
To configure tracing messages to a local disk, use the log trace local enable command in Cisco AXP configuration mode.
log trace local enable
Syntax Description
There is no syntax description for this command.
Defaults
None
Command Modes
Cisco AXP configuration
Command History
Usage Guidelines
Enable local tracing to a disk.
Examples
The following example configures tracing to a local disk:
se-Module> config tse-Module(config)> log trace local enablese-Module(config)> exitRelated Commands
log trace server
To configure tracing messages for remote storage, use the log trace server command in Cisco AXP configuration mode.
log trace server {enable | url url}
Syntax Description
enable
Enables tracing to the FTP server.
url
Designates remote storage directory.
url
FTP URL address.
Defaults
None
Command Modes
Cisco AXP configuration
Command History
Usage Guidelines
Configures tracing messages for remote storage.
Examples
The following example configures tracing remotely:
se-Module> config tse-Module(config)> log trace server url ftp urlse-Module(config)> exitRelated Commands
log server address
To configure the remote logging server, use the log server address command in Cisco AXP application service configuration mode.
To disable the remote logging server, use the no form of this command.
log server address {ip-address | hostname}
no log server address {ip-address | hostname}
Syntax Description
Defaults
No external log server is configured.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
This command enables and disables remote logging, and configures the remote logging server. Application syslog messages are sent to the specified log server. The hostname can be an IP address or a name.
When an invalid IP address format such as 0.0.0.0 is entered, the following error message appears:
Error Message 0.0.0.0 is an invalid Host IP addressThis is used to stream out the application logs to the remote syslog server.
Examples
In the following example, IP address 10.1.61.16 is assigned as the external log server:
se-Module(config-mping)> log server address 10.1.61.16se-Module(config-mping)> exitRelated Commands
show hosts
Displays all configured hosts.
show log
Displays a specific log.
show logs
Displays all logs.
show running-config
Displays the log server as part of the configuration.
log level
To configure the different system log levels, use the log level command in Cisco AXP application service configuration mode.
To disable log levels, use the no form of this command.
log level levels
no log level levels
Syntax Description
Defaults
warn is the default value.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Examples
The following example shows the log level being set so that events with LOG_INFO or higher severity are logged:
se-Module(config-myapp)> log level infoUsage Guidelines
log level info logs events with LOG_INFO or higher severity.
In the following example, events within the stdout of a CLI plug-in and the output from System.out.println calls made by the application MyAppMain, are redirected to syslog if they have a log level of LOG_INFO or above.
# java -cp ./app_bin/myApp.jar:/cli_comm/:/usr/lib/java/localsocket.jar:/usr/lib/java/cli_distributio n_vm.jar com.myApp.MyAppMain | /bin/logger -p infoRelated Commands
netconf
To configure the Network Configuration Protocol (NETCONF), use the netconf command in Cisco AXP configuration mode.
To remove the NETCONF configuration, use the no form of this command.
netconf {beep initiator {hostname | ip-address} dest-port | max-sessions max-sessions}
no netconf {beep initiator {hostname | ip-address} dest-port | max-sessions max-sessions}
Syntax Description
Defaults
None
Command Modes
Cisco AXP configuration
Command History
Usage Guidelines
The NETCONF over BEEP feature must be configured on the router and the Cisco AXP service module. NETCONF over BEEP in Cisco IOS software does not support any authentication. It supports only an SASL/Anonymous profile.
The NETCONF over BEEP feature allows you to enable either the NETCONF server or the NETCONF client to initiate a connection. This supports large networks of intermittently connected devices and those devices that must reverse the management connection where firewalls and network address translators (NATs) exist.
The Network Configuration Protocol (NETCONF) defines a simple mechanism through which a network device can be managed, configuration data information can be retrieved, and new configuration data can be uploaded and manipulated. NETCONF uses Extensible Markup Language (XML)-based data encoding for the configuration data and protocol messages.
Blocks Extensible Exchange Protocol (BEEP) can use the Simple Authentication and Security Layer (SASL) profile to provide simple and direct mapping to the existing security model. Alternatively, NETCONF over BEEP can use the transport layer security (TLS) to provide a strong encryption mechanism with either server authentication or server and client-side authentication.
NETCONF over BEEP sends notifications of any configuration change over NETCONF. A notification is an event indicating that a configuration change has happened. The change can be a new configuration, deleted configuration, or changed configuration. The notifications are sent at the end of a successful configuration operation as one message showing the set of changes, rather than individual messages for each line in the configuration that is changed.
Examples
The following example configures tracing remotely:
se-Module> config tse-Module(config)> netconf max-sessions 16se-Module(config)>Related Commands
ntp server
To synchronize the Cisco AXP application system clock with a remote Network Time Protocol (NTP) server, use the ntp server command in Cisco AXP configuration mode.
To disable the Cisco AXP application system clock from being synchronized with an NTP server, use the no form of this command.
ntp server {hostname | ip-address} [prefer]
no ntp server {hostname | ip-address}
Syntax Description
hostname
Hostname of the NTP server.
ip-address
IP address of the NTP server.
prefer
(Optional) Marks the server as preferred.
Defaults
The default is the IP address of the server.
Command Default
None.
Command Modes
Cisco AXP configuration.
Command History
Usage Guidelines
Use this command in conjunction with the clock time command to set the timing functions for Cisco AXP systems and applications.
The prefer option indicates that the specified server is chosen for synchronization from among a set of correctly operating hosts.
Caution
Examples
The following example assigns the server with address 192.168.1.100 as the preferred NTP server:
se-Module(config)> ntp server 192.168.1.100 preferThe following example assigns the server with hostname main_ntp as the NTP server:
se-Module(config)> ntp server main_ntpRelated Commands
clock timezone
Configures the local time zone.
show clock detail
Displays current clock statistics.
show ntp source
Displays current NTP server statistics.
reload apps
To apply new resource limits without rebooting the service module, use the reload apps command in Cisco AXP EXEC mode.
reload apps
Syntax Description
There are no arguments for this command.
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Use the reload apps command after configuring the new resource limits and executing the write memory command.
Related Commands
limit memory utilization
configures memory limits.
limit cpu utilization
Configures CPU limits.
limit disk utilization
Configures disk capacity limits.
reset
To reset the hosting envirnment, use the reset command in Cisco AXP EXEC mode.
reset
Syntax Description
There are no arguments for this command.
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Use the reset command reset the application services hosting environment.
Related Commands
route-map
To configure the route map, use the route-map command in Cisco AXP configuration mode.
To remove the route map, use the no form of this command.
route-map name sequence-num
no route-map name sequence-num
Syntax Description
Defaults
None
Command Modes
Cisco AXP configuration
Command History
Usage Guidelines
This command configures the route map name and sequence number parameters.
Route maps are identified by a map name. You can assign the route map name when the route map is created. It can be composed of multiple lines, each with a sequence number in the range of 1 to 99, where each line can have multiple match and set commands. An incoming packet is compared to each line of the route map until there is a match, then the set actions for that line are applied to the packet similar to the way an access list is applied. The last line of a route-map is an implicit deny.
Examples
The following example configures tracing remotely:
se-Module> config tse-Module(config)> route-map test 45se-Module(config-route-map)>Related Commands
service password-encryption
To enter the password encryption mode, use the service password-encryption command in Cisco AXP configuration mode.
To exit the password encryption mode, use the no form of this command.
service password-encryption
no service password-encryption
Syntax Description
There are no arguments for this command.
Defaults
None
Command Modes
Cisco AXP configuration
Command History
Usage Guidelines
Use the service password-encryption command to enter the password encryption mode.
Related Commands
show running-config
Displays the content of the current running configuration.
show startup-config
Displays the content of the startup configuration.
status-monitor
To configure the status monitor and recovery threshold, use the status-monitor command in Cisco AXP application service configuration mode.
status-monitor monitor_interval Interval-Num recovery_threshold Threshold-Num
Syntax Description
Defaults
Default value for monitor interval is 12 and recovery threshold is 5.
Command Default
None.
Command Modes
Cisco AXP application service configuration.
Command History
Usage Guidelines
Cisco AXP allows third party applications to plug in their status monitoring and allows recovery from a malfunctioned state.
An application must provide one or more watchdog scripts or executable files bundled in their package to use the Cisco AXP application monitoring feature. The number of scripts or executables is dependent on the application, resulting in a unique way of determining the status of the application. For example, it can be based on Process Identifier (PID), or a response to an application ping. Cisco AXP supports Shell scripts and C language executables for application status monitoring.
For more information on watchdog scripts and executables, see the Cisco AXP Developer Guide.
The application status monitor has a heartbeat of 5 seconds, which is the minimum interval used for monitoring. For example, if the monitor interval is set at 12, monitoring of each virtual instance takes place every 12 heartbeat intervals, which is every one minute. You can configure the monitoring interval for a virtual instance through the status-monitor monitor interval command.
The scripts or executables return a status code where zero indicates that the application is healthy and alive. A non zero status code indicates that the application is not functional. When a watchdog script or executable returns a non zero status code, relevant information such as the name of the watchdog script, return status, and time of failure is logged.
A recovery counter counts the number of times the failure takes place, and acts as a delay mechanism for further action. A recovery count of three means that the application monitor has run for three iterations and is receiving either a non zero return status, or the watchdog script has been running for over 3 monitoring intervals and is not returning a value.
You can use the status-monitor monitor interval command for configuring the recovery threshold that decides on the number of recovery counters before taking the next action. When the recovery threshold is reached, the virtual instance restarts and the application monitor continues to run, repeating the monitoring cycle. A virtual instance can restart any number of times.
If you are developing a third party application, you can provide default configuration parameters using a configuration file that is packaged together with the application.
Examples
The following example sets the threshold value for the monitor interval to 10 (monitoring occurs every 50 seconds) and the threshold value for recovery attempts to 10.
se-Module(config-mping)> status-monitor monitor_interval 10 recovery_threshold 10Related Commands
show app-service state
To display the state and health of all installed virtual instances and applications, use the
show app-service state command in Cisco AXP EXEC mode.show app-service state
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Usage Guidelines
Use this command frequently on the application service module to determine whether your applications are up and running.
Examples
In the following example, for each of three running applications, the application's name, state, and health are displayed on the screen.
se-Module> show app-service stateAPPLICATION STATE HEALTHhelloworld online ALIVEsimpleFC4CPlusApp online ---x11_app online ---Related Commands
show app-service state
Displays the status and health of a specific application in Cisco AXP application service EXEC mode.
show app-service statistics
To display the memory and processing time information of an installed virtual instance, use the show app-service statistics command in Cisco AXP EXEC mode.
show app-service statistics
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the statistics for all installed virtual instances are displayed on the screen.
se-Module> show app-service statisticsCTX PROC VSZ RSS userTIME sysTIME UPTIME NAME0 122 2.7G 626.9M 1h23m20 1h39m08 6d18h56 root server2 4 8.6M 2.9M 1m46s57 2m07s88 6d18h54 helloworldCTX = context number for the virtual instancePROC = quantity of processes in the contextVSZ = number of pages of virtual memoryRSS = Resident set size limits for memoryuserTime = utime User-mode CPU time accumulatedsysTime = ctime Kernel-mode CPU time accumulatedupTime = uptimeRelated Commands
show app-service statistics
Allows third party applications to integrate their own application statistics for display.
show app-service status-monitor
To display status monitor information for all installed applications, use the show app-service status-monitor command in Cisco AXP EXEC mode.
show app-service status-monitor
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the monitoring information for helloworld is displayed on the screen. (helloworld is the only installed application.)
se-Module> show app-service status-monitorApplication: helloworldMonitor status: PASSEDMonitor in progress: YesLast executed watchdog: W00template.shLast executed date: Wed Sep 5 14:09:58 PDT 2007Last failed watchdog: ---Last failed return code: -Last failed date: ---Last restarted date: ---Recovery threshold: 4Monitor interval: 3Related Commands
show app-service status-monitor
Displays the application service status.
show running-config
Displays the current running configuration.
show arp
To display the ARP table, use the show arp command in Cisco AXP EXEC mode.
show arp [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the ARP table is displayed.
se-Module> show arpAddress HWtype HWaddress Flags Mask Iface1.100.30.150 ether 00:1E:7A:E1:41:B8 C eth0Related Commands
show clock detail
To display clock statistics, use the show clock detail command in Cisco AXP EXEC mode.
show clock [detail | |]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the clock statistics are displayed on the screen.
se-Module> show clock detailse-Module> show clock detail15:22:08.375 PST Thu Nov 29 2007time zone: America/Los_Angelesclock state: unsyncdelta from reference (microsec): 0estimated error (microsec): 16time resolution (microsec): 1clock interrupt period (microsec): 10000time of day (sec): 1196378528time of day (microsec): 378926Related Commands
clock timezone
Configures the local timezone.
ntp server
Configures the NTP server for time synchronization
show configuration
To display non-volatile memory (NVRAM) configuration, use the show configuration command in Cisco AXP EXEC mode.
show configuration [paged | |]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the NVRAM configuration displayed on the screen.
se-Module> show configuration!! This adds all the platform CLI commands!! host namehostname se-1-100-30-151! domain nameip domain-name localdomain! DNS Servers!VAR_DNS_SERVER! Timezone Settingsclock timezone America/Los_Angeles! NTP Serversntp server 1.100.30.150 preferendRelated Commands
clock timezone
Configures the local timezone.
ntp server
Configures the NTP server for time synchronization
show cores
To display a list of core files, use the show cores command in Cisco AXP EXEC mode.
show cores [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show cores command displays a list of the core files.
se-Module> show coresSIZE LAST_MODIFIED_TIME NAMERelated Commands
show crash buffer
To display the recent kernel crash log, use the show crash buffer command in Cisco AXP EXEC mode.
show crash buffer [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, there was no recent crash of the kernel so that the show crash buffer command does not display the crash buffer contents.
se-Module> show crash bufferPress <CTRL-C> to exit...Related Commands
show debugging
To display the state of each debugging option, use the show debugging command in Cisco AXP EXEC mode.
show debugging [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, there was no recent debug activity, so that the show debug command does not display the trace results.
se-Module> show debuggingDebug Logging Info:MODULE ENTITY ACTIVITYNo debug activeRelated Commands
show device serial
To display the serial device ID, use the show device serial command in Cisco AXP EXEC mode.
show device serial
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values.
Command Default
None
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, all the serial devices are displayed on the screen.
se-Module> show device serialDevice Name TTY No. Line No. Line Type Intf Name Assigned Tovaux1 1 1 AUX - -vtty000 0/0/0 2 TTY Se0/0/0 serialappvtty001 0/0/1 3 TTY Se0/0/1 -Related Commands
show errors
To display error statistics by module, entity, or activity, use the show errors command in Cisco AXP EXEC mode.
show errors [|]
Syntax Description
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Use this command with the show log name command to narrow down error statements.
Examples
The following example shows the result of the show errors command.
se-Module> show errorsModule error report:MODULE ENTITY ACTIVITY NUM ERRORSStartup Capabilities cap_include.sh 4Related Commands
show history iosapi
To display the IOS service API historical records, use the show history iosapi command in Cisco AXP EXEC mode.
show history iosapi [num-records | config num-records | exec num-records]
Syntax Description
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
The Cisco IOS Service API allows you to write applications that access router information and change system configurations using commands equivalent to Cisco IOS configuration and AXP EXEC mode commands.
Use this command to view the historical records of the IOS API.
Related Commands
show hosts
To display IP domain-name, lookup style, nameservers, and host table, use the show hosts command in Cisco AXP EXEC mode.
show hosts [|]
Syntax Description
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Use this command with the show log name command to narrow down error statements.
Examples
The following example shows the result of the show hosts command.
se-Module> show hostsHostname: se-1-100-30-151Domain: localdomainRelated Commands
show interfaces
To display all the configured interfaces, including virtual and VLAN interfaces, use the show interfaces command in Cisco AXP EXEC mode.
show interfaces [GigabitEthernet | ide | |]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show interfaces command displays all configured interfaces on the screen: a GigabitEthernet interface and an IDE (hard disk) interface.
se-Module> show interfacesGigabitEthernet 0 is up, line protocol is upInternet address is 10.10.1.20 mask 255.255.255.0 (configured on router)25629 packets input, 1688582 bytes0 input errors, 0 dropped, 0 overrun, 0 frame errors25634 packets output, 1785015 bytes0 output errors, 0 dropped, 0 overrun, 0 collision errors0 output carrier detect errorsIDE hd0 is up, line protocol is up2060 reads, 32704512 bytes0 read errors489797 write, 2520530944 bytes0 write errorsRelated Commands
show ip access-list
To display IP access list information, use the show ip access-list command in Cisco AXP EXEC mode.
show ip access-list [acl-name | acl-num | details]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show ip access-list 10 command displays the access list identified by the number 10.
se-Module> show ip access-list 101Related Commands
show ip route
To display the static IP route information, use the show ip route command in Cisco AXP EXEC mode.
show ip route [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show ip route command displays the IP route information.
se-Module> show ip routeMain Routing Table:DEST GATE MASK IFACE1.100.30.0 0.0.0.0 255.255.255.0 eth00.0.0.0 1.100.30.150 0.0.0.0 eth0Related Commands
show license udi
To view the unique device identifier (UDI) of the service module, use the show license udi command in Cisco AXP EXEC mode.
show license udi
Syntax Description
There are no arguments for this command.
Defaults
None
Command Modes
Cisco AXP EXEC
Command History
Usage Guidelines
Each Cisco AXP service module contains a unique device identifier (UDI) that must be used by customers when they contact their Cisco marketing representative for unrestricted shell access.
The UDI consists of the following sequence:
1.
2.
3.
Examples
Step 1
show license udi: Example 1
In this example, the command is run on a network module.
show license udiPID SN UDI---------------------------------------------------AIM-CUE FOC10222W1M AIM-CUE:FOC10222W1Mshow license udi: Example 2In this example, the command is run on PC 104 hardware or VMware.
show license udiPID SN UDI---------------------------------------------------AIM-CUE -- AIM-CUE:FOC10222W1Mshow log name
To display a specific log file in the application environment, use the show log name command in Cisco AXP application service EXEC mode.
To display system-level logging data for a specific log file, use the show log name command in Cisco AXP EXEC mode.
show log name log-name {containing expression | paged | interactive | {|begin | |exclude | |include [string | module] | |page} | tail}
Syntax Description
log-name
Log name. See the show logs command for log names.
containing expression
Displays events matching a regular expression (regex) pattern, where expression is a regex.
paged
(Optional) Displays enough output to fill the current viewing screen.
interactive
Displays logs in interactive mode.
|begin string
Checks if string begins the line and pipes output to another command.
|exclude string
Checks if string is not included in the line and pipes output to another command.
|include string
Checks is string is included in the line and pipes output to another command.
string
A literal that can be an ERROR or INFO message.
module
Defines a logging or tracing module (see Table 1).
|page
Pipes output to another command and paginates the output.
tail
Waits for events and prints them as they occur.
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
show logging
To display the console logging options, use the show logging command in Cisco AXP EXEC mode.
show logging [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show logging command displays the console logging options.
se-Module> show logginginfo: offnotice: offwarning: offerrors: offfatal: onMonitored event Info:MODULE ENTITY ACTIVITY FILTERNo monitored events activeServer Info:Log server address:Related Commands
show log name
Displays system-level logging data for a specific log file.
show logs
Displays log files on the Cisco AXP service module.
show logs
The show logs command can be used in either of the following two modes:
•
show logs
•
show logs [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP application service EXEC.
Cisco AXP EXEC.
Command History
Usage Guidelines
In Cisco AXP application service EXEC mode, this command displays all the log files under the /var/log directory of the virtual instance.
Examples
In the following example, the show logs command, executed in Cisco AXP application service EXEC mode, shows the log files under the /var/log directory of the virtual instance.
se-Module(exec-mping)> show logsSIZE LAST_MODIFIED_TIME NAME108 Mon Nov 05 19:50:33 PST 2007 messages.logIn the following example, the show logs command, executed in Cisco AXP EXEC mode, shows the log files on the Cisco AXP service module.
se-Module> show logsSIZE LAST_MODIFIED_TIME NAME43452 Tue Nov 06 10:46:44 PST 2007 linux_session.log7630 Thu Nov 15 16:18:22 PST 2007 install.log8508 Thu Nov 15 16:18:00 PST 2007 dmesg0 Thu Nov 01 18:12:34 PDT 2007 eem.log4614755 Thu Nov 15 16:16:50 PST 2007 messages.log.prevRelated Commands
log level
Configures the severity of messages to be logged.
log trace
Configures trace logging options.
show memory
To display memory statistics, use the show memory command in Cisco AXP EXEC mode.
show memory [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Examples
In the following example, the show memory command displays the memory statistics.
se-Module> show memorySDRAM (MByte): 512Total Memory (kB): 512788Active Memory (kB): 129232Inactive Memory (kB): 105632Other Memory (kB): 21472MemoryPool (kB): 256452Kernel MemoryMAXUSED(S) INUSE(S) INUSE(O) MAXUSED(O) ERR TYPE4976 4904 4535 4680 0 fs12992 12424 11549 12322 0 other128 124 98 110 0 netS - Slab memoryO - Object memoryRelated Commands
show netconf session
To display Network Configuration Protocol (NETCONF) sessions, use the show netconf session command in Cisco AXP EXEC mode.
show netconf session [|]
Syntax Description
Defaults
No default behavior or values.
Command Default
None.
Command Modes
Cisco AXP EXEC.
Command History
Usage Guidelines
This command displays the NETCONF session configured on the router and the Cisco AXP service module.
This command displays open connections in large networks of intermittently connected devices and those devices that must reverse the management connection where firewalls and network address translators (NATs) exist.
Examples
In the following example, because there are no open sessions, the show netconf sessions command displays a no open corrections replay.
se-Module> show netconf session% No open connectionsRelated Commands
show ntp associations
To display the association identifier and status for all Network Time Protocol (NTP) servers, use the show ntp associations command in Cisco AXP EXEC mode.
show ntp associations [assocID association-id | |]
Syntax Description
Command Modes
Cisco AXP EXEC.
Command History
Usage Guidelines
The show ntp associations command displays the association identifier and status for all the NTP servers configured for Cisco AXP and does not provide details about the servers. The show ntp associations assocID association-id command provides details on the status of a specified NTP server.
Use the status field to determine the configuration and status of all the NTP servers. This field consists of 4 hexadecimal digits:
•
•
Table 2 shows common status codes and their descriptions. The first digit specifies the configuration, reachability, and authentication status for the specified server. The second digit records how well the specified server passed through the clock selection algorithm.
Guest
