1. Cisco MGCP IP Phone Administrator Guide, Versions 6.x and 7.x
Appendix B - Configurable Parameters for the MGCP IP Phone (Versions 6.x and 7.x)
Downloads: This chapterpdf (PDF - 216.0KB) The complete bookPDF (PDF - 881.0KB) | Feedback

Configurable Parameters for the MGCP IP Phone

Table Of Contents

Configurable Parameters for the MGCP IP Phone


Configurable Parameters for the MGCP IP Phone


This appendix describes configurable MGCP parameters (see Table B-1). Parameters are in alphabetical order. Optional parameters are so noted.

Table B-1 Parameters in the Default Configuration File 

MGCP Parameter
Description

date_format

(Optional) Format for dates. Valid values are the following:

M/D/Y—Month/day/year

D/M/Y—Day/month/year

Y/M/D—Year/month/day

Y/D/M—Year/day/month

Y-M-D—Year-month-day

YY-M-D—4-digit year-month-day

Default is M/D/Y.

dial_template

Template with which you can specify which file to download for your dial plan.

directory_url

(Optional) URL of the external directory server. This URL is accessed when the Directory key is pressed and the External Directory option is selected. For example, use directory_url http://10.10.10.10/CiscoServices/Directory.asp.

dst_auto_adjust

(Optional) Date, time, and whether to use Daylight Saving Time (DST). Automatically adjusts for DST on the phones. Valid values are 0 (disable automatic adjustment) and 1 (enable automatic adjustment). Default is 1.

dst_offset

Offset from the phone time when DST is in effect. When DST is not in effect, the specified offset is no longer applied to the phone time. Valid values are the following:

hour/minute

-hour/minute

+hour/minute

hour

-hour

+hour

dst_start_day

(Optional) Day of the month on which DST begins. Valid values are the following:

1 to 31 (for days of the month)

0 (ignore this field and use the value in the dst_start_day_of_week parameter instead)

Default is 0.

dst_start_day_of_week

(Optional) Day of the week on which DST begins. Valid values are as follows:

Any of the following: Sunday or Sun, Monday or Mon, Tuesday or Tue, Wednesday or Wed, Thursday or Thu, Friday or Fri, Saturday or Sat, Sunday or Sun

1 to 7 (1 is Sunday; 7 is Saturday)

Name of the day is not case-sensitive. In the United States, the default is Sunday.

dst_start_month

(Optional) Month in which DST starts. Valid values are January, February, March, April, May, June, July, August, September, October, November, and December or 1 through 12 with 1 being January and 12 being December. Name of the month is not case-sensitive. In the United States, the default is April.

dst_start_time

(Optional) Time of day on which DST begins. Valid values are hour/minute (02/00) and hour:minute (02:00). In the United States, the default is 02:00.

dst_start_week_of_month

(Optional) Week of month in which DST begins. Valid values are
1 to 6 and 8 (1 is the first week; each subsequent number is a subsequent week; 8 is the last week in the month regardless of which week the last week is). In the United States, the default is 1.

dst_stop_day

(Optional) Day of the month on which DST ends. Valid values are as follows:

1 to 31 (for the days of the month)

0 (ignore this field and use the value in the dst_stop_day_of_week parameter instead)

Default is 0.

dst_stop_day_of_week

(Optional) Day of the week on which DST ends. Valid values are as follows:

Any of the following: Sunday or Sun, Monday or Mon, Tuesday or Tue, Wednesday or Wed, Thursday or Thu, Friday or Fri, Saturday or Sat, Sunday or Sun

1 to 7 (1 is Sunday; 7 is Saturday)

Name of the day is not case-sensitive. In the United States, the default is Sunday.

dst_stop_month

(Optional) Month in which DST ends. Valid values are January, February, March, April, May, June, July, August, September, October, November, and December or 1 through 12 with 1 being January and 12 being December. Name of the month is not case-sensitive. In the United States, the default is October.

dst_stop_time

(Optional) Time of day on which DST ends. Valid values are hour/minute (02/00) or hour:minute (02:00). In the United States, the default is 02:00.

dst_stop_week_of_month

(Optional) Week of month in which DST begins. Valid values are
1 to 6 and 8 (1 is the first week; each subsequent number is a subsequent week; 8 is the last week in the month regardless of which week the last week is). In the United States, the default is 1.

dtmf_avt_payload

(Optional) Payload type for audio-video transport (AVT) packets. Range is 96 to 127. If the value specified is null or invalid, default is 101.

dtmf_inband

(Optional) In-band signaling format.

Valid values are 1 (generate DTMF digits in-band) and 0 (do not generate DTMF digits in-band). Default is 1.

dtmf_outofband

(Optional) Out-of-band signaling for tone detection on the IP side of a gateway. The phone supports out-of-bound signaling using the AVT tone method. Valid values are the following:

none—Do not generate DTMF digits out-of-band.

avt—If requested by the remote side, generate DTMF digits out-of-band (and disable in-band DTMF signaling); otherwise, do not generate DTMF digits out-of-band.

avt_always—Always generate DTMF digits out-of-band. This option disables in-band DTMF signaling.

Default is avt.

dyn_dns_addr_1

(Optional) IP address of a new dynamic DNS server. If a new DNS server address is specified, it is used for any further DNS requests after the phone uses the initial DNS address upon bootup. DNS addresses are used in the following order:

1. dyn_dns_addr_1 (if present)

2. dyn_dns_addr_2 (if present)

3. DNS Server 1

4. DNS Server 2

5. DNS Server 3

6. DNS Server 4

7. DNS Server 5

The dynamic address is not stored in flash memory. Only dotted IP addresses are accepted. You can clear this value by removing it from the configuration file or by changing its value to a null value " " or to "UNPROVISIONED."

dyn_dns_addr_2

(Optional) IP address of a second dynamic DNS server to be used for DNS requests.

dyn_tftp_addr

(Optional) IP address of a new dynamic TFTP server. After initially querying the default TFTP server, the phone rerequests the default and phone-specific configuration files from the new TFTP server. The dynamic TFTP server address is not stored in flash memory. The number of dyn_tftp_addr values supported by the phone is limited to prevent the phone configuration being downloaded repeatedly from multiple TFTP servers. Only dotted IP addresses are accepted. This value can be cleared by removing it from the configuration file or by changing its value to a null value " " or to "UNPROVISIONED."

end_media_port

(Optional) Configures the Real-Time Transport Protocol (RTP) end range for media. Valid values are from 16384 to 32766. Default is 32766.

http_proxy_addr

(Optional) IP address of the HTTP proxy server. You can use either a dotted IP address or a DNS name (a record only).

http_proxy_port

(Optional) Number of the HTTP proxy port. Default is 80.

image_version

Firmware version that the phone uses. Enter the name of the image version as it is released by Cisco. Do not enter the filename extension (.bin).

Note You cannot change the image version by changing the filename because the version is also built into the file header. Trying to change the image version by changing the filename causes the firmware to fail when the firmware compares the version in the header against the filename.

language

(Optional) This parameter is for future use. The only valid value is English.

logo_url

(Optional) Location of the company logo file. This logo appears on the phone display. The background space allocated for the image is 90 x 56 pixels. Images that are larger than this automatically scale down to 90 x 56 pixels. The recommended file size for the image is from 5 to 15 kilobytes. For example, use logo_url http://10.10.10.10/companylogo.bmp.

Note This parameter supports Windows 256 color bitmap format only. CMXML PhoneImage objects are not supported for this parameter. Using anything other than a Windows bitmap (.bmp) file can cause unpredictable results.

mgcp_endpoint_id

Configures the MGCP endpoint identifier. This parameter is a text string that can be up to 32 characters in length. The default value is d001, which is the same as the old hard-coded value.

mgcp_gw_controller

IP address of the call agent (CA).

mgcp_input_port

Port on which the phone listens. Default is 2427.

mgcp_keepalive

Whether to use the Restart In Progress (RSIP) keepalive to keep Network Address Translation (NAT) bindings open to the CA. Valid values are 0 (off) and 1 (on). Default is 0.

mgcp_keepalive_timer

Time interval, in seconds, for the MGCP keepalive timer. Range is 10 to 600. Default is 30.

mgcp_output_port

Port on which the the phone transmits. Default is 2427.

nat_address

(Optional) WAN IP address of the NAT or firewall server. You can use either a dotted IP address or a DNS name (a record only).

nat_enable

(Optional) Enables NAT. If NAT is enabled, the Session Description Protocol (SDP) message uses the nat_address and an RTP port between the start_media_port and the end_media_port range in the C and M fields. All RTP traffic is sourced from the port advertised in the SDP message. Valid values are 0 (disable) and 1 (enable). Default is 0.

phone_label

Text to display on the top right status line of the LCD. This field is for end-user display only and has no effect on caller identification or messaging. For example, a phone label can display "User A's phone." Up to 11 characters can be used to specify the phone label.

phone_password

(Optional) Password for console or Telnet access. Limited to 32 characters. Default is cisco.

phone_prompt

(Optional) Prompt that displays during Telnet or console access. Limited to 16 characters. Default is MGCP Phone.

services_url

URL of the services BTXML files to access when the Services button is pressed. For example, use services_url http://10.10.10.10/CiscoServices/Services.asp.

sntp_mode

Mode in which the phone listens for the Simple Network Time Protocol (SNTP) server. Valid values are unicast, multicast, anycast, and directedbroadcast. Default is anycast.

sntp_server

IP address of the SNTP server from which the phone obtains time data. If the SNTP server is set to 0 or is not set, the MGCP software defaults the SNTP server address to the address of the CA.

start_media_port

(Optional) Start RTP range for media. Range is from 16384 to 32766. Default is 16384.

stutter_msg_waiting

(Optional) Enables a stutter dial tone when there is a message waiting. Valid values are 0 (off) and 1 (on). Default is 0.

telnet_level

(Optional) Enables Telnet for the phone. Valid values are 0 (disabled), 1 (enabled without privileged commands), and 2 (enabled with privileged commands). Default is 0.

tftp_cfg_dir1

Path to the TFTP subdirectory in which phone-specific configuration files are stored. Limited to 64 characters.

Note This parameter exists only in the MGCDefault.cnf file.

time_format_24hr

(Optional) Whether 12- or 24-hour time format displays by default on the phone. Valid values are the following:

0—12-hour format is displayed by default but can be changed to 24-hour format from the user interface.

1—24-hour format is displayed by default but can be changed to 12-hour format from the user interface.

2—12-hour format is displayed and cannot be changed to 24-hour format from the user interface.

3—24-hour format is displayed and cannot be changed to 12-hour format from the user interface.

Default is 1.

time_zone

Time zone in which the phone is located. Abbreviations are case sensitive and must be in all capital letters. For a list of time zones, see Table 3-2. Default is PST.

tos_media

(Optional) Type of service (ToS) level for the media stream being used. Valid values are the following:

0—IP_ROUTINE

1—IP_PRIORITY

2—IP_IMMEDIATE

3—IP_FLASH

4—IP_OVERRIDE

5—IP_CRITIC

Default is 5.

use_domain_name_braces

Whether MGCP will add [ ] around the IP address on the endpoint identifier. This is a boolean field; it is either turned on or turned off.

Valid values are 0 (off) and 1 (on). Default is 0.

use_mac_name

Whether to use the IP address or the MAC address in the endpoint name. Valid values are 0 (IP address) and 1 (MAC address). Default is 0.

user_info

(Optional) Configures the "user=" parameter in the REGISTER message. Valid values are the following:

none—No value is inserted.

phone—The value user=phone is inserted in the To, From, and Contact headers for REGISTER.

ip—The value user=ip is inserted in the To, From, and Contact headers for REGISTER.

Default is none.

xml_card_dir

(Optional) Directory to use for retrieving the XML cards file. The base for the directory is the base TFTP server directory. Limited to 64 characters.

xml_card_file

(Optional) Filename of the XML cards. Limited to 20 characters.

1 Required if the phone-address configuration files are located in a subdirectory.