# 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:

<div class="table-wrap" id="bkmrk-windows%3A%C2%A0putty-mac%3A%C2%A0">- Windows: [PuTTY](http://www.putty.org/)
- Mac: [Terminal](http://guides.macrumors.com/Terminal), or [iTerm2](https://www.iterm2.com/), and [ssh](https://www.centos.org/docs/5/html/5.1/Deployment_Guide/s2-openssh-using-ssh.html)
- Linux: [ssh](https://www.centos.org/docs/5/html/5.1/Deployment_Guide/s2-openssh-using-ssh.html) or [PuTTY](http://www.putty.org/)

</div><p class="callout danger">Warning: With great power comes great responsibility. Most changes done via the CLI are applied <u>Immediately.</u></p>

<p class="callout danger">Please be familiar with all commands prior to using the CLI</p>

<div class="table-wrap" id="bkmrk-"></div>[Test the firezirrah](https://public.intellasoft.net/pages/viewpage.action?pageId=8030410#CommandLineInterface(CLI)-ancPolycomStatus)

# Commands

<div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" id="bkmrk--3" style="border-style: solid; border-width: 1px;"><div class="panelContent"><div class="IntellaTitle conf-macro output-block" data-hasbody="true" data-macro-name="div" id="bkmrk--4" title="Root Commands for CLI"></div></div></div>**Please note that all CLI commands are case-sensitive.**

There are two modes available to you when working in the CLI:

<div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" id="bkmrk-command" style="border-style: solid; border-width: 1px;"><div class="panelContent">- Command

</div></div> 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

<span style="color: rgb(153,51,102);">   
</span>

<div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" id="bkmrk-configure" style="border-style: solid; border-width: 1px;"><div class="panelContent">- Configure

</div></div> Used for changing configurations for any settings, or viewing existing configurations for specific nodes.

 This mode can be accessed from the [root](https://public.intellasoft.net/pages/createpage.action?spaceKey=CLI&title=root&linkCreation=true&fromPageId=8030410) of Command Mode by typing **configure**

<div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" id="bkmrk--5" style="border-style: solid; border-width: 1px;"><div class="panelContent">  
</div></div>## Command Mode

#### callqueue

<div aria-labelledby="expand-button-1101997407" class="expand-content" id="bkmrk-agent" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**agent**</div><div class="panelContent">  
</div></div></div>Agent command description

<div aria-labelledby="expand-button-1101997407" class="expand-content" id="bkmrk-queues" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**queues**</div><div class="panelContent">  
</div></div></div>Queues command description

#### clear

##### voicemail

<div aria-labelledby="expand-button-1352968271" class="expand-content" id="bkmrk-box" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**box**</div><div class="panelContent">  
</div></div></div><div aria-labelledby="expand-button-1352968271" class="expand-content" id="bkmrk-greeting" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**greeting**</div><div class="panelContent">  
</div></div></div>#### configure

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-terminal"><div aria-labelledby="expand-button-619973389" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**terminal**</div><div class="panelContent">  
</div></div></div></div>#### disable

#### exit

#### mtr

##### ip

##### ipv6

#### ping

##### ip

##### ipv6

##### arp

#### reboot

#### services

##### restart

##### stop

##### start

#### Show

##### callqueue

agent

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-ogins"><div aria-labelledby="expand-button-1623775751" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**ogins**</div><div class="panelContent">  
</div></div></div></div>Show currently logged in agents

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-assignments"><div aria-labelledby="expand-button-1623775751" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**assignments**</div><div class="panelContent">  
</div></div></div></div>Show current agent assignments by call queue

queues

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-status"><div aria-labelledby="expand-button-231218556" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div></div>Show current queue statuses

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-config"><div aria-labelledby="expand-button-231218556" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**config**</div><div class="panelContent">  
</div></div></div></div>Show current queue configurations

polycom

<div aria-labelledby="expand-button-1349035215" class="expand-content" id="bkmrk-status-1" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div>Show current device status<span class="confluence-anchor-link conf-macro output-inline" data-hasbody="false" data-macro-name="anchor" id="bkmrk--7"></span>

<div aria-labelledby="expand-button-1349035215" class="expand-content" id="bkmrk-config-1" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**config**</div><div class="panelContent">  
</div></div></div>Show current device configuration

##### calls

<div aria-labelledby="expand-button-2039677654" class="expand-content" id="bkmrk-status-2" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div>List all current active calls

##### cos

List only CoS

<div aria-labelledby="expand-button-16655888" class="expand-content" id="bkmrk-includes" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**includes**</div><div class="panelContent">  
</div></div></div>List all CoS as well as any includes

##### devices

sip

<div aria-labelledby="expand-button-1035616597" class="expand-content" id="bkmrk-status-3" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div>iax

<div aria-labelledby="expand-button-1078396591" class="expand-content" id="bkmrk-status-4" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div>polycom

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk-status-5"><div aria-labelledby="expand-button-1490074502" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand"><div aria-labelledby="expand-button-744415835" class="expand-content" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div></div></div></div>##### diag

Show diagnostic information?

##### extensions

<div aria-labelledby="expand-button-1386206454" class="expand-content" id="bkmrk-status-6" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**status**</div><div class="panelContent">  
</div></div></div>##### interfaces

Show all interfaces and their current configuration/status

##### ip

<div aria-labelledby="expand-button-516344324" class="expand-content" id="bkmrk-interface" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**interface**</div><div class="panelContent">  
</div></div></div><div aria-labelledby="expand-button-516344324" class="expand-content" id="bkmrk-route" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**route**</div><div class="panelContent">  
</div></div></div>##### licenses

Display current available and assigned licenses

##### phonegroups

Display all current phonegroup information

##### polycoms

Show only installed polycoms on the system

##### registrations

<div aria-labelledby="expand-button-1442377190" class="expand-content" id="bkmrk-sip-1" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**sip**</div><div class="panelContent">  
</div></div></div><div aria-labelledby="expand-button-1442377190" class="expand-content" id="bkmrk-iax-1" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**iax**</div><div class="panelContent">  
</div></div></div><div aria-labelledby="expand-button-1442377190" class="expand-content" id="bkmrk-all" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">  
</div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**all**</div><div class="panelContent">  
</div></div></div>##### routes

Show route information

##### running-config

Show full configuration for all configured nodes

##### services

Show running services

<div aria-labelledby="expand-button-1835509331" class="expand-content" id="bkmrk-detail" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelHeader" style="border-bottom-width: 1px;">**detail**</div><div class="panelContent">  
</div></div></div>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

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--11"><div aria-level="6" class="expand-control" id="bkmrk--12" role="heading"></div></div><div aria-labelledby="expand-button-121806632" class="expand-content" id="bkmrk--13" role="region" style="display: block; opacity: 1;"></div><div aria-labelledby="expand-button-164991149" class="expand-content" id="bkmrk--14" role="region" style="display: block; opacity: 1;"></div><div aria-labelledby="expand-button-169194123" class="expand-content" id="bkmrk--15" role="region" style="display: block; opacity: 1;"></div><div aria-labelledby="expand-button-1658916538" class="expand-content" id="bkmrk--16" role="region" style="display: block; opacity: 1;"></div><div aria-labelledby="expand-button-65887207" class="expand-content" id="bkmrk--17" role="region" style="display: block; opacity: 1;"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--18"><div aria-level="6" class="expand-control" id="bkmrk--19" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--20"><div aria-level="6" class="expand-control" id="bkmrk--21" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--22"><div aria-labelledby="expand-button-1917868992" class="expand-content" id="bkmrk--23" role="region" style="display: block; opacity: 1;"><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--24"></div></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--25"><div aria-level="6" class="expand-control" id="bkmrk--26" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--27"><div aria-level="6" class="expand-control" id="bkmrk--28" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--29"><div aria-level="6" class="expand-control" id="bkmrk--30" role="heading"></div></div><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" id="bkmrk--31" style="border-style: solid; border-width: 1px;"><div class="panelContent"><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--32"><div aria-level="6" class="expand-control" id="bkmrk--33" role="heading"></div></div></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--34"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--35"><div aria-level="6" class="expand-control" id="bkmrk--36" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--37"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--38"><div aria-level="6" class="expand-control" id="bkmrk--39" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--40"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--41"><div aria-level="6" class="expand-control" id="bkmrk--42" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--43"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--44"><div aria-level="6" class="expand-control" id="bkmrk--45" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--46"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--47"><div aria-level="6" class="expand-control" id="bkmrk--48" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--49"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--50"><div aria-level="6" class="expand-control" id="bkmrk--51" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--52"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--53"><div aria-level="6" class="expand-control" id="bkmrk--54" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--55"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--56"><div aria-level="6" class="expand-control" id="bkmrk--57" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--58"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--59"><div aria-level="6" class="expand-control" id="bkmrk--60" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--61"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--62"><div aria-level="6" class="expand-control" id="bkmrk--63" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--64"></div>## Configure Mode

<div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--65"><div aria-level="6" class="expand-control" id="bkmrk--66" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--67"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--68"><div aria-level="6" class="expand-control" id="bkmrk--69" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--70"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--71"><div aria-level="6" class="expand-control" id="bkmrk--72" role="heading"></div></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--73"></div><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--74"><div aria-level="6" class="expand-control" id="bkmrk--75" role="heading"></div></div><div class="wiki-content" id="bkmrk--76"><div class="contentLayout2"><div class="columnLayout single" data-layout="single"><div class="cell normal" data-type="normal"><div class="innerCell"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-style: solid; border-width: 1px;"><div class="panelContent"><div class="expand-container conf-macro output-block" data-hasbody="true" data-macro-name="expand" id="bkmrk--77"></div></div></div>  
</div></div></div></div></div>#### 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

##### pbx2\_transport

##### pbx\_ip

##### pbx2\_reg\_period

##### pbx\_transport

<div id="bkmrk--79"></div>##### ringseconds\_till\_voicemail

##### server\_name

##### sip\_port

#### core\_sip\_settings

##### dtmfmode

##### qualify

##### qualifyfreq

##### rtpholdtimeout

##### rtptimeout

#### cos

Class of Service (CoS) takes a second argument which specifies either:

<div aria-labelledby="expand-button-606164794" class="expand-content" id="bkmrk-a-new-cos-name-you-w" role="region" style="display: block; opacity: 1;"><div class="panel conf-macro output-block" data-hasbody="true" data-macro-name="panel" style="border-width: 1px;"><div class="panelContent">- A new CoS name you wish to create and configure, e.g. "cos foo"
- An existing CoS name you wish to make changes to, e.g. "cos foo" where "foo" is an already existing CoS

</div></div></div>