Back to Details

cisco-ucce-cli

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Cisco UCCE CLI

Cisco UCCE CLI

Read-only CLI for monitoring and troubleshooting Cisco Unified Contact Center Enterprise 12.6. Covers 5 API services: AW Config/Status, Finesse, CVP, Diagnostic Portal, and VVB.
用于监控和排查Cisco Unified Contact Center Enterprise 12.6故障的只读CLI工具，覆盖5个API服务：AW配置/状态、Finesse、CVP、诊断门户和VVB。

Setup

安装

bash
undefined
bash
undefined

Install globally

全局安装

npm install -g cisco-ucce
npm install -g cisco-ucce

Or run without installing

无需安装直接运行

npx cisco-ucce --help
undefined
npx cisco-ucce --help
undefined

Configuration

配置

bash
undefined
bash
undefined

Add a cluster

添加集群

cisco-ucce config add prod
cisco-ucce config add prod

Edit config with hosts and credentials

编辑主机和凭证配置

Config location: ~/.cisco-ucce/config.json

配置文件路径: ~/.cisco-ucce/config.json

cisco-ucce config show
cisco-ucce config show

Set active cluster

设置活跃集群

cisco-ucce config use prod
cisco-ucce config use prod

Test connectivity

测试连通性

cisco-ucce config test

Config supports `<ss:ID:field>` placeholders for ss-cli integration (optional).
cisco-ucce config test

配置支持`<ss:ID:field>`占位符用于ss-cli集成（可选）。

Global Flags

全局参数

--format table|json|toon|csv   (default: table)
--host <host>                  (override target host)
--cluster <name>               (use specific cluster)
--insecure                     (skip TLS verification)
--no-audit                     (disable audit logging)
--format table|json|toon|csv   (默认: table)
--host <host>                  (覆盖目标主机)
--cluster <name>               (使用指定集群)
--insecure                     (跳过TLS校验)
--no-audit                     (关闭审计日志)

Common Workflows

常用工作流

System Health Check

系统健康检查

bash
undefined
bash
undefined

Quick health check across all services

跨所有服务快速健康检查

cisco-ucce doctor
cisco-ucce doctor

AW system-wide status

AW全系统状态

cisco-ucce status
cisco-ucce status

Version check across all PGs/Routers

跨所有PG/路由器检查版本

cisco-ucce diag version --host all
undefined
cisco-ucce diag version --host all
undefined

Agent & Queue Monitoring

Agent与队列监控

bash
undefined
bash
undefined

All agent states from Finesse

从Finesse获取所有Agent状态

cisco-ucce finesse users
cisco-ucce finesse users

Queue stats by ID (IDs = skill group IDs from AW)

按ID查询队列统计（ID为来自AW的技能组ID）

cisco-ucce finesse queue 205001
cisco-ucce finesse queue 205001

List all teams

列出所有团队

cisco-ucce finesse teams
cisco-ucce finesse teams

Not-ready reason codes

未就绪原因码

cisco-ucce finesse reason-codes --category NOT_READY
cisco-ucce finesse reason-codes --category NOT_READY

Find agents by team (pipe JSON to jq)

按团队筛选Agent（将JSON管道传给jq）

cisco-ucce agent list --format json | jq '.[] | select(.agentTeamName == "IT.CALL")'
cisco-ucce agent list --format json | jq '.[] | select(.agentTeamName == "IT.CALL")'

Count agents per team

统计每个团队的Agent数量

cisco-ucce agent list --format json | jq 'group_by(.agentTeamName) | .[] | {team: .[0].agentTeamName, count: length}'
undefined
cisco-ucce agent list --format json | jq 'group_by(.agentTeamName) | .[] | {team: .[0].agentTeamName, count: length}'
undefined

PG / Router Diagnostics

PG / 路由器诊断

The Diagnostic Portal runs on PGs (port 7890), Routers (port 7890), AW (port 8443), CUIC (port 8443), and Finesse (port 8443). Use 
--host
to target a specific server, or 
--host all
for all.
bash
undefined
诊断门户运行在PG（端口7890）、路由器（端口7890）、AW（端口8443）、CUIC（端口8443）和Finesse（端口8443）上。使用
--host
指定目标服务器，或使用
--host all
批量查询所有服务器。
bash
undefined

What's running on a PG?

PG上运行着哪些进程？

cisco-ucce diag list-processes --host pg1b.example.com
cisco-ucce diag list-processes --host pg1b.example.com

Service states

服务状态

cisco-ucce diag list-services --host pg1b.example.com
cisco-ucce diag list-services --host pg1b.example.com

Active alarms

活跃告警

cisco-ucce diag alarms --host pg1b.example.com
cisco-ucce diag alarms --host pg1b.example.com

Performance counters

性能计数器

cisco-ucce diag perf --host pg1b.example.com
cisco-ucce diag perf --host pg1b.example.com

Network connections

网络连接

cisco-ucce diag netstat --host pg1b.example.com
cisco-ucce diag netstat --host pg1b.example.com

IP configuration

IP配置

cisco-ucce diag ipconfig --host pg1b.example.com --args "/all"
cisco-ucce diag ipconfig --host pg1b.example.com --args "/all"

Available log files

可用日志文件

cisco-ucce diag log-files --host pg1b.example.com
cisco-ucce diag log-files --host pg1b.example.com

Product version

产品版本

cisco-ucce diag version --host pg1b.example.com
cisco-ucce diag version --host pg1b.example.com

Check ALL hosts at once

一次性检查所有主机

cisco-ucce diag alarms --host all
undefined
cisco-ucce diag alarms --host all
undefined

CVP Investigation

CVP排查

bash
undefined
bash
undefined

CVP version

CVP版本

cisco-ucce cvp version
cisco-ucce cvp version

All CVP nodes and types (CALL, MEDIA, VXML)

所有CVP节点和类型（CALL、MEDIA、VXML）

cisco-ucce cvp servers
cisco-ucce cvp servers

SIP/IVR/ICM config on a call server

呼叫服务器上的SIP/IVR/ICM配置

cisco-ucce cvp properties --host cvp1a.example.com

CVP OPS (`/cvp-config/`) uses a dedicated API user. CVP call servers (`/cvp-orm/rest/`) use AW credentials.
cisco-ucce cvp properties --host cvp1a.example.com

CVP OPS (`/cvp-config/`) 使用独立的API用户。CVP呼叫服务器 (`/cvp-orm/rest/`) 使用AW凭证。

VVB Active Calls

VVB活跃通话

bash
undefined
bash
undefined

Active calls on first VVB

首个VVB上的活跃通话

cisco-ucce vvb active-calls
cisco-ucce vvb active-calls

Active calls across ALL VVBs

所有VVB上的活跃通话

cisco-ucce vvb active-calls --host all
undefined
cisco-ucce vvb active-calls --host all
undefined

Configuration Audit & Export

配置审计与导出

bash
undefined
bash
undefined

Export resources to CSV for comparison/reporting

将资源导出为CSV用于对比/报表生成

cisco-ucce agent list --format csv > agents.csv cisco-ucce skillgroup list --format csv > skillgroups.csv
cisco-ucce agent list --format csv > agents.csv cisco-ucce skillgroup list --format csv > skillgroups.csv

Full machine inventory (all servers in solution)

完整机器清单（解决方案内所有服务器）

cisco-ucce inventory list
cisco-ucce inventory list

Specific machine details

指定机器的详情

cisco-ucce inventory get 5000
cisco-ucce inventory get 5000

Precision queue routing

精准队列路由

cisco-ucce precisionqueue list
cisco-ucce precisionqueue list

PG configuration with CTI addresses

带CTI地址的PG配置

cisco-ucce peripheralgateway list
cisco-ucce peripheralgateway list

Dialed numbers

被叫号码

cisco-ucce dialednumber list
cisco-ucce dialednumber list

Call types

呼叫类型

cisco-ucce calltype list
undefined
cisco-ucce calltype list
undefined

Scripting & Monitoring

脚本编写与监控

bash
undefined
bash
undefined

Monitor queue depth every 30s

每30秒监控一次队列深度

watch -n 30 'cisco-ucce finesse queue 205001 --format json | jq .callsInQueue'
watch -n 30 'cisco-ucce finesse queue 205001 --format json | jq .callsInQueue'

Export all config resources

导出所有配置资源

for resource in agent skillgroup calltype precisionqueue attribute; do cisco-ucce $resource list --format csv > "${resource}.csv" done
for resource in agent skillgroup calltype precisionqueue attribute; do cisco-ucce $resource list --format csv > "${resource}.csv" done

JSON output for pipe-friendly scripting

输出JSON格式结果，适配管道式脚本调用

cisco-ucce finesse system-info --format json
undefined
cisco-ucce finesse system-info --format json
undefined

AW Config Resources

AW配置资源

All support 
list
and 
get <id>
(except 
department
which is list-only):
CommandAPI ResourceNotes
agent
agent3000+ agents, paginated
skillgroup
skillgroupIDs map to Finesse queue IDs
calltype
calltype
precisionqueue
precisionqueue
attribute
attribute
expandedcallvariable
expandedcallvariableNOT 
callvariable
mediaroutingdomain
mediaroutingdomain
bucketinterval
bucketinterval
dialednumber
dialednumber
peripheralgateway
peripheralgatewayIncludes CTI addresses
department
departmentList only, no get
inventory
machineinventoryFull solution inventory
agentteam
agentteamMay return 403 for some users
Pagination: 
--page N --page-size N
. Without these flags, auto-paginates all records.
所有资源均支持
list
和
get <id>
操作（
department
仅支持list）：
命令API资源说明
agent
agent支持3000+ Agent，分页返回
skillgroup
skillgroupID对应Finesse队列ID
calltype
calltype
precisionqueue
precisionqueue
attribute
attribute
expandedcallvariable
expandedcallvariable注意不是
callvariable
mediaroutingdomain
mediaroutingdomain
bucketinterval
bucketinterval
dialednumber
dialednumber
peripheralgateway
peripheralgateway包含CTI地址
department
department仅支持list，不支持get
inventory
machineinventory完整解决方案清单
agentteam
agentteam部分用户可能返回403错误
分页参数：
--page N --page-size N
。不带这些参数时会自动拉取全量记录。

Diagnostic Portal Endpoints

诊断门户端点

All support 
--host <hostname>
and 
--host all
:
CommandEndpointNotes
diag list-processes
ListProcesses
diag list-services
ListServices
diag version
GetProductVersion
diag license
GetProductLicense
diag netstat
GetNetStat
diag ipconfig
GetIPConfig
--args "/all"
diag perf
GetPerformanceInformation
--component <path>
diag perf-counter
GetPerfCounterValue
diag trace-level
GetTraceLevel
diag alarms
GetAlarms
diag trace-components
ListTraceComponents
diag trace-files
ListTraceFiles
<component>
required, 
--hours N
diag log-components
ListLogComponents
diag log-files
ListLogFiles
<component>
required, 
--hours N
diag app-servers
ListAppServers
diag config-categories
ListConfigurationCategories
diag config-category
GetConfigurationCategory
<category>
required
diag traceroute
GetTraceRoute
diag ping
GetPing
diag download-trace
DownloadTraceFile
<component> <file>
, 
-o path
diag download-log
DownloadLogFile
<component> <file>
, 
-o path
所有端点均支持
--host <hostname>
和
--host all
参数：
命令端点说明
diag list-processes
ListProcesses
diag list-services
ListServices
diag version
GetProductVersion
diag license
GetProductLicense
diag netstat
GetNetStat
diag ipconfig
GetIPConfig
--args "/all"
diag perf
GetPerformanceInformation
--component <path>
diag perf-counter
GetPerfCounterValue
diag trace-level
GetTraceLevel
diag alarms
GetAlarms
diag trace-components
ListTraceComponents
diag trace-files
ListTraceFiles需要指定
<component>
，支持
--hours N
diag log-components
ListLogComponents
diag log-files
ListLogFiles需要指定
<component>
，支持
--hours N
diag app-servers
ListAppServers
diag config-categories
ListConfigurationCategories
diag config-category
GetConfigurationCategory需要指定
<category>
diag traceroute
GetTraceRoute
diag ping
GetPing
diag download-trace
DownloadTraceFile需要
<component> <file>
，支持
-o path
diag download-log
DownloadLogFile需要
<component> <file>
，支持
-o path

Trace & Log File Collection

跟踪与日志文件收集

bash
undefined
bash
undefined

1. Discover available trace components

1. 查找可用的跟踪组件

cisco-ucce diag trace-components --host pg1a.example.com
cisco-ucce diag trace-components --host pg1a.example.com

2. List trace files for a component (last 12 hours default)

2. 列出某个组件的跟踪文件（默认查询最近12小时）

cisco-ucce diag trace-files "Peripheral Gateway 1A/opc" --host pg1a.example.com cisco-ucce diag trace-files "CTI Server 1A/ctisvr" --hours 24
cisco-ucce diag trace-files "Peripheral Gateway 1A/opc" --host pg1a.example.com cisco-ucce diag trace-files "CTI Server 1A/ctisvr" --hours 24

3. Download a trace file

3. 下载跟踪文件

cisco-ucce diag download-trace "Peripheral Gateway 1A/opc" "PG1A_opc_trace.zip" -o ./traces/
cisco-ucce diag download-trace "Peripheral Gateway 1A/opc" "PG1A_opc_trace.zip" -o ./traces/

1. Discover available log components

1. 查找可用的日志组件

cisco-ucce diag log-components --host pg1a.example.com
cisco-ucce diag log-components --host pg1a.example.com

2. List log files (EventLog, Tomcat, ICMDBA, etc.)

2. 列出日志文件（EventLog、Tomcat、ICMDBA等）

cisco-ucce diag log-files "EventLog" --host pg1a.example.com cisco-ucce diag log-files "Tomcat" --hours 24
cisco-ucce diag log-files "EventLog" --host pg1a.example.com cisco-ucce diag log-files "Tomcat" --hours 24

3. Download a log file

3. 下载日志文件

cisco-ucce diag download-log "EventLog" "System.evtx.xml" -o ./logs/system-events.xml
undefined
cisco-ucce diag download-log "EventLog" "System.evtx.xml" -o ./logs/system-events.xml
undefined

Server-Side Log Locations

服务端日志位置

When RDP/SSH access is needed, these are the common file paths:
当需要RDP/SSH访问时，以下是常用文件路径：

PG / Router (Windows)

PG / 路由器（Windows）

PathContents
C:\icm\<instance>\logfiles\
ICM binary trace logs (opc, pim, jgw, etc.)
C:\icm\<instance>\logfiles\dumplog\
Text-converted trace logs
C:\icm\serviceability\diagnostics\logs\
Diagnostic Framework service logs
C:\icm\serviceability\wsccli\
Unified System CLI tool and output
C:\icm\serviceability\wsccli\conf\devices.csv
Multi-server collection config
Use 
dumplog <process> /bt HH:MM /et HH:MM /ms /o
on the server to convert binary logs to text.
路径内容
C:\icm\<instance>\logfiles\
ICM二进制跟踪日志（opc、pim、jgw等）
C:\icm\<instance>\logfiles\dumplog\
文本转换后的跟踪日志
C:\icm\serviceability\diagnostics\logs\
诊断框架服务日志
C:\icm\serviceability\wsccli\
统一系统CLI工具和输出
C:\icm\serviceability\wsccli\conf\devices.csv
多服务器收集配置
在服务器上使用
dumplog <process> /bt HH:MM /et HH:MM /ms /o
命令将二进制日志转换为文本。

AW / HDS (Windows)

AW / HDS（Windows）

PathContents
C:\icm\<instance>\logfiles\
AW/HDS service logs
C:\icm\<instance>\logfiles\dbworker\
Database replication logs
C:\icm\serviceability\diagnostics\logs\
Diagnostic Framework logs
路径内容
C:\icm\<instance>\logfiles\
AW/HDS服务日志
C:\icm\<instance>\logfiles\dbworker\
数据库复制日志
C:\icm\serviceability\diagnostics\logs\
诊断框架日志

CVP (Windows)

CVP（Windows）

PathContents
%CVP_HOME%\logs\
CVP application logs
%CVP_HOME%\logs\OAMP\
OPS Console logs
%CVP_HOME%\conf\
CVP configuration files
路径内容
%CVP_HOME%\logs\
CVP应用日志
%CVP_HOME%\logs\OAMP\
OPS控制台日志
%CVP_HOME%\conf\
CVP配置文件

Finesse / CUIC / VVB (VOS Linux)

Finesse / CUIC / VVB（VOS Linux）

PathContents
/var/log/active/tomcat/logs/
Finesse/CUIC web application logs
/var/log/active/platform/log/
Platform service logs
Use 
cisco-dime
CLI for VOS log collection		DIME-based log download
路径内容
/var/log/active/tomcat/logs/
Finesse/CUIC web应用日志
/var/log/active/platform/log/
平台服务日志
使用
cisco-dime
CLI收集VOS日志		基于DIME的日志下载

Cluster Config Structure

集群配置结构

json
{
  "activeCluster": "prod",
  "clusters": {
    "prod": {
      "aw": {
        "hosts": ["aw-a.example.com"],
        "username": "<your-aw-user>",
        "password": "<ss:ID:password>"
      },
      "finesse": {
        "hosts": ["fin-a.example.com"],
        "username": "<your-finesse-user>",
        "password": "..."
      },
      "cvpOps": {
        "host": "cvpops.example.com",
        "port": 8111,
        "username": "<your-cvp-api-user>",
        "password": "..."
      },
      "cvpCallServers": { "hosts": ["cvp1a.example.com"], "port": 8111 },
      "diagnosticPortal": {
        "hosts": [
          { "host": "pg1a.example.com", "port": 7890 },
          { "host": "aw-a.example.com", "port": 8443 }
        ],
        "username": "<domain\\your-admin-user>",
        "password": "..."
      },
      "vvb": {
        "hosts": ["vvb1a.example.com"],
        "username": "<your-vvb-user>",
        "password": "..."
      },
      "insecure": true
    }
  }
}
Auth precedence: CLI flags > env vars (
CISCO_UCCE_USERNAME
/
CISCO_UCCE_PASSWORD
) > config file.
json
{
  "activeCluster": "prod",
  "clusters": {
    "prod": {
      "aw": {
        "hosts": ["aw-a.example.com"],
        "username": "<your-aw-user>",
        "password": "<ss:ID:password>"
      },
      "finesse": {
        "hosts": ["fin-a.example.com"],
        "username": "<your-finesse-user>",
        "password": "..."
      },
      "cvpOps": {
        "host": "cvpops.example.com",
        "port": 8111,
        "username": "<your-cvp-api-user>",
        "password": "..."
      },
      "cvpCallServers": { "hosts": ["cvp1a.example.com"], "port": 8111 },
      "diagnosticPortal": {
        "hosts": [
          { "host": "pg1a.example.com", "port": 7890 },
          { "host": "aw-a.example.com", "port": 8443 }
        ],
        "username": "<domain\\your-admin-user>",
        "password": "..."
      },
      "vvb": {
        "hosts": ["vvb1a.example.com"],
        "username": "<your-vvb-user>",
        "password": "..."
      },
      "insecure": true
    }
  }
}
认证优先级：CLI参数 > 环境变量（
CISCO_UCCE_USERNAME
/
CISCO_UCCE_PASSWORD
） > 配置文件。