The command line interface enables you to execute the Report Tool from any command interpreter that supports executables (.bat, wsh, power shell and others). This enables you to use the Report Tool in scripts and to run it automatically at scheduled times via the Windows Task Scheduler.
Settings such as server IP address and credentials can be passed in as command line options and have priority over the inherited settings of the Report Tool which have been configured in GUI mode. If you have multiple environments with different reports settings, you would first start Report Tool in GUI mode and create a new profile in the top header of Report Tool, then generate the report by using the command line attribute /config <customer profile name.cfg>. The customer profile name is displayed in the drop down box in the header of Report Tool.
The supported reports of the command line interface are:
Command Line Options
C:\Program Files (x86)\ReportTool>ReportTool.exe /help
UPLINX(c) Report Tool for Cisco Unified Communications:
12.0.19 / 19 Oct 2019
Date: 21 Oct 2019 - 15h 09m 53s
ReportTool.exe
[/options]
# GENERAL options:
/profile or /p <profile
name> Load settings from this profile name else use Default. Use GUI to
create profiles.
/outpath
<path>
Path to be prepended to all generated files
/l
<logfile>
Log output to this file.
/help or /h or
/?
Displays this help
# CUCM report options:
/cucm_ip
<IP>
/cucm_user <user>
/cucm_password
<password>
/cucm_ssh_user
<user>
/cucm_ssh_password
<password>
/cucm_test_axl or
/t Test CUCM
AXL
/cucm_test_ssh
Test CUCM SSH
/cucm_sync
<reportname> Sync to
CUCM
/cucm_report <reportname>
Create CUCM configuration report
or
/inventory
<reportname> Create phone
Inventory report
or
/cucm_provuser_report
<reportname> Create Provisioned User report
# IMP/CUPS report
options:
/cups_ip <IP>
/cups_user
<user>
/cups_version
<version> Mandatory <9 to
12>
/cups_password <password>
/cups_ssh_user
<user>
/cups_ssh_password
<password>
/cups_test_axl
Test CUPS
AXL
/cups_test_ssh
Test CUPS SSH
/cups_sync
<reportname> Sync to
CUPS
/cups_report <reportname>
Create CUPS configuration report
# CUC report options:
/cuc_ip
<IP>
/cuc_user <user>
/cuc_password
<password>
/cuc_ssh_user <user>
/cuc_ssh_password
<password>
/cuc_test
Test CUC Remote DB access
/cuc_sync
<reportname> Sync to
CUC
/cuc_report <reportname>
Create CUC configuration report
# CER report options:
/cer_ip
<IP>
/cer_user <user>
/cer_password
<password>
/cer_test
Test CER SSH
/cer_report
<reportname> Create CER configuration
report
# UCCX report options:
/uccx_ip
<IP>
/uccx_webuser <user>
/uccx_webpassword
<password>
/uccx_sshuser <user>
/uccx_sshpassword
<password>
/uccx_test
Test UCCX Web Login and
SSH
/uccx_includecucm
Include CUCM CTI Port and Route Point information in the
report
/uccx_report <reportname>
Create UCCX configuration report
# CIMC report options:
/ucs_ip
<IP>
/ucs_user <user>
/ucs_password
<password>
/ucs_test
Test CIMC
/ucs_report
<reportname> Create CIMC configuration
report
# VMware report options:
/vm_ip
<IP>
/vm_user <user>
/vm_password
<password>
/vm_test
Test VMware
/vm_report
<reportname> Create VMware
report
# Cisco Expressway report
options:
/cew_ip <IP>
/cew_user
<user>
/cew_password
<password>
/cew_test
Test Cisco Expressway
/cew_report
<reportname> Create Cisco Expressway
report
# InformaCast report
options:
/ic_ip <IP>
/ic_user
<user>
/ic_password
<password>
/ic_test
Test InformaCast
/ic_report
<reportname> Create InformaCast
report
# CMS report options:
/cms_ip
<IP>
IP address of CMS Web + API
/cms_port <port>
/cms_user
<user>
/cms_password <password>
/cms_ssh_ip
<IP>
IP address of CMS SSH
/cms_ssh_port <port>
/cms_ssh_user
<user>
/cms_ssh_password
<password>
/cms_test
Test CMS Web-API + SSH - requires all of above CMS
parameters
/cms_report
<reportname> Create CMS configuration
report
# COMPARE report
options:
/compare_out
<path\compare_filename_out> Create
CUCM comparison report with this output file (required)
/compare_base
<path\compare_filename_base> Base file for CUCM
comparison report (optional)
/compare_changed
<path\compare_filename_chgd> Changed file for CUCM comparison report
(optional)
/compare_auditlogpath <path> Folder
of Cisco Audit Logs. All subfolders will be searched
(optional)
/compare_utcoffset Time offset of
CUCM server to UTC in hours. Required if audit logs are provided else
optional
/compare_includeunchanged Include unchanged records in the comparison report.
/inventory phone inventory comparison instead of CUCM comparison (optional)
# SQL query to CSV file
options:
/sql <SQL
command>
Specify SQL command such as "Select * from endusers"
(required)
/csvfile
<path\filename> Set filename for
output
(required)
/csvheader
Adds column names at top (optional)
# SQL XML file:
/sqlxmlfile
<path\filename> XML file with SQL commands and output
filenames (required) - see sqlxmlsample.txt
# Note:
+ To include spaces or special chars in a
parameter, use quotation marks ie "my param"
+ <CommonApplicationData> =
C:\Users\<userid>\AppData\Local\UPLINX
Report Tool
Please note:
Support for Scripts |
Unfortunately, scripting itself is not part of our
support for the UPLINX Report Tool. |