# Install globally
npm install -g cisco-ucce
# Or run without installing
npx cisco-ucce --help

# Add a cluster
cisco-ucce config add prod

# Edit config with hosts and credentials
# Config location: ~/.cisco-ucce/config.json
cisco-ucce config show

# Set active cluster
cisco-ucce config use prod

# Test connectivity
cisco-ucce config test

--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)

# Quick health check across all services
cisco-ucce doctor

# AW system-wide status
cisco-ucce status

# Version check across all PGs/Routers
cisco-ucce diag version --host all

# All agent states from Finesse
cisco-ucce finesse users

# Queue stats by ID (IDs = skill group IDs from AW)
cisco-ucce finesse queue 205001

# List all teams
cisco-ucce finesse teams

# Not-ready reason codes
cisco-ucce finesse reason-codes --category NOT_READY

# Find agents by team (pipe JSON to jq)
cisco-ucce agent list --format json | jq '.[] | select(.agentTeamName == "IT.CALL")'

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

# What's running on a PG?
cisco-ucce diag list-processes --host pg1b.example.com

# Service states
cisco-ucce diag list-services --host pg1b.example.com

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

# Performance counters
cisco-ucce diag perf --host pg1b.example.com

# Network connections
cisco-ucce diag netstat --host pg1b.example.com

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

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

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

# Check ALL hosts at once
cisco-ucce diag alarms --host all

# CVP version
cisco-ucce cvp version

# All CVP nodes and types (CALL, MEDIA, VXML)
cisco-ucce cvp servers

# SIP/IVR/ICM config on a call server
cisco-ucce cvp properties --host cvp1a.example.com

# Active calls on first VVB
cisco-ucce vvb active-calls

# Active calls across ALL VVBs
cisco-ucce vvb active-calls --host all

# Export resources to CSV for comparison/reporting
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

# Specific machine details
cisco-ucce inventory get 5000

# Precision queue routing
cisco-ucce precisionqueue list

# PG configuration with CTI addresses
cisco-ucce peripheralgateway list

# Dialed numbers
cisco-ucce dialednumber list

# Call types
cisco-ucce calltype list

# Monitor queue depth every 30s
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

# JSON output for pipe-friendly scripting
cisco-ucce finesse system-info --format json

# 1. Discover available trace components
cisco-ucce diag trace-components --host pg1a.example.com

# 2. List trace files for a component (last 12 hours default)
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
cisco-ucce diag download-trace "Peripheral Gateway 1A/opc" "PG1A_opc_trace.zip" -o ./traces/

# 1. Discover available log components
cisco-ucce diag log-components --host pg1a.example.com

# 2. List log files (EventLog, Tomcat, ICMDBA, etc.)
cisco-ucce diag log-files "EventLog" --host pg1a.example.com
cisco-ucce diag log-files "Tomcat" --hours 24

# 3. Download a log file
cisco-ucce diag download-log "EventLog" "System.evtx.xml" -o ./logs/system-events.xml

{
  "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
    }
  }
}