This appendix provides information on the parameters and defaults for the profile, or configuration file, that you use to provision your Cisco IP Phone 7905G. It also contains a sample profile text file. It contains the following sections:
When you configure a Cisco IP Phone 7905G using a TFTP server, you create a text file with parameters and values to use for various phone settings and the network to which the phone connects. This text file is called the profile for the phone.
Profiles use the following conventions:
•The characters #txt must appear at the beginning of the first line of a file so that the formatting tool, cfgfmt.exe, will treat it as text file.
•A pound sign (#) at the beginning of a line indicates a comment.
•Parameter/value pairs are entered in the form parameter:value, each pair on a separate line.
•All parameter/value pairs are optional, but the Cisco IP Phone 7905G might not function properly if some values are missing.
•A parameter value is one of the following types:
–Alphanumeric string
–Numeric digit string
–Array of short integers
–IP address (for example, 192.168.2.170)
–Extended IP address—IP address with port (for example, 192.168.2.170.9001)
–Boolean (1 or 0)
–Bitmap—unsigned hexadecimal integer (for specifying bits in 32-bit integer)
–Integer (32-bit integer)
Parameter definitions and defaults are provided in the following tables:
Specifies whether the phone has been configured or not.
Enter a value of 0 or 1.
•Use 0 if the phone has been previously configured.
•Use 1 if the phone is fresh from factory and has never been configured.
A good habit is to include "ToConfig:0" in every profile so that the proper value is downloaded on every TFTP refresh.
UseTftp
Specifies whether to contact an TFTP server to download the configuration profile.
Enter a value of 0 or 1.
•Use 0 if do not use a TFTP server.
•Use 1 if you are using a TFTP server:
If TftpURL is set to 0, use the TFTP IP address or URL obtained from the DHCP server to contact the TFTP server.
If TftpURL is set to other than 0, use the specified IP address or URL to contact the TFTP server.
If you set this value to 1 and subsequently make changes via the web interface, you must set it to 0 before saving those changes; otherwise, the changes are overwritten by the TFTP server.
TftpURL
Specifies the IP address or URL of the TFTP server.
Use alphanumeric string, up to 31 characters. You must set the IP address or URL of the TFTP server if the DHCP server does not provide it.
Optionally, you can include the path prefix to the profile file to download. For example, if the TFTP server IP address is 192.168.2.170 or www.cisco.com, and the path to the file is /ip7905, you can specify the URL as 192.168.2.170/ip7905 or www.cisco.com/ip7905.
CfgInterval
Specifies the time in seconds that the phone waits to contact the TFTP server for configuration updates.
Enter a numeric value between 60 to 4,294,967,295.
The default value is 3600.
At the earliest idle time following each interval expiration, the phone retrieves its configuration file using the tftp get command. Intervals should vary among phones on a network to prevent massive simultaneous contact of the TFTP server.
EncryptKey
Specifies the key to be used to decrypt the configuration profile that was downloaded from the TFTP server.
Use an alpha numeric string, up to 8 characters if you encrypted the binary profile. Use the same key that you used when you converted the profile to a binary file with cfgfmt.exe.
Set the key to 0 if you are not encrypting the configuration profile.
The default value is 0.
DHCP
Specifies whether to contact the DHCP server to obtain values for network-related parameters such as IP address, router IP address, subnet mask, NTP, TFTP, domain name, DNS, VLAN ID, and more.
Set DHCP to 0 if you are not using a DHCP server. Set DHCP to 1 if you are using a DHCP server. The default value is 1.
StaticIP
The static IP address of the Cisco IP Phone 7905G when DHCP is not used.
Enter the assigned IP address for the phone.
This value is ignored when DHCP is enabled.
StaticRoute
The static IP address of the network router when DHCP is not used.
Enter the assigned IP address of the network router.
This value is ignored when DHCP is enabled.
StaticNetMask
The static IP address of the Cisco IP Phone 7905G when DHCP is not used.
Enter the subnet mask for the phone.
This value is ignored when DHCP is enabled.
Domain
The domain name on the network in which the phone operates, used in the creation of the endpoint identifier.
Enter the domain name, up to 31 alphanumeric characters maximum.
For example, if the name of the endpoint is aaln1 and the domain is cisco.com, the endpoint identifier is aaln1@cisco.com.
•. =Use the DHCP-provided IP address if available; otherwise use the static IP address.
•0=Use the DHCP-provided domain name if available; otherwise use the static IP address.
•string=Use the specified domain name string and overwrite any DHCP-provided domain name.
•Blank field=The default behavior is the same as a dot.
The default value is 0.
DNS1IP, DNS2IP
IP address of the primary and secondary DNS servers when DHCP is not used.
Enter the IP address for the DNS server.
If you specify an IP address for either DNS1IP or DNS2IP, you will overwrite the DHCP-supplied value for those parameters. Set DNS1IP and DNS2IP to 0 if you want the phone to use the DHCP-supplied values. Do not specify a port; the phone uses the default DNS port only.
The default value is 0.
NTPIP
IP address of the primary NTP server.
Enter the IP address for the NTPIP.
If you specify an IP address for NTPIP, you will overwrites the DHCP-supplied value for that parameter. Set NTPIP to 0 if you want the phone to use the DHCP-supplied value. Do not specify a port; the phone uses the default NTP port only.
The default value is 0.
AltNTPIP
IP address of a secondary NTP server when redundancy is desired.
Enter the IP address for the Alternate NTPIP.
Enter a value of 0 when only there is only one NTP server or if you wish to use the DHCP-supplied value. Do not specify a port; the phone uses the default NTP port only.
The default value is 0.
OpFlags
Turns on or off various features on the Cisco IP Phone 7905G.
The bitmap is as follows:
•Bit 0 (mask 0x1): 1=Ignore the DHCP-assigned TFTP filename and use the filename (ldxxxxxxxxxxxx where each xx is the two-digit lowercase hexadecimal representation for each integer in the phone's MAC address) as the profile when using TFTP for provisioning.
•Bit 1 (mask 0x2): If the phone is configured to use static IP (route/gateway address statically assigned), set to 1 to prevent probing at boot time. Otherwise, the phone probes the route/gateway address to determine if there is any network connectivity.
•Bit 2: Reserved.
•Bit 3 (mask 0x8): 1=Do not ask for DHCP option 150 in the DHCP DISCOVERY message.
•Bit 4 (mask 0x10): 1=Assume operation under VLAN (the VLAN ID is specified in the VLANSetting parameter).
•Bit 5 (mask 0x20): 1=Turn off VLAN IP encapsulation.
•Bit 6 (mask 0x40): 1=Do not perform CDP discovery.
•Bit 7 (mask 0x80): 1=Do not allow web configuration of the phone.
•Bit 8 (mask 0x100):1 = Do not allow web refresh of the phone.
•Bit 9 (mask 0x200):1= Do not allow web reset of the phone.
The default value is 0x00000002.
VLANSetting
Specifies various VLAN settings
The bitmap is as follows:
•Bits 0-2 (mask 0x7): 802.1Q=Priority for signalling IP packets.
•Bits 3-5 (mask 0x38): 802.1Q=Priority for audio voice IP packets.
Specifies the IP address and port of a host to which all phone debug messages are sent.
Enter the extended IP address of the host in the form of "a.b.c.d.port."
The host must be running the prserv.exe application at the corresponding port.
For example, if you want to send debug messages to a server running the pserv application at 192.168.2.170 on port, you would set this parameter to 192.168.2.170.9001. Set NPrintf to 0 if you do not want the phone to generate debug trace messages.
The default value is 0.
TraceFlags
Turns on or off specific trace features when Nprintf is set to a valid host address and port.
The bitmap is as follows
•Bits 0-7 and 9-31 are reserved and should be set to 0.
•Bit 8(mask 0x100): 1=Enable RTP statistics log.
Set TraceFlag to 0 is you do not want to generate debug messages.
The default value is 0.
H.323 Parameters
Table A-2 H.323 Parameters
Parameter
Description
Usage Notes
UID
The E.164 identification corresponding to the phone number.
Alphanumeric string, 31 characters maximum.
PWD
User password
Alphanumeric string, 31 characters maximum. Use the PWD parameter in conjunction with LoginID for user authentication.
Gk
IP address of the gatekeeper.
Enter the IP address of the gatekeeper. If you are not using a gatekeeper, set the GK value to 0. The user can still dial other H.323 devices by dialing their IP address and substituting * for the period.
The default value is 0.0.0.0.
Gateway
IP address of the gateway, when a gatekeeper is not used.
Enter the IP address of the gateway.
The default value is 0.0.0.0
This value is ignored if Gk is nonzero.
UseLoginID
Specifies whether to use the login identification specified in LoginID.
Boolean value of 0 or 1:
•0=Do not use LoginID; use UID.
•1=Use LoginID.
The default value is 0.
This value is required if AutMethod is set to 1.
LoginID
Login identification.
Alphanumeric string, 19 characters maximum. If you enable UseLoginID, you will need to set a LoginID and PWD for user authentication.
Note The LoginID value is case sensitive.
AltGk
IP address of the alternate gatekeeper.
Enter the IP address of the alternate gatekeeper.
AltGkTimeOut
Alternate gatekeeper timeout value in seconds.
Enter a numeric value from 0 to 4,294,967,295.
The default value is 0.
GkTimeToLive
Gatekeeper time-to-live value.
Enter a numeric value from 0 to 4,294,967,295.
The default value is 300.
GkId
Gatekeeper zone identification
Alphanumeric string, 31 characters maximum
AutMethod
Authentication method:
Bitmap is as follows:
•Bits 0-1 (mask 0x3):
–0=No authentication.
–1=Cisco registration-level security (H.235).
–2=Cisco admission-level security.
•Bit 2 (mask 0x4): Prefix password value when registering.
The default value is 0.
Tone Parameters
Table A-3 Tone Parameters
Parameter
Description
Usage Notes
SigTimer
Timeout values for signal events.
32 bit hexadecimal value.
•Bits 0-7: Call Waiting Tone Period,the interval during which call-waiting tone is played. Range is 0 to 255, in 0.1-second increments. The default is 100 (0x64, 10 seconds).
•Bits 8-13: Reorder Delay, the interval after the far end hangs up before reorder tone (fast busy) is played. Range is 0 to 62 seconds. 63=Never play reorder tone. The default is 5 seconds.
•Bits 14-19: Ring Timeout, the timeout in ringing the phone after which the phone rejects the incoming call. Range is 0 to 63, in 10-second increments. 0=Never time out. The default is 6 (60 seconds).
•Bit 20-25: Incoming Call No Answer Timeout: Time to declare no answer and initiate call forwarding on no answer (Note: Call forwarding is not a supported feature for H.323) Range = 0 to 63 second. The default is 20 (0x14 = 20 sec).
•Bits 26-32: Reserved
The default value is 0x01418564.
RingOnOffTime
Ringer cadence pattern.
Triplet of integers a,b,c separated by commas, where:
•a=Number of seconds to wait before turning the ring on.
•b=Number of seconds to wait before turning the ring off.
•c=Ring frequency.
The default standard value in the United States is 2,4,25.
Note The ring frequency portion of this parameter is currently not enabled and must be set to 25.
DialTone
Tone that plays when the phone is ready to accept the first digit of a telephone number or IP address.
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the DialTone in terms of frequency by using DialToneFreq.
The value is the number of 10-milliseconds units (so 100=1 second).
For DialTone, the following is appropriate for the US: DialTone=2,31538,30831,3100,3885,1,0,0,0 (equal to -10 dBm).
For DialTone, the following is appropriate for Sweden: DialTone=1,30959,0,4253,0,1,0,0,0 (equal to -5 dBm).
BusyTone
Tone that plays when the called number is occupied.
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the BusyTone in terms of frequency by using BusyToneFreq.
The value is the number of 10-milliseconds units (so 100=1 second).
The following is appropriate for the US: BusyTone=2,30467,28959,1191,1513,0,4000,4000,0 (equal to -21 dBm).
The following is appropriate for Sweden: BusyTone=1,30959,0,2392,0,0,2000,2000,0 (equal to -10 dBm).
ReorderTone
Tone that plays when the network is congested
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the ReorderTone in terms of frequency by using ReorderToneFreq.
The value is the number of 10-milliseconds units (so 100=1 second).
The following is appropriate for the US: ReorderTone=2,30467,28959,1191,1513,0,2000,2000,0 (equal to -21 dBm).
The following is appropriate for Sweden: ReorderTone=1,30959,0,2392,0,0,2000, 6000, 0 (equal to -10 dBm).
RingBackTone
Tone that alert the caller that the called number is ringing.
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the RingBackTone in terms of frequency by using RingBackToneFreq.
The value is the number of 10-milliseconds units (so 100=1 second).
The following are appropriate for the US: RingBackTone=2,30831,30467,1943,2111,0,16000,32000,0 (equal to -16 dBm) or RingBackToneFreq:2,440.0,480.0,-10.0,-10.0,0,2000,4000,0.
The following is appropriate for Sweden: RingBackTone=1,30959,0,2392,0,0,8000,40000,0 (equal to -10 dBm).
CallWaitTone
Tone that alert a user on a call that there is an incoming call.
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the CallWaitTone in terms of frequency by using CallWaitToneFreq.
The value is the number of samples at 8000 samples/second).
The call-waiting tone repeats at 10-second intervals while call-waiting is active. The value is the number of samples at 8000 samples/second).
The following is appropriate for the US: CallWaitTone=1,30831,0,5493,0,0,2400,2400,4800 (equal to -10 dBm).
The following is appropriate for Sweden: CallWaitTone=1,30959,0,2392,0,0,1600,4000,11200 (equal to -10 dBm).
AlertTone
Tone that prompts users to enter a phone number when they use supplementary service, such as call-forwarding, or blind transfer.
Array of 9 short integers - see Table A-4 for details on the playback tone parameters.
You can specify the AlertTone in terms of frequency by using AlertToneFreq.
The value is the number of samples at 8000 samples/second).
The following is appropriate for the US: AlertTone=1,30467,0,5970,0,0,480,480,1920.
The following is appropriate for Sweden: AlertTone=1,30959,0,2392,0, 0, 480, 480,1920.
DialPlan
Specifies dial plan rules.
Alphanumeric string, 199 characters maximum.
No syntax check is performed. You must ensure that the dial plan is syntactically valid.
–3=Use Q931 keypad facility to send hookflash and DTMF user input.
The default value is 0x00150015.
ConnectMode
Connection mode of the selected call-signaling protocol.
Bitmap as follows:
•Bit 0 (mask ox1):
–0=Slow start (H.323).
–1=Fast start(H.323).
•Bit 1 (mask 0x2):
–0=Disable H.245 tunneling.
–1=Enable H.245 tunneling.
•Bit 2: Reserved.
•Bit 3 (mask 0x8): 1=Send RRQ when switching to alternate gatekeeper.
•Bit 4 (mask 0x10): 1=Enable phone to operate in Cisco CallManager environment.
•Bit 5 (mask 0x20): 1=Disable two-way cut-through of voice path before receipt of connect.
•Bit 6 (mask 0x40): 1=Require progress indicator before decoding RTP packets received before connect.
•Bits 7-18: Reserved. Set to 0.
•Bit 19 (mask 0x80000): 1=Send ringback tone to the caller.
•Bits 20-31: Reserved. Set to 0
The default value is 0x00060400.
NumTxFrames
Number of frames per outbound audio RTP packet.
Values from 1 to 6. For G.729 codecs, a frame is 10 ms.
The default value is 2.
UDPTOS
UDP IP type of service (ToS). Controls IP precedence and delay of sent UDP packets.
Set only the lower 8 bits.
The default value is 0xa0.
MediaPort
Port where the phone transmits and receives RTP messages.
Enter an even number from 0 to 65535. This must be an even number; each connection uses the next available even-numbered port for RTP. 0=Use the default value.
The default value is 16384.
Dial Plan Detail
The DialPlan field contains dial plan rules.
Note No syntax check is performed by the actual implementation. You are responsible for ensuring that the dial plan is syntactically valid.
The DialPlan field provides programmable strings of dial plan that allow you to specify:
•Special rule—I{timeout} to control default interdigit timeout. Specifying this rule also has the side effect of preventing nonmatching dial strings from being sent out.
•Optional send character to use; for example, the pound sign (#) or the asterisk (*).
•Number of digits before auto-send.
•Send after timeout at any specified number of digits (timeout can be changed as digits are entered).
The DialPlan field uses the following conventions:
•Table A-6 describes the use of special characters in a dialplan.
Table A-6 Characters used in DialPlan
String
Effect
Period (.)
Match any digit.
Hyphen (-)
More digits can be entered. If this character is needed, it must appear at the end of an individual rule. For example, 1408t5- is legal, but 1408t5-3... is illegal.
Pound sign (#)
The terminating key to send is #, and termination can be applied only after matching hits >#. So >* means that the terminating character is the asterisk (*); that is, the terminating key must follow the greater-than sign (>).
Characters "tn"
Set the timeout to n seconds. Note: n is 0-9 and a-z, which ranges from 0 to 26.
Characters "rn"
Repeat the last pattern n times. Note: The characters ">#" and "tn" are modifiers, not patterns. n is 0-9 and a-z, which ranges from 0 to 26. Use the repeat modifier to specify more rules in less space.
Modifier "S"
Cause rule-matching to cease (that is, if a rule matches and the modifier "S" is seen, all other rules after that matching rule are not used for matching).
•Rules are applied in the listed order. The first rule that completely matches triggers the send.
•Multiple rules are separated by a pipe (|).
Dial Plan Rules Example 1
Table A-7 describes how to translate the following two sets of dial plan rules.
".t7>#......t4-|911|1t7>#..........t1-|0t4>#.t7-"
".t7>#r6t4-|911|1t7>#.r9t1-|0t4>#.t7-"
Table A-7 Dial Plan Rules Example 1
String
Effect
.t7>#......t4-
At least one digit needs to be entered. After that, send after 7 seconds. The terminating # character can also be applied after the first digit is entered. After 7 digits are entered, the timeout changes to 4 seconds. The * character means that more digits can be entered, as long as the string is not terminated by timeout or #.
911
Send immediately.
1t7>#..........t1-
At least one digit needs to be entered. After that, send after 7 seconds. The terminating character # can also be applied after the first digit is entered. After 10 digits are entered, the timeout changes to 1 second. The * character means that more digits can be entered, as long as the string is not terminated by timeout or #.
0t4>#.t7-"
After a 0, if no other digit is entered, send after 4 seconds. If another digit is entered, send after 7 seconds. Again, # is the terminating digit.
Dial Plan Rules Example 2
Table A-8 describes how to translate the following set of dial plan rules.
"911|1>#.r9t3.t5-|0t411t9-"
Table A-8 Dial Plan Rules Example 2
String
Effect
911
Send immediately.
1>#.r9t3.t5-
If 14088713344 is entered, send after 3 seconds. If another digit is entered (for example, 140887133445), send after 5 seconds.
0t411t9-
If 0 is entered, send after 4 seconds. If 011 is entered, send after 9 seconds.
Sample Parameter Profile
The following sample parameter profile (stripped of most comment lines) is shown here for demonstration purposes only. Your Cisco IP Phone 7905G software release contains a more appropriate example.txt file that you can use as a template for generating templates for the phones at your site.
#txt - Sample Cisco IP Phone 7905G (H.323) Parameter Profile
Feedback
The characters #txt must appear at the beginning of the first line of a file so that the formatting tool, cfgfmt.exe, will treat it as text file.
