The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
You must perform discovery to manage devices in Cisco Prime Collaboration database. After adding the required device credentials, you can discover and manage all the supported devices in Cisco Prime Collaboration.
Discovery involves three phases:
Gets all the defined credential profiles, based on the IP address. See Manage Device Credentials to understand how to define the credential profiles.
Checks whether the SNMP credentials match.
Identifies the device types.
Verifies all other mandatory device credentials, based on the device type. If the mandatory credentials are not defined, discovery fails. See Manage Device Credentials for information on required device credentials.
Inventory discovery—Cisco Prime Collaboration polls MIB-II and other device MIBs to collect information on the inventory, neighboring switches, and default gateway. It also verifies whether the polled device is supported in Cisco Prime Collaboration.
Path trace discovery—Cisco Prime Collaboration verifies whether CDP is enabled on the device and discovers the topology, based on CDP. The links between the devices are computed using CDP and they are persisted in the Cisco Prime Collaboration database.
A device state indicates that Cisco Prime Collaboration is able to access the device and collect the inventory. The device state is updated only after performing either a discovery or an update inventory task.
The following diagram shows the device discovery lifecycle.
Cisco Prime Collaboration displays the following device states:
This is the preliminary state, when the device is first added. This is a transient state. |
|||
Unreachable |
Cisco Prime Collaboration is unable to ping the device using ICMP. If ICMP is not enabled on the device, the device is moved to the Unreachable state. |
||
Cisco Prime Collaboration compares the device with the device catalog. If the device does not match with the devices in the device catalog or the SysObjectID is not known, the device is moved to this state. For a list of devices supported by Cisco Prime Collaboration Assurance and Analytics—Business 11.5, see Supported Devices for Prime Collaboration Business 11.5 |
|||
Cisco Prime Collaboration is able to access the device through all mandated credentials. This is part of the access-level discovery, which is an intermediate (transient) state during the device discovery. |
|||
Cisco Prime Collaboration is not able to access the device through any of the mandated credentials. You must check the credentials and discover the devices. |
|||
The device is hidden from Inventory Management. However, the device is in the Cisco Prime Collaboration database and can be discovered. |
|||
Cisco Prime Collaboration is able to collect the required data using the mandated data collectors. This is part of the inventory discovery, which is an intermediate (transient) state during device discovery. |
|||
Cisco Prime Collaboration is not able to collect the required data using the mandated data collectors. Connectivity issues can be caused by SNMP or HTTP/HTTPS timeout. Also, if you use HTTP/HTTPS to collect data, only one HTTP/HTTPS user can log in at a time. If Cisco Prime Collaboration faces any of these problems, the device state is moved to the Undiscoverable state. You must perform a rediscovery. |
|||
Cisco Prime Collaboration has successfully imported the required device data to the inventory database. All conference, endpoints, and inventory data are available for devices in this state.
If the Cisco Prime Collaboration inventory exceeds your device limit, you will see a warning message. For information on how many devices Cisco Prime Collaboration can manage, see the Cisco Prime Collaboration Assurance and Analytics Install and Upgrade Guide. |
|||
Partially Managed |
Devices which are in managed state but have some credentials missing. These credentials are not mandatory for managing inventory, but required for all other features, such as conference monitoring to work. You can click on the corresponding number to cross launch to see a list of all devices in the inventory table which are managed but with insufficient credentials. This count is updated only when you perform rediscovery after adding the credentials. |
||
User has suspended monitoring of the device. Conference and endpoint data are not displayed for devices in this state. Periodic polling is also not performed for devices in this state. You cannot update inventory for these devices. To do so, you will need to perform Resume Management. See Suspend and Resume Managed Devices for details on suspended devices. |
Choose one of the following discovery methods to manage devices in Cisco Prime Collaboration:
Note | Endpoints and infrastructure devices that are not registered with any of the management applications, conferencing devices, or call processors cannot be discovered using logical discovery. Use ping sweep or direct discovery to discover these devices. |
Before performing the discovery, you must review the following and configure the devices as required:
If DNS is configured on a device, ensure that Cisco Prime Collaboration can resolve the DNS name for that device. Check the DNS Server configuration to make sure it is correct. This is critical for Cisco Unified CM, Unified Presence Server, Unity Connection devices. Cisco Prime Collaboration needs to resolve the hostnames for MGCP gateways. This is because, the MGCP gateway hostnames are not added to the DNS server generally as the gateways and Cisco Unified CM are capable of operating together without DNS resolution. However, the Cisco Unified CM does not resolve the hostnames for MGCP gateways, considering it as a FQDN.
CDP must be enabled on all network devices (routers and switches). For more information, see Configuring Cisco Discovery Protocol on Cisco Routers and Switches Running Cisco IOS.
You can discover the devices, such as endpoints, TelePresence server, and so on individually, except for . These endpoints are discovered only with the discovery of the call processor with which they are registered.
You must ensure that the device credentials that you have entered are correct. During the discovery process, based on the device that you want to discover, Cisco Prime Collaboration connects to the device by using HTTP/HTTPS, or SNMP.
When you add devices, the HTTP (and HTTPS) port numbers are optional. These settings are automatically detected.
Firewall devices are not supported.
If HTTP is used to retrieve device details, disable the HTTP firewall.
HSRP-enabled devices are not supported.
When you add devices that have multiple interfaces and HTTP administrative access, you must manage the devices in Cisco Prime Collaboration using the same interface on which you have enabled HTTP administrative access.
After discovering devices, if the IP address changes for network devices and infrastructure devices (such as Cisco Unified CM, Cisco MCU, Cisco VCS, Cisco TS, and so on), you must rediscover these devices by providing the new IP address or hostname. See Rediscover Devices for information on rediscovering devices.
If a managed device is removed from the network, it will continue to be in the Managed state until the next inventory collection occurs, even though the device is unreachable. If a device is unreachable, an Unreachable event for this device appears.
Configuration changes on a device are discovered by Cisco Prime Collaboration only during the inventory collection process. Therefore, any changes to a device’s configuration will not be shown by Cisco Prime Collaboration until the next inventory collection after the configuration change.
To periodically update inventory, and synchronize the inventory with the Cisco Prime Collaboration database, you must perform inventory update. For more information, see Update and Collect Inventory Details.
Cisco Prime Collaboration supports Unified Communications Manager cluster discovery. The Cluster IDs must be unique.
The Access Control List (ACL) in Unified Communications Manager must contain all endpoints to be managed. If the Unified Communications Manager SNMP user configuration includes the ACL, all Unified Communications Manager nodes in the cluster must contain the Cisco Prime Collaboration server IP address.
Cisco Prime Collaboration must discover and manage only the Unified Communications Manager publisher to manage a cluster. Subscribers are not discovered directly; they are discovered through the publisher. Cisco Prime Collaboration must manage the publisher to monitor a cluster. The Computer Telephony Integration (CTI) service must be running on all subscribers. You must ensure that the access control list in Unified Communications Manager contains all endpoints that need to be managed. If the Unified Communications Manager SNMP user configuration includes the use of the Access Control List, you must enter the Unified Communications Manager server IP address on all Unified Communications Manager nodes in the cluster.
Note | You can automatically configure syslog receiver and CDR billing application server only when Unified Communications Manager is in managed state in Cisco Prime Collaboration. |
The SNMP and HTTP credentials are mandatory for Cisco Unified CM publishers and subscribers.
After discovering Cisco Unified CM, if you have registered any new endpoints, you must rediscover Unified CM Publisher node to add them to Cisco Prime Collaboration. See Rediscover Devices for information on rediscovering devices.
Note | It is recommended that you should not add a subscribe node manually. |
For discovery of Cisco Cius and Cisco Unified IP Phone 8900 and 9900 series, you must enable the HTTP interface so these devices appear in the inventory table. See the "Enabling and Disabling Web Page Access" section in the Cisco Unified IP Phone 8961, 9951, and 9971 Administration Guide for Cisco Unified Communications Manager 7.1 (3) (SIP) for more information.
To enable Cisco Prime Collaboration to provide the correct phone count for the Cisco Unified CM Express and Cisco Unity Express (CUE), you must use the following configuration:
ephone 8 mac-address 001A.E2BC.3EFB type 7945
where type is equal to the phone model type. If you are unsure of your model type, see Cisco.com for details on all phone model types, or enter type?. For information on how phone counts are displayed, see the window in the Inventory Management page.
If a UC500 Series router is running Cisco Unified CM Express, you must configure "type" under ephone config for each phone so that the cmeEphoneModel MIB variable of CISCO-CME_MIB will return the correct phone model. This enables Cisco Prime Collaboration to discover the phones registered with Cisco Unified CM Express.
For a Cisco Unity Express that is attached to a Cisco Unified CM Express to display in the Service Level View, you must use the following configuration:
dial-peer voice 2999 voip <where voip tag 2999 must be different from voicemail> destination-pattern 2105 <prefix must be the full E.164 of configured voicemail 2105> protocol sipv2 target ipv4:10.10.1.121 dtmf-relay sip-notify codec g711ulaw no vad ! ! telephony-service voicemail 2105
where the dial-peer VoIP tag, 2999, is not equal to the voice mail number, and the destination-pattern tag, 2105, is equal to the voice mail number. This will allow Unity Express to display properly in the Service Level View.
Note | Even if one VCS in a cluster is not in a managed state, there will be inconsistencies in data reporting. |
After discovering Cisco VCS, the newly registered endpoints are automatically discovered. Also, if there any changes in the endpoint IP address, Cisco Prime Collaboration detects the IP address change automatically.
If the Cisco VCS Expressway is configured within the DMZ, Cisco Prime Collaboration must be able to access the Cisco VCS Expressway through SNMP. If it cannot, then this device is moved to the Inaccessible state. For more information on setting up devices for Cisco Prime Collaboration 11.5, see the Configure Devices for Prime Collaboration Assurance wiki page.
If you login to Cisco TMS using the <domain/username> format, then ensure that you add the same <domain/username> value for the HTTPS credentials in the HTTP(s) Username field. In case the HTTP(s) Username does not match, discovery of that Cisco TMS will fail.
If you have Cisco MSE Supervisor, ensure that it is registered with the Cisco TMS.
Cisco Prime Collaboration cannot manage two standalone Cisco TMS. If you are using more than one Cisco TMS, you must configure in a cluster for the Cisco Prime Collaboration application to manage. Before performing the discovery, enter the IP address of the primary active server and the secondary active or passive server details in .
Cisco Prime Collaboration supports Cisco TelePresence Conductor XC in the standalone model. The cluster model is not supported.
For Cisco Prime Collaboration Release 11.6 and later
Note | Cisco Prime Collaboration Assurance does not support CMR reports and Endpoint diagnostic feature for ciscoDX70 and ciscoDX80 devices with CE image. |
You can discover seed or publisher devices with endpoints and subscriber devices registered to them.
Note |
|
To discover clusters using logical discovery, you must discover the publisher of the cluster, which will automatically discover its subscribers and all the endpoints and infrastructure devices registered with both publisher and subscribers.
If the IP address of a DHCP-enabled endpoint registered with Cisco Unified CM, Cisco Prime Collaboration may not be able to automatically discover this endpoint. This is applicable to all Cisco TelePresence systems registered with Cisco Unified CM.
When a Unified Communications Manager publisher is added to Cisco Prime Collaboration using auto discovery User Interface, the configured ELM or PLM also gets discovered and managed. This is possible only if Cisco Prime Collaboration has the credential profile with ELM or PLM device type and right IP address pattern.
To discover Unified Contact Center devices, you must enter the CVP - OAMP server as the seed device for the task.
Managing Device Credentials: The required credentials must be entered before performing discovery.
Discovery Methods: Based on your deployment, select the appropriate discovery methods.
Prerequisites and Recommendation: Configure the required settings on the devices and review the recommendations.
Setting up Clusters: If you are managing multiple Cisco TMS clusters, you need to enter specific application details.
Step 1 | Choose . | ||
Step 2 | In the Inventory Management page, click Auto Discovery. | ||
Step 3 | Enter the job name, and check the Check Device Accessibility check box. | ||
Step 4 | Select a discovery method.
For information on the best discovery option to use, see
Prerequisites and Recommendations.
| ||
Step 5 | Enter the IP address or
hostname of the device. For various discovery protocols, enter the following:
Example:
| ||
Step 6 | (Optional) Enter the Filter and Advanced Filter details (available only for logical, CDP and ping sweep discovery methods). You can use a wildcard to enter the IP address and DNS information that you may want to include or exclude. See Discovery Filters for field descriptions. | ||
Step 7 | (Optional) If
you have selected
"Communications
Manager (UCM) Cluster and connected devices" from the
Discover drop-down list in
Step 4,
you must uncheck the
Add the
Prime Collaboration Server as a CDR Destination in the Unified CM
Servers check box from the Auto-Configuration pane if you do not
want to enable automatic configuration of CDR billing server on Unified
Communications Manager servers.
| ||
Step 8 | (Optional) If
you have selected
"Communications
Manager (UCM) Cluster and connected devices" from the
Discover drop-down list in
Step 4,
you must uncheck the
Add the
Prime Collaboration Server as a Syslog Destination in the Unified CM
Servers check box from the Auto-Configuration pane if you do not
want to enable automatic configuration of syslog receiver on Unified
Communications Manager servers.
| ||
Step 9 | Schedule a periodic discovery job (see Discovery Filters for field descriptions) or run the discovery job immediately by following Step 10. | ||
Step 10 | Click
Run
Now to immediately run the discovery job, or click
Schedule to schedule a periodic discovery job to run
at a later time. If you have scheduled a discovery, a notification appears
after the job is created. You can click Job Progress to view the job status on
the job management page. Or, if you have run the discovery immediately, you can
click Device Status Summary hyperlink to know the current state of the device
being discovered.
|
Issue: Cisco Prime Collaboration is not added as a CDR application billing server in the device.
Ensure that Unified Communications Manager publisher is added in Cisco Prime Collaboration by using the "Auto Discovery" option.
Ensure that the device is in managed state after you discover the inventory. Also, the device should appear as a Call Quality Data Source under
.In the Unified Communications Manager Administration page, select the Serviceability page and navigate to CDR Management page. Ensure that at least one slot of CDR Billing Server is available so that automatic configuration can occur.
Issue: Cisco Prime Collaboration is not added as a Remote Syslog receiver in the device.
Recommended Action:
Ensure that Unified Communications Manager publisher is added in Cisco Prime Collaboration by using the "Auto Discovery" option.
Ensure that the device is in managed state after you discover the inventory.
In the Unified Communications Manager Administration page, select the Serviceability page and navigate to
. Ensure that at least one slot of Syslog Receiver is available so that automatic configuration can occur.The following table describes the filters that are available when you run discovery.
Comma-separated IP addresses or IP address ranges for included or excluded devices. For the octet range 1-255, use an asterisk (*) wildcard, or constrain using [xxx-yyy] notation; for example:
You can use both wildcard types in the same range; for example, 172.20.[55-57].*. If both include and exclude filters are specified, the exclude filter is applied before the include filter. After a filter is applied to an auto-discovered device, no other filter criterion is applied to the device. If a device has multiple IP addresses, the device is processed for auto-discovery as long as it has one IP address that satisfies the include filter. |
|
Comma-separated DNS domain names for included or excluded devices. An asterisk (*) wildcard matches, up to an arbitrary length, any combination of alphanumeric characters, hyphen (-), and underscore (_). A question mark (?) wildcard matches a single alphanumeric character, hyphen (-), or underscore (_). For example,*.cisco.com matches any DNS name ending with .cisco.com. and *.?abc.com matches any DNS name ending with .aabc.com, .babc.com, and so on. |
|
Available only for CDP and ping sweep discovery methods) Comma-separated strings that match the string value stored in the sysLocation OID in MIB-II, for included or excluded devices. An asterisk (*) wildcard matches, up to an arbitrary length, any combination of alphanumeric characters, hyphen (-), underscore (_), and white space (spaces and tabs). For example, a SysLocation filter of San * matches all SysLocation strings starting with San Francisco, San Jose, and so on. A question mark (?) wildcard matches a single alphanumeric character, hyphen (-), underscore (_), or white space (space or tab). |
The following table describes the scheduling options that are available
Click Start Time to enter the start date and time in the yyyy/MM/dd and hh:mm AM/PM formats, respectively. Click the date picker if you want to select the start date and time from the calendar. The time displayed is the client browser time. The scheduled periodic job runs at this specified time. |
|
Click None, Hourly, Daily, Weekly, or Monthly to specify the job period. |
|
If you do not want to specify an end date/time, click No End Date/Time. Click Every number of Times to set the number of times you want the job to end in the specified period. Enter the end date and time in the yyyy/MM/dd and hh:mm AM/PM formats, respectively. |
You can add single or multiple devices to Cisco Prime Collaboration manually by using the Add Device option in the page.
Step 1 | Choose . |
Step 2 | In the page, click Add Device. |
Step 3 | In the Add Device window, enter the necessary information. For information regarding different credentials, see the Credential Profiles Field Descriptions table. |
You can import devices into Cisco Prime Collaboration, by importing a file with the device list and credentials.
You need to add the following for each devices to import it:
Manage Device Credentials: The required credentials to manage devices.
Discovery Methods: Based on your deployment, select the appropriate discovery methods.
Prerequisites and Recommendation: Configure the required settings on the devices and review the recommendations.
Export Device Lists and Credentials: The import file format is same as export.
Step 1 | Choose . | ||
Step 2 | Click Import. | ||
Step 3 | In the Import dialog box, browse to the file with the list of devices and credentials that you want to import. (Only CSV or XML file format is supported.) If you are importing a file with encrypted credentials, select the File contains Encrypted Credentials check box. | ||
Step 4 | Click
Import.
Credential Profiles are not created for the imported list of devices and credentials. After import, device discovery is triggered automatically using the credentials available in the import file. You can check the status of the import-based discovery job in the Job Management page. See Verify Discovery Status for more information. If any of the imported device credentials are incorrect, then the device may not be in Managed state. After discovery, the imported devices appear in the inventory. You can also look at the Device Status Summary window to know the number of discovered devices and the number of devices for which discovery is in progress. |
You can export device lists, and device credentials to a file. You could use this file to modify the device list and credentials and import it later. This feature is only available to users with network administrator, super administrator, and system administrator roles.
To export device list and credentials:
Step 1 |
Issue:
Devices are not getting discovered while trying to import the device credential
from one server to other.
Recommendation: You can import the exported device credentials file on the same server only. |
Step 2 | Issue: Devices are not
getting discovered while trying to use the exported credential from the
previous release to import in current release.
Recommendation: You can import the exported device credentials file on the same server only. |
After the Unified CM publisher is managed in Cisco Prime Collaboration, you must collect the additional inventory data by performing the Cluster Data Discovery. This discovery helps you to collect:
Cluster configuration data including Redundancy group, Devicepool, Location, Region, RouteList, RouteGroup, RoutePattern, Partition, and so on. This also includes the entities provisioned in the cluster such as phones, voice mail endpoints, media resources, gateways, and trunks.
Registration information about all the entities which register with the Unified CM cluster. This includes Device IP, Registration status, the Unified CM server to which the entity is registered currently, the latest registration or unregistration time stamp, and the status reason.
Registration information can be configured using a configuration file. This information is collected from all the subscriber nodes in the clusters to which the entities such as phones or gateways register.
Cisco Prime Collaboration collects cluster configuration from the Cisco Unified CM once a day as well as at startup. This periodic discovery data collection is done by default at midnight daily; the default schedule can be changed.
Note |
|
The following conditions must be met before you perform Unified CM cluster discovery:
Data is collected from Publisher or First node through AXL. Therefore, the publisher should be in fully in monitored state with proper HTTP credentials entered and the AXL Web Service should be running in the publisher.
Cisco RIS Data Collector running in 7.x versions of Unified CM.
Cisco SOAP - CDRonDemand Service running in other versions of Unified CM.
If the Unified CM publisher is configured using name in the Unified CM section or System Server section of Unified CM Administration, then this name must be resolvable through DNS from the Cisco Prime Collaboration server. Otherwise, an entry must be configured for this name in the host files for the data collection to proceed further.
For Cisco Prime Collaboration to be able to receive syslogs and process configurations required in the Unified CM, you must perform the steps in the Syslog Receivers section. Any changes in the registration information are updated through processing the relevant syslogs from Cisco Unified CM.
Syslog processing can detect the following changes of the entities registered to the Cisco Unified CM cluster:
If any of the following changes occur on the cluster configuration before the scheduled periodic data collection and you want these changes to appear in Cisco Prime Collaboration immediately, you must use the Run Now option to collect the following types of data:
If changes are limited to a specific cluster, you can rediscover the publisher of the cluster by using . For a new Unified CM cluster, discovery or rediscovery is followed by phone discovery for that cluster. In case there is any other phone synch up operation (such as cluster phone discovery, or XML discovery) in progress then the cluster-based phone discovery will wait for it to complete. Thus a phone status change reflection in Cisco Prime Collaboration takes more time than expected in case there is any other phone sync up operation in progress. |
You can rediscover devices that have already been discovered. The credentials previously entered are already available in the Cisco Prime Collaboration database, and the system is updated with the changes. Devices in any state can be rediscovered.
There are changes in the first hop router configuration, and for software image updates.
There are changes to the credentials; location; time zone; and device configurations such as IP address or hostname, SIP URI, H.323 gatekeeper address, and so on.
After performing a backup and restoring Cisco Prime Collaboration.
Use the Rediscover button in the Current Inventory pane to rediscover devices listed in the Current Inventory table. You can perform rediscovery on a single device as well as on multiple devices.
Note | Accessibility information is not checked during rediscovery. |
The workflow for rediscovery is the same as for discovery. See Device Discovery Lifecycle for details.
Step 1 | From the Inventory Management page, choose the Deleted quick filter to get a list of devices that are in the Deleted state in the Current Inventory table. | ||
Step 2 | Select the devices you want to rediscover. Click Rediscover. | ||
Step 3 | In the confirmation message box that appears, click OK. | ||
Step 4 | From the
Inventory Management
page, click the Discovery Jobs button to check the progress and the status of
the job in the Job Management page. For more information, see
Verify
Discovery Status.
|
The status of all discovery jobs is displayed in the Job Management page. After running discovery, a dialog box appears with the Job Progress Details link to enable you to verify the discovery status. The time taken to complete a discovery job depends on your network. After the discovery is complete, the details appear in the Current Inventory table.
To verify discovery status:
Step 1 | Choose . |
Step 2 | From the Job Management page,
select the discovery job for which you want to view the details.
The status of discovery, and all the devices discovered during discovery appear in the pane below the Job Management table. |
Step 3 | Check the Job Management table for discovery status. or the Job details pane for details about discovered devices. |
Step 4 | Depending on your results, do
one or more of the following:
|
Issue: Cisco TelePresence Video Communication Server (Cisco VCS) Edge - External interface IP address is not reachable and causes alarms.
Recommended Action: You must discover the Cisco VCS Core and Cisco VCS Edge before discovering the Cisco Unified Communications Manager. This ensures that all the IP addresses of Cisco VCS - Edge external and internal interfaces are known in the Cisco Prime Collaboration inventory. When the Cisco Unified Communications Manager publisher is discovered, the interface IP address is matched with the collected inventory and does not cause unreachable alarms.
Issue: Cisco TelePresence Management Suite (TMS) - The associated devices are not discovered.
Recommended Action: Ensure that you have performed Logical Discovery of the Cisco TelePresence Management Suite (TMS) to discover the associated devices. The Add Device option only discovers the TMS and does not discover the associated devices.
Rediscover the TMS with selection of the Auto Discovery option. Ensure that the credentials are added for all the associated devices.
Issue: DX80/Phones are not discovered successfully.
Recommended Action: DX 80 and other phones are only discovered as part of Phone Sync, CDT, or Cisco Unified Communications Manager publisher cluster discovery. Other than Registration/Un-Registration status, any configuration change in phones is updated in the Cisco Prime Collaboration inventory only after the Cluster Data Discovery.
You should not discover the DX 80 device separately by adding DX IP address.
Issue: Unable to find the serial number of phones.
Recommended Action: Device 360° View of the phone shows the serial number. Go to
, and click the icon on the IP address of the phone to launch its Device 360° View.Issue: Cisco Unified Communications Manager shows as a non-Cisco Device.
Recommended Action: Enable the Cisco Unified Communications Manager SNMP service on the Cisco Unified Communications Manager. See the Configure Devices for Prime Collaboration Assurance 11.5 wiki page for more information.