Home >  User Guide - UPLINX Report Tool > How to Generate a Report > Step 1 - Configure Server Settings > Advanced Server Settings

  Advanced Server Settings

 

 

 

 

Below is more detailed information about required user and server access by UPLINX Report Tool, depending on the server type:

CISCO UNIFIED COMMUNICATIONS MANAGER (CUCM)

On CUCM, an application user with the AXL SOAP privileges needs to be created and the AXL SOAP service needs to be running in Cisco Serviceability.
 

By default all users in the administrative group have access to AXL SOAP. Some report contents are retrieved via command line SSH shell. You can choose to set the same user as for the AXL SOAP by ticking the tick box, or alternatively by explicitly configuring another user with administrative privileges for the SSH access.


 

In order to generate Phone Inventory Reports, the application user must be a member of the group Standard AXL API Access role or Standard CCM Server Monitoring. This is required by CISCO to access the RIS component.

For configuration reports, the report tool user needs to have the AXL SOAP privilege assigned.


Cisco IM and Presence (IMP) /  CISCO UNIFIED PRESENCE SERVER (CUPS)

 On IMP an application user with the AXL SOAP privileges needs to be created and the AXL SOAP service needs to be running in Cisco Serviceability.

 

By default all users in the administrative group have access to AXL SOAP. Some report contents are retrieved via the Command Line SSH shell. You can choose to set the same user as for the AXL SOAP by ticking the tick box, or alternatively by explicitly configuring another user with administrative privileges for the SSH access.


CISCO EMERGENCY REPORTER (CER)

Cisco Emergency Reporter (CER) report contents are retrieved via the command line SSH shell. Please test the user credentials by logging into CER with a SSH terminal client.

CISCO UNIFIED CONTACT CENTER EXPRESS (UCCX)

Reports for Cisco Unified Contact Center Express (UCCX) are generated in the following formats: Configuration reports of the UCCX administration pages in HTML, Word, CHM.

All reports may include the UCCX scripts (.aef). This requires that the Cisco UCCX Editor for the UCCX server version is installed on the same machine as the Report Tool. All UCCX scripts (.aef) are copied to the output folder.

If the following checkbox is checked, the UCCX report includes the configuration of CTI ports of Call Control Groups and CTI Route Points of UCCX triggers:

 

If checked, the CUCM credentials must be entered to retrieve CUCM configuration data.

UCCX requirements

SSO is not supported.
 

To download the UCCX scripts (.aef) scripts from the script repository on the UCCX server and to generate the script documentation as PNG images, the Cisco UCCX Script Editor must be installed on the same machine as the Report Tool. Please verify that the Cisco UCCX Script Editor works and can access the script repository on the UCCX server. If the Cisco UCCX Script Editor is not available, the report will contain the configuration of the UCCX administration pages.

PHONE INVENTORY REPORTS

In order to generate Phone Inventory Reports, the CUCM application user must be assigned the roles Standard AXL API Access and Standard CCM Admin Users . This can be accomplished by doing one of the following:

1.Adding the user to the Standard CCM Super Users group.

2.Creating a custom group that has both roles.

3.Adding the user to a custom group with the Standard AXL API Access role and Standard CCM Admin Users or Standard CCM Server Monitoring .

This is a requirement by CISCO to access the RIS component. If this is not the case, a 403 error (access forbidden) will occur. For more detailed troubleshooting steps, please see Troubleshooting Phone Inventory Connectivity Issues.

Furthermore:

AXL must be enabled.

The HTTP server on the phones must be enabled to retrieve the serial number of phones and extension modules.

If CDP or LLDP  is enabled on the switches the neighbor port details will be available.

SUBSCRIBERS AND STANDBY SERVERS

Entering the IP addresses of the Subscriber within the CUCM cluster and Standby servers will run the defined Command Line commands on these servers and retrieve the Services Status. The output of these servers is grouped by the server IP addresses when added to the generated report. This is optional and not required.

Subscribers and Standby Servers have no effect on the Phone Inventory report but are only used for configuration reports.

 

 

 

 

Copyright © 2024 UPLINX - Last updated 26 Feb 2024