The Remote Media Gateway Model object is a child of the Remote Media Gateway Models object. It allows you to configure standard parameter settings that are used by one or more Subscriber Gateways, Trunk / Access Gateways, Configured SIP Bindings, or Registered SIP Bindings.
For a Subscriber Gateway or Trunk / Access Gateway that uses the MeGaCo H248 control protocol, the Remote Media Gateway Model that you use should have a name that matches the Profile name reported by the gateway during its start-of-day message exchange. If the name does not match, the MetaSwitch NE generates an error log, although it continues to operate using the selected model; in this case, you should verify that the gateway is using the correct model. If you are sure that the model is correct even though the name does not match, you can use the option Does not check profile in the field Fix bits (MeGaCo) to suppress name checking on this model.
For a Subscriber Gateway or Trunk / Access Gateway that uses the MGCP control protocol, or for a Configured SIP Binding, the model name is used only as an identifier in the EMS and does not have to match any parameter reported by the device.
If the NE supports access from SIP devices over Registered SIP Bindings, you need to do one or more of the following.
To create a Remote Media Gateway Model object appropriate to the type of gateway you are using, you can use MetaSwitch-supplied configuration files, which are available from the MetaSwitch Customer Portal (http://support.metaswitch.com), and use the EMS's Import function on the parent Remote Media Gateway Models object to import them into your configuration. A user name and password are required to access the portal; contact your MetaSwitch account representative to obtain these if necessary.
![]() |
Any Remote Media Gateway Model with a name that begins MetaSwitchMediaGateway is for use by MetaSwitch Trunk / Access Gateways. Only a MetaSwitch support engineer can create or delete these models. |
![]() |
You can change a Remote Media Gateway Model while it is enabled and one or more active Subscriber Gateways, Configured SIP Bindings, or Trunk / Access Gateways refer to it, but you should be aware that your changes will affect all subscribers using these gateways or bindings. To avoid possible service disruption, you are recommended to create a new Remote Media Gateway Model with the new settings (for example by using the Export function to export the existing model and changing the parameters as required), and test it with one or more gateways or bindings during a maintenance window by changing each gateway or binding to use the new model. When you are sure that your changes will not cause any problems, you can then change the existing Remote Media Gateway Model in the same way. If there are a large number of gateways or bindings that reference the Remote Media Gateway Model, it may take some time for your change to be applied to all of them. You can check the progress of the change by comparing the Reference count field (the total number of gateways and bindings using this model) and the Up to date count field (the number of gateways and bindings that have been updated with the most recent change to the model). When these two fields show the same value, all gateways and bindings are up to date. |
![]() |
You cannot delete or disable a Remote Media Gateway Model if one or more active Subscriber Gateways, Configured SIP Bindings, Registered SIP Bindings, or Trunk / Access Gateways refer to it. You need to disable these objects, or configure them to use a different model, before you can disable the Remote Media Gateway Model.
If you need to delete a Remote Media Gateway Model that is in use by one or more Registered SIP Bindings, first disable the subscribers (Individual Lines or Business Group Lines) associated with these Registered SIP Bindings. Alternatively, configure the subscribers to use a different Remote Media Gateway Model and wait for any current calls to end so that the change is fully committed; you can verify this by checking the Remote Media Gateway Model shown in the Registered SIP Binding for each subscriber, which changes to the new value only when all calls using the old model have finished.
If an existing Remote Media Gateway Model is in use by a Registered SIP Binding because its name was matched against the user agent information, and you have defined a new Remote Media Gateway Model with a name that is a better match for the user agent information, do one of the following:
|
![]() |
This object includes a number of Fix bits fields, which provide options that control the detailed behaviour of Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. More information about specific fix bits is available in a Knowledge Base article on the MetaSwitch Customer Portal: http://support.metaswitch.com/customerportal_kb/scripts/article.aspx?article_id=5170. |
Parameter |
Access |
Description |
Category | Create | Specifies the type of gateway to which this model applies. Values:
|
Model index | Read only | The EMS's identifier for this Remote Media Gateway Model. This is used to identify the object when using the EMS's configuration export / import function. |
Model name | Change | A text string used in the EMS System Explorer to identify this Remote Media Gateway Model. Specify a string of up to 64 characters, which must not match the name of any other Remote Media Gateway Model. Names beginning with MetaSwitchMediaGateway are reserved for use by MetaSwitch Trunk / Access Gateways; you cannot create a model with a name beginning with this string. On an NE earlier than V4.2, this field is Change Inactive; you must disable the Remote Media Gateway Model before you can change it. |
Description | Change | An optional text description of this Remote Media Gateway Model. Specify a string of up to 64 characters, which must not match the description of any other Remote Media Gateway Model. |
Management connection command | Change | An optional command that can be run using an action on the Trunk / Access Gateway or Subscriber Gateway using this Remote Media Gateway Model.
Supply up to 256 characters of free-form text. The following details are a summary of the function. You can find more detail of the format of this string in Managing Trunk / Access Gateways and Subscriber Gateways at the end of this object.
The text string can include the parameters listed below. These parameters take their values from the fields on the Gateway object using this model. The appropriate value is substituted when the command is run.
|
Subscriber Gateway monitoring options | Change | This field appears only if Category is set to Subscriber. Specifies whether Subscriber Gateways that use this model should have statistics recorded. If required, select the following value:
|
Control protocol | Change Inactive / Read only | The control protocol used to communicate between the Call Agent and Media Gateways.
If Category is set to Subscriber or Trunk / Access, select one of the following values:
|
Control protocol variant | Change / Read only | The variant of the control protocol used to communicate between the Call Agent and Media Gateways. This field is not visible if Category is set to SIP.
If Control protocol is set to MGCP, select one of the following values:
|
Authentication | Change Inactive | This field appears only if Control protocol is set to MGCP. Specifies whether the Subscriber Gateway's communications with the NE require authentication using HTTP Digest Security as defined in RFC2617. Values:
|
Default model | Change Inactive | Specifies whether this Remote Media Gateway Model is the default model (which will be used for dynamically-created Media Gateways if a more appropriate model cannot be determined).
This parameter applies only if Category is set to SIP. You cannot set this parameter to True on more than one Remote Media Gateway Model. Values:
|
Alert-Info strings for Distinctive Ringing - normal ringing | Change | This field appears only if Category is set to SIP. The Alert-Info header string, if any, sent to the SIP device to indicate that a call should be announced using normal ring tone. If the SIP device is an Application Server, this also defines the Alert-Info header string that the server sends to the MetaSwitch NE to request normal ring tone. Specify a string of maximum 128 characters. To indicate that no Alert-Info header is required, leave this field blank. |
Alert-Info strings for Distinctive Ringing - distinctive ringing 2 (Intra-Business Group calling) | Change | This field appears only if Category is set to SIP. The Alert-Info header string, if any, sent to the SIP device to indicate that a call should be announced using the Distinctive Ringing 2 ring tone. If the SIP device is an Application Server, this also defines the Alert-Info header string that the server sends to the MetaSwitch NE to request Distinctive Ringing 2 ring tone. This tone is normally used to distinguish between external and internal calls in a Business Group. It is also used by a SIP Teen Service Line, if one of its Ring Pattern fields is set use Distinctive Ring Pattern 2. Specify a string of maximum 128 characters. To indicate that no Alert-Info header is required, leave this field blank. |
Alert-Info strings for Distinctive Ringing - distinctive ringing 3 (Automatic Recall/Callback) | Change | This field appears only if Category is set to SIP. The Alert-Info header string, if any, sent to the SIP device to indicate that a call should be announced using the Distinctive Ringing 3 ring tone. If the SIP device is an Application Server, this also defines the Alert-Info header string that the server sends to the MetaSwitch NE to request Distinctive Ringing 3 ring tone. This tone is normally used to indicate Automatic Recall or Automatic Callback calls. It is also used by a SIP Teen Service Line, if one of its Ring Pattern fields is set use Distinctive Ring Pattern 3. Specify a string of maximum 128 characters. To indicate that no Alert-Info header is required, leave this field blank. |
Alert-Info strings for Distinctive Ringing - distinctive ringing 4 (Priority Calling) | Change | This field appears only if Category is set to SIP. The Alert-Info header string, if any, sent to the SIP device to indicate that a call should be announced using the Distinctive Ringing 4 ring tone. If the SIP device is an Application Server, this also defines the Alert-Info header string that the server sends to the MetaSwitch NE to request Distinctive Ringing 4 ring tone. This tone is normally used to indicate Priority Calling. It is also used by a SIP Teen Service Line, if one of its Ring Pattern fields is set use Distinctive Ring Pattern 4. Specify a string of maximum 128 characters. To indicate that no Alert-Info header is required, leave this field blank. |
Supported high-bandwidth media formats | Change | High-bandwidth formats, if any, that Media Gateways using this model can use to communicate with other Media Gateways. A high-bandwidth format can be used only if both Media Gateways in a call support the same format. Specify one or more of the following values:
|
Supported low-bandwidth media formats | Change | Low-bandwidth formats, if any, that Media Gateways using this model can use to communicate with other Media Gateways. A low-bandwidth format can be used only if both Media Gateways in a call support the same format, and is not used if the subscriber line is a fax-only line. Specify zero or more of the following values:
|
Preferred low-bandwidth media formats | Change | Preferred low-bandwidth formats for Media Gateways using this model. Specify one or more of the following values, or none to indicate no preference:
|
Packetization interval | Change | Preferred media packetization interval, in milliseconds, for Media Gateways using this model. If this field is set to zero, the partner Media Gateway's packetization interval will be used instead. When programming endpoints, or when the packetization intervals are zero on both Media Gateways, then a default value will be used instead. Some individual media formats do not use this field, or may impose constraints on its value. For example, TDM and MF trunks do not require a packetization interval; G.729 requires a multiple of 10ms. If you specify an invalid value for the format in use, the default value for that format will be used instead. |
Silence suppression allowed | Change | Specifies whether silence suppression is allowed for this Media Gateway.
If two Media Gateways are connecting a call and both are configured to allow silence suppression, the link between them will be silence suppressed.
Note that the Line Usage specified for a subscriber may indicate that a line is fax-only. If such a subscriber is already part of a call, silence suppression will not be used. Values:
|
Supported connection types | Change | This field is not visible if Category is set to SIP. Specifies whether this Media Gateway supports Access Devices using analog connections, digital connections, or both. Select one or both of the following values. The default is analog only.
|
Access Device analog port name prefix | Change Inactive | A text string that will be used as a prefix in generating port names for new Access Devices using analog connections to this Remote Media Gateway Model. This field is not visible if Category is set to SIP, and appears only if Supported connection types includes the value Analog. Specify a string of up to 12 characters. If you do not specify a prefix, MetaSwitch uses the standard string AALN. |
Access Device digital port name prefix | Change Inactive | A text string that will be used as a prefix in generating port names for new Access Devices using digital connections to this Remote Media Gateway Model. This field is not visible if Category is set to SIP, and appears only if Supported connection types includes the value Digital. Specify a string of up to 12 characters. If you do not specify a prefix, MetaSwitch uses the standard string ds/ds1. |
Maximum simultaneous transactions outstanding | Change | The maximum number of outstanding transactions between the MetaSwitch Call Agent and the remote Media Gateway. You should not need to modify this setting except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Specify a value in the range 10 - 1000. The default is 300 if Control protocol is MeGaCo H248, and 100 otherwise. |
Digit overhang time | Change | The minimum time delay in milliseconds between detecting the last digit dialed by a subscriber on this device and cutting the call through to the target device. If subscribers are having problems connecting to voicemail or other services where the target device interprets key presses from the subscriber, you may need to increase this value; please discuss with your MetaSwitch support contact. Specify a value in the range 0 - 1000 (0 - 1 second). The default is 250. |
Poll interval | Change | This field does not appear if Category is set to SIP. The interval in seconds at which the MetaSwitch NE should check connectivity to the MGCP or MeGaCo device.
|
Fix bits (MGCP, MeGaCo, SIP) | Change | A series of options that control the detailed behaviour of Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MGCP, MeGaCo, SIP) 2 | Change | A series of options that control the detailed behaviour of Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MGCP, MeGaCo) | Change | This field appears only if Control protocol is set to MGCP or MeGaCo H248. A series of options that control the detailed behaviour of MGCP and MeGaCo Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MGCP) | Change | This field appears only if Control protocol is set to MGCP. A series of options that control the detailed behaviour of MGCP Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MGCP) 2 | Change | This field appears only if Control protocol is set to MGCP. A series of options that control the detailed behaviour of MGCP Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MeGaCo) | Change | This field appears only if Control protocol is set to MeGaCo H248. A series of options that control the detailed behaviour of MeGaCo Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (MeGaCo) 2 | Change | This field appears only if Control protocol is set to MeGaCo H248. Additional options that control the detailed behaviour of MeGaCo Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Fix bits (SIP) | Change | This field appears only if Category is set to SIP. A series of options that control the detailed behaviour of SIP Media Gateways. You should not need to modify these settings except during integration or interoperability testing with new Media Gateways, or as instructed by MetaSwitch support personnel. Select zero or more of the following values:
|
Reference count | Read only | This field tracks the count of Subscriber Gateways, Configured SIP Bindings, and/or Trunk / Access Gateways that refer to this gateway model. If one or more gateways or bindings refer to this gateway model, it cannot be deleted or disabled. |
Up to date count | Read only | This field tracks the count of Subscriber Gateways, Configured SIP Bindings, and/or Trunk / Access Gateways referring to this gateway model that have been updated with the most recent change to the model. Compare this field with Reference count to track the progress of a change; if the two fields show the same value, all gateways and bindings are up to date. |
Export - number of objects exported | Read only | The total number of objects (including child objects) written to the export file so far in the current or most recent export operation. |
Export - status | Read only | The status of the current or most recent export operation, if any. Values:
|
Export - file | Change | The name of the text file (in the EMS User's home directory on the EMS Server) to which configuration information for this object will be exported. The maximum length of the filename is 32 characters. |
Export - log correlator | Read only | If the export status is Failed, this field contains a correlator for the log message that contains details of the failure. Click on the 'go to log' button next to this field to jump to this message in the EMS log viewer window. |
Export - correlator metaswitch | Read only | If the export status is Failed, this field contains the name of the EMS Server or MetaSwitch Network Element that generated the failure log. You may need this information to find the log in the EMS log viewer window. |
Requested status | Read only | Specifies whether an administrator has attempted to enable the Remote Media Gateway Model. Values:
|
Actual status | Read only | Specifies the current status of the Remote Media Gateway Model. Values:
|
Managing Trunk / Access Gateways and Subscriber Gateways
When working with Trunk / Access Gateways and Subscriber Gateways, the manufacturer will often supply management applications for these systems. For example, you may have access to a web-based management application, or you may need to connect to the gateway to check some status information. When working with these objects in the EMS System Explorer, you can quickly launch those additional applications using the Connect to action on that object. This runs a command that you have defined on the Remote Media Gateway Model used by that Gateway.
![]() |
Many commands that you might want to configure will be specific to a particular operating system. For example, if you configure the Management connection command to run a Windows application, this will obviously not work on a Solaris computer. Typically, this will mean that you can only support the management command on one operating system for your deployment. |
To set up the command you want to run, you edit the Management connection command on the Remote Media Gateway Model object. This allows you to specify up to 256 characters, including parameters that vary based on the gateway. For example, you could run the popular PuTTY application to connect to the Gateway's IP address.
putty.exe #IPAddress#
The parameters that you can specify are:
These IP addresses and domain names correspond to the EMS Server's view of the Gateway, and may not always be appropriate. For example, you may have a network configuration where the computer running the EMS System Explorer cannot access the Gateway using a particular IP address. For a Subscriber Gateway, you can use the six Customer information fields to hold additional information that can be substituted in using these parameters:
This is not supported for Trunk / Access Gateways.
The Description and Customer information fields can potentially be used to supply parameters such as user-names, filenames, or other options that vary from Gateway to Gateway. Note that if you include passwords in these fields, you should make sure that the EMS operators able to view these objects are authorized to know those passwords.
In order to run the default web browser on a Windows computer, use the parameter #WindowsBrowser#, and you should specify http:// in the URL. For example, if you want to access a web-based interface on port 8080 using the domain name of the Gateway, you would use the command:
#WindowsBrowser# http://#DomainName#:8080/
Note that if you want to run a batch file under Windows, you should specify the command as cmd.exe filename.bat. Commands that are part of the Windows 'Command Prompt' (such as echo, cd, or set) are not normal files that can be executed. Including those commands in a batch file is the simplest way of executing them. Some Windows commands can also be run using the start command. For example:
start telnet #DomainName#
When you run the command, it produces two files in the directory the EMS System Explorer is installed in.
Viewing these files will often provide you with enough information to debug any problems. You may need to provide these files to your MetaSwitch support engineer to debug the command. These files are over-written (replaced) each time you use the action, and only show the results of the last use of the action.