3.5 CCME_GetConfig

Use this Knowledge Script to retrieve configuration data from one or more Communications Manager Express devices and deposit that data into SQL tables located in the Data Mart. By default, this script retrieves configuration data for all Communications Manager Express devices that have sent RADIUS records to the Data Source and have EFXS (virtual voice) ports through which ephones are connected. However, you can choose to limit the devices by using the “Include” and “Exclude” parameters.

This script raises an event if configuration data is retrieved and deposited successfully, if no Communications Manager Express devices are found, if the retrieve and/or deposit processes fail for any Communications Manager Express device, or if the entire GetConfig job fails for any reason.

The collected configuration data helps AppManager associate the virtual voice port from the RADIUS records with the IP address and device name of the associated Communications Manager Express phone. The data is also required by the Report_CCME_StatsByEPhone and Report_UnusedPhones Knowledge Scripts.

3.5.1 Prerequisites

  • Run AddDataSource_H323RADIUS.

  • Configure your AXL passwords in AppManager Security Manager. AVVID XML Layer (AXL), a Cisco application programming interface (API), enables Communications Manager Express to access the Communications Manager Express HTTP server.

    If your AXL password information is the same for all Communications Manager Express devices, complete the following procedure once. If your AXL password information is different for different devices, complete the following procedure once for each different password.

    On the Custom tab in AppManager Security Manager, complete the following fields:

Field

Description

Label

CiscoCME

Sub-label

  • For a single Communications Manager Express device, type the name of the device.

  • For all Communications Manager Express devices, type default.

NOTE:If you type a single device name, ensure the name is an exact match to the gateway name (h323-gw-id) or the NAS-IP-Address from the RADIUS records. If you are unsure of the gateway name or NAS IP address, run Discovery_CallDataAnalysis after IAS logs have been processed. The name of the gateway will appear in the TreeView pane under the H.323 Data Source object. To see the NAS IP address, click on the gateway name, and then click the Details tab.

Value 1

Type the AXL password you configured using the “og password” IOS command on the router. If you did not configure an AXL password, type the “Router privilege mode” password.

Extended application support

Enable to encrypt the AXL password. Do not leave this option unselected.

3.5.2 Resource Object

Call Data H.323 RADIUS object

3.5.3 Default Schedule

By default, this script runs once every day.

3.5.4 Setting Parameter Values

Set the following parameters as needed:

Parameter

How to Set It

General Settings

Include only these CallManager Express devices

Specify which Communications Manager Express devices (gateways) to poll for configuration data. Use this parameter to limit the number of “learned” devices that are polled or to poll devices that are not yet “learned.” A learned device is one that has already sent RADIUS records to the Data Source.

If you specify one or more unlearned devices, you must specify the gateway name that matches the name returned in the h323_gw_id field of the RADIUS record.

Leave this parameter blank to poll all learned Communications Manager Express devices for configuration data.

Separate the names of multiple devices with a comma and no space.

Exclude these CallManager Express devices

Specify which Communications Manager Express devices (gateways) to exclude from polling. Separate the names of multiple devices with a comma and no space.

Leave this parameter blank to exclude no devices.

Event Notification

Raise event if retrieve/deposit process succeeds?

Select Yes to raise an event if the configuration data is retrieved and deposited (into the Data Mart SQL tables) successfully. The default is Yes.

Event severity when retrieve/deposit process succeeds

Set the severity level, from 1 to 40, to reflect the importance of an event in which configuration data is retrieved and deposited successfully. The default is 25.

Raise event if no CallManager Express devices found?

Select Yes to raise an event if AppManager cannot find any Communications Manager Express devices to poll for configuration data. The default is Yes.

Event severity when no CallManager Express devices found

Set the severity level, from 1 to 40, to reflect the importance of an event in which AppManager can find no Communications Manager Express devices to poll. The default is 15.

Event severity when retrieve/deposit process fails

Set the severity level, from 1 to 40, to reflect the importance of an event in which any part of the retrieve and deposit process fails for any individual Communications Manager Express device.

This event is raised if the retrieve/deposit process fails for one or more Communications Manager Express devices, but succeeds for others.

The default is 10.

Event severity when job fails

Set the severity level, from 1 to 40, to reflect the importance of an event in which the GetConfig Knowledge Script job fails.