|
Table Of Contents
Configuring HSI Release 2.21 Features
Provisioning the Cisco HSI
Introduction
This chapter describes the data that must be provisioned for the Cisco H.323 Signaling Interface (HSI). The data is divided into two areas: system configuration and H.323 stack data. This chapter contains the following sections:
Cisco HSI Configuration
All configuration data is contained within configuration files. Cisco HSI starts with an initial configuration file in $BASEDIR/currentGW/etc/GWmain.conf. This file is created during installation of the software.
The configuration data within the file is defined as dynamic, static, or constant:
•Dynamic data can be modified by a provisioning session (see Appendix A, "MML User Interface and Command Reference"). It can be activated on the currently running Cisco HSI.
•Static data can be modified by a provisioning session but cannot be activated on a running Cisco HSI. Changes to dynamic and static data can be written to a separate provisioning file (in $BASEDIR/currentGW/var/prov/configname/session.dat) that can be used during subsequent restarts of the Cisco HSI.
•Constant configuration data is contained within the configuration file and cannot be modified by provisioning sessions. Constant configuration data can be modified only by system technicians or administrators who use UNIX editing tools. This data is replicated from the initial configuration file into the provisioning files, and is included in subsequent provisioning sessions.
Examples of the use of constant data are given in Appendixes D, E, F, and G. These appendixes determine the mapping of cause values for incoming and outgoing H.323 and Enhanced ISDN User Part (E-ISUP) messages. System technicians can modify these values in the initial configuration file to explicitly choose the mappings for their system.
When a provisioning session creates a new configuration file, it also verifies that provisioned data is within allowable ranges and indicates this in the start of the file. It checksums the configuration file and writes the checksum as $BASEDIR/currentGW/var/prov/configname/checksum.dat. When the Cisco HSI starts up, it attempts to read the active configuration, checks that the configuration has been verified, and ensures that the checksum matches. If the active configuration is not verified or if the checksum is faulty, the configuration reverts to using the $BASEDIR/currentGW/etc/GWmain.conf file.
All configuration data that can be set in the system is defined in the Skeleton Configuration file (see "Skeleton Configuration File"). The Skeleton Configuration file defines the data names and types (strings or numbers), and defines whether the data is dynamic, static, or constant.
MML Configuration Commands
There are three types of MML configuration command:
•Configuration session commands that work with entire provisioning data files (see Table 3-1)
•Configuration component or parameter commands that perform actions on components or parameters affecting a specific data file (see Table 3-2)
•Configuration export commands
For more information about MML configuration commands, see Appendix A, "MML User Interface and Command Reference."
Note Parameter names used in MML commands are not case sensitive.
The configuration export command is prov-exp, which exports the currently provisioned configuration of the Cisco HSI to a file.
System Configuration Data
System configuration data can be static or dynamic. Static data can be activated only at startup. Dynamic data can be activated during system run time.
Static System Data
To modify the static system data parameters in Table 3-3, use the sys_config_static MML name variable for the prov-add, prov-dlt, and prov-ed commands. Halt and restart the application for the changes to take effect.
In the following example, the prov-add command adds the static system data parameter VSCA_PORT_NUMBER1 to a static configuration file. The prov-ed command modifies the value of the VSCA_PORT_NUMBER1 parameter. The prov-dlt command deletes the VSCA_PORT_NUMBER1 parameter from the static configuration file.
Example
prov-add:name=sys_config_static,vsca_port_number1=8003
prov-ed:name=sys_config_static,vsca_port_number1=8002
prov-dlt:name=sys_config_static,vsca_port_number1
The parameters in Table 3-3 are written to a static configuration file or to a section within a file.
Table 3-3 Static System Data Parameters
Parameter Type DescriptionHOST_PORT_NUMBER1
[0-65535]
The first port number to be used by the Cisco HSI. The default value is 0.
Note This value must match the peer port setting on the PGW1 2200 E-ISUP IPLNK object.
HOST_PORT_NUMBER2
[0-65535]
The second port number to be used by the Cisco HSI. The default value is 0.
Note This value should always be set to 0.
VSCA_IPADDR1
STRING
The primary IP address of the primary PGW 2200.
VSCA_IPADDR2
STRING
The secondary IP address of the primary PGW 2200.
Note This value must match that of VSCA_IPADDR1.
VSCB_IPADDR1
STRING
The primary IP address of the secondary PGW 2200.
Note This parameter is not used in a standalone PGW configuration.
VSCB_IPADDR2
STRING
The secondary IP address of the secondary PGW 2200.
Note This value of this parameter must match that of VSCB_IPADDR1. This parameter is not used in a standalone PGW configuration.
VSCA_PORT_NUMBER1
[0-65535]
The first port number of the primary PGW 2200.
VSCA_PORT_NUMBER2
[0-65535]
The second port number of the primary PGW 2200.
Note This value must match that of VSCA_PORT_NUMBER1.
VSCB_PORT_NUMBER1
[0-65535]
The first port number of the secondary PGW 2200.
Note This parameter is not used in a standalone PGW configuration.
VSCB_PORT_NUMBER2
[0-65535]
The second port number of the secondary PGW 2200.
Note This value of this parameter must match that of VSCA_PORT_NUMBER2. This parameter is not used in a standalone PGW configuration.
ClipClirSupported
STRING
CLI Presentation or restriction is enabled if this parameter is present and set to anything other than "". For example, to enable CLIP/CLIR support, set this parameter explicitly to "Enabled."
RaiSupported
STRING
RAI support is enabled if this parameter is present and set to anything other than "". For example, to enable RAI support, set this parameter to "Enabled."
DtmfSupportedDirection
STRING
This is set to "both", "tx," or "rx". If this parameter is not present or is set to any value other than "both," "tx," or "rx," the DTMF Relay feature is disabled.
DtmfSupportedType
STRING
This is set to "dtmf" or "basicString." If this parameter is not present or set to any other value, the DTMF Relay feature is disabled.
H225PavoSupported
STRING
Pavo support is enabled if this parameter is present and set to anything other than "". For example, set it to "Enabled."
PavoRedirScreeningInd
[0-3]
The value of the Pavo redirecting number screening indicator. (If this parameter is not provisioned, the default is Q.931 zero—user provided, not screened.)
PavoRedirReason
[0-15]
The value of the Pavo redirecting number reason field. This parameter has no default. If unprovisioned, the redirecting number parameter will not contain the Reason for Redirection field (octet 3b).
PavoRedirPresInd
[0-3]
The value of the Pavo redirecting number presentation indicator. (If this parameter is not provisioned, the default is Q.931 zero—no indication.)
CliInDisplaySupported
STRING
If this parameter is present and set to anything other than "", the Calling Number is also sent in the DISPLAY IE. The NetMeeting endpoint retrieves the calling party number from the DISPLAY IE in the H.225 setup message. To enable this parameter, set it to "Enabled."
T38MaxVal
STRING
This T.38 Faxt38MaxVal parameter has the following optional attributes that can be assigned values in a specific range.
Note Values for the following attributes must be expressed in hexadecimal format.
•MaxBit—[0x0—0xFFFFFFFF]. The default value is 0x90.
•FxMaxBuf—[0x0—0xFFFFFFFF]. The default value is 0xc8.
•FxMaxData—[0x0—0xFFFFFFFF]. The default value is 0x48.
T38Options
STRING
This T.38 Fax parameter is assigned one of the following optional values:
•FxFillBit—[0 or 1] The default value is 0.
•FxTransMMR—[0 or 1] The default value is 0.
•FxRateTransJBIG—[0 or 1] The default value is 0.
•FXRate—[Local or Trans] The default value is Trans.
•FxUdpEC—[Red or FEC] The default value is Red.
AsymmetricHandlingSupported
STRING
Asymmetric Codec Treatment support is enabled if this parameter is present and set to anything other than "". To enable Asymmetric Codec Treatment, set this parameter to "Enabled."
UseConfID
STRING
Use this parameter to specify the precedence of extracting the Global Call ID from the Conference ID or the GUID in the H.225 Setup message. The provisioning of this property to a value other than "" gives precedence to the Conference ID. For example, set it to "Enabled." To set the precedence to the GUID field, the crafts person can either delete the property from the config or set it to "".
DualCLISupported
STRING
To enable Dual CLI support (see H.246 Annex C), set this parameter to anything other than "". For example, to explicitly enable Dual CLI support, set this parameter to "Enabled."
1 PGW = Public Switched Telephone Network (PSTN) Gateway
Dynamic System Data
To modify the dynamic system data parameters in Table 3-4, use the sys_config_dynamic MML name variable for the prov-add, prov-dlt, and prov-ed commands. You need not halt and restart call processing for the changes to take effect.
In the following example, the prov-add command adds the dynamic system data parameter OVLDLEVEL1PERCENT to a dynamic configuration file. The prov-ed command modifies the value of the OVLDLEVEL1PERCENT parameter. The prov-dlt command deletes the OVLDLEVEL1PERCENT parameter from the dynamic configuration file.
Example
prov-add:name=sys_config_dynamic,OVLDLEVEL1PERCENT=20
prov-ed:name=sys_config_dynamic,OVLDLEVEL1PERCENT=25
prov-dlt:name=sys_config_dynamic,OVLDLEVEL1PERCENT
The MML commands write the parameters in Table 3-4 to a dynamic configuration file or to a section within a file.
Table 3-4 Dynamic System Data Parameters
Parameter Description DefaultLOGDIRECTORY
Specifies the directory used when the active log file is created, and also specifies the directory where the rotated log file is stored.
/var/log/
LOGFILENAMEPREFIX
Specifies the filename prefix used when the log files are created or rotated. The .log postfix is appended to the end of the prefix to establish the name of the active log file.
platform.log
LOGPRIO
Defines the initial logging levels. By default it is set to TRACE. When the system initializes and is running, the levels set for individual packages (0x0000 to 0xFFFF) determine the log levels. See the "Logging Levels" section on page 4-10.
TRACE
LOGFILEROTATESIZE
Triggers a log file rotation based on the size of the active file. The application regularly checks the current size of the file to determine whether a rotation is required. If a file rotation is triggered by this parameter, the rotated file might be slightly larger than the size specified by this parameter. A file rotation is triggered by this parameter causes the timer associated with the LOGFILEROTATEINTERVAL parameter to be reset as well.
10 Mb
LOGFILEROTATEINTERVAL
Triggers a log file rotation based on the time elapsed since the previous rotation. This timer is reset after any rotation occurs, regardless of the cause or trigger of the rotation.
1440 minutes
(24 hours)IPADDRNMS
Defines the IP address of the network management system.
—
OVLDSAMPLERATE
Defines the frequency of CPU sampling and threshold checking.
3000 millisecond (ms) polling rate
OVLDLEVEL1PERCENT
Indicates what percentage of calls should be rejected when an overload condition occurs. This parameter is used in conjunction with the OVLDLEVEL1FILTER parameter. The overload level 1 value is the lowest level of overload and must be less than or equal to the provisioned values for OVLDLEVEL2PERCENT and OVLDLEVEL3PERCENT.
Note If this value is set to zero, no overload level 1 treatment occurs.
20
OVLDLEVEL1FILTER
Indicates what call types should be gapped if an overload level 1 condition occurs. The possible values are:
•Normal—Emergency or priority calls are not gapped.
•All—All calls are gapped, regardless of type.
Note If the overload percentage is set to 100, all calls are gapped irrespective of this setting.
Normal
OVLDLEVEL1THRESHLOWERCALLS
Determines the number of active calls below which the application load must fall in order for the overload level 1 condition to be removed.
1800
OVLDLEVEL1THRESHUPPERCALLS
Determines how many simultaneous active calls trigger an overload level 1 condition.
1900
OVLDLEVEL1THRESHLOWERCPU
Determines the CPU utilization level below which the application must fall in order for the overload level 1 condition to be removed.
60
OVLDLEVEL1THRESHUPPERCPU
Determines the level of CPU utilization that triggers an overload level 1 condition.
65
OVLDLEVEL2PERCENT
Indicates what percentage of calls should be rejected when an overload condition occurs. The parameter is used in conjunction with the OVLDLEVEL2FILTER parameter. This is the second level of overload and must be less than or equal to the provisioned value of OVLDLEVEL3PERCENT and greater than or equal to the provisioned value of OVLDLEVEL1PERCENT.
Note If this value is set to zero, no overload level 1 or 2 treatment occurs (by definition, the level 1 value must also be zero).
75
OVLDLEVEL2FILTER
Indicates what call types should be gapped if an overload level 2 condition occurs (see OVLDLEVEL1FILTER).
Normal
OVLDLEVEL2THRESHLOWERCALLS
Determines the number of active calls below which the application load must fall in order for the overload level 2 condition to be removed.
2000
OVLDLEVEL2THRESHUPPERCALLS
Determines how many simultaneous active calls trigger an overload level 2 condition.
2200
OVLDLEVEL2THRESHLOWERCPU
Determines the level of CPU utilization below which the application must fall in order for the overload level 2 condition to be removed.
70
OVLDLEVEL2THRESHUPPERCPU
Determines the level of CPU utilization that triggers an overload level 2 condition.
80
OVLDLEVEL3PERCENT
Indicates what percentage of calls should be rejected when an overload condition occurs. The parameter is used in conjunction with the OVLDLEVEL3FILTER parameter. This is the highest level of overload and must be greater than or equal to the provisioned values for OVLDLEVEL1PERCENT and OVLDLEVEL2PERCENT.
Note If this value is set to zero, no overload treatment occurs (by definition, the level 1 and level 2 values must also be zero).
90
OVLDLEVEL3FILTER
Indicates what call types should be gapped if an overload level 3 condition occurs (see OVLDLEVEL1FILTER).
Normal
OVLDLEVEL3THRESHLOWERCALLS
Determines the number of active calls below which the application load must fall in order for the overload level 3 condition to be removed.
2300
OVLDLEVEL3THRESHUPPERCALLS
Determines how many simultaneous active calls trigger an overload level 3 condition.
2400
OVLDLEVEL3THRESHLOWERCPU
Determines the level of CPU utilization below which the application must fall in order for the overload level 3 condition to be removed.
85
OVLDLEVEL3THRESHUPPERCPU
Determines the level of CPU utilization that triggers an overload level 3 condition.
95
CIAGENTSCANPERIOD
Specifies the frequency with which the CIagent polls the CPU utilization.
—
ALARMDEBOUNCETIME
Specifies the length of time that an alarm condition must persist before being reported, and any associated action taken.
0
CALLREFERENCEUSAGE
Determines which call reference identity is passed on to the PGW 2200 (call reference field or Conference ID).
—
DISKUSAGELIMIT
Represents a percentage of disk occupancy.
The application continually polls the system for disk occupancy, and if the percentage rises above the limit set by DISKUSAGELIMIT, the LOW_DISK_SPACE alarm is raised.
DISKUSAGELIMIT has a default value of 95 percent. The value range is 0-100, inclusive. When dynamically provisioned, the parameter DISKUSAGELIMIT, if not set within that range, is set to the default value (95) and the CONFIGURATION_ FAILURE alarm is raised.
95
RegFailureReleaseCause
This parameter specifies the Q.850 release cause, which the HSI uses after the HSI fails three times to register to a gatekeeper.
This parameter is assigned a value in the range 1—127
—
H.323 Stack Configuration
Refer to the RADVision H.323 Protocol Stack Programmer's Guide for definitions of each of the RADVision parameters.
The parameter name is based on the ASN.1 paths, but in some cases the parameter name has been shortened for convenience. For example, "capabilities" has been shortened to "caps."
The case of the parameter name reflects exactly the ASN.1 definitions, but case is not important to MML configuration.
Nonprovisionable Data
The parameters in Table 3-5 cannot be altered through MML commands.
MML Provisionable Data
H.323 System Parameters
The parameters in Table 3-6 are required for H.323 stack initialization. To modify the parameters in Table 3-6, use the h323_sys MML name variable for the prov-add, prov-dlt, and prov-ed commands. Halt and restart the application for these changes to take effect.
Note The asterisk (*) after a parameter name in the first column of Table 3-6 denotes a mandatory RADVision parameter that has an inbuilt default value if a value is not set in provisioning.
Q.931 Parameters
To modify the parameters listed in Table 3-7, use the q931 MML name variable for the prov-add, prov-dlt, and prov-ed commands.
In the following example, the prov-add command sets the Q.931 parameter maxCalls to the value 2000.
Example
prov-add:name=q931,maxCalls=2000
The Update Type column in Table 3-7 shows when the change to a parameter takes effect once a change is made:
•Immediate means that the effect of the change is immediate.
•Start means that the application needs to be restarted for the change to take effect.
•Next Call means that the next call has the new parameter set.
Note Immediate and Next Call update types refer to dynamic system data.
Note The asterisk (*) after a parameter name in the first column of Table 3-7 denotes a mandatory RADVision parameter with an inbuilt default value that will be used if the value is not set in provisioning.
Note The Q.931 parameter overlappedSending has been combined with the RAS overlappedSending parameter. If you set the Q.931 overlappedSending parameter, you also set the RAS overlappedSending parameter.
RAS Parameters
The parameters in Table 3-8 are required for RAS stack initialization. To modify the RAS parameters, use the ras MML name variable for the prov-add, prov-dlt, and prov-ed commands.
In the following example, the prov-add command sets the RAS parameter maxfail to the value 3.
Example
prov-add:name=ras,maxfail=3
The array index [i] in some of the parameter names in the first column of Table 3-8 must be replaced with a valid braced index from 1 to 20, and must be continuous and unique (that is, it must contain no duplicates).
The Update Type column in Table 3-8 shows when the change to a parameter takes effect after it is modified:
•Immediate means that the effect of the change is immediate.
•Start means that the application needs to be restarted for the change to take effect.
•Next Call means that the next call has the new parameter set.
Note Immediate and next call update types are dynamic system data.
Note The RAS parameter overlappedSending is not available here because it has been combined with the Q.931 overlappedSending parameter. If you set the Q.931 overlappedSending parameter, you also set the the RAS overlappedSending parameter.
Note The asterisk (*) after a parameter name in the first column of Table 3-8 denotes a mandatory RADVision parameter with an inbuilt default value that will be used if the value is not set in provisioning.
H.245 Parameters
To modify the H.245 parameters listed in Table 3-9, use the h245 MML name variable for the prov-add, prov-dlt and prov-ed commands.
In the following example, the prov-add command sets the H.245 parameter masterSlave.timeout to the value 5.
Example
prov-add:name=h245,masterSlave.timeout=5
The Update Type column in Table 3-9 shows when a change to an H.245 parameter takes effect after it is modified:
•Immediate means that the effect of the change is immediate.
•Start means that the application needs to be restarted for the change to take effect.
•Next Call means that the next call has the new parameter set.
Note Immediate and Next Call update types are dynamic system data.
Table 3-10, Table 3-11, and Table 3-12 list the parameters and modes related to the configuring of codecs. The array index [i] must be replaced with a valid braced index from 1 to 20. The braced index must be continuous and unique (that is, there must be no duplicates).
Configuring HSI Release 2.21 Features
This section tells you how to enable the HSI features introduced in HSI Release 2.21. These features are:
•Asymmetric Codec Treatment
•Empty Capability Set
•H.323 Hairpin
•T.38 Fax
Asymmetric Codec Treatment
The Asymmetric Codec Treatment feature averts the potential for inconsistencies in codec selection, which can result if the open channel requests are sent by each endpoint at nearly the same time, so that neither side has received an open channel request prior to sending one. In practice, such asymmetric conditions occur only for slow start calls. When there is a fast start recipient, both channels agree to use the same codec in unison.
The Asymmetric Codec Treatment support is enabled if this parameter is present and set to anything other than "". For example, support is enabled if the parameter is explicitly set to "Enabled." To enable Asymmetric Codec Treatment, enter the following command:
Example:
prov-add:name=sys_config_static, asymmetrichandlingsupported = "Enabled"
Empty Capability Set
The Empty Capability Set feature enables an H.323 endpoint to send a TCS message with empty capabilities during a call. The TCS message causes the audio channels to close. This action enables the negotiation and opening of new audio channels.
The Empty Capability Set feature is useful when the H.323 endpoint wishes to change the audio codec during a call or if the endpoint needs to divert the media streams to a different location. Typically, the feature is used to place a call on hold to disable the media stream until the user presses the Resume button.
The Empty Capability Set feature on the HSI requires no provisioning.
H.323 Hairpin
The H.323 Hairpin feature (also called H.323 Hairpin) can be used to connect a call between two H.323 endpoints without using resources on the media gateway. For example, the PGW can respond to the dialled number in an incoming H.323 call by routing the call to another HSI (perhaps the same HSI) rather than routing the call to the PSTN. In this case, the originating and terminating HSIs establish the call normally but pass the H.245 address of the H.323 endpoints. This enables the two endpoints to use H.245 to negotiate media channels with each other directly, independent of the HSI.
The H.323 Hairpin feature on the HSI requires no provisioning. However, to operate throughout the system, H.323 Hairpin must be enabled on the PGW. On the PGW, you enable H.323 Hairpin through a trunk group property by issuing the following commands:
prov-add:trnkgrpprop:name="2000",AllowH323Hairpin="1"
prov-add:trnkgrpprop:name="3000",AllowH323Hairpin="1"
Note H.323 Hairpin must be enabled for both the ingress and egress EISUP trunk groups.
Refer to PGW and Cisco IOS documentation at www.cisco.com for further information on these commands.
T.38 Fax
You enable T.38 Fax for the HSI by specifying static system data parameters. By default, T.38 is provisioned on the HSI by use of the following commands:
prov-add:name=sys_config_static,t38maxval="MaxBit 0x90, FxMaxBuf 0xc8, FxMaxData 0x48"
prov-add:name=sys_config_static,t38options="FxFillBit 0, FxTransMMR 0, FxTransJBIG 0, FxRate Trans, FxUdpEC Red"
Table 3-3 describes the T.38 static system data parameters. The T.38 parameters for HSI correspond to T.38 parameters proposed in the ITU T.38 recommendation.
Configuring T.38 Fax on the Cisco PSTN Gateway
To enable T.38 Fax throughout the system, you must enable T.38 Fax on the Cisco PGW. On the PGW, T.38 is enabled through a trunk group property by use of the following MML command:
prov-add:trnkgrpprop:name="2000",FaxSupport="1"
Configuring T.38 Fax on a Cisco IOS H.323 Gateway
Enable T.38 Fax on a Cisco IOS H.323 gateway by issuing the following IOS commands:
voice service voip
fax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback none
Configuring T.38 Fax on a Cisco IOS MGCP Gateway
Enable T.38 fax on a Cisco IOS MGCP gateway by issuing the following IOS commands:
voice service voip
fax protocol t38 ls-redundancy 0 hs-redundancy 0 fallback none
mgcp package-capability fxr-package
Refer to PGW and Cisco IOS documentation at www.cisco.com for further information on these commands.
Posted: Wed Feb 7 12:07:04 PST 2007
All contents are Copyright © 1992--2007 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.