Table Of Contents
Managing the Collection Manager
Collection Manager Support Information
Configuring the Collection Manager
Installing the Periodic Checker
How to Monitor the Collection Manager
Checking the Database Capacity
Managing the Collection Manager
Revised: July 23, 2009, OL-7208-10Introduction
This chapter explains how to use utility scripts to view and update collection manager (CM) parameters.
Any machine connected to the CM through, for example, Telnet or SSH, can use utility scripts to monitor and manage the CM. The utility scripts are located in the installation directory of the CM.
For information on managing the database and the CSV repository, see Managing Databases and the Comma Separated Value Repository, page 5-1.
•
Collection Manager Support Information
•
•
Using Utility Scripts
General instructions for using utility scripts include:
•
•
Note
The following example shows how to display a description of the dbperiodic.py script.
>~scmscm/scripts/dbperiodic.py --helpUsage: ~scmscm/scripts/dbperiodic.py --load load configuration from /export/home/scmscm/db_maint/dbperiodic.conf ~scmscm/scripts/dbperiodic.py --loadfile=FILE load configuration from FILE ~scmscm/scripts/dbperiodic.py --dump print the current configuration in INI format to standard output ~scmscm/scripts/dbperiodic.py --help print this help message
Note
Collection Manager Support Information
If you are experiencing difficulties with the CM installation, it may be necessary to provide the Cisco Technical Assistance Center (TAC) with information about the current system setup. The CM can create the required support information or files for TAC by running one of the following scripts:
•
•
The output is a zip file with the investigation supporting files. The following example shows the output that appears when running this script:
bash-2.05$ ~scmscm/unsupported/getinfo/get_support_files.shGathering support files into Sun_14_Oct_2007_06-05-03_PM_JST.zip, please wait................done.The generated support file contains the output of ~scmscm/unsupported/getinfo/get_cm_info.shConfiguring the Collection Manager
Use utility scripts to:
•
•
•
•
Use the following scripts to configure the CM:
•
•
•
•
For information about scripts for managing the database and the CSV repository, see Managing Databases and the Comma Separated Value Repository, page 5-1.
The following files are also used to configure the CM:
•
•
Activating Servers
To set which servers (CM or Sybase) are activated at startup, use the on-boot.py script:
~scmscm/setup/on-boot.py --cm=flag --sybase=flagChanges take effect the next time the system restarts.
Note
To restart the CM, run the following script as the scmscm user:
~scmscm/cm/bin/cm restart
Table 4-1 on-boot.py Options
--cm={ on | off }Activate/do not activate the CM at startup.
--sybase={ on | off }Activate/do not activate the Sybase server at startup.
The following example shows how to set the CM and Sybase servers to be activated at startup. (This is the default setting of the script.)
>~scmscm/setup/on-boot.py --cm=on --sybase=onControlling Adapters
To shut down or bring up a configured adapter, or to list the currently running CM adapters, use the adapterconf.py script:
~scmscm/scripts/adapterconf.py --op=action [ --adapter=adapter name ]
To shut down an adapter, as the scmscm user, run the following script:
~scmscm/scripts/adapterconf.py --op=stop --adapter=adapter nameTo bring up an adapter, as the scmscm user, run the following script:
~scmscm/scripts/adapterconf.py --op=start --adapter=adapter nameEnabling Adapters
You can define an adapter to turn on when the CM starts by removing the remark character at the start of the appropriate line in the cm.conf file.
The following example shows how to define the RAG adapter to turn on when the CM starts.
adapter.4 = com.cisco.scmscm.adapters.rag.RAGAdapterThe following example shows how to define the CSV adapter to remain off when the CM starts.
#adapter.2 = com.cisco.scmscm.adapters.CSVAdapter
Note
Dropping an SCE Connection
To drop a connection to a particular SCE, use the sceconf.sh script:
~scmscm/scripts/sceconf.sh --op=drop --ip=IP addressThis script can be used only if the HTTP adaptor of the CM is running.
This script is also used to display information about the SCE connection. (See Checking the SCE Connection)
Table 4-3 sceconf.sh Options
Drop the connection at the specified IP address.
Display these options.
To drop an SCE connection, as the scmscm user, run the following command:
~scmscm/scripts/sceconf.sh --op=drop --ip=IP addressConfiguring Databases
To configure a database, use the dbconf.sh script:
~scmscm/scripts/dbconf.shThe script prompts you to choose the database type and the corresponding database configuration parameters.
The following example shows how to use the dbconf.sh script to configure the CM to work with an external Oracle database:
$ ~scmscm/scripts/dbconf.shEnter the DB type:1 - Oracle2 - MySQL3 - Sybase (external not bundled)Enter your choice: 1Enter Oracle server host (current is localhost) :10.56.216.80Enter Oracle server listening port (current is 1521) :Enter Oracle server instance id (current is apricot) :Enter CM schema user name (current is pqb_admin) :Enter CM schema user password (current is pqb_admin) :Do you want to test the DB connection? (yes/no): yesPASS:db is upDB connection succeeded.$Configuring the Categorizer
The Categorizer classifies each RDR according to its RDR tag. An RDR can be routed to a specific adapter by adding its RDR tag to the tags parameter (a comma-separated list of RDR tags) of the adapter. This configuration is contained in the queue.conf file.
The following example configures the RDR tags 4042321920 and 4042321922 to be sent to the topper/aggregator adapter.
# Topper/Aggregator Adapter [topper-hi] adapter_id=3 priority=3 warning_size=40000 maximum_size=50000 tags=4042321920,4042321922
Note
Monitoring System Health
The CM contains a small, expandable framework that monitors the system and issues alerts for predefined, potentially problematic conditions.
The following scripts are used to monitor the CM:
•
•
Installing the Periodic Checker
To make (or remove) an entry for monitor.sh, the periodic checker script, in the cron (periodic scheduler) subsystem, use the setup-monitor.sh script:
~scmscm/setup/monitor/setup-monitor.sh -a flag [ -I flag ]
The following example shows how to install monitor.sh so that it runs one time every 30 minutes.
$ ./setup-monitor.sh -a install -I 30mThe following example shows how to uninstall monitor.sh.
$ ./setup-monitor.sh -a uninstallPeriodic Checker Script
Periodic Checker Script
The periodic checker script, monitor.sh, calls a series of subscripts that monitor different aspects of a running system:
~scmscm/setup/monitor/monitor.sh { -a | TEST NAME } [ -v ] [ -d ]The script is not intended to be run from the command line, although you can do so. Test results are sent to the syslog subsystem and are logged in the file /var/log/messages.
Any test that is run returns a result in the following format:
STATUS: Message•
•
For example, FAIL: db "apricot" has only 1523 free blocks
The following example shows how to run all available tests and print system output to the window.
$ ./monitor.sh -d -aTest: 01free_db.sh. Status: PASS. Message: db apricot has 1532 free blocks Test: 02cm_is_up.sh. Status: FAIL. Message: cm process is not runningThe following example shows how to run one test to check that the installed database has sufficient free space.
$ ./monitor.sh -d free_dbTest: 01free_db.sh. Status: PASS. Message: db apricot has 1532 free blocksTests
The following tests can be run using monitor.sh:
•
•
•
•
•
The scripts for all these tests are located in the ~/setup/monitor/tests directory.
When calling a test called test_name, the script expects to find a file called NNtest_name.sh, where NN is a number that denotes script priority. For example, the test free_db is mapped to the file 01free_db.sh.
Managing Users
The CM uses the p3rpc utility to manage users for authenticated RPC calls.
The command format is: p3rpc OPERATION [OPTIONS]
The following table lists p3rpc operations and options.
Examples
The following example shows how to add and update the username and password:
bash-2.05$ p3rpc --set-user --username=lulu --password=liliCommand terminated successfully bash-2.05$The following example shows how to validate username and password. In this example, the user is successfully validated.
bash-2.05$ p3rpc --validate-password --username=lala --password=lalaLocal machine: user lala was authenticated successfully : (auth level root) Command terminated successfully bash-2.05$The following example shows how to validate username and password. In this example, the user validation fails.
bash-2.05$ p3rpc --validate-password --username=lala --password=luluError - Failed to authenticate user lala bash-2.05$The following example shows how to delete a user configuration.
bash-2.05$ p3rpc --delete-user --username=luluCommand terminated successfully bash-2.05$The following example shows how to display all of the configured users. In this example, only one configured user exists: clu.
bash-2.05$ p3rpc --show-usersclu Command terminated successfully bash-2.05$Managing Virtual Links
A script is included in the CM distribution to allow you to manage virtual link names and indexes that are configured for a specific SCE.
To show or set virtual links, use the update_vlinks.sh script:
~scmscm/cm/bin/update_vlinks.sh --sce=SCE IP address [ --file=file | --show ]
To set the virtual link details, as the scmscm user, run the following command:
~scmscm/cm/bin/update_vlinks.sh --sce=SCE IP address --file=fileThe CSV file format is: link id (positive integer), link direction (0=upstream, 1=downstream), name (string).
The following validation steps are performed on the file:
•
•
•
•
•
•
After the file is successfully validated, the script performs the following actions:
1.
2.
–
–
3.
To show the virtual link details, as the scmscm user, run the following command:
~scmscm/cm/bin/update_vlinks.sh --sce=SCE IP address --showHow to Monitor the Collection Manager
You can use scripts to monitor system statistics that are relevant to the CM, such as:
•
•
•
•
•
The following scripts are used to monitor the CM:
•
•
•
•
•
•
•
The following scripts are used to configure the CM (see Configuring the Collection Manager), but can also be invoked to display the relevant configuration:
•
•
Checking the Database Capacity
To display the percentage of free space in the database report tables and the associated transaction log, use the dbfree.sh script:
~scmscm/scripts/dbfree.shThe script can be used only with a bundled database.
Step 1
Checking the RDR Rate
To display the momentary total rate of reports entering the CM, use the rdr-rate.py script
~scmscm/scripts/rdr-rate.pyThe output is a single floating-point number representing the total rate per second of incoming RDRs (from all sources) that have entered the CM in the past 5 seconds.
This script can be used only if the HTTP adaptor of the CM is running.
Step 1
Checking the SCE Connection
To display information about the SCE connections, use the sceconf.sh script:
~scmscm/scripts/sceconf.sh --op=listThis script can be used only if the HTTP Adaptor of the CM is running.
The script is also used to drop a connection from a particular SCE. See Dropping an SCE Connection.
Step 1
~scmscm/scripts/sceconf.sh --op=listExample:
The following example shows SCE connection output:
>~scmscm/scripts/sceconf.sh --op=listIP Rate Peak ------- ------- ------- 10.1.6.93 0.71798986 0.718 10.1.9.36 0.14420895 0.1442139 10.1.9.35 0.0 0.027929332 10.1.12.11 0.0 0.0
Verifying Server Operation
To verify that the server is functioning correctly, use the alive.sh script:
~scmscm/setup/alive.shThe script verifies that the following components are operational:
•
•
•
If any component is down, the script issues an error message.
Step 1
Note
Viewing Database Statistics
To view the statistics of the CM database, use the p3stats command line utility (CLU).
~scmscm/cm/bin/p3stats [options]Table 4-8 lists the p3stats options.
Table 4-8 p3stats Options
Displays statistics information in the format <DB RDR tag> <RDR rate> <peak RDR rate>
Resets the statistics counters.
Note
The following example shows how to display the statistics of the CM database:
$ ~scmscm/cm/bin/p3stats --show-statsLUR { rate=0, peak=0 }MALUR { rate=0, peak=0 }TR { rate=0, peak=0 }VLUR { rate=0, peak=0 }NUR { rate=0, peak=0 }SUR { rate=0, peak=0 }MEDIA { rate=0, peak=0 }PUR { rate=0, peak=0 }Command terminated successfully$Viewing Version Information
The Collection Manager includes two scripts to display the current version of the Collection Manager and of the database:
•
•
The following example shows how to view the current Collection Manager version:
$ ~scmscm/cm/bin/cm versionCM CD Version 3.5.5 Build 336The following example shows how to view the current database version:
$ ~scmscm/cm/bin/cm dbversionSybase ase150/
