Overview
|
The CLI is a powerful tool for viewing and editing your current system configuration. To use the CLI, you will need to access your phone system's console via a superuser. The system console is available either at the local terminal, or via SSH. We recommend the following SSH Clients:
Warning With great power comes great responsibility. Most changes done via the CLI are applied Immediately. Please be familiar with all commands prior to using the CLI |
|---|
Commands
Please note that all CLI commands are case sensitive.
There are two modes available to you when working in the CLI:
- Command
Used for informational purposes, such as viewing current active call status or current device availability status.
Used for controlling real-time aspects of the system, such as rebooting, disconnecting calls, or logging out call center agents
This mode is the default mode when entering the CLI
- Configure
Used for changing configurations for any settings, or viewing existing configurations for specific nodes.
This mode can be accessed from the root of Command Mode by typing configure
Command Mode
callqueue
Agent command description
Queues command description
clear
voicemail
configure
disable
exit
mtr
ip
ipv6
ping
ip
ipv6
arp
reboot
services
restart
stop
start
Show
callqueue
agent
Show currently logged in agents
Show current agent assignments by call queue
queues
Show current queue statuses
Show current queue configurations
polycom
Show current device status
Show current device configuration
calls
List all current active calls
cos
List only CoS
List all CoS as well as any includes
devices
sip
iax
polycom
diag
Show diagnostic information?
extensions
interfaces
Show all interfaces and their current configuration/status
ip
licenses
Display current available and assigned licenses
phonegroups
Display all current phonegroup information
polycoms
Show only installed polycoms on the system
registrations
routes
Show route information
running-config
Show full configuration for all configured nodes
services
Show running services
Show running services actual process details
startup-config
Show startup-config (currently failing)
system-users
Show system users, not sure what they relate to
tenants
Show all current tenants on the active system
trunks
Show all available trunks configured on the system
traceroute
Configure Mode
clone
daynight_group
extension
route
core_settings
beep_on_xfer
enable_phone_reprogram_feature
enable_steal_holding_call
externhost
externip
externrefresh
externtcpport
externtlsport
hosted_mode
localnet
pbx2_host
pbx2_port
pbx2_reg_period