Use this Knowledge Script to create an inventory of the phones configured in a Communications Manager cluster. You choose both the search criteria for the inventory and the location of the output folder (for the results file containing the inventory list). Unless you specify a UNC path (\\servername\sharename\directoryname\filename), the results file is written to the computer on which the NetIQ AppManager agent is running. If you specify a UNC path, ensure the NetIQmc service is running as an account that has the proper permissions on the UNC path.
You can determine the status, registered or deregistered, of Communications Manager phones for Unified Communications Manager clusters on which failover has occurred. Failover occurs when Communications Manager status changes from Primary to Backup.
Communications Managers that fail over contain only a list of phones that registered since failover occurred. They do not provide a list of phones that deregistered as a result of failover. To determine which phones have deregistered, use the PhoneInventory Knowledge Script.
To determine whether failover has occurred, use the RoleStatus or CCM_RegisteredResources script.
CiscoCM_Devices
By default, this script runs once.
Set the following parameters as needed:
|
Parameter |
How to Set It |
|---|---|
|
General Settings |
|
|
Job Failure Notification |
|
|
Event severity when job fails |
Set the event severity level, from 1 to 40, to indicate the importance of the failure of the PhoneInventory job. The default is 5. |
|
Raise event if phone inventory succeeds? |
Select Yes to raise an event when a phone inventory file is successfully generated. The default is Yes. |
|
Event severity when phone inventory succeeds |
Set the event severity level, from 1 to 40, to indicate the importance of an event in which the inventory file is successfully generated. The default is 25. |
|
Raise event if no records found? |
Select Yes to raise an event when the PhoneInventory job finds no phones based on the criteria you selected. The default is Yes. |
|
Event severity when no records found |
Set the event severity level, from 1 to 40, to indicate the importance of an event in which the PhoneInventory job found no phones based on the criteria you selected. The default is 25. |
|
Search Options |
|
|
Select by |
Choose the type of selection criteria you want to use to create the list of phones.
|
|
Selection criteria |
Type the selection criteria for the phones to be listed. You can specify the actual item or you can specify a pattern by using the * wildcard. For example, to monitor all the phones with device names that begin with SEP, enter SEP*. You can enter multiple items by separating each item with a comma. For example: SEP0009A*,SEP0009B* The items you enter must be of the same type as the Select by parameter. So if Select by is Name, then the items you enter must be device names or patterns. If Select by is DirectoryNumber, then the items you enter must be directory numbers or patterns. The default is blank. |
|
List only phones with status of |
To further filter the list of phones, select a status. Only phones of this status type, matching the criteria you specified in Selection criteria and Select by, will be included in the inventory list. Select from the following status types:
NOTE:Setting this parameter to a value of Not Registered will also list those phones with a status of Unregistered. |
|
Result File Options |
|
|
Full path to output folder for result file |
Type the full path or a UNC path to a location on the agent computer in which to save the inventory .csv file. The default path is blank. |
|
Order by |
Select Name to display the contents of the results file in order by phone name. The default is Name. Select DirectoryNumber to display the contents of the results file in order by directory numbers. If you select DirectoryNumber, also enable the Include directory number and partition columns in report? parameter. |
|
Include directory number and partition columns in report? |
Because a phone can be associated with multiple directory numbers and partitions, your inventory report can present the same phone several times, once for each directory number or partition. Select Yes to include the directory number and partition columns in the inventory, allowing multiple entries per phone. Deselect Yes to remove the directory number and partition columns from the inventory, allowing only one entry per phone. NOTE:You must select Yes if you selected any of the following parameter options:
|