custom cisco configuration files - spiceworks

Z u l t y s , I n c . 7 7 1 V a q u e r o s S u n n y v a l e , C a l i f o r n i a , U S A 9 4 0 8 5 w w w . z u l t y s . c o m

Author: Zultys Technical Support Department

At times you wish to have more control, and personalization of the Cisco phones than what is offered by the default profile options provided by the MX’s profile. This document covers how to create your own custom configuration files that will be used instead of the configurations built by the MX. This document is provided as is with limited support from Zultys. It is important to remember to modify the SIPDefault.cnf file to point to a directory other than the /Cisco7960 directory which the MX controls. This document is meant to be an addition to the Cisco 7940/7960 Install and configuration document. Please refer to this document for all details on supported features and functionality of the Cisco 7940/7960 device.

April 14

Custom Cisco Configuration Files

Z

Technical Publications

Custom Configuration Files for Cisco Phones (0000000332)/Revision 6 Apr. 15, 14 © 2014 Zultys, Inc. No reproduction of distribution without permission

of 19


No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Zultys, Inc. Under the law, “reproducing” includes translating the document’s content into another language or format.

Information in this document is subject to change without notice. Every effort has been made to ensure that the information in this document is accurate. Zultys, Inc. is not responsible for printing or clerical errors. Any troubleshooting suggestions or suggestions for resolving common issues included in this document are recommendations made by Zultys Technical Support team and are not guaranteed to resolve every issue the reader may encounter.


of 19


1 Contents 1 CREATE PROFILE FOR CISCO PHONE ............................................................................................ 3 1.1 DEFINE THE PROFILE ................................................................................................................ 4

2 CREATE CUSTOM CONFIGURATION FILE(S) ...................................................................... 5

2.1 LOGO (OPTIONAL) ................................................................................................................... 5 2.2 DIRECTORY (OPTIONAL) ........................................................................................................... 5 2.3 TELNET (OPTIONAL) ................................................................................................................. 6 2.4 FIRMWARE VERSION ................................................................................................................. 6 2.5 TIME / DAYLIGHT SAVINGS ....................................................................................................... 6 2.6 AUTHENTICATION MUST BE ADDED TO THE PARTICULAR CONFIGURATION FILES....................... 6

3 COMPLETE TEXT (EXAMPLE CONFIGURATION) ............................................................... 8

1.2 SIPDEFAULT.CNF (FULL EXAMPLE) ......................................................................................... 10

4 CONFIGURATION FILE FOR A CISCO 7970/7971 PHONE ................................................ 11

5 FIRMWARE FILES ................................................................................................................... 18

5.1 OS79XX.TXT ...................................................................................................................... 18 5.2 SIPDEFAULTGENERIC.CNF ..................................................................................................... 18 5.3 SIPCONFIGGENERIC.CNF ....................................................................................................... 18 5.4 RINGLIST.DAT .................................................................................................................... 18 5.5 RINGER1.PCM ......................................................................................................................... 19 5.6 P003.........BIN ....................................................................................................................... 19 5.7 P003.........SBN ...................................................................................................................... 19 5.8 P0A3.........LOADS................................................................................................................... 19 5.9 P0A3.........SB2 ....................................................................................................................... 19

1 Create Profile for Cisco phone

From the MX Administration UI select Configure | Devices | Profile button, and right mouse click “ZultysPhones” and choose “New” to create a new device profile. You must have an existing device profile to add a device.


of 19


From the pop up select “Cisco 7960”

Enter in a profile name; here we used “7960”

1.1 Define the Profile

The profile screen can be left empty, as we are not going to be using the profile, or the configuration files it creates.


of 19


2 Create Custom Configuration file(s) When creating a custom configuration file you must create a separate file per phone that you are deploying, and it is all or none. You cannot mix custom files with non-custom files.

The configuration files must follow Cisco’s naming convention which is “SIP00036B75ABF1.cnf” that is it always starts with “SIP” in capitals followed by the MAC address all capitals, the extension is “.cnf”.

2.1 Logo (optional)

# Pointer to Zultys logo on the MX250. logo_url:" http://192.168.1.1/images/7960_LCD_screen5.bmp "

This image already resides on the MX250/MX30, and does not need to be installed.

2.2 Directory (optional)

#Directory directory_url: "http://10.0.0.220/cisco/phone_book.php"


of 19


This directory file is a custom file that reads from the CDR Database on the MX and needs to be hosted on a separate web server. Please refer to document Cisco_Phonebook.pdf (0000000009) for further information. It can also be a custom flat file you host as well.

2.3 Telnet (optional)

# Open telnet access to Cisco telnet_level:2

2.4 Firmware version

# Version number 7.5 image_version: P0S3-07-5-00

In this example we will be using firmware version 7.5 which can only be obtained from Cisco.

2.5 Time / Daylight savings

sntp_mode : DirectedBroadcast sntp_server : 192.168.1.1 time_zone : EST dst_offset : 1 dst_start_month : Mar dst_start_day : 2

dst_start_day_of_week : Sun dst_start_week_of_month : 1 dst_start_time : 02 dst_stop_month : Nov dst_stop_day : 1 dst_stop_day_of_week : Sun dst_stop_week_of_month : 1 dst_stop_time : 2 dst_auto_adjust : 1 time_format_24hr : 1 date_format : M/D/Y

2.6 Authentication must be added to the particular configuration files In this example we are registering with the Device ID set to be the MAC address of the device, and that device has extension 5040.

;Authname ; Name used by phone for auth if registration challenges line1_authname : "00036B75ABF1" line2_authname : UNPROVISIONED


of 19


line3_authname : UNPROVISIONED line4_authname : UNPROVISIONED line5_authname : UNPROVISIONED line6_authname : UNPROVISIONED ; ;Contact ; The URL that appears in the SIP contact field line1_contact : "5040" line2_contact : UNPROVISIONED line3_contact : UNPROVISIONED line4_contact : UNPROVISIONED line5_contact : UNPROVISIONED line6_contact : UNPROVISIONED ;

;Displayname ; Caller ID as it appears to remote users line1_displayname : "Ext 5040" line2_displayname : UNPROVISIONED line3_displayname : UNPROVISIONED line4_displayname : UNPROVISIONED line5_displayname : UNPROVISIONED line6_displayname : UNPROVISIONED ; ;Name ; Name used for registering with SIP server line1_name : "00036B75ABF1" line2_name : UNPROVISIONED line3_name : UNPROVISIONED

line4_name : UNPROVISIONED line5_name : UNPROVISIONED line6_name : UNPROVISIONED ; ;Password ; Password used by phone for auth if registration challenges -- Put SIP Proxy Password here ; line1_password : "" line2_password : "" line3_password : "" line4_password : "" line5_password : "" line6_password : ""

; ;Shortname ; Used on the phone LCD display next to the line button ; line1_shortname : "5040" line2_shortname : UNPROVISIONED line3_shortname : UNPROVISIONED line4_shortname : UNPROVISIONED line5_shortname : UNPROVISIONED line6_shortname : UNPROVISIONED


of 19


;

3 Complete Text (Example Configuration) call_waiting: 3

dtmf_outofband: avt_always

;

# SIP Phone-specific configuration file

# Version number 7.5

image_version: P0S3-07-5-00

;

# Pointer to Zultys logo on the MX1200.

logo_url:"http://192.168.1.1/images/7960_LCD_screen5.bmp"

;

#Directory

directory_url: "http://10.0.0.220/cisco/phone_book.php"

;

# Open telnet access to Cisco

telnet_level:2

services_url : ""

############## Time related

sntp_mode : DirectedBroadcast

sntp_server : 192.168.1.1

time_zone : EST

dst_offset : 1

dst_start_month : Mar

dst_start_day : 2

dst_start_day_of_week : Sun

dst_start_week_of_month : 1

dst_start_time : 02

dst_stop_month : Nov

dst_stop_day : 1

dst_stop_day_of_week : Sun

dst_stop_week_of_month : 1

dst_stop_time : 2

dst_auto_adjust : 1

time_format_24hr : 1

date_format : M/D/Y

##############

preferred_codec : g711ulaw

phone_label : "Zultys 7960"

;

;Authname

; Name used by phone for auth if registration challenges

line1_authname : "00036B75ABF1"

line2_authname : UNPROVISIONED





;

;Contact

; The URL that appears in the SIP contact field

line1_contact : "5040"

line2_contact : UNPROVISIONED





of 19



;

;Displayname

; Caller ID as it appears to remote users

line1_displayname : "Ext 5040"

line2_displayname : UNPROVISIONED





;

;Name

; Name used for registering with SIP server

line1_name : "00036B75ABF1"

line2_name : UNPROVISIONED





;

;Password

; Password used by phone for auth if registration challenges -- Put SIP Proxy

Password here

;

line1_password : ""

line2_password : ""

line3_password : ""

line4_password : ""

line5_password : ""

line6_password : ""

;

;Shortname

; Used on the phone LCD display next to the line button

;

line1_shortname : "5040"

line2_shortname : UNPROVISIONED





;

speed_label2 : "Speed 2"

speed_line2 : "5041"

speed_label3 : "speed 3"

speed_line3 : "5030"

speed_label4 : ""

speed_line4 : ""

speed_label5 : ""

speed_line5 : ""

speed_label6 : ""

speed_line6 : ""

; Enable NAT -- Put YOUR External (Outside of your firewall) Address in the

nat_address field

nat_enable: 0

nat_address: UNPROVISIONED

; Enable Message Waiting Indicator (MWI)

messages_uri: "*86"

###############################

proxy1_address : "192.168.1.1"

proxy2_address : ""

proxy3_address : ""

proxy4_address : ""


of 19


proxy5_address : ""

proxy6_address : ""

proxy1_port : 5060

proxy2_port : 5060

proxy3_port : 5060

proxy4_port : 5060

proxy5_port : 5060

proxy6_port : 5060

outbound_proxy : "192.168.1.1"

outbound_proxy_port : 5060

proxy_register : 1

proxy_backup : ""

proxy_emergency : ""

proxy_backup_port : 5060

proxy_emergency_port : 5060

dnd_control : 0

1.2 SIPDefault.cnf (full example)

This is modified from the default 7.5 version. It is extremely important to change the tftp_cfg_dir so that it is NOT ./Cisco7960 as the MX will overwrite any custom configuration files you create.

tftp_cfg_dir: ./ logo_url: "http://192.168.1.1/images/7960_LCD_screen5.bmp"

image_version: "P0S3-07-5-00" network_media_type : Auto network_port2_type : Hub/Switch dscpForAudio : 184 phone_password : "cisco" phone_prompt : ">>" language : english voip_control_port : 5060 start_media_port : 16384 end_media_port : 32766 sync : "1" xml_card_dir : "" xml_card_file : "CARD.XML" http_proxy_addr : UNPROVISIONED

http_proxy_port : 80 garp_enable : 0 enable_vad : 0 dial_template : "dialplan" callerid_blocking : 0 anonymous_call_block : 0 autocomplete : 1 dtmf_outofband : avt dtmf_avt_payload : 101 dtmf_db_level : 4


of 19


dtmf_inband : 0 sip_retx : 10 sip_invite_retx : 6 timer_t1 : 500 timer_t2 : 4000 timer_invite_expires : 180 timer_register_expires : 3600 nat_received_processing : 0 call_waiting : 1 user_info : "" cnf_join_enable : 1 remote_party_id : 1 semi_attended_transfer : 0 transfer_onhook_enabled : 1

call_hold_ringback : 1 stutter_msg_waiting : 0 cfwd_url : "" call_stats : 0 auto_answer : 0 local_cfwd_enable : 0 timer_register_delta : 5 sip_max_forwards : 70 rfc_2543_hold : 0 version_stamp : "" timer_keepalive_expires : 120 connection_monitor_duration : 120

4 Configuration file for a Cisco 7970/7971 phone

Zultys only currently supports the 7970/7971 phones. In configuration files for phones other than the 7970 such as the 7970 you need to set the authName and authPassword fields to be the Device Name in the MX and SIP Proxy Password in the MX. Incomplete sample XML file:

<device>

<deviceProtocol>SIP</deviceProtocol>

<sshUserId>user</sshUserId>

<sshPassword>pass</sshPassword>

<devicePool>

<dateTimeSetting>

<dateTemplate>M-D-Ya</dateTemplate>

“a” indicates time shown in 12 hour format

Setting these parameters will allow you to ssh to the IP phone. Login with these first, and then login with debug/debug to debug the phone.


of 19


<timeZone>Mountain Standard/Daylight Time</timeZone>

<ntps>

<ntp>

<name>172.16.30.1</name>

<ntpMode>Unicast</ntpMode>

</ntp>

</ntps>

</dateTimeSetting>

<callManagerGroup>

<members>

<member priority="0">

<callManager>

<ports>

<ethernetPhonePort>2000</ethernetPhonePort>

<sipPort>5060</sipPort>

<securedSipPort>5061</securedSipPort>

</ports>

<processNodeName>172.16.30.1</processNodeName>

</callManager>

</member>

</members>

</callManagerGroup>

</devicePool>

<sipProfile>

<sipProxies>

<backupProxy></backupProxy>

These SIP proxy settings seem to need the port umbers set even though we don’t set the IP addresses for the proxies

Not sure this one is necessary, but is the IP address of the MX250

NTP Server Address


of 19


<backupProxyPort>5060</backupProxyPort>

<emergencyProxy></emergencyProxy>

<emergencyProxyPort>5060</emergencyProxyPort>

<outboundProxy></outboundProxy>

<outboundProxyPort>5060</outboundProxyPort>

<registerWithProxy>true</registerWithProxy>

</sipProxies>

<sipCallFeatures>

<cnfJoinEnabled>true</cnfJoinEnabled>

<callForwardURI>x--serviceuri-cfwdall</callForwardURI>

<callPickupURI>x-cisco-serviceuri-pickup</callPickupURI>

<callPickupListURI>x-cisco-serviceuri-opickup</callPickupListURI>

<callPickupGroupURI>x-cisco-serviceuri-gpickup</callPickupGroupURI>

<meetMeServiceURI>x-cisco-serviceuri-meetme</meetMeServiceURI>

<abbreviatedDialURI>x-cisco-serviceuri-abbrdial</abbreviatedDialURI>

<rfc2543Hold>false</rfc2543Hold>

<callHoldRingback>2</callHoldRingback>

<localCfwdEnable>true</localCfwdEnable>

<semiAttendedTransfer>true</semiAttendedTransfer>

<anonymousCallBlock>2</anonymousCallBlock>

<callerIdBlocking>2</callerIdBlocking>

<dndControl>0</dndControl>

<remoteCcEnable>true</remoteCcEnable>

</sipCallFeatures>

<sipStack>

<sipInviteRetx>6</sipInviteRetx>

Necessary!

0 indicates “on” here


of 19


<sipRetx>10</sipRetx>

<timerInviteExpires>20</timerInviteExpires>

<timerRegisterExpires>20</timerRegisterExpires>

<timerRegisterDelta>5</timerRegisterDelta>

<timerKeepAliveExpires>20</timerKeepAliveExpires>

<timerSubscribeExpires>20</timerSubscribeExpires>

<timerSubscribeDelta>5</timerSubscribeDelta>

<timerT1>500</timerT1>

<timerT2>4000</timerT2>

<maxRedirects>70</maxRedirects>

<remotePartyID>false</remotePartyID>

<userInfo>None</userInfo>

</sipStack>

<preferredCodec>g711u</preferredCodec>

<dtmfAvtPayload>101</dtmfAvtPayload>

<dtmfDbLevel>3</dtmfDbLevel>

<dtmfOutofBand>avt</dtmfOutofBand>

<alwaysUsePrimeLine>false</alwaysUsePrimeLine>

<alwaysUsePrimeLineVoiceMail>false</alwaysUsePrimeLineVoiceMail>

<kpml>3</kpml>

<phoneLabel>Brian</phoneLabel>

<callStats>false</callStats>

<disableLocalSpeedDialConfig>false</disableLocalSpeedDialConfig>

<startMediaPort>16384</startMediaPort>

<stopMediaPort>32766</stopMediaPort>

<sipLines>


of 19


<line button="1">

<featureID>9</featureID>

<featureLabel>8931</featureLabel>

<proxy>172.16.30.1</proxy>

<port>5060</port>

<name>7971</name>

<displayName>BrianO</displayName>

<autoAnswer>

<autoAnswerEnabled>2</autoAnswerEnabled>

</autoAnswer>

<authName></authName>

<authPassword></authPassword>

<sharedLine>false</sharedLine>

<messageWaitingLampPolicy>1</messageWaitingLampPolicy>

<messagesNumber>*86</messagesNumber>

<ringSettingIdle>4</ringSettingIdle>

<ringSettingActive>5</ringSettingActive>

<contact>7b452e87-4496-4762-e11f-b26751a1884b</contact>

<forwardCallInfoDisplay>

<callerName>true</callerName>

<callerNumber>true</callerNumber>

<redirectedNumber>true</redirectedNumber>

<dialedNumber>true</dialedNumber>

</forwardCallInfoDisplay>

</line>

</sipLines>


of 19


<voipControlPort>5060</voipControlPort>

<dscpForAudio>184</dscpForAudio>

<ringSettingBusyStationPolicy>0</ringSettingBusyStationPolicy>

<dialTemplate>dialplan.xml</dialTemplate>

<softKeyFile></softKeyFile>

</sipProfile>

<commonProfile>

<phonePassword></phonePassword>

<backgroundImageAccess>true</backgroundImageAccess>

<callLogBlfEnabled>2</callLogBlfEnabled>

</commonProfile>

<loadInformation>SIP70.8-3-5S</loadInformation>

<vendorConfig>

<disableSpeaker>false</disableSpeaker>

<disableSpeakerAndHeadset>false</disableSpeakerAndHeadset>

<pcPort>0</pcPort>

<settingsAccess>1</settingsAccess>

<garp>0</garp>

<voiceVlanAccess>0</voiceVlanAccess>

<videoCapability>0</videoCapability>

<autoSelectLineEnable>0</autoSelectLineEnable>

<webAccess>1</webAccess>

<daysDisplayNotActive>1,7</daysDisplayNotActive>

<displayOnTime>08:00</displayOnTime>

<displayOnDuration>10:30</displayOnDuration>

<displayIdleTimeout>01:00</displayIdleTimeout> 1 indicates “off”

This file needs to be available in the TFTP server

We didn’t change these as we’re on a Cisco switch and it recognizes Cisco phones connected to it. Changes might be necessary if connected to a non-Cisco switch


of 19


<spanToPCPort>1</spanToPCPort>

</vendorConfig>

<versionStamp>1136931633-57191cee-5ffc-4342-b286-4246b4991890</versionStamp>

<userLocale>

<name>English_United_States</name>

<langCode>en_US</langCode>

<version>1.0.0.0-1</version>

<winCharSet>iso-8859-1</winCharSet>

</userLocale>

<networkLocale>United_States</networkLocale>

<networkLocaleInfo>

<name>United_States</name>

<version>1.0.0.0-1</version>

</networkLocaleInfo>

<deviceSecurityMode>1</deviceSecurityMode>

<idleTimeout>0</idleTimeout>

<authenticationURL></authenticationURL>

<directoryURL>http://172.16.20.1/directorylist.asp</directoryURL>

<idleURL></idleURL>

<informationURL></informationURL>

<messagesURL></messagesURL>

<proxyServerURL></proxyServerURL>

<servicesURL>http://phone-xml.berbee.com/menu.xml</servicesURL>

<dscpForSCCPPhoneConfig>96</dscpForSCCPPhoneConfig>

<dscpForSCCPPhoneServices>0</dscpForSCCPPhoneServices>

<dscpForCm2Dvce>96</dscpForCm2Dvce>

This points to our LDAP directory


of 19


<transportLayerProtocol>4</transportLayerProtocol>

<capfAuthMode>0</capfAuthMode>

<capfList>

<capf>

<phonePort>3804</phonePort>

</capf>

</capfList>

<certHash></certHash>

<encrConfig>false</encrConfig>

</device>

5 Firmware Files There are several configuration files used in the provisioning of a Cisco phone (From Cisco’s SIP Conversion document). All files listed here must be obtained from Cisco.

5.1 OS79XX.TXT This file tells the Cisco 7940/7960 which binary to download from the TFTP server. This file is case sensitive and must only contain the name of the file that you want to load, without the .bin extension. For example, if you attempt to load the SIP version 2.3 software, it must contain only the line P0S30203. If you try to load versions 3.0 and later, the file name must be in the format P0S3-xx-y-zz. For example, if you attempt to load the SIP version 7.1 software, OS79XX.TXT must contain the line P0S3-07-1-00. The binary referenced here must also be present in the TFTP root directory. Without this file, the phone does not know which file it needs to retrieve, in order to replace its existing software.

5.2 SIPDefaultGeneric.cnf This file is an example of a default configuration file. This file contains configuration information relevant to all phones.

5.3 SIPConfigGeneric.cnf This file is similar to the previous one, except that it contains information relevant to a specific phone instead of to all phones.

5.4 RINGLIST.DAT Lists audio files that are the custom ring type options for the phones. The audio files listed in the RINGLIST.DAT file must also be in the root directory of the TFTP server.


of 19


5.5 ringer1.pcm This file is a sample ring tone that is used by the Cisco 7940/7960.

5.6 P003.........bin Nonsecure universal application loader for upgrades from images earlier than 5.x.

5.7 P003.........sbn Secure universal application loader for upgrades from images 5.x or later.

5.8 P0a3.........loads File that contains the universal application loader and application image, where a represents the protocol of the application image LOADS file: 0 for SCCP, and S for SIP.

5.9 P0a3.........sb2 Application firmware image, where a represents the application firmware image: 0 for SCCP, and S for SIP.

custom cisco configuration files - spiceworks

Documents