Thursday, March 14, 2019

ShoreTel: ShoreTel CLI Command Reference Sheet

This is just a quick reference sheet for CLI commands that can be used on the ShoreTel server, DVS server, ShoreTel switches, and ShoreTel phones. A lot of this info can also be found in the Maintenance guide.


Server commands

  1. Showlog.exe – shows logs in real time “best used during quiet time on the system”
  2. Burnflash – forces the switch to accept new firmware
    1. burnflash – s <switch IP address> ex: burnflash –s 10.167.20.21
  3. slogwin - Start the ShoreTel app to pull Server logs

IPBXctl commands: (all must be done from C:\program files\shoreline communications\shoreware server or C:\program files <x86>\shoreline communications\shoreware server depending on the server partition setup)

  1. IPBXctl –telneton <switch IP address> ex: IPBXctl –telneton 10.167.20.21
  2. IPBXctl –reboot <switch IP address> ex: IPBXctl –reboot 10.167.20.21
  3. IPBXctl –flash <switch IP address> ex: IPBXctl –flash 10.167.20.21
  4. IPBXctl –ftp <switch IP address> ex: IPBXctl –ftp 10.167.20.21
  5. IPBXctl –reset <switch IP address> ex: IPBXctl –reset 10.167.20.21
  6. IPBXctl –diag <switch IP address> ex: IPBXctl –diag 10.167.20.21


Switch Environment Settings: Used when the switch enters perpetual boot loop or fails to boot from FTP – basic configuration is possible in this area but should be performed through Application Layer.

Login to application layer of the switch after connecting via putty or telnet

  1. bootChange – will take you to the Vxworks
  2. printenvdiag – displays switch environmental settings
  3. setenv – followed with environment field and variable setenv/bootfile/flash0/vxworks
  4. saveenv – saves any environment changes
  5. reset - command is used to cycle the Switch into a full reboot

Linux DVS Login: root  Password: ShoreTel
Commands:

  1. svccli: Starts the service command line interface. All subcommands are run from the main
    1. Ex: svccli getstatus
  2. getsvcstatus: reports all services status
  3. startsvc <service name> ex: svccli startsvc TMS
  4. stopsvc <service name> ex: svccli stopsvc TMS
  5. CTRL +C exits svccli



Switch Commands



  1. gotoshell - Used to get to the VXworks CLI
  2. cliStart - Used to get to ShoreTel CLI configuration menu
  3. ping "<IP_Address>" 
  4. traceroute "<IP_Address>"
  5. reboot
  6. Record2File2(port,time,<file_name>;0) - Records inbound medaio on the speciied port for the specified time (in seconds) and writes the file to inetpub/ftproot



Switch Diagnostics:

  1. memShow – use prior doing traces to ensure the switch has enough available memory for trace timestamp_st_dpf=1 -- provides time stamps with each debug message
  2. dbg “clear” -- clears all debugs on the switch.
  3. LSP (Location Service Protocol)
    1. lspConList – switch connectivity to other switches
    2. lsp_debug_level- shows messaging that switches are exchanging
    3. lsp_ping test LSP UDP communications between switches – much like a ping including location response

Switch Trunks:

  1. Pri_verbose –used to trace PRI output
    1. Pri_log – D Channel output begins at Level 4.
    2. Pri_trace – PRI D channel trace debug level
  2. Trunk_coo_status – Call Control Object of the trunk
  3. Trunk_debug_level – sets debug level (both SIP and PRI)
  4. Sip_debug_level -
  5. Sip_register_debug_level – SIP level which shows how much SIP code will be collected.
  6. Record2File2- records audio from trunk to trunk

Phones:

  1. printSysInfo - show phone configuration
  2. Ext_cco_status – switches extension Call control object
  3. Ext_conf_status – displays Make me conference ports
  4. Ext_debug_level – logs the Call control object configuration
  5. MGCP
    1. MGCP_msg_debug – logs messages – not commonly used
    2. MGCP_trans_debug -- logs transactions – not commonly used
  6. SIP
    1. Sip_debug_Level – log SIP messaging and ShoreTel Enchanced SIP
    2. sipualList – List all SIP device managed by switch