4.44 Report_PhoneDeregAudit

Use this Knowledge Script to create a history of phone deregistrations and reregistrations. This script uses the data stored in the CiscoCM supplemental database and collected by the PhoneDeregistrations script.

The completed Phone Deregistrations Audit report contains a column titled “Entry Type.” In this column, you might occasionally see an entry of “Reregister - Missed.” This entry indicates a phone that has, apparently, deregistered and then reregistered within a single iteration of this script. AppManager can tell something happened because the timestamp on the reregistration is different from the last time the phone was polled. However, because the phone is registered, AppManager is unable to determine exactly what transpired.

4.44.1 Prerequisite

For the AppManager for Cisco Unified Communications Manager module, the Report agent pulls data from the CiscoCM supplemental database rather than from the AppManager repository. The netiqmc service on the Report agent computer must be running as an account that has permission to access the supplemental database you created using the SetupSupplementalDB Knowledge Script. The Report agent and supplemental database must be located on the same computer for the PhoneDeregAudit report to work.

4.44.2 Resource Object

Report agent

4.44.3 Default Schedule

By default, this script runs once.

4.44.4 Setting Parameter Values

Set the following parameters as needed:

Parameter

How to Set It

Data Source

Select cluster

Select the Communications Manager cluster for which you want to create a deregistered phone audit report.

CiscoCM SQL instance

Specify the SQL instance that contains the CiscoCM supplemental database from which the report should pull data. Use the same SQL instance you specified in the PhoneDeregistrations script parameters.

Leave this parameter blank to accept the default instance.

Select time range

Select a Specific or Sliding date/time range from which the report should pull data. The default is Sliding.

Search Criteria

Note for entering search criteria: If you enter only the wildcard (*) for a field (such as Partition name), then AppManager matches only those deregistered phones that have a value for that field. Phones for which that field has no value (i.e., is NULL) will not be matched. For example, if you enter * in the “Partition name” parameter, then the search matches only those phones that have been configured for some partition name. To match all deregistered phones (including phones that have no value for the selected field), leave the search criteria parameter blank.

Directory number

Type the directory number for which you want to identify phone deregistrations.

Device name

Type the name of the device for which you want to identify phone deregistrations.

Device IP address

Type the IP address of the device for which you want to identify phone deregistrations. You can use one of the following formats:

  • Single dotted-decimal IP address, such as 10.41.2.31

  • Dotted-decimal IP address that includes a wildcard, such as 10.41.*.*, which would search for all IP addresses in the range of 10.41.0.0 to 10.41.255.255.

  • Range of dotted-decimal IP addresses separated by a hyphen, such as 10.41.2.31-10.41.2.41. The first address indicates the beginning of the range; the second IP address marks the end of the range.

Device pool

Type the name of the device pool for which you want to identify phone deregistrations.

Location

Type the name of the device location for which you want to identify phone deregistrations.

NOTE:The device location is the location configured on the Communications Manager.

Partition name

Type the name of the partition for which you want to identify phone deregistrations.

Report Settings

Order rows by?

Select the column by which you want to sort the rows in the report. The default is DeregTimeDescending.

Show outage time in minutes or seconds?

Select whether the Outage Time column of the report displays the deregistration period in Minutes or Seconds. The default is Minutes. The outage time is calculated as the difference between the time of deregistration and the time of reregistration.

Include parameter help card?

Select y to include a table in the report that lists parameter settings for this script. The default is y.

Select output folder

Set parameters for the output folder. The default folder name is PhoneDeregistrationAudit.

Add job ID to output folder name?

Select y to append the job ID to the name of the output folder. The default is n.

A job ID is helpful for making the correlation between a specific instance of a Report script and the corresponding report.

Select properties

Set miscellaneous report properties as desired. The default report name is Phone Deregistration Audit.

Add time stamp to title?

Select y to append a time stamp to the title of the report, making each title unique. The default is n. The time stamp is made up of the date and time the report was generated.

Adding a time stamp is useful in order to run consecutive iterations of the same report without overwriting previous output.

Event Notification

Raise event if report succeeds?

Select y to raise an event when the report is successfully generated. The default is y.

Event severity when report succeeds

Set the severity level, from 1 to 40, to indicate the importance of an event in which the report is successful. The default is 35.

Event severity when report has no data

Set the severity level, from 1 to 40, to indicate the importance of an event in which the report contains no data. The default is 25.

Event severity when report fails

Set the severity level, from 1 to 40, to indicate the importance of an event in which the report fails. The default is 5.