-
User Guide for the Cisco Mobile Wireless Transport Manager 6.0
-
About this Guide
-
Overview
-
Configuring Security
-
Setting Up Your Server
-
Getting Started
-
Basic Operations
-
Understanding Basic Object Functions
-
Managing Views
-
Understanding Detailed Object Functions
-
Managing Events
-
Viewing Network Topology
-
Accessing Data from the Web Interface
-
Managing ITP Reports
-
Editing an ITP Route Table File
-
Editing an ITP Global Title Translation Table
-
Editing ITP MLR Address Table Files
-
Object Map Reference
-
Command Reference
-
FAQs
-
Troubleshooting MWTM and the Network
-
Status Definitions
-
MIB Reference
-
Trap Reference
-
Configuring MWTM to Run with Various Networking Options
-
Archived Reports File Formats
-
MWTM Ports
-
Open Source License Notices for the Cisco Mobile Wireless Transport Manager
-
Glossary
-
Index
-
Feedback
Table Of Contents
Command Reference
This appendix provides the format and a brief description of these Cisco Mobile Wireless Transport Manager (MWTM) commands, listed alphabetically. Each command is available on the:
•
Server only (including Solaris and Linux).
•
•
You can run commands from:
•
where install_directory is the directory where the MWTM server is installed (by default, /opt/CSCOsgm).
•
This appendix contains:
Note
General Commands
General commands for the MWTM include:
•
mwtm
Server and Solaris or Linux Clients Only
Command Description
Displays the command syntax for the mwtm command and all of its options. The function of this command is identical to mwtm help.
MWTM help is personality specific; so, only the commands pertaining to each personality are shown. If you set the RAN-O personality, only RAN-O commands appear within the help; same for ITP. If you set both personalities, you can see all the commands.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm ?
Server and Solaris or Linux Clients Only
Command Description
Displays the command syntax for the mwtm command and all of its options. The function of this command is identical to mwtm help.
MWTM help is personality specific, so only the commands pertaining to each personality are shown. If you set the RAN-O personality, only RAN-O commands appear within the help; same for ITP. If you set both personalities, you see all the commands listed.`
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm addcreds
Server Only
Full Syntax
mwtm addcreds [-d nodetype] [-u username -n enable username] [-i ipaddress] [-r protocoltype]
Command Description
Adds credentials for a given IP address, if specified; otherwise, credentials are added to the system as Default, which applies the specified credentials to all nodes in the MWTM database.
•
–
–
–
–
•
•
•
•
–
–
You must log in as the root user or superuser to use this command.
Related Topic
Configuring Login Credentials, page 3-19
mwtm adduser
Server Only
Full Syntax
mwtm adduser [username]
Command Description
If you enable MWTM User-Based Access, adds the specified user to the authentication list.
When you add a user, the MWTM prompts you for this information:
•
•
•
–
–
–
–
–
You must log in as the root user or superuser to use this command.
Note
Related Topic
•
•
mwtm authtype
Server Only
Full Syntax
mwtm authtype [local | solaris | linux]
Command Description
Configures MWTM security authentication:
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
•
•
mwtm backup
Server Only
Command Description
Backs up MWTM data files to the MWTM installation directory. The MWTM automatically backs up all data files nightly at 1:30 AM; but, you can use this command to back up the files at any other time. If you installed the MWTM in:
•
•
To restore the MWTM data files from the previous night's backup, use the mwtm restore command. Do not try to extract the backup files manually.
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Configuring a Backup MWTM Server, page 3-9
mwtm backupdir
Server Only
Full Syntax
mwtm backupdir [directory]
Command Description
Note
You can change the directory in which the MWTM stores its nightly backup files. The default backup directory is the directory in which the MWTM is installed. If you installed the MWTM in:
•
•
If you specify a new directory that does not exist, the MWTM does not change the directory and issues an appropriate message.
You must log in as the root user to use this command.
Related Topic
Configuring a Backup MWTM Server, page 3-9
mwtm badloginalarm
Server Only
Full Syntax
mwtm badloginalarm [number-of-attempts | clear]
Command Description
If you enable MWTM User-Based Access, number of unsuccessful log-in attempts allowed before the MWTM generates an alarm.
The valid range is 1 unsuccessful attempt to an unlimited number of unsuccessful attempts. The default value is 5 unsuccessful attempts.
The MWTM records alarms in the system security log file. The default path and filename for the system security log file is /opt/CSCOsgm/logs/sgmSecurityLog.txt. If you installed the MWTM in a directory other than /opt, then the system security log file resides in that directory.
To view the system security log file, enter mwtm seclog. You can also view the system security log on the MWTM System Security Log web page (see Displaying the Contents of the System Security Log (Server Only), page 2-16).
To disable this function (that is, to prevent the MWTM from automatically generating an alarm after unsuccessful log-in attempts), enter mwtm badloginalarm clear.
You must log in as the root user or superuser to use this command.
Related Topic
Automatically Disabling Users and Passwords (Server Only), page 2-8
mwtm badlogindisable
Server Only
Full Syntax
mwtm badlogindisable [number-of-attempts | clear]
Command Description
If you enable MWTM User-Based Access, number of unsuccessful log-in attempts by a user allowed before the MWTM disables the user's authentication. The MWTM does not delete the user from the authentication list, the MWTM only disables the user's authentication. To re-enable the user's authentication, use the mwtm enableuser command.
The valid range is 1 unsuccessful attempt to an unlimited number of unsuccessful attempts. The default value is 10 unsuccessful attempts.
To disable this function (that is, to prevent the MWTM from automatically disabling a user's authentication after unsuccessful log-in attempts), enter mwtm badlogindisable clear.
You must log in as the root user or superuser to use this command.
Related Topic
Automatically Disabling Users and Passwords (Server Only), page 2-8
mwtm browserpath
Server and Solaris or Linux Clients Only
Command Description
Sets a user-defined MWTM web browser path and verifies that the browser specified by the user exists.
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm certgui
Solaris Clients Only
Command Description
If you enable the Secure Sockets Layer (SSL) on your MWTM system, opens the MWTM Certificate Tool window in which you manage SSL certificates on the MWTM client.
Note
You must log in as the root user (not as a superuser) to use this command in Solaris.
Related Topic
Launching the MWTM Certificate Tool for SSL, page 2-24
mwtm certtool
Server and Solaris Clients Only
Full Syntax
mwtm certtool [clear | delete alias | export alias [-file filename] | import alias [-file filename] | list]
Command Description
If you enable the Secure Sockets Layer (SSL) ion your MWTM system, you can use this command to manage SSL certificates on the MWTM client from the command line.
Note
Use these keywords and arguments with this command:
•
The alias argument can be any character string; the hostname of the server from which you are importing the certificate is a good choice.
To import the certificate from a file, specify the optional -file keyword and a filename.
•
To export the certificate to a file, specify the optional -file keyword and a filename.
•
•
•
Solaris Only: You must log in as the root user (not as a superuser) to use this command in Solaris.
Related Topic
Importing an SSL Certificate to an MWTM Client, page 2-26
mwtm changes
Server Only
Command Description
Displays the contents of the MWTM CHANGES file. The CHANGES file lists all bugs that have been resolved in the MWTM, sorted by release, from the current release back to Release 5.0. If you installed the MWTM in:
•
•
mwtm checksystem
Server Only
Command Description
Checks the system for a server installation and reviews the:
•
•
•
•
•
You must log in as the root user (not as a superuser) to use all features of this command. The logs/troubleshooting folder has limited permissions to read when the user is not a root user.
mwtm clean
Server Only
Command Description
Removes all MWTM data from the MWTM server, excluding message log files, backup files, and report files. This command restores the MWTM server to a state that would exist after a new installation of the MWTM; except for the message log files, backup files, and report files.
Removed data includes all:
•
•
•
•
•
•
•
•
•
•
•
You must log in as the root user (not as a superuser) to use this command.
mwtm cleanall
Server Only
Command Description
Removes all MWTM data from the MWTM server, including message log files, backup files, report files, configuration settings, and security settings. This command restores the MWTM server to a state that would exist after a new installation of the MWTM.
Data removed includes all:
•
•
•
•
•
•
•
•
•
•
•
You must log in as the root user (not as a superuser) to use this command.
mwtm cleandb
Server Only
Command Description
Removes all MWTM data from the MWTM server, including the:
•
•
•
•
Excludes:
•
•
•
•
•
•
•
•
This command restores the MWTM server to a state that would exist after a new installation of the MWTM; except for the presence of the retained files.
Data removed includes all:
•
•
•
•
•
You must log in as the root user (not as a superuser) to use this command.
mwtm cleandiscover
Server Only
Full Syntax
mwtm cleandiscover [seed-node] [seed-node]...
Command Description
You can use this command to delete all current network data and begin a clean discovery of the ITP network from the command line. Use the seed-node arguments to specify the DNS names or IP addresses of one or more seed nodes.
Note
Running this command does not remove any notes, preferences, route files, views, message log files, backup files, or report files, nor any user-created files stored in the MWTM directories.You must log in as the root user or superuser to use this command.
Related Topic
Discovering Your Network, page 4-4
mwtm cliconntimer
Server Only
Full Syntax
mwtm cliconntimer [number-of-seconds | clear]
Command Description
Specifies how long, in seconds, an MWTM client should wait for a message from the MWTM server before exiting. If the timer expires, the client pings the server and takes one of these actions. If the server:
•
•
•
The valid range is 10 seconds to an unlimited number of seconds. The default value is 60 seconds.
To restore the default timeout of 60 seconds, enter the mwtm cliconntimer clear command.
Any changes you make take effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
mwtm client
Solaris or Linux Clients Only
Full Syntax
mwtm client [hostname]
Command Description
Starts an MWTM client on the specified host. If no hostname is specified, starts an MWTM client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
If you access a remote workstation by Telnet, the DISPLAY variable must be set to your local display or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually. See Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3 for details.
Related Topic
Starting the MWTM Client, page 4-2
mwtm clientlogs
Server Only
Command Description
Uses PAGER to display the MWTM client log files.
The MWTM client log files contain client console output for all MWTM clients, one file per local or remote client. The MWTM automatically creates the file for a client when the client starts. If you installed the MWTM in:
•
•
mwtm clitimeout
Server Only
Full Syntax
mwtm clitimeout [number-of-minutes | clear]
Command Description
Specifies how long, in minutes, an MWTM client can be inactive before the MWTM automatically disconnects it.
This function is disabled by default. If you do not specify this command, clients are never disconnected as a result of inactivity.
If you enter the mwtm clitimeout command, the valid range is 1 minute to an unlimited number of minutes. No default value exists.
If you enable this function and you want to disable it (that is, never disconnect a client as a result of inactivity), enter the mwtm clitimeout clear command.
You must log in as the root user or superuser to use this command.
Related Topic
Automatically Disabling Users and Passwords (Server Only), page 2-8
mwtm cmdlog
Server Only
Full Syntax
mwtm cmdlog [clear | -r]
Command Description
Uses PAGER to display the contents of the system command log. The system command log lists:
•
•
•
To clear the log, enter mwtm cmdlog clear.
To display the contents of the log in reverse order, with the most recent commands at the beginning of the log, enter mwtm cmdlog -r.
You must log in as the root user or superuser to use this command.
mwtm console
Server Only
Command Description
Displays the contents of the console log file, sgmConsoleLog.latest. The console log file contains unexpected error and warning messages from the MWTM server, such as those that might occur if the MWTM server cannot start.
You must log in as the root user or superuser to use this command.
mwtm countnodes
Server Only
Command Description
Displays the number of nodes in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countobjects
Server Only
Command Description
Displays a count of all objects in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm cwsetup
Solaris Server Only
Full Syntax
mwtm cwsetup [install | uninstall]
Command Description
Manages the integration of the MWTM with CiscoWorks:
•
–
–
•
Note
You must log in as the root user (not as a superuser) to use this command.
mwtm dbtool
Server Only
Full Syntax
mwtm dbtool {SQL}
Command Description
Issues a SQL query against the MWTM database. Use a standard SQL query, except replace any instances of the asterisk (*) with a question mark (?) instead. For example, a sample SQL query might be:
"select * from events"Using the mwtm dbtool command, this SQL query would be:
mwtm dbtool "select ? from events"You must log in as the root user or superuser to use this command.
mwtm delete
Server Only
Full Syntax
mwtm delete [all | node [all | node [node]...] | sp [all | point-code:net [point-code:net]...] | linkset [all | node/linkset [node/linkset]...]
Command Description
Deletes objects from the MWTM database.
•
•
•
•
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
mwtm deletecreds
Server Only
Full Syntax
mwtm deletecreds [-d nodetype] [-i ipaddress] [-a]
Command Description
Deletes credentials for a given IP address, if specified. Otherwise, Default credentials are deleted. To delete:
•
–
–
–
–
•
•
Related Topic
Configuring Login Credentials, page 3-19
mwtm deluser
Server Only
Full Syntax
mwtm deluser [username]
Command Description
If you enable MWTM user-based access, deletes the specified user from the authentication list. To add the user back to the list, use the mwtm adduser command.
You must log in as the root user or superuser to use this command.
Related Topic
Manually Disabling Users and Passwords (Server Only), page 2-11
mwtm disablepass
Server Only
Full Syntax
mwtm disablepass [username]
Command Description
If you enable the MWTM User-Based Access, and set mwtm authtype to local, disables the specified user's authentication and password. The MWTM does not delete the user from the authentication list; rather, the MWTM only disables the user's authentication and password. To re-enable the user's authentication with:
•
•
Note
If you set mwtm authtype to solaris or linux, you cannot use this command; instead, you must manage passwords on the external authentication servers.
You must log in as the root user or superuser to use this command. You must also set the mwtm authtype to local.
Related Topic
Manually Disabling Users and Passwords (Server Only), page 2-11
mwtm disableuser
Server Only
Full Syntax
mwtm disableuser [username]
Command Description
If you enable MWTM User-Based Access, disables the specified user's authentication.The MWTM does not delete the user from the authentication list, the MWTM only disables the user's authentication. To re-enable the user's authentication with:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Manually Disabling Users and Passwords (Server Only), page 2-11
mwtm discover
Server Only
Full Syntax
mwtm discover [seed-node] [seed-node]...
Command Description
You use this command to discover the ITP network from the command line. Use the seed-node arguments to specify the DNS names or IP addresses of one or more seed nodes.
Note
You must log in as the root user or superuser to use this command.
Related Topic
Discovering Your Network, page 4-4
mwtm enableuser
Server Only
Full Syntax
mwtm enableuser [username]
Command Description
If you enable MWTM user-based access, re-enables the specified user's authentication, which had been disabled either automatically by the MWTM or by a superuser.
The user's authentication is re-enabled with the same password as before.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling and Changing Users and Passwords (Server Only), page 2-12
mwtm eventautolog
Server Only
Full Syntax
mwtm eventautolog [clear | -r]
Command Description
Uses PAGER to display the contents of the MWTM event automation log. The event automation log lists all messages generated by scripts launched by event automation.
To clear the log and restart the server, enter mwtm eventautolog clear.
To display the contents of the log in reverse order, with the most recent events at the beginning of the log, enter mwtm eventautolog -r.
You must log in as the root user or superuser to use this command.
mwtm eventconfig
Server Only
Full Syntax
mwtm eventconfig [view | edit |restore | master]
Command Description
Allows you to manage the event configuration:
•
•
•
•
You must log in as the root user or superuser to use this command.
mwtm eventeditor
Solaris or Linux Clients Only
Full Syntax
mwtm eventeditor [hostname]
Command Description
Starts an MWTM Event Editor on the specified host. If no hostname is specified, starts an MWTM Event Editor on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
For more information about the MWTM Event Editor, see Changing the Way the MWTM Processes Events, page 9-27.
If you Telnet into a remote workstation, the DISPLAY variable must be set to your local display, or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
Related Topic
mwtm eventtool
Server Only
Full Syntax
mwtm eventtool {-a actionName} {parameters}
Command Description
Invokes MWTM event API operations.
These action names (and any corresponding required parameters) can be specified with the -a option:
These parameters can be used:
You must log in as the root user or superuser to use this command.
Related Documentation
See the Cisco Mobile Wireless Transport Manager 6.0 OSS Integration Guide.
mwtm evilstop
Server Only
Command Description
Forcefully stops all MWTM servers on the local host. This command can be useful if a normal mwtm stop does not stop the servers.
You must log in as the root user (not as a superuser) to use this command.
mwtm export
Server Only
Full Syntax
mwtm export [-d {bar | comma | tab}] [all | as | asp | aspa | links | linksets | nodes | mwtmp | sps]
Command Description
Exports current MWTM data.
By default, the MWTM separates data fields with vertical bars (|). However, you can specify commas (,) or tabs as the separator:
•
•
•
By default, the MWTM exports all data. However, you can limit the data that the MWTM exports:
•
•
•
•
•
•
Note
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
mwtm export cw
Solaris Server Only
Full Syntax
mwtm export cw
Command Description
Exports current MWTM node names, and read and write SNMP community names, in CiscoWorks import format, with fields separated by commas (,). You can export this data to a file, then use the file to import the nodes into the CiscoWorks database.
You must log in as the root user or superuser to use this command.
Related Topic
mwtm help
Server and Solaris or Linux Clients Only
Full Syntax
mwtm help [keyword]
Command Description
Displays the command syntax for the mwtm command and all of its options. The function of this command is identical to mwtm ?.
MWTM help is personality specific; so, only the commands pertaining to each personality appear. If you have the RAN-O personality set, only RAN-O commands appear within the help; the same goes for ITP. If you set both personalities, all the commands are visible.
To see the command syntax for a specific keyword, enter mwtm help and that keyword. For example, if you enter mwtm help restart, the MWTM displays:
mwtm restart - Restarts all MWTM Servers on the local host.mwtm restart web - Restarts Web servers on the local host.mwtm restart jsp - Restarts JSP servers on the local host.mwtm restart pm - Restarts Process Manager on the local host.Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm inactiveuserdays
Server Only
Full Syntax
mwtm inactiveuserdays [number-of-days | clear]
Command Description
If you enable MWTM user-based access, number of days a user can be inactive before disabling that user account.
This function is disabled by default. If you do not specify this command, user accounts are never disabled as a result of inactivity.
If you enter the mwtm inactiveuserdays command, the valid range is 1 day to an unlimited number of days. There is no default setting.
If you have enabled this function and you want to disable it (that is, prevent the MWTM from automatically disabling user accounts as a result of inactivity), enter mwtm inactiveuserdays clear.
To re-enable the user's authentication, use the mwtm enableuser command.
You must log in as the root user or superuser to use this command.
Related Topics
•
•
mwtm installlog
Server and Solaris or Linux Clients Only
Full Syntax
mwtm installlog [server | client]
Command Description
Displays the latest install log for the server or client. If you do not specify server or client, displays the latest install log for both the server and client.
You must log in as the root user or superuser to use this command.
mwtm inventorytool
Server Only
Full Syntax
mwtm inventorytool -a actionName [parameters]
Command Description
Invokes inventory API operations.
These action names (and any corresponding required parameters) can be specified with the -a option:
-a
getAllNEs
-c
-H
-p
-S
-h
getRootNEs
getNE
-f
-c
-H
-p
-S
-h
getChildNEs
getDescendantNEs
getNote
setNote
-f
-u
-n
-H
-p
-S
-h
appendNote
You can use these parameters:
You must log in as the root user or superuser to use this command.
Related Documentation
See the Cisco Mobile Wireless Transport Manager 6.0 OSS Integration Guide.
mwtm ipaccess
Server Only
Full Syntax
mwtm ipaccess [add [ip-addr] | clear | edit | list | rem [ip-addr] | sample]
Command Description
You use this command to create and manage a list of client IP addresses that can onnect to the MWTM server.
The list of allowed client IP addresses resides in the ipaccess.conf file. By default, when you first install the MWTM, the ipaccess.conf file does not exist and all client IP addresses can connect to the MWTM server. To create the ipaccess.conf file and specify the list of allowed client IP addresses, use one of these keywords:
•
•
•
•
•
•
Any changes you make take effect when you restart the MWTM server.
See Implementing Secure User Access (Server Only), page 2-2 for more information about using this command.
You must log in as the root user or superuser to use this command.
mwtm jspport
Server Only
Full Syntax
mwtm jspport [port-number]
Command Description
Sets a new port number for the JSP server, where port-number is the new, numeric port number. The MWTM verifies that the new port number is not already in use.
This command is needed only if you must change the port number after you install the MWTM; because another application must use the current port number.
The new port number must contain only numbers. If you enter a port number that contains nonnumeric characters, such as mwtm13, an error message appears, and the MWTM returns to the command prompt without changing the port number.
You must log in as the root user (not as a superuser) to use this command.
mwtm keytool
Solaris Server Only
Full Syntax
mwtm keytool [clear | genkey | import_cert cert_filename | import_key key_filename cert_filename | list | print_csr | print_crt]
Command Description
If you implement SSL in your MWTM system, manages SSL keys and certificates on the MWTM server.
If you installed the MWTM server and client on the same workstation, it also automatically manages the certificates on the client.
Use these keywords and arguments with this command:
•
•
•
•
•
•
•
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Implementing SSL Support in the MWTM, page 2-20
mwtm killclients
Server Only
Command Description
Forcefully stops all MWTM clients on the local host, including all GTT clients and Event Editors.
You must log in as the root user (not as a superuser) to use this command.
mwtm listusers
Server Only
Full Syntax
mwtm listusers [username]
Command Description
If you enable MWTM User-Based Access, lists all currently defined users in the authentication list, including this information for each user:
•
•
•
•
To list information for a specific user, use the username argument to specify the user.
You must log in as the root user or superuser to use this command.
Related Topic
Listing All Currently Defined Users (Server Only), page 2-16
mwtm logger
Server Only
Command Description
Displays the system messages messageLog.txt file with tail -f.
To stop the display, press Ctrl-C.
mwtm logtimemode
Server Only
Full Syntax
mwtm logtimemode [12 | 24]
Command Description
Sets the time mode for dates in log files:
•
•
You must log in as the root user or superuser to use this command.
mwtm manage
Full Syntax
mwtm manage [itp enable | disable] [ran-o enable | disable] [status]
Command Description
Enables, disables, or checks the status of managed network(s):
•
•
•
•
•
You must log in as the root user or superuser to use this command.
mwtm maxasciirows
Server Only
Full Syntax
mwtm maxasciirows [number-of-rows]
Command Description
Sets the maximum number of rows for MWTM ASCII web output; for example, detailed debugging information.
If you enter this command without the number-of-rows argument, the MWTM displays the current maximum number of rows. You can then change that value or leave it. The valid range is 1 row to an unlimited number of rows. The default value is 6000 rows.
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm maxevhist
Server Only
Full Syntax
mwtm maxevhist [number-of-rows]
Command Description
Sets the maximum number of rows for the MWTM to search in the event history logs. The event history logs are the current and archived MWTM network status logs for status change and SNMP trap messages. The MWTM sends the results of the search to the web browser, where the setting of the mwtm maxhtmlrows command further limits the results.
If you enter this command without the number-of-rows argument, the MWTM displays the current maximum number of rows. You can then change that value or leave it. The valid range is 1 row to an unlimited number of rows. The default value is 15,000 rows.
The default setting is sufficient in most MWTM environments. However, you might need to increase the setting if the MWTM has archived a large number of event history logs, each log contains thousands of messages, and you want to search more than 15,000 rows. Remember that increasing this setting can increase the search time.
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm maxhtmlrows
Server Only
Full Syntax
mwtm maxhtmlrows [number-of-rows]
Command Description
Sets the maximum number of rows for MWTM HTML web output; for example, statistics reports, status change messages, or SNMP trap messages.
Note
If you enter this command without the number-of-rows argument, the MWTM displays the current maximum number of rows. You can then change that value or leave it. The valid range is 1 row to an unlimited number of rows. The default value is 200 rows.
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm mldebug
Server Only
Full Syntax
mwtm mldebug [mode]
Command Description
Sets the mode for logging MWTM debug messages:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
This command can adversely affect the MWTM performance. Use this command only under guidance from the Cisco Technical Assistance Center (TAC).
You must log in as the root user or superuser to use this command.
mwtm motd
Server Only
Full Syntax
mwtm motd [cat | disable | edit | enable]
Command Description
Manages the MWTM message of the day file, which is a user-specified MWTM system notice. You can set the message of the day to inform users of important changes or events in the MWTM system. The message of the day also provides users with the chance to exit the MWTM or GTT client before launching.
If you enable the message of the day, it appears whenever a user attempts to launch an MWTM or GTT client. If the user:
•
•
Use these keywords with this command:
•
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Displaying a Message of the Day (Server Only), page 2-13
mwtm msglog
Server Only
Full Syntax
mwtm msglog [clear | -r]
Command Description
Uses PAGER to display the contents of the system message log.
To save the current contents of the log, clear the log, and restart the server, enter mwtm msglog clear.
To display the contents of the log in reverse order, with the most recent messages at the beginning of the log, enter mwtm msglog -r.
You must log in as the root user or superuser to use this command.
mwtm msglogage
Server Only
Full Syntax
mwtm msglogage [number-of-days]
Command Description
Sets the maximum number of days to archive system message log files before deleting them from the MWTM server.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
You must log in as the root user or superuser to use this command.
mwtm msglogdir
Server Only
Full Syntax
mwtm msglogdir [directory]
Command Description
Note
Changes the default location of all MWTM system message log files. By default, the system message log files reside on the MWTM server at /opt/CSCOsgm/logs.
Note
After you change the directory, the MWTM asks if you want to restart the MWTM server. The new directory takes effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command. If you change to a default location outside the MWTM, you must have appropriate permissions for that location.
mwtm msglogsize
Server Only
Full Syntax
mwtm msglogsize [number-of-lines]
Command Description
Sets the maximum number of lines to write to the message log file before starting a new file.
If you enter this command without the number-of-lines argument, the MWTM displays the current maximum number of lines. You can then change that value or leave it.
The message log process maintains two log files while it is running:
•
•
When messageLog.txt reaches the number of lines specified by the mwtm msglogsize command, the MWTM copies the contents of the messageLog.txt file to the messageLog-old.txt file, and starts a new messageLog.txt file.
The default value for number-of-lines is 50,000 lines.
The valid range is 1,000 lines to an unlimited number of lines. The default value is 50,000 lines. If you specify a larger file size for the message log file, the message log file and its copy require proportionally more disk space.
When changing the number of lines to display, remember that every 5,000 lines require approximately 1 MB of disk space. You need to balance your need to refer to old messages against the amount of disk space they occupy.
You must log in as the root user or superuser to use this command. If you change the number-of-lines value, you must restart the server (see mwtm restart).
mwtm netlog
Server Only
Full Syntax
mwtm netlog [clear | -r]
Command Description
Uses PAGER to display the contents of the network status log. To:
•
•
You must log in as the root user or superuser to use this command.
mwtm netlogger
Server Only
Command Description
Displays the current contents of the network status log file with tail -f.
To stop the display, enter Ctrl-c.
mwtm newlevel
Server Only
Full Syntax
mwtm newlevel [username]
Command Description
If you enable MWTM User-Based Access, changes the authentication level for the specified user. Valid levels are:
•
•
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Enabling and Changing Users and Passwords (Server Only), page 2-12
mwtm osinfo
Server Only
Command Description
Depending on the personality you have set (ITP, RAN-O, or both) displays the operating system versions of ITP and/or RAN-O software that the MWTM supports.
mwtm passwordage
Note
Server Only
Full Syntax
mwtm passwordage [number-of-days | clear]
Command Description
If you enable MWTM User-Based Access and you set mwtm authtype to local, number of days allowed before forcing users to change passwords.
This function is disabled by default. If you do not specify this command, users will never need to change their passwords.
If you enter the mwtm passwordage command, the valid range is 1 day to an unlimited number of days. No default setting exists.
If you enabled this function and you want to disable it (that is, prevent the MWTM from forcing users to change passwords), enter mwtm passwordage clear.
Note
You must log in as the root user or superuser to use this command.
Related Topic
Automatically Disabling Users and Passwords (Server Only), page 2-8
mwtm patchlog
Server Only
Full Syntax
mwtm patchlog
Command Description
Uses PAGER to display the contents of the patch log, which lists the patches that you installed on the MWTM server.
The default path and filename for the patch log file is /opt/CSCOsgm/install/sgmPatch.log. If you installed the MWTM in a directory other than /opt, then the patch log file resides in that directory.
You must log in as the root user or superuser to use this command.
mwtm poll
Server Only
Full Syntax
mwtm poll [node] [node]...
Command Description
You use this command to poll one or more known nodes from the command line. Use the node arguments to specify the DNS names or IP addresses of one or more known nodes.
You must log in as the root user or superuser to use this command.
mwtm pollertimeout
Server Only
Full Syntax
mwtm pollertimeout [number-of-seconds]
Command Description
Specifies how long, in seconds, MWTM clients that are connected to the MWTM server can run a demand poller, as in a real-time data window or web page, before the MWTM automatically stops the poller to prevent unnecessary traffic on the network. When the demand poller times out, the MWTM stops the poller and sends an appropriate error message to the client.
The valid range is 1 second to an unlimited number of seconds. The default timeout is 8 hours (28800 seconds).
After you change the timeout, the MWTM asks if you want to restart the MWTM server. The new poller timeout takes effect when you restart the MWTM server.
See Server Status Information:Pollers, page 5-44 for more information on demand pollers.
You must log in as the root user or superuser to use this command.
mwtm print
Server Only
Full Syntax
mwtm print {all | device | snmp | task}
Command Description
Displays information about device versions, SNMP settings, running tasks, or all three.
You must log in as the root user or superuser to use this command.
mwtm props
Server and Solaris or Linux Clients Only
Command Description
Displays the contents of the System.properties files for both MWTM server and client installs.
You must log in as the root user or superuser to use this command.
mwtm provisiontool
Server Only
Full Syntax
mwtm provisiontool -a actionName [parameters]
Command Description
Invokes provisioning API operations.
You can specify these action names (and any corresponding required parameters) by using the -a option:
-a
provision
-r
-H
-p
-S
-h
syncFromDevice
-f
-H
-p
-S
-h
iosWriteToStartup
You can use these parameters:
You must log in as the root user or superuser to use this command.
Related Documentation
See the Cisco Mobile Wireless Transport Manager 6.0 OSS Integration Guide.
mwtm purgedb
Server Only
Command Description
Permanently deletes all components in the MWTM database marked for deletion.
You might need to use this command if you made a network configuration change and, as a result, mismatched node IP addresses or signaling-point codes appear in the MWTM client. For example, you create this problem if you assign an IP address or point code to an ITP node that was previously assigned to another ITP node.
If you reassign a point code to a different ITP node, when a new discovery is performed, the MWTM compares the newly discovered configuration with the previously discovered configuration. Any components (nodes, signaling points, linksets, and so on) not in the new configuration are marked as deleted in the MWTM database. However, the MWTM does not immediately delete the associated information from the database but keeps it for a period of time to preserve any existing user-customized attributes. In this way, if you restore the component back to the configuration, user-customized changes remain unchanged and you do not have to re-enter them.
Unfortunately, this benefit has a side effect. If you restore a deleted component but in a different location (for example, if you restore a point code that was once on one node but is now on a different node), the MWTM uses the old information in the database; rather than the new information. Ultimately, some of the configuration changes are not detected and the viewable data from the client application is incorrect.
Note
You must log in as the root user or superuser to use this command.
mwtm readme
Server and Solaris or Linux Clients Only
Command Description
Displays the contents of the README file for the MWTM.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm reboot
Server Only
Command Description
Reboots the Solaris MWTM system.
Note
You must log in as the root user (not as a superuser) to use this command.
mwtm rep15minage
Server Only
Full Syntax
mwtm rep15minage [number-of-days]
Command Description
Maximum number of days the MWTM should archive 15-minute reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm repdailyage
Server Only
Full Syntax
mwtm repdailyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive daily reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 90 days.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm rephelp
Server Only
Command Description
Displays help for all commands that are related to MWTM reports.
You must log in as the root user or superuser to use this command.
mwtm rephourlyage
Server Only
Full Syntax
mwtm rephourlyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive hourly reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm repmonthlyage
Server Only
Full Syntax
mwtm repmonthlyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive monthly reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 3650 days.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm restart
Server Only
Full Syntax
mwtm restart [jsp | pm | web]
Command Description
Restarts MWTM servers on the local host:
•
•
•
If you do not specify a keyword, mwtm restart restarts all MWTM servers.
You must log in as the root user or superuser to use this command.
mwtm restore
Server Only
Full Syntax
mwtm restore [archive | atbl | gtt | logs | reports | routes | security]
Command Description
Restores the MWTM data files from the previous night's backup, stored in the MWTM installation directory. If you installed the MWTM in:
•
•
You can restore data files on the same Solaris or Linux server; or, on a different Solaris or Linux server that is running MWTM 6.0.
To restore only specific parts of the MWTM data files, use these keywords:
•
•
•
•
•
•
•
To change the directory in which the MWTM stores these backup files, use the mwtm backupdir command.
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Backing Up or Restoring MWTM Files (Server Only), page 2-32
mwtm restoreprops
Server and Solaris or Linux Clients Only
Command Description
Restores the MWTM server and client System.properties files and other important configuration files to the backup versions of the files.
You must log in as the root user (not as a superuser) to use this command.
mwtm rootvars
Server and Solaris or Linux Clients Only
Command Description
Displays the contents of the /etc/CSCOsgm.sh file, which determines the root location of the MWTM server and client installation.
mwtm sechelp
Server Only
Command Description
Displays help for all commands that are related to MWTM security.
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 2, "Configuring Security"
mwtm seclog
Server Only
Full Syntax
mwtm seclog [clear | -r]
Command Description
Uses PAGER to display the contents of the system security log.
These security events are recorded in the log:
•
•
•
•
•
•
•
•
To clear the log, enter mwtm seclog clear.
To display the contents of the log in reverse order, with the most recent security events at the beginning of the log, enter mwtm seclog -r.
The default path and filename for the system security log file is /opt/CSCOsgm/logs/sgmSecurityLog.txt. If you installed the MWTM in a directory other than /opt, then the system security log file resides in that directory.
You must log in as the root user or superuser to use this command.
Related Topic
Displaying the Contents of the System Security Log (Server Only), page 2-16
mwtm secondaryserver
Server Only
Full Syntax
mwtm secondaryserver [hostname [naming-port] | list]
Command Description
Configures a secondary MWTM server, where:
•
•
For best results, Cisco recommends that you configure the primary server and the secondary server as secondaries for each other.
If you use the mwtm secondaryserver command to configure a secondary MWTM server, but the primary MWTM server fails before you launch the MWTM client, the MWTM client does not detect the secondary server.
To list the secondary MWTM server that you configured for this primary MWTM server, enter the mwtm secondaryserver list command.
You must log in as the root user or superuser to use this command.
Related Topic
Configuring a Backup MWTM Server, page 3-9
mwtm servername
Server and Solaris or Linux Clients Only
Full Syntax
mwtm servername [hostname]
Command Description
Resets the MWTM server' default hostname, where hostname is the new default hostname:
•
•
•
•
Note
Related Topic
•
mwtm setpath
Server and Solaris or Linux Clients Only
Full Syntax
mwtm setpath [username]
Command Description
Appends binary (bin) directories to the path for a user. Users can then append the proper MWTM binary directories to their paths without manually editing the .profile and .cshrc files.
This command appends lines such as these to the user's .profile file:
PATH=$PATH:/opt/CSCOsgm/bin:/opt/CSCOsgmClient/bin # CiscoSGM
and appends lines such as these to the user's .cshrc file:
set path=($path /opt/CSCOsgm/bin /opt/CSCOsgmClient/bin) # CiscoSGM
Thereafter, you can enter MWTM commands as:
mwtm help
instead of:
/opt/CSCOsgm/bin/mwtm help
When entering this command, remember that:
•
•
–
–
–
•
•
mwtm showcreds
Server Only
Full Syntax
mwtm showcreds [-i ipaddress] [-d nodetype]
Command Description
Displays credentials for a given IP address, if specified; otherwise, displays the Default credentials. To:
•
•
–
–
–
–
You must log in as the root user or superuser to use this command.
Related Topic
Credentials Commands, page 3-22
mwtm snmpcomm
Server Only
Full Syntax
mwtm snmpcomm [name]
Command Description
You use this command to set a new default SNMP read community name. The MWTM automatically updates the name in the SNMP parameters file. The default path and filename for the SNMP parameters file is /opt/CSCOsgm/etc/communities.conf.
You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm snmpconf
Server Only
Full Syntax
mwtm snmpconf [filename]
Command Description
Sets the file used for SNMP parameters, such as community names, timeouts, and retries.
The default path and filename for the SNMP parameters file is /opt/CSCOsgm/etc/communities.conf. If you installed the MWTM in a directory other than /opt, then the file resides in that directory.
When you specify a new path or filename, the MWTM restarts the servers.
Note
You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm snmpget
Server Only
Full Syntax
mwtm snmpget [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-d output_delimiter] [--header|--no-header] [--raw-octets|--no-raw-octets] [--str-octets|--no-str-octets] [--raw-timeticks|--no-raw-timeticks] [--resolve-integer|--no-resolve-integer] [--resolve-bits|--no-resolve-bits] [--get-sysuptime|--no-get-sysuptime] [--detect-mib-error] [--instance oids] [--int-instance integer] [--str-instance string] [hostname] [oid] [oid]...
Command Description
Queries the specified hostname by using SNMP GetRequests. Use these optional keywords and arguments with this command:
•
For example, by default JVM uses a maximum of 64 MB of memory; however, if you are walking a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this syntax:
-J-Xmx256m
•
•
•
•
•
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
mwtm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
mwtm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
•
•
mwtm snmpget --str-instance link_1 node_1 cItpSpLinksetState
mwtm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOsgm/etc/
communities.conf. If you installed the MWTM in a directory other than /opt, then the file resides in that directory. You can edit the file manually or using the MWTM client (see Launching the Discovery Dialog, page 4-6).You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm snmphelp
Server Only
Command Description
Displays help for all commands that are related to SNMP queries.
You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm snmpnext
Server Only
Full Syntax
mwtm snmpnext [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-d output_delimiter] [--header|--no-header] [--raw-octets|--no-raw-octets] [--str-octets|--no-str-octets] [--raw-timeticks|--no-raw-timeticks] [--resolve-integer|--no-resolve-integer] [--resolve-bits|--no-resolve-bits] [--get-sysuptime|--no-get-sysuptime] [--detect-mib-error] [--instance oids] [--int-instance integer] [--str-instance string] [hostname] [oid] [oid]...
Command Description
Queries the specified hostname by using SNMP GetNextRequests. Use these optional keywords and arguments with this command:
•
For example, by default JVM uses a maximum of 64 MB of memory; however, if you explore a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this option:
-J-Xmx256m
•
•
•
•
•
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
mwtm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
mwtm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
•
•
mwtm snmpget --str-instance link_1 node_1 cItpSpLinksetState
mwtm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOsgm/etc/communities.conf. If you installed the MWTM in a directory other than /opt, then the file resides in that directory. You can edit the file manually or by using the MWTM client (see Launching the Discovery Dialog, page 4-6).
You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm snmpwalk
Server Only
Full Syntax
mwtm snmpwalk [-JJVM_ARG1 [-JJVM_ARG2]...] [-v snmp_version] [-c community_string] [-r retry] [-t timeout] [-x maximum_rows] [-d output_delimiter] [--tabular|--no-tabular] [--getbulk|--no-getbulk] [--header|--no-header] [--raw-octets|--no-raw-octets] [--str-octets|--no-str-octets] [--raw-timeticks|--no-raw-timeticks] [--resolve-integer|--no-resolve-integer] [--resolve-bits|--no-resolve-bits] [--get-sysuptime|--no-get-sysuptime] [--detect-mib-error] [--instance oids] [--int-instance integer] [--str-instance string] [hostname] [oid] [oid]...
Command Description
Queries the specified hostname by using SNMP GetNextRequests to go through the MIB. Use these optional keywords and arguments with this command:
•
For example, by default JVM uses a maximum of 64 MB of memory; however, if you are going through a large table, JVM might require more memory. To enable JVM to use a maximum of 256 MB of memory, use this option:
-J-Xmx256m
•
•
•
•
•
However, for every 10,000 rows gone through, JVM requires an additional 10 MB of memory. You can use the -J keyword and argument to increase the memory available to JVM.
•
•
–
–
•
–
–
•
–
–
•
–
–
The other option for displaying octets is --str-octets|--no-str-octets.
•
–
–
The other option for displaying octets is --raw-octets|--no-raw-octets.
•
–
–
•
–
–
•
–
–
•
–
–
•
Sometimes multiple MIB variables are returned at the same time, some of which are in error; others are not. If this occurs and you:
–
–
•
mwtm snmpget --instance 172.18.16.10 node_1 ipAdEntIfIndex ipAdEntNetMask
mwtm snmpget node_1 ipAdEntIfIndex.172.18.16.10 ipAdEntNetMask.172.18.16.10
•
•
mwtm snmpget --str-instance link_1 node_1 cItpSpLinksetState
mwtm snmpget node_1 cItpSpLinksetState.6.108.115.110.97.109.101
•
•
The default path for the SNMP parameters file, communities.conf, is /opt/CSCOsgm/etc/communities.conf. If you installed the MWTM in a directory other than /opt, then the file resides in that directory. You can edit the file manually or using the MWTM client (see Launching the Discovery Dialog, page 4-6).
You must log in as the root user or superuser to use this command.
Related Topic
SNMP Configuration Commands, page 3-18
mwtm sounddir
Server Only
Full Syntax
mwtm sounddir [directory]
Command Description
Note
Sets the directory in which the MWTM server stores event automation sound files (see Changing the Way the MWTM Processes Events, page 9-27 for information about sound files).
The default directory for sound files resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to use a different directory for MWTM server event automation sound files, such as a Network File System location on another server.
Note
You must log in as the root user to use this command.
mwtm ssl
Server Only
Full Syntax
mwtm ssl [enable | disable | status]
Command Description
If you enable the SSL on the MWTM and you have an SSL key-certificate pair on the MWTM, you can use this command to manage SSL support in the MWTM:
•
•
•
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Implementing SSL Support in the MWTM, page 2-20
mwtm sslstatus
Server Only
Command Description
Displays the current status for SSL that the MWTM supports, including whether you enabled or disabled SSL support; and, which SSL keys and certificates exist.
You must log in as the root user to use this command.
Related Topic
Implementing SSL Support in the MWTM, page 2-20
mwtm start
Server Only
Command Description
Starts all MWTM servers on the local host.
You must log in as the root user or superuser to use this command.
Related Topic
Starting the MWTM Server, page 4-1
mwtm start client
Server and all Clients
Full Syntax
mwtm start client [hostname]
Command Description
Starts an MWTM client on the specified host. If you did not specify a hostname, starts an MWTM client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
If you log in to a remote workstation through Telnet or SSH, you must set the DISPLAY variable to your local display, or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
This command has the same function as the mwtm client command.
mwtm start jsp
Server Only
Command Description
Starts the MWTM JSP Server on the local host.
You must log in as the root user or superuser to use this command.
mwtm start pm
Server Only
Command Description
Starts the MWTM Process Manager and all managed processes on the local host.
You must log in as the root user or superuser to use this command.
mwtm start web
Server Only
Command Description
Starts the MWTM web server on the local host.
You must log in as the root user or superuser to use this command.
mwtm status
Server Only
Command Description
Displays the status of all MWTM servers on the local host.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm stop
Server Only
Command Description
Stops all MWTM servers on the local host.
You must log in as the root user or superuser to use this command.
mwtm stopclients
Server and Solaris or Linux Clients Only
Command Description
Stops all MWTM clients, including all GTT clients and Event Editors, on the local host.
You must log in as the root user (not as a superuser) to use this command.
mwtm stop jsp
Server Only
Command Description
Stops the MWTM JSP Server on the local host.
You must log in as the root user or superuser to use this command.
mwtm stop pm
Server Only
Command Description
Stops the MWTM Process Manager and all managed processes on the local host.
You must log in as the root user or superuser to use this command.
mwtm stop web
Server Only
Command Description
Stops the MWTM web server on the local host.
You must log in as the root user or superuser to use this command.
mwtm superuser
Server Only
Full Syntax
mwtm superuser [username]
Command Description
Allows the specified user to perform most functions that otherwise require the user to log in as the root user. (The root user can still perform those functions, too.) The specified user account must exist in the local /etc/passwd file. You cannot specify a user that is defined in a distributed Network Information Services (NIS) system.
Note
For a complete list of the MWTM commands that a superuser cannot use, as well as other superuser considerations, see Specifying a Super User (Server Only), page 2-18.
You must log in as the root user (not as a superuser) to use this command.
mwtm syncusers
Server Only
Command Description
If you enable MWTM User-Based Access and you set mwtm authtype to solaris, synchronizes local MWTM passwords with Solaris.
You must log in as the root user (not as a superuser) to use this command.
Related Topic
Manually Synchronizing Local MWTM Passwords (Server Only), page 2-15
mwtm tac
Server Only
Command Description
Collects important troubleshooting information for the Cisco Technical Assistance Center and writes the information to the /opt/CSCOsgm/tmp/cisco_mwtm_tshoot.log file.
You must log in as the root user or superuser to use this command.
Related Topic
Appendix D, "Troubleshooting the MWTM and the Network"
mwtm tnproxy
Server Only
Full Syntax
mwtm tnproxy [disable | enable | status]
Command Description
Manages a Telnet proxy that resides on a server and forwards Telnet requests from clients to ITPs that are accessible only from that server. You use a Telnet proxy to enable remote clients on desktop networks to Telnet to ITPs that otherwise would be unreachable. You can use these options with this command:
•
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Enabling the Telnet Server Proxy Service, page 3-11
mwtm trapaccess
Server Only
Full Syntax
mwtm trapaccess [add [ip-addr] | clear | edit | list | rem [ip-addr] | sample]
Command Description
You use this command to create and manage a list of ITP IP addresses that can send traps to the MWTM server.
The list of allowed ITP IP addresses resides in the trapaccess.conf file. By default, when you first install the MWTM, the trapaccess.conf file does not exist and the MWTM allows all IP addresses to send traps to the MWTM server. To create the trapaccess.conf file and work with the list of allowed client IP addresses, specify one of these keywords:
•
•
•
•
•
•
Any changes that you make take effect when you restart the MWTM server.
See Limiting Traps by IP Address, page 3-8 for more information about using this command.
You must log in as the root user or superuser to use this command.
mwtm trapsetup
Server Only
Full Syntax
mwtm trapsetup [disable]
Command Description
Stops the MWTM server, configures the MWTM to receive SNMP traps (or prevents the MWTM from receiving traps), then restarts the MWTM server.
When you select an SNMP trap port number for the MWTM server, ensure that your ITPs use the same SNMP trap port number. See the description of the snmp-server host command in the "ITP Requirements" section of the Installation Guide for the Cisco Mobile Wireless Transport Manager 6.0 for more information.
To prevent the MWTM from receiving traps, enter the mwtm trapsetup disable command. The MWTM restarts the MWTM server.
You must log in as the root user (not as a superuser) to use this command.
Related Topic
•
•
mwtm trapstatus
Server Only
Command Description
Displays the current trap reception configuration for the MWTM, including:
•
•
Related Topic
mwtm tshootlog
Server Only
Full Syntax
mwtm tshootlog {enable | disable | status}
Command Description
The MWTM can record all output from troubleshooting commands into a log file. To:
•
•
•
The default path for the troubleshooting log file is /opt/CSCOsgm/logs/troubleshooting. If you installed the MWTM in a directory other than /opt, then the troubleshooting log file resides in that directory.
Related Topic
Appendix D, "Troubleshooting the MWTM and the Network"
mwtm uninstall
Server and Solaris or Linux Clients Only
Command Description
Uninstalls the MWTM.
You must log in as the root user (not as a superuser) to use this command.
mwtm unknownage
Server Only
Full Syntax
mwtm unknownage [number-of-days]
Command Description
Sets the maximum number of days to retain Unknown objects before deleting them from the MWTM database.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 7 days. Setting this value to 0 days means that, after one hour, the system deletes Unknown.
You must log in as the root user or superuser to use this command.
mwtm updateuser
Server Only
Full Syntax
mwtm updateuser [username]
Command Description
If you enable MWTM User-Based Access, changes the authentication level for the specified user. Valid levels are:
•
•
•
•
•
If you set mwtm authtype to local, you also use this command to change the user's password. When setting the password, follow the rules and considerations in Creating Secure Passwords, page 2-5.
See Enabling and Changing Users and Passwords (Server Only), page 2-12 for more information on authentication levels and the use of this command.
You must log in as the root user or superuser to use this command.
Note
mwtm useraccess
Server Only
Full Syntax
mwtm useraccess [disable | enable]
Command Description
Enables or disables MWTM User-Based Access.
User-Based Access provides multilevel password-protected access to MWTM features. Each user can have a unique user name and password. You can also assign each user to one of five levels of access, which control the list of MWTM features accessible by that user.
You must enable MWTM User-Based Access to use the associated MWTM security commands (see Configuring User Access, page 2-1).
You must log in as the root user or superuser to use this command.
mwtm userpass
Server Only
Full Syntax
mwtm userpass [username]
Command Description
If you enable MWTM User-Based Access and mwtm authtype is set to local, changes the specified user's MWTM security authentication password.
If the MWTM or a superuser automatically disables the user's authentication, this command re-enables the user's authentication with a new password.
If mwtm authtype is set to solaris, you cannot use this command; instead, you must manage passwords on the external authentication servers.
You must log in as the root user to use this command.
Related Topic
Enabling and Changing Users and Passwords (Server Only), page 2-12
mwtm version
Server and Solaris or Linux Clients Only
Command Description
Displays version information for MWTM servers and clients on the local host.
Related Topic
Chapter 11, "Accessing Data from the Web Interface"
mwtm viewlog
Server Only
Command Description
Uses PAGER to display the contents of the system message log. To:
•
•
This command has the same function as the mwtm msglog command.
You must log in as the root user or superuser to use this command.
mwtm wall
Server Only
Full Syntax
mwtm wall message_string
Command Description
Sends a message to all clients that are connected to the server. For example:
./mwtm wall Server going down at 9:00 pm tonight.
sends this message:
Server going down at 9:00 pm tonight.
The MWTM ignores quotation marks ("") in message_string. To include quotation marks (""), use the escape character (\) in combination with quotation marks (""). For example:
./mwtm wall Example of the \"mwtm wall\" command.
sends this message:
Example of the "mwtm wall" command.
You must log in as the root user or superuser to use this command.
mwtm webaccesslog
Server Only
Full Syntax
mwtm webaccesslog [clear | -r]
Command Description
Uses PAGER to display the MWTM system web access log file for the server to which you connect and which is currently running the MWTM server. The system web access log lists all MWTM system web access messages that it logged for the MWTM server. This method provides an audit trail of all access to the MWTM server via the web interface. To:
•
•
You must log in as the root user or superuser to use this command.
mwtm weberrorlog
Server Only
Full Syntax
mwtm weberrorlog [clear | -r]
Command Description
Uses PAGER to display the MWTM web server error log file for the server to which you connect, and which is currently running the MWTM server. The web server error log lists all MWTM web error messages that it logged for the MWTM web server. To:
•
•
You must log in as the root user or superuser to use this command.
mwtm weblogupdate
Server Only
Full Syntax
mwtm weblogupdate [interval | disable]
Command Description
Controls how often, in seconds, the MWTM updates certain web output.
When you enter this command, the MWTM displays the current interval. You can then change that value or leave it. The valid range is 1 second to an unlimited number of seconds. The default value is 300 seconds (5 minutes).
To disable the update interval, enter the mwtm weblogupdate disable command. This option reduces the CPU usage on the server and client.
You must log in as the root user or superuser to use this command.
mwtm webnames
Server Only
Full Syntax
mwtm webnames [display | real]
Command Description
Specifies whether the MWTM should show real node names or display names in web pages:
•
•
You must log in as the root user or superuser to use this command.
mwtm webport
Server Only
Full Syntax
mwtm webport [port-number]
Command Description
Sets a new port number for the web server, where port-number is the new, numeric port number. The MWTM verifies that the new port number is not already in use.
The new port number must contain only numbers. If you enter a port number that contains nonnumeric characters, such as mwtm13, the MWTM displays an error message and returns to the command prompt without changing the port number.
You must log in as the root user (not as a superuser) to use this command.
mwtm webutil
Server Only
Full Syntax
mwtm webutil [percent | erlangs]
Command Description
Specifies whether the MWTM should display send and receive utilization for linksets and links as percentages or in Erlangs (E), in web pages:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
•
•
•
mwtm who
Server Only
Command Description
Displays a list of all client user names and processes connected to the server.
mwtm xtermpath
Server or Solaris or Linux Clients Only
Command Description
Specifies the path to the xterm application to use for xterm sessions on the MWTM client, as well as any special parameters to pass to the xterm application. The default path is /usr/openwin/bin/xterm.
If one of the special parameters that you pass to the xterm application is a title, the title can contain hyphens (-) and underscores (_), but no spaces.
You must log in as the root user (not as a superuser) to use this command.
ITP Commands
ITP commands include:
mwtm accstats
Server Only
Full Syntax
mwtm accstats [node-list [id-tag]] [sort-option] [quiet]
Command Description
Generates MWTM accounting statistics reports. To:
•
–
–
mwtm-75-59a.cisco.com
To specify a node name and signaling point:
mwtm-75-59a.cisco.com;net0
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm accstats command.
•
–
–
–
–
–
–
–
–
•
Before entering this command, you must enable the MWTM to generate accounting statistics reports. See the description of the mwtm statreps [acct | noacct] command for more information.
The first time you use the mwtm accstats command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you need only to enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling Custom Archived Statistics Reports, page 12-49
mwtm archivedir
Server Only
Full Syntax
mwtm archivedir [directory]
Command Description
Note
Sets the Version Control System (VCS) repository directory, the directory in which the MWTM stores archived files.
The default VCS repository directory resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to use a different directory; for example, a Network File System location on another server.
•
–
–
You must log in as the root user or superuser to use this command.
Note
mwtm atblclient
Solaris or Linux Clients Only
Full Syntax
mwtm atblclient [hostname]
Command Description
Starts an MWTM Address Table Editor client on the specified host. If you do not specify a hostname, starts an MWTM Address Table Editor client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
For more information about the MWTM Address Table Editor, see Chapter 15, "Editing ITP MLR Address Table Files."
If you log in to a remote workstation through Telnet, you must set the DISPLAY variable to your local display or you cannot use this command. If the system does not automatically set the DISPLAY variable, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
mwtm atbldir
Server Only
Full Syntax
mwtm atbldir [directory]
Command Description
Note
Sets the address-table staging directory, the directory in which the MWTM stores address table files. For more information about address table files, see Chapter 15, "Editing ITP MLR Address Table Files."
The default address table staging directory resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to use a different address table staging directory, such as /tftpboot, or such as a Network File System location on another server, used as the TFTP server for server configuration files for ITPs in the network.
•
–
–
When you enter this command, the MWTM also prompts you to enable TFTP file transfer for the address table staging directory and prompts you for the TFTP path for the directory, tftp://hostname/path, where:
•
If you enter a DNS name (such as mwm-jumbo) instead of an IP address (such as 172.18.12.10), then the ITP must be able to resolve the DNS name; otherwise, when you try to deploy a file, the MWTM issues an appropriate error message and does not deploy the file.
To enable the ITP to resolve DNS names, enter the ip domain-lookup command on the ITP. For more information about this command, see the Cisco IOS IP Command Reference, Volume 1 of 4: Addressing and Services, Release 12.3 or later.
•
After you change the directory or enable TFTP file transfer for the directory, the MWTM asks if you want to restart the MWTM server. The new directory and TFTP setting take effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
Note
mwtm autosyncconfig
Server Only
Full Syntax
mwtm autosyncconfig [enable | disable | status]
Command Description
Manages auto sync configuration settings to automatically save the IOS configuration changes.
mwtm checkgtt
Server Only
Full Syntax
mwtm checkgtt [-l logfilename] filename signalingpointname
Command Description
Checks the semantics and syntax of the specified GTT file on the specified signaling point. To write detailed syntax- and semantics-checking results to a file, specify -l and the name of the file.
You must log in as the root user or superuser to use this command.
mwtm checkmlr
Server Only
Full Syntax
mwtm checkmlr [-l logfilename] filename signalingpointname
Command Description
Checks the semantics and syntax of the specified MLR address table on the specified signaling point. To write detailed syntax- and semantics-checking results to a file, specify -l and the name of the file.
You must log in as the root user or superuser to use this command.
mwtm checkroute
Server Only
Full Syntax
mwtm checkroute [-l logfilename] filename signalingpointname
Command Description
Checks the semantics and syntax of the specified route table file on the specified signaling point. To write detailed syntax- and semantics-checking results to a file, specify -l and the name of the file.
You must log in as the root user or superuser to use this command.
mwtm countas
Server Only
Command Description
Displays a count of application servers in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countasp
Server Only
Command Description
Displays a count of application server processes in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countaspa
Server Only
Command Description
Displays a count of application server process applications in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countlinks
Server Only
Command Description
Displays a count of links in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countlinksets
Server Only
Command Description
Displays a count of linksets in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countsgmp
Server Only
Command Description
Displays a count of signaling gateway-mated pairs in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm countsps
Server Only
Command Description
Displays a count of signaling points in the current MWTM database.
You must log in as the root user or superuser to use this command.
mwtm deletearchive
Server Only
Full Syntax
mwtm deletearchive {-s signaling-point-name} {-t type} [-a address-table-name]
Command Description
Deletes a file from the archive.
•
–
–
–
*If you specify the type as mlr, you must also specify -a and the name of the address table.
You must log in as the root user or superuser to use this command.
mwtm deployarchive
Server Only
Full Syntax
mwtm deployarchive {-s signaling point name of source configuration} {-t type} [-a address table name] [-r revision number of file] [-c archive comment for deploy]
Command Description
Allows you to deploy an archived file to a specified signaling point. To:
•
–
–
–
*If you specify the type as mlr, you must also specify -a and the name of the address table.
•
•
Once you have entered the command, you will receive a prompt to enter the destination signaling-point name.
You must log in as the root user or superuser to use this command.
mwtm deploycomments
Server Only
Full Syntax
mwtm deploycomments {required | optional | status}
Command Description
Allows you to require or make optional user comments during deployment. To:
•
•
•
You must log in as the root user or superuser to use this command.
mwtm evreps clean
Server Only
Command Description
Removes all data from MWTM network event reports, restoring the reports to an unchanged state.
You must log in as the root user or superuser to use this command.
mwtm evreps cleancustom
Server Only
Full Syntax
mwtm evreps cleancustom [tag]
Command Description
Removes all data from one or more MWTM custom event reports, restoring the reports to an unchanged state. To clean:
•
•
You must log in as the root user or superuser to use this command.
mwtm evreps diskcheck
Full Syntax
mwtm evreps [diskcheck | nodiskcheck]
Command Description
Specifies whether the MWTM should verify that a disk has at least 10 MB of space remaining before generating network event reports:
•
•
If your system does not return the necessary amount of free space in a correct format that the MWTM can parse, use this command to disable checking and to allow reporting to continue.
See Chapter 12, "Managing ITP Reports" for more information on the output of this command.
You must log in as the root user or superuser to use this command.
mwtm evreps enable
Server Only
Full Syntax
mwtm evreps [disable | enable]
Command Description
Enables the MWTM to generate event reports:
•
•
The mwtm evreps command enables or disables the MWTM event reporting feature. To enable a specific type of event reporting, you must also enable that report type.
Note
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 12, "Managing ITP Reports"
mwtm evreps hourlyage
Server Only
Full Syntax
mwtm evreps hourlyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive hourly network event reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
You must log in as the root user or superuser to use this command.
mwtm evreps mtp
Server Only
Full Syntax
mwtm evreps [mtp | nomtp]
Command Description
Specifies whether the MWTM should generate MTP3 event reports:
•
•
Note
You must log in as the root user or superuser to use this command.
Related Topic
Chapter 12, "Managing ITP Reports"
mwtm evreps status
Server Only
Command Description
Displays the current status of all MWTM network event report parameters. You set these parameters by using the other mwtm evreps commands, such as:
•
•
You must log in as the root user or superuser to use this command.
mwtm evreps timer
Server Only
Command Description
Displays the timer file for MWTM network event reports. The timer file is useful for identifying how much time the MWTM spends gathering report data and generating reports.
You must log in as the root user or superuser to use this command.
mwtm gttclient
Solaris or Linux Clients Only
Full Syntax
mwtm gttclient [hostname]
Command Description
Starts an MWTM GTT client on the specified host. If no hostname is specified, starts an MWTM GTT client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
For more information about the MWTM GTT client, see Chapter 14, "Editing an ITP Global Title Translation Table."
If you access a remote workstation through Telnet, you must set the DISPLAY variable to your local display or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
mwtm gttdir
Server Only
Full Syntax
mwtm gttdir [directory]
Command Description
Note
Sets the GTT staging directory, the directory in which the MWTM stores GTT files and enables Trivial File Transfer Protocol (TFTP) file transfer for the directory. See Chapter 14, "Editing an ITP Global Title Translation Table" for information about GTT files.
The default GTT staging directory resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to use a different GTT staging directory, such as /tftpboot or the Network File System location on another server, which is used as the TFTP server for server configuration files for ITPs in the network.This command copies all files in the current directory to the new directory. If you are not logged in as the superuser and do not own the new directory, you might not be able to copy the files. In this case, you must specify a directory that you own or log in as the root user.
Do not set the new directory to any of these: /usr, /var, /opt, or /tmp.
Do not set the new directory to the same directory in which you are storing:
•
•
•
When you enter this command, the MWTM also prompts you to enable TFTP file transfer for the GTT staging directory and prompts you for the TFTP path for the directory, tftp://hostname/path, where:
•
If you enter a DNS name (such as mwm-jumbo) instead of an IP address (such as 172.18.12.10), then the ITP must be able to resolve the DNS name; otherwise, when you try to deploy a file, the MWTM issues an appropriate error message and does not deploy the file.
To enable the ITP to resolve DNS names, enter the ip domain-lookup command on the ITP. For more information about this command, see the Cisco IOS IP Command Reference, Volume 1 of 4: Addressing and Services, Release 12.3 or later.
•
After you change the directory or enable TFTP file transfer for the directory, the MWTM asks if you want to restart the MWTM server. The new directory and TFTP setting take effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
Note
mwtm gttstats
Server Only
Full Syntax
mwtm gttstats [node-list [id-tag]] [sort-option] [quiet]
Command Description
Generates MWTM GTT accounting statistics reports. To:
•
–
A single node or signaling point, specify a single node name, or node name and signaling-point name, as the node-list argument. The node name must exactly match the node name that the MWTM discovered, including the domain name, and each line must end with a colon (:).
For example:
mwtm-75-59a.cisco.com:
To specify a node name and signaling point, enter:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm gttstats command.
•
–
–
–
–
–
–
•
Before entering this command, you must enable the MWTM to generate GTT accounting statistics reports. See the description of the mwtm statreps [gtt | nogtt] command for more information.
The first time you use the mwtm gttstats command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you only need to enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling Custom Archived Statistics Reports, page 12-49
mwtm linkstats
Server Only
Full Syntax
mwtm linkstats [node-list [id-tag]] [sort-option] [quiet]
Command Description
Generates MWTM link and linkset statistics summary reports. To include:
•
–
–
For example:
mwtm-75-59a.cisco.com:
A node name and signaling point:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm linkstats command.
•
–
–
–
–
–
–
–
•
Before entering this command, you must enable the MWTM to generate link and linkset statistics summary reports. See the description of the mwtm statreps [link | nolink] command for more information.
The first time you use the mwtm linkstats command to generate a report, you must enter the command at least three times. The:
•
•
•
Thereafter, you only need to enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling Custom Archived Statistics Reports, page 12-49
mwtm listarchive
Server Only
Full Syntax
mwtm listarchive {-n node name | -s signaling point name} {-t type} [-a address table name]
Command Description
Displays a list of all the files in the Version Control System (VCS) archive or just those of a particular type for a specified node or signaling point. To show a list of files in the VCS of a particular:
•
•
•
–
–
–
*If you specify the type as mlr, you must also specify -a and the name of the address table.
You must log in as the root user or superuser to use this command.
mwtm listgtt
Server Only
Full Syntax
mwtm listgtt [directory]
Command Description
Lists all current GTT files in the specified directory (directory must be a subdirectory of the GTT staging directory). If no directory is specified, lists all current GTT files in the GTT staging directory.
You must log in as the root user or superuser to use this command.
mwtm listhistory
Server Only
Full Syntax
mwtm listhistory {-s signaling point name} {-t type} [-a address table name]
Command Description
Displays the revision history for a specified archive file. To show the revision history for a particular:
•
•
–
–
–
*If you specify the type as mlr, you must also specify -a and the name of the address table.
You must log in as the root user or superuser to use this command.
mwtm listmlr
Server Only
Full Syntax
mwtm listmlr [directory]
Command Description
Lists all current MLR address files in the address table staging directory (for details on setting the address table staging directory, see mwtm atbldir.) If a subdirectory is specified, lists all current MLR address files in the specified subdirectory (directory must be a subdirectory of the address table staging directory).
You must log in as the root user or superuser to use this command.
mwtm listroute
Server Only
Full Syntax
mwtm listroute [directory]
Command Description
Lists all current route table files in the specified directory (directory must be a subdirectory of the DPC Route staging directory). If no directory is specified, lists all current route table files in the DPC Route staging directory.
You must log in as the root user or superuser to use this command.
mwtm mlrstats
Server Only
Full Syntax
mwtm mlrstats [node-list [id-tag]] [sort-option] [quiet]
Command Description
Generates MWTM MLR processed, aborts, continues, result invokes, rule matches, subtriggers, and triggers reports. To:
•
–
–
For example:
mwtm-75-59a.cisco.com:
To specify a node name and signaling point:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm mlrstats command.
•
–
–
–
–
–
–
–
–
–
–
–
•
If you do not specify the quiet keyword (that is, if you view the output on your terminal), the MWTM displays only instance-level statistics (as listed in the description of the sort-option argument). To see the full set of trigger-level statistics, you must use the MWTM web interface (see MLR Reports, page 12-33).
Before entering this command, you must enable the MWTM to generate MLR processed, aborts, continues, result invokes, rule matches, subtriggers, and triggers reports. See the description of the mwtm statreps [mlr | nomlr] command for more information.
The first time you use the mwtm mlrstats command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you only need to enter this command once to generate the report.
See MLR Reports, page 12-33 for more information on MLR reports.
You must log in as the root user or superuser to use this command.
mwtm mtpevents
Server Only
Full Syntax
mwtm mtpevents [node-list [id-tag]] [quiet]
Command Description
Generates MWTM MTP3 event reports. To:
•
–
–
For example:
mwtm-75-59a.cisco.com:
To specify a node name and signaling point:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm mtpevents command.
•
The first time you use the mwtm mtpevents command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you need only enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling Custom Archived Statistics Reports, page 12-49
mwtm pcformat
Server Only
Full Syntax
mwtm pcformat {edit | list | master | restore}
Command Description
You use this command to set the point code format for this MWTM server and for all associated MWTM clients to use. You need to set the point code format usually only once, after installation.
You also use this command to configure the MWTM to recognize a single-instance ITP connecting to multiple instances on a multiple-instance ITP. In effect, the MWTM views the multiple networks as a single all-encompassing network.
The point code format configuration is contained in the PointCodeFormat.xml file. To work with the file, specify one of these keywords:
•
•
•
•
Any changes that you make take effect when you restart the MWTM server.
The MWTM preserves customized point code formats when you upgrade to a new version or release of the MWTM.
See Setting the ITP Point Code Format, page 3-5 and Connecting a Single-Instance ITP to a Multiple-Instance ITP, page 3-6 for more information about using this command.
You must log in as the root user or superuser to use this command.
mwtm pclist
Server Only
Command Description
Lists all point codes that all nodes that the MWTM detects are currently using.
You must log in as the root user or superuser to use this command.
mwtm pushgtt
Server Only
Full Syntax
mwtm pushgtt [-l logfilename] [-u username] [-p password] [-n enableusername] [-e enablepassword] [-s storagedevicename] [-c archive comments] [--overwrite|--no-overwrite] [--activate|--no-activate] filename signalingpointname
Command Description
Uploads the specified GTT file to the specified ITP signaling point.
Use these keywords and arguments with this command. If you do not specify a required keyword or argument, the MWTM prompts you to specify it.
•
•
•
•
•
•
•
•
•
•
•
You must log in as the root user or superuser to use this command.
mwtm pushmlr
Server Only
Full Syntax
mwtm pushmlr [-l logfilename] [-u username] [-p password] [-n enableusername] [-e enablepassword] [-s storagedevicename] [-c archive comments] [--overwrite|--no-overwrite] [--activate|--no-activate] filename signalingpointname
Command Description
Uploads the specified address table file to the specified ITP signaling point.
Use these keywords and arguments with this command. If you do not specify a required keyword or argument, the MWTM prompts you to specify it.
•
•
•
•
•
•
•
•
•
•
•
You must log in as the root user or superuser to use this command.
mwtm pushroute
Server Only
Full Syntax
mwtm pushroute [-l logfilename] [-u username] [-p password] [-n enableusername] [-e enablepassword] [-s storagedevicename] [-c archive comments] [--overwrite|--no-overwrite] [--activate|--no-activate] filename signalingpointname
Command Description
Uploads the specified route table file to the specified ITP signaling point.
Use these keywords and arguments with this command. If you do not specify a required keyword or argument, the MWTM prompts you to specify it.
•
•
•
•
•
•
•
•
•
•
•
You must log in as the root user or superuser to use this command.
mwtm q752stats
Server Only
Full Syntax
mwtm q752stats [node-list [id-tag]] [quiet]
Command Description
.Manually generates MWTM Q.752 statistics reports. To include:
•
–
–
For example:
mwtm-75-59a.cisco.com:
To specify a node name and signaling point:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm q752stats command.
•
The first time you use the mwtm q752stats command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you only need to enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling Custom Archived Statistics Reports, page 12-49
mwtm repcustage
Server Only
Full Syntax
mwtm repcustage [number-of-days]
Command Description
Maximum number of days the MWTM should archive custom reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 10 days.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm repdir
Server Only
Full Syntax
mwtm repdir [directory]
Command Description
Note
Sets the directory in which the MWTM stores report files. See Chapter 12, "Managing ITP Reports" for information about MWTM reports.
The default directory for report files resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to store report files in a different directory; for example, in a Network File System location on another server.
Note
Do not set the new directory to any of these: /usr, /var, /opt, or /tmp.
Do not set the new directory to the same directory in which you are storing GTT files (mwtm gttdir), message log files (mwtm msglogdir), route table files (mwtm routedir), or address table files (mwtm atbldir).After you change the directory, the MWTM asks if you want to restart the MWTM server. The new directory takes effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
mwtm replog
Server Only
Full Syntax
mwtm replog [clear | -r]
Command Description
Uses PAGER to display the contents of the system reports log. The reports log lists all messages that you use for the creation and maintenance of MWTM reports.
To clear the log and restart the server, enter mwtm replog clear.
To display the contents of the log in reverse order, with the most recent commands at the beginning of the log, enter mwtm replog -r.
The default path and filename for the system reports log file is /opt/CSCOsgm/logs/sgmReportLog.txt. If you installed the MWTM in a directory other than /opt, then the system reports log file resides in that directory.
You must log in as the root user or superuser to use this command.
mwtm routedir
Server Only
Full Syntax
mwtm routedir [directory]
Command Description
Note
Sets the DPC Route staging directory, the directory in which the MWTM stores ITP route table files, and enables Trivial File Transfer Protocol (TFTP) file transfer for the directory. See Chapter 13, "Editing an ITP Route Table File" for information about ITP route table files.
The default DPC Route staging directory resides in the MWTM installation directory. If you installed the MWTM in:
•
•
Use this command if you want to use a different DPC Route staging directory, such as /tftpboot or a Network File System location on another server that is used as the Trivial File Transfer Protocol (TFTP) server for server configuration files for ITPs in the network.
Note
Do not set the new directory to any of these: /usr, /var, /opt, or /tmp.
Do not set the new directory to the same directory in which the GTT files (mwtm gttdir), message log files (mwtm msglogdir), report files (mwtm repdir), or address table files (mwtm atbldir) reside.When you enter this command, the MWTM also prompts you to enable TFTP file transfer for the DPC Route staging directory and for the TFTP path for the directory, tftp://hostname/path, where:
•
If you enter a DNS name (such as mwm-jumbo) instead of an IP address (such as 172.18.12.10), then the ITP must be able to resolve the DNS name; otherwise, when you try to deploy a file, the MWTM issues an appropriate error message and does not deploy the file.
To enable the ITP to resolve DNS names, enter the ip domain-lookup command on the ITP. For more information about this command, see the Cisco IOS IP Command Reference, Volume 1 of 4: Addressing and Services, Release 12.3 or later.
•
After you change the directory or enable TFTP file transfer for the directory, the MWTM asks if you want to restart the MWTM server. The new directory and TFTP setting take effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
Note
mwtm routetabledefs
Server Only
Full Syntax
mwtm routetabledefs [true | false]
Command Description
Specifies whether the MWTM should automatically populate the Route Table dialog box with default values:
•
•
When you enter this command, the new setting takes effect when you restart the MWTM server.
You must log in as the root user or superuser to use this command.
mwtm start atblclient
Server and all Clients
Full Syntax
mwtm start atblclient [hostname]
Command Description
Starts an MWTM Address Table Editor client on the specified host. If no hostname is specified, starts an MWTM Address Table Editor client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
If you access a remote workstation through Telnet, you must set the DISPLAY variable to your local display or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
This command has the same function as the mwtm atblclient command.
mwtm start gttclient
Server and all Clients
Full Syntax
mwtm start gttclient [hostname]
Command Description
Starts an MWTM GTT client on the specified host. If no hostname is specified, starts an MWTM GTT client on the default host, as specified during installation. See Connecting to a New Server, page 5-42 for information about determining the default host.
If you access a remote workstation through Telnet, you must set the DISPLAY variable to your local display or you cannot use this command. If the DISPLAY variable is not set automatically, you must set it manually (see Setting the DISPLAY Variable for Solaris or Linux Clients, page 4-3).
This command has the same function as the mwtm gttclient command.
mwtm statreps 15minage
Server Only
Full Syntax
mwtm statreps 15minage [number-of-days]
Command Description
Maximum number of days the MWTM should archive 15-minute network statistics reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
This command has the same function as the mwtm rep15minage command.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps acct
Server Only
Full Syntax
mwtm statreps [acct | noacct]
Command Description
Specifies whether the MWTM should generate MTP3 accounting statistics reports:
•
•
Note
See MTP3 Accounting Reports, page 12-43 for more information on MTP3 accounting statistics reports.
You must log in as the root user or superuser to use this command.
mwtm statreps clean
Server Only
Command Description
Removes all data from MWTM network statistics reports, restoring the reports to an unchanged state.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps cleancustom
Server Only
Full Syntax
mwtm statreps cleancustom [tag]
Command Description
Removes all data from one or more MWTM custom statistics reports, restoring the reports to an unchanged state. To clean:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps custage
Server Only
Full Syntax
mwtm statreps custage [number-of-days]
Command Description
Maximum number of days the MWTM should archive custom reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 10 days.
This command has the same function as the mwtm repcustage command.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps dailyage
Server Only
Full Syntax
mwtm statreps dailyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive daily network statistics reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 90 days.
This command has the same function as the mwtm repdailyage command.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps diskcheck
Server Only
Full Syntax
mwtm statreps [diskcheck | nodiskcheck]
Command Description
Specifies whether the MWTM should verify that a disk has at least 10 MB of space remaining before generating network statistics reports:
•
•
If your system does not return the necessary amount of free space, in a correct format that the MWTM can parse, use this command to disable checking to allow reporting to continue.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps enable
Server Only
Full Syntax
mwtm statreps [disable | enable]
Command Description
Use to generate network statistics and accounting reports:
•
•
You must enter this command to generate network statistics and accounting reports before entering the mwtm accstats, mwtm gttstats, mwtm linkstats, mwtm mlrstats, and mwtm xuastats commands.
See Chapter 12, "Managing ITP Reports" for more information on network statistics and accounting reports.
You must log in as the root user or superuser to use this command.
mwtm statreps export
Server Only
Full Syntax
mwtm statreps [export | noexport]
Command Description
Specifies whether the MWTM should generate network statistics and accounting reports in export format:
•
•
Network statistics reports in export format are .zip files that contain comma-separated value (CSV) text files that you can download and unzip.
You must log in as the root user or superuser to use this command.
Related Topic
Enabling ITP Reports, page 12-2
mwtm statreps gtt
Server Only
Full Syntax
mwtm statreps [gtt | nogtt]
Command Description
Specifies whether the MWTM should generate GTT accounting statistics reports:
•
•
Note
See GTT Accounting Reports, page 12-41 for more information on GTT accounting statistics reports.
You must log in as the root user or superuser to use this command.
mwtm statreps hourlyage
Server Only
Full Syntax
mwtm statreps hourlyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive hourly network statistics reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 31 days.
This command has the same function as the mwtm rephourlyage command.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps iplinks
Server Only
Full Syntax
mwtm statreps [iplinks | noiplinks]
Command Description
Specifies whether the MWTM should include links that use the Stream Control Transmission Protocol (SCTP) IP transport protocol in network statistics reports:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps link
Server Only
Full Syntax
mwtm statreps [link | nolink]
Command Description
Specifies whether the MWTM should generate link and linkset statistics summary reports:
•
•
Note
You must log in as the root user or superuser to use this command.
mwtm statreps maxcsvrows
Server Only
Full Syntax
mwtm statreps maxcsvrows [rows]
Command Description
Specifies the maximum number of rows that the MWTM includes in export CSV files:
•
Note
This command only applies to these files:
•
•
•
See Rolling Network Statistics Archived Reports, page 12-71 and Daily MTP3 Accounting Statistics Archived Reports, page 12-45 for more information on affected CSV files.
You must log in as the root user or superuser to use this command.
mwtm statreps mlr
Server Only
Full Syntax
mwtm statreps [mlr | nomlr]
Command Description
Specifies whether the MWTM should generate MLR accounting reports:
•
•
Note
See MLR Reports, page 12-33 for more information on MLR reports.
You must log in as the root user or superuser to use this command.
mwtm statreps monthlyage
Server Only
Full Syntax
mwtm statreps monthlyage [number-of-days]
Command Description
Maximum number of days the MWTM should archive monthly network statistics reports.
If you enter this command without the number-of-days argument, the MWTM displays the current maximum number of days. You can then change that value or leave it. The valid range is 1 day to an unlimited number of days. The default value is 3650 days.
This command has the same function as the mwtm repmonthlyage command.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps msu
Server Only
Full Syntax
mwtm statreps [msu | nomsu]
Command Description
Specifies whether the MWTM should generate MSU rates reports:
•
•
See MSU Rates Reports, page 12-39 for more information on MSU rates reports.
You must log in as the root user or superuser to use this command.
mwtm statreps nullcaps
Server Only
Full Syntax
mwtm statreps [nullcaps | nonullcaps]
Command Description
Specifies whether the MWTM should include SCTP links that do not have planned send and receive capacities in network statistics reports:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps q752
Server Only
Full Syntax
mwtm statreps [q752 | noq752]
Command Description
Specifies whether the MWTM should generate Q.752 daily statistics reports:
•
•
Note
You must log in as the root user or superuser to use this command.
mwtm statreps servratio
Server Only
Full Syntax
mwtm statreps servratio [factor]
Command Description
Displays a red ball in the In-Service cell in a network statistics report, if this condition is met:
Current In-Service < factor * Long-Term In-Service
The default value for factor is 0.95. Therefore, when the percentage of time that a link is in service (for an hour) falls below 95% of the long-term in-service percentage for that link, a red ball appears in the In-Service cell.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps status
Server Only
Command Description
Displays the current status of all MWTM network statistics report parameters. You use the other mwtm statreps commands, such as mwtm statreps [disable | enable] and mwtm statreps [diskcheck | nodiskcheck] to set these parameters.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps timemode
Server Only
Full Syntax
mwtm statreps timemode [12 | 24]
Command Description
Sets the time mode for dates in network statistics reports:
•
•
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps timer
Server Only
Command Description
Displays the timer file for MWTM network statistics reports. The timer file is useful for identifying how much time the MWTM spends gathering report data and generating reports.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps utilratio
Server Only
Full Syntax
mwtm statreps utilratio [factor]
Command Description
Displays a red ball in the Send Utilization or Receive Utilization cell in a network statistics report, if this condition is met:
Current Utilization > factor * Long-Term Utilization
The default value for factor is 1.50. Therefore, if the link utilization for a particular hour is more than 150% of the long-term average for that link, the red ball appears in the Send Utilization or Receive Utilization cell.
You must log in as the root user or superuser to use this command.
Related Topic
Customizing ITP Report Preferences, page 12-7
mwtm statreps xua
Server Only
Full Syntax
mwtm statreps [xua | noxua]
Command Description
Specifies whether the MWTM should generate statistics reports for application servers and application server processes:
•
•
Note
See Application Server Reports, page 12-11 and Application Server Process Reports, page 12-14 for more information on statistics reports for application servers and application server processes.
You must log in as the root user or superuser to use this command.
mwtm xuastats
Server Only
Full Syntax
mwtm xuastats [node-list [id-tag]] [sort-option] [quiet]
Command Description
Generates MWTM accounting statistics reports for application servers and application server processes. To:
•
–
–
For example:mwtm-75-59a.cisco.com:
To specify a node name and signaling point:
mwtm-75-59a.cisco.com;net0:
–
–
If you specify a node-list, you can also specify an id-tag to identify the reports. The id-tag can be any meaningful character string, but it cannot contain any spaces. The default value for id-tag is the process ID of the mwtm xuastats command.
•
–
–
•
–
–
–
–
–
–
•
Before entering this command, you must enable the MWTM to generate accounting statistics reports for application servers and application server processes. See the description of the mwtm statreps [xua | noxua] command for more information.
The first time you use the mwtm xuastats command to generate a report, you must enter the command at least twice. The:
•
•
Thereafter, you need only enter this command once to generate the report.
You must log in as the root user or superuser to use this command.
Related Topic
