3 Administering Configuration Management

This chapter describes how to complete administrative tasks in Oracle Communications Configuration Management.

Using System Properties Files

This section describes how to perform administration tasks on Configuration Management using system properties files.

Using Logging Properties File

The system properties file, logging.properties, is located in the CM_Home/ConfigurationManagement/Config directory.

This is the default location and can be changed during installation.

Changing Logging Levels

The logging.properties file controls the logging level used in Configuration Management. This section provides instructions for changing the logging level.

Changing the logging level is recommended for troubleshooting purposes and should be done only by an administrator.

Table 3-1 describes the logging levels.

Table 3-1 Logging Levels

Level	User Type	Description
Fatal	Operator	Very severe errors that will most likely cause Configuration Management to stop or crash.
Error	Operator	Errors that are most likely recoverable and will allow Configuration Management to continue running.
Warn	Operator	Indicates a potentially harmful condition.
Info	Operator	Indicates the progress of an action performed in Configuration Management.
Debug	Administrator	Very detailed error messages that are useful only when debugging Configuration Management.

To change the logging level:

Open the CM_Home/ConfigurationManagement/Config/logging.properties file.
Search for the following line:
```
log4j.rootLogger=info, file
```
Change info to any of the levels listed in Table 3-1.

To enable full logging, uncomment the following line in the logging.properties file:

#log4j.logger.com.metasolv.oss.cm.impl=trace2#com.metasolv.util.logging.TraceLevel, file

Using Collector Properties Files

The system properties files, Collector.properties, CollectorIpsa.properties, and logging.properties, are located in the CM_Home/ConfigurationManagement/CMCollector directory.

This is the default location and can be changed during installation.

Changing Parameters in the Collector Properties files

Table 3-2 lists the parameters, definitions, and default values for the Collector.properties file. If you delete any of these parameters, the default values that exist in the Configuration Management software are used.

User login credentials, such as user name and password are encrypted in the CollectorIpsa.properties file.

Table 3-2 Collector.properties Parameters

Parameter	Description	Default
ORB Server port	Configuration Management Collector Port Number	2829
Aggregator Port	Aggregator Port Note: If you are using a managed server, this port must be the managed server port of WebLogic	7001
Collector Name	Collector Name	cm-collector-1
Time reading syslog	Time between reading in seconds.	60
Syslog locations	Location of the syslog.log file.	CM_Home/ConfigurationManagement/logs
Syslog message format file	Message format file of the Syslog.	CM_Home/ConfigurationManagement/CMCollector/SyslogMessageFormats.xml
IPSA Host	Host for IP Service Activator.	127.0.0.1
IPSA Home Dir	IP Service Activator Home Directory	CM_Home/ServiceActivator

Changing Logging Levels for Collector Properties

You can changing logging levels for collector properties. See "Changing Logging Levels" for more information.

Using Server Log Files

The server log files for Configuration Management include logging.log (for the main logs in the GUI and Engine) and cmuser.audit.log (for the user audit trail).

The server logs for Configuration Management are located in the WLS_home/user_projects/Domain_name/logging.log directory:

For example: /opt/Oracle/Middleware/user_projects/domains/CMDomain

Changing the Name of the logging.log File

To change the name of the logging.log file:

In the CM_Home/ConfigurationManagement/Config directory, open the logging.properties file in a text editor.
In the File output section, locate the following line and change the value logging.log to another file name, as shown in the following example:
```
log4j.appender.file.File=logging.log
```

Changing the Name of the cmuser.audit.log File

The cmuser.audit.log file tracks and reports user actions.

To change the name of the cmuser.audit.log file:

In the CM_Home/ConfigurationManagement/Config directory, open the logging.properties file in a text editor.
In the File output section, locate the following line and change the value cmuser.audit.log to another file name, as shown in the following example:
```
log4j.appender.userAudit.File=cmuser.audit.log
```

System Configuration Script

To create a schedule to archive device and network configurations, you must provision a role on the management interfaces for all of the devices that are managed. Do this manually by using the Configuration Management Administration GUI, or by executing a script that is packaged with the Configuration Management software.

The system configuration script ConfigMgmtRoleAssign.sh is located in the CM_Home/ConfigurationManagement/Scripts directory.

When you run the script, you are prompted to enter login credentials.

Running the Script

To provision a role, run the following script, in either the foreground or background, by using the following command:

./ConfigMgmtRoleAssign.sh

The CmRoleAssign.log log file is created in CM_Home/ConfigurationManagement You can also see the status of the script execution on the console.

If you run the script in the foreground, you can terminate it by using CTRL-C.

To stop a script running in the background:

Find the process you want to stop by using the following command:

ps –ef | grep Config

Text appears, similar to the following example:

root 16127 14862 0 19:49:08 pts/7 0:00 /bin/sh ./ConfigMgmtRoleAssign.sh

root 16128 16127 1 19:49:08 pts/7 0:02 /usr/jdk/jdk1.7.0_21/bin/java DPROPFILE_BASE=/CM_Home/Config

Stop all processes with a process ID (PID) associated with the ConfigMgmtRoleAssign process.

In the above example, two processes belong to the ConfigMgmtRoleAssign script (16127 and 16128). Stop both processes by using the following command:
```
kill -9 16127 16128
```

Managing the Database

Device configuration archives are stored in the Configuration Management database. Because a significant amount of data can accumulate in the database over time, you must purge archive records that are no longer required.

Purging Unlocked Archive Records from the Database

Running the database purge script purges unlocked archive records from the Configuration Management database. Configuration Management must be running in order for you to run the database purge script. A confirmation appears before the archive delete begins, allowing you to verify the operation before continuing. The logging.log file records the progress of the database purge operation.

After you start the database purge script, you cannot stop it. You can press CTRL-C to return to the console, but the script continues to run in the background.

The script purges records at a rate of 100 per minute: allocate sufficient time for the operation to complete.

The script BulkArchiveDelete.sh is in the CM_Home/ConfigurationManagement/Scripts directory.

Note:

After you enter the command to run either the database purge or bulk archive delete scripts, you are prompted for your IP Service Activator/Configuration Management user ID and password.

To run the database purge script:

Run the following command as the root user:

./BulkArchiveDelete.sh start_date end_date [IP_address]

where start_date and end_date are in the format mm/dd/yyyy and IP_address is either an IPv4 or IPv6 IP address, and is used to narrow the operation to records belonging to the specified address. If IP_address is omitted, the command purges all records for all devices between start_date and end_date.

For example, the command

./BulkArchiveDelete.sh 10/22/2013 04/22/2014 10.13.22.77

purges all device records for the device 10.13.22.77 between the dates October 22, 2013 and April 22, 2014.

The BulkArchiveDelete.log log file is created in CM_Home/ConfigurationManagement each time you run the database purge script.

Stopping and Starting Oracle WebLogic Server

WebLogic Server provides several ways to start and stop server instances. For information about starting and stopping a WebLogic server instance, see Oracle WebLogic Server documentation.

Reducing the ORB Message Timeout

You can customize the Configuration Management Server response time to reduce the ORB message timeout.

When the network that IP Service Activator is managing is over 10,000 devices, the OSS Integration Manager may take longer than the ORB default for message timeouts to respond to a Configuration Management requested device search. Increasing the ORB message timeout setting ensures that the Configuration Management client receives the proper data, and not a timeout notification, from an initiated device search.

Reducing the ORB message timeout increases the amount of time that the Configuration Management Server can wait for a response from the OSS Integration Manager when conducting a device search on a very large IP Service Activator network.

To reduce the ORB message timeout:

In the Configuration Management server WLS_home/user_projects/domains/Domain_name directory, open the startWeblogic.sh file.
Find the following line:
```
JAVA_OPTIONS="${SAVE_JAVA_OPTIONS}"
```

Replace it with the following:

JAVA_OPTIONS="${SAVE_JAVA_OPTIONS} -Dcom.sun.CORBA.transport.ORBTCPReadTimeouts=1:15000:300:1"

Save and close the file.

After you edit the file, you must restart the Configuration Management server for the change to take effect.

Restoring Configuration When the Device Model Contains Configlets

When performing a device restoration operation, if the device model contains one or more configlets that were created and persisted through Configuration Management, the commands are re-sent to the device even though the restored configuration has the configlets as part of the device model.

To restore a device configuration:

Log in to Configuration Management and display the domain containing the discovered device.
Create an archive for the device.
Select the device, click Actions, and select View/Modify Configuration.
Create a configlet and activate it.
Click Archive to create an archive.
Click the Configuration Archives link to display the archive list.
Select the check box for the archive you just created.
Click Restore, and select Complete Restore.

The device is restored and restarted, and it is left in Offline Test mode.
Select the device, click Actions, and select Put in Online Mode.

The configlet is pushed to the device.

Typically, when you restore the configuration to the device, no configuration commands are sent to the device. This is the only exception.

For complete details, see Configuration Management online Help.

Restarting After Adding a New Domain or Network

If you add a new domain or network to IP Service Activator, you must restart Configuration Management to see the new domain or network.

To restart Configuration Management:

In a browser, go to the WebLogic server console:

http://IP_address:Port/console

where IP_address is the WebLogic server domain IP address or hostname, and Port is the port on which the WebLogic server listens for traffic.
Log in using your WebLogic credentials.
Select Deployments.
Select the check box next to the ConfigurationManagement deployment.
Click the Stop button, and then select Force Stop Now.
Click the Start button, and then select Servicing All Requests.