Command
|
Description
|
backup.pl
|
Backs up the database.
$NMSROOT/bin/perl backup.pl backdir [logfilename [numberGen] ]
|
crmimport
|
Script used for CRM device data import. The crmimport command is a command line utility for the Resource Manager Essentials which is used to import device information from CiscoWorks(tm), CiscoWorks for Switched Internetworks(tm), HP OpenView(tm), Castlerock's SNMPc(tm) (on Windows only), or any other source of devices that can export lists of devices and their passwords. crmimport is similar to CRM's function Admin > Inventory > Import from File.
On Unix enter:
$NMSROOT/bin/crmimport.pl [-o | -d] importFile
On Windows enter:
$NMSROOT\bin\crmimport.cmd [-o | -d] importFile
|
cwconfig
|
CiscoWorks command line tool that allows you to access the configuration archive or configurations on devices. You can use cwconfig to update, export, and import configurations on devices and in the archive. You can also compare configurations and delete old configurations. To get a list of supported commands, run the command:
$NMSROOT/bin/cwconfig -help
Help on each command can be obtained as:
cwconfig command -help
For example:
cwconfig export -help
Additionally, man pages are available on UNIX installations for individual commands. To view the man page for any command, enter:
man cwc -command
|
cwinvcreport
|
CiscoWorks command line interface for the Inventory Custom Reports. cwinvcreport allows you to run the previously created Inventory Custom Reports. The output is displayed in comma separated value (CSV) format. You can re-direct the output to an e-mail recipient or to a file.
The log and the output files are created in the current directory. The report name should be given within double quotes.
$NMSROOT/bin/cwinvcreport [-d debuglevel] [-m email] [-l logfile] [-o outputfile] "reportname"
You could enable debug mode and set the debug using the -d option. You could mail the output to an e-mail recipient using the -m option. You could log the error messages to a file using the -o option.
• To display the list of existing reports, specify the -r option.
cwinvcreport -r
• To display cwinvcreport version information, specify the -v option.
cwinvcreport -v
• To display the usage information, specify the -h option.
cwinvcreport -h
|
cwexport
|
CiscoWorks command line interface for exporting inventory/config details into XML format.
The command line syntax of the application is in the following format:
$NMSROOT/bin/cwexport command arguments options
command specifies the core operation that is to be performed. The core commands are:
• inventory
This generates Inventory data in XML format.
• config
This generates configlets in XML format.
cwexport command {-u userid} {-p password} [-arg1 [arg1Value] -arg2 [arg2Value] ...... -argN [argNValue]]
The options that must be specified with all functions are:
• -u userid
This specifies the CiscoWorks username.
• -p password
This specifies the password for the CiscoWorks username.
For optional arguments, examples and more details, see the online help for Data Extracting Engine (DEE), or the manpage for this command:
man cwexport
You can also access man pages for each cwexport command by entering the command:
man cwe command
where command is the command name (for example, config).
|
dbpasswd.pl
|
Changes the database password along with its access configuration files.
$NMSROOT/bin/dbpasswd.pl {all | dsn=data source [opwd=old password] [pfile=properties file] | listdsn}
|
dbRestoreOrig.pl
|
Changes the database password along with its access configuration files.
Syntax:
$NMSROOT/bin/perl $NMSROOT/bin/dbRestoreOrig.pl dsn=dsnname dmprefix=dmprefixname [ npwd=newpassword ]
Where:
dsn=xxx
xxx is the ODBC data source name for the database
For Common Services, dsn=cmf
For Essentials, dsn=rme
dmprefix is required for constructing database engine process name.
For Common Services, dmprefix=Cmf
For Essentials, dmprefix=Essentials
All the user configurable variable parameters are case-sensitive. Ensure that you enter the exact value as mentioned here— if not, the database will get corrupted.
|
dig
|
Sends domain name query packets to name servers. Dig (domain information groper) is a flexible command line tool which can be used to gather information from the Domain Name System servers. Dig has two modes:
• Simple interactive mode which makes a single query
• Batch which executes a query for each in a list of several query lines.
All query options are accessible from the command line.
$NMSROOT/bin/dig [@server] domain [query-type] [query-class] [+query-option] [-dig-option] [%comment]
|
dmgtd
|
Process manager daemon. Specify the tcp port to use the Daemon Management protocol on. All clients will need to have the env var PX_DMGTHOST and env var set. Daemon Manager Protocol enabled applications can report additional status. Daemon Manager sends status information to Syslog (facility: LOG_DAEMON).
$NMSROOT/bin/dmgtd [ -p port -v] [ names ]
|
import_rme.pl
|
Restores RME files required for remote upgrade from RME 3.4.x and RME 3.3.x:
$NMSROOT/rigel/scripts/import_rme.pl
|
pdexec / pdshow / pdterm
|
Controls process manager.
$NMSROOT/bin/pdshow [ appName1 appName2 ... ]
$NMSROOT/bin/pdexec [ appName1 appName2 ... ]
$NMSROOT/bin/pdterm [ appName1 appName2 ... ]
• To get status of registered processes appName1, appName2, ..., send a request to CRM process manager using the command:
pdshow [appName1 appName2 ...]
• To start the registered process appName1 if it is not running, send a request to CRM process manager using the command:
pdexec appName1
• To stop the registered application appName1 if it is running send a request to CRM process manager using the command:
pdterm appName1
pdshow will show the status of all processes registered if no arguments are given.
pdexec and pdterm require one or more appNames.
where appNameN represents the registered name of each process that is registered with CRM process manager.
|
pdmsg
|
Broadcasts a string to all registered daemons under Daemon Management that are in the "Running Normally" state.
To use this command, Daemon Management server must be running.
$NMSROOT/bin/pdmsg msg-string
|
pdreg
|
Registers and unregisters applications with CRM Process Manager.
$NMSROOT/bin/pdreg [-r appName -e pgm [-f pgmFlags ] [-d dependencies ] [-n] [-t 0|p|n ] ] | [-u appName ] | [-l appName ]
• To register a process and invoke it without the -n or -t option.
pdreg -r appName
appName must be 25 alphanumeric characters or less.
• To unregister a process and shut it down if the process is running.
pdreg -u appName
• To list the registry for a particular daemon.
pdreg -l appName
|
pdrun.pl
|
A wrapper to run a command-line instruction within the CiscoWorks environment.
The command line instruction to be run needs to be double quoted as the argument. If the command-line instruction itself contains double quotes, precede it with a back slash.
To run a command line instruction within the CiscoWorks environment:
$NMSROOT/bin/perl pdrun "pdshow \"ANIServer jrm\""
|
ProxyAdminInterface.pl
|
A CiscoWorks command line instruction for initial recollection of data from Auto Update Server (Proxy Server).
$NMSROOT/bin/perl $NMSROOT/cgi-bin/import/ ProxyAdminInterface.pl
|
removeJrmJobs.pl
|
Removes all the existing JRM jobs from cmf database. This is used in remote upgrade from RME 3.4.x and RME 3.3.x.
$NMSROOT/rigel/scripts/removeJrmJobs.pl
|
removeRmeJobs.pl
|
Deletes all the Job Information from RME database. This is used in remote upgrade from RME 3.4.x and RME 3.3.x.
$NMSROOT/rigel/scripts/removeRmeJobs.pl
|
restorebackup.pl
|
Restores an earlier backup of the database.
$NMSROOT/bin/perl restorebackup.pl [-force] [-s groupName] [-gen generationNumber] {-d backup directory}
This script can be used for user-specific requirements to:
• Restore only one group. For this, use the '-s groupName' parameter.
• Restore all groups. For this, do not use the '-s' parameter.
• Installed suites that includes Common Services and Essentials.
• See a list of the available backed-up generations. For this, enter the following at the command line:
$NMSROOT/bin/perl restorebackup.pl -h {-d backup directory}
|
RmeJobCreateService.pl
|
Creates new jobs from exported RME job data into CiscoWorks system. Exported job data will be read from NMSROOT/rigel backup directory. Script will disable all the jobs after creation.
$NMSROOT/rigel/scripts/RmeJobCreateService.pl
|
RmeJobEnableService.pl
|
Enables all the jobs disabled by CiscoWorks upgrade or Job creation service.Information about list of jobs to be enabled is obtained from joblist.jrm and rmedisabledjobs.jrm under NMSROOT/setup directory.
$NMSROOT/rigel/scripts/RmeJobEnableService.pl
|
SampleEmailScript.pl
|
Wrapper around the OS specific mail program. Accepts the usual parameters like sender, subject, email_ids, text_message and sends the message to the intended recipient.
$NMSROOT/cgi-bin/sysloga/sampleEmailScript.pl -email_ids list of comma separated email addresses, -subject [subject of email] optional -from [from who] -sender [sender] -smtp [SMTP, needed for Windows], -text_message [message text, '\n' character is used to break up message into multiple lines]
|
uninstall.sh
|
Uninstallation program that removes files and settings. Uninstallation allows you to remove only Essentials or remove CiscoWorks CD One as well. To remove CD One, you must remove Essentials as well. Before removing Essentials, you must first remove any applications that depend on Essentials.
$NMSROOT/bin/uninstall.sh
|