The Subscriber Gateway object is a child of the Subscriber Gateways object. It manages communications with subscribers using VoIP access devices. This object corresponds to the Call Agent's view of the subscriber gateway, rather than the physical gateway itself.
Normally there is a single Access Device child for each Subscriber Gateway, but in some cases there may be more than one. For example, if the Subscriber Gateway corresponds to a Broadband Loop Carrier, which manages a large number of Access Lines, each block of access lines on the gateway should be configured as a separate Access Device.
To configure and use a Subscriber Gateway, you need to do the following:
![]() |
You cannot delete a Subscriber Gateway if one or more Access Devices refer to it. |
Object-Specific Actions | |
Connect to | This actions runs the command defined in the Management connection command field on the Remote Media Gateway Model for this object, using the fields on this Subscriber Gateway to fill in the parameters. This is typically used to run a vendor-supplied management application for your gateway. |
Statistics | Opens the Statistics viewer, which allows you to view historical statistics data for this object. |
Parameter |
Access |
Description |
Description | Change | A text string used in the EMS System Explorer to identify this Subscriber Gateway. Specify a string of up to 64 characters, which must not match the description of any other Trunk / Access Gateway or Subscriber Gateway. |
Customer information | Change | A text field that can be used to store information about the Subscriber Gateway, for example the address of the customer associated with it. This field is optional; you can supply up to 64 characters of free-form text. The text wraps to the width of the field on screen, or you can use the Enter key to force linebreaks. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 2 | Change | A text field that can be used to store additional information about the Subscriber Gateway. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 3 | Change | A text field that can be used to store additional information about the Subscriber Gateway. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 4 | Change | A text field that can be used to store additional information about the Subscriber Gateway. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 5 | Change | A text field that can be used to store additional information about the Subscriber Gateway. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
Customer information 6 | Change | A text field that can be used to store additional information about the Subscriber Gateway. This field is optional; you can supply up to 32 characters of free-form text. The total contents of all six Customer information fields must not exceed 164 characters. |
IP address | Change Inactive | The IP address of this Subscriber Gateway, used to send gateway control commands. This parameter is optional if you have specified a Domain name that can be resolved to an IP address using the NE's Domain Name Services settings. Specify a standard dotted-decimal IP address. |
Domain name | Change Inactive | Domain name for the Subscriber Gateway. This parameter is required if the Subscriber Gateway uses authentication; otherwise it is optional if you have specified the IP address.
|
Resolved IP address | Read only | The IP address of this Subscriber Gateway that was determined from the supplied domain name using Domain Name Services. |
Media Gateway model | Change | The Media Gateway model that describes this gateway. Select from the displayed list of Media Gateway models for subscriber gateways. If you change the model while this gateway is enabled, note that your changes may affect service to subscribers using the gateway. You will be prompted to confirm the change. |
Preferred location of Trunk Gateway | Change | Specifies the location for Trunk / Access Gateways that should be used to route calls for this object where possible (to reduce unnecessary long-distance traffic when a call can be routed within the same location). Select from the displayed list of available Location objects or None (no location). The value defaults to None. |
Use static NAT mapping | Change Inactive | Specifies whether the NE should perform Network Address Translation on the contents of messages sent to this Subscriber Gateway. Values:
|
Authentication required | Change Inactive / Read only | This field appears only if the selected Remote Media Gateway Model's 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:
|
Password | Change Inactive | This field appears only if Authentication required is True. The password that is used to calculate the HTTP Digest. The password is not displayed in the EMS and you cannot view it, although you can change it to a new value if necessary. Specify a text string of 6 - 15 characters. Note that the HTTP Digest is calculated from the Subscriber Gateway's Domain name and the NE's system name as well as the Password field. If you change either of these two names, you will need to specify the password again to force the EMS to create a new HTTP Digest for the Subscriber Gateway. |
Confirm password | Change Inactive | This field appears only if Authentication required is True. To confirm that you have typed the password correctly, type it again in this field. The characters you type must exactly match the characters you typed in the Password field. |
Maximum concurrent media streams allowed | Change Inactive | Maximum number of bi-directional RTP media streams (RTP terminations) that can exist concurrently on this gateway. A value of zero (the default) indicates no limit. Changing this value changes the maximum IP bandwidth that may be taken up by calls associated with this gateway. |
Maximum concurrent high bandwidth media streams allowed | Change Inactive | Maximum number of high bandwidth bi-directional RTP media streams (RTP terminations) that can exist concurrently on this gateway. This value must not exceed Maximum concurrent media streams allowed, unless that value is zero. A value of zero (the default) indicates that the number of streams is limited only by Maximum concurrent media streams allowed. Changing this value changes the maximum IP bandwidth that may be taken up by calls associated with this gateway. |
Current number of media streams in use | Read only | Current number of bi-directional RTP media streams (RTP terminations) in use on this gateway. |
Current number of high bandwidth media streams in use | Read only | Current number of high bandwidth bi-directional RTP media streams (RTP terminations) in use on this gateway. Note that this counts only streams that were allocated as high bandwidth at the start of the call; for example, the count is not updated if a fax or modem call falls back to using a high bandwidth stream. |
Provider status | Read only | The availability status of the gateway. Values:
|
Congestion - system load - status | Read only | Specifies whether the associated media gateway is currently reporting congestion status. If the gateway hardware does not support congestion status reporting, this field is not displayed. Values:
|
Congestion - system load - value | Read only | This field appears only if Congestion - system load - status is visible and set to Reported by Gateway. The congestion level of the associated media gateway. This is typically around 10% in normal conditions. A higher value means that the media gateway is overloaded (in terms of its capacity to set up and tear down calls). 100% indicates the gateway's maximum tolerated level of overload; when the gateway reaches this level, the Call Agent can no longer use it to set up any new calls. |
Congestion - RTP resources - status | Read only | Specifies whether the associated media gateway is currently reporting RTP congestion status. If the gateway hardware does not support congestion status reporting, this field is not displayed. Values:
|
Congestion - RTP resources - value | Read only | This field appears only if Congestion - RTP resources - status is visible and set to Reported by Gateway. The congestion level of the associated media gateway's RTP resources. A sudden jump in this value may indicate that a piece of hardware has failed or has been deactivated. |
Congestion - RTP resources - combined status | Read only | Specifies whether RTP resource usage is currently limited by the associated media gateway's resource usage or by the bandwidth constraints configured on the Call Agent. Values:
|
Congestion - RTP resources - combined value | Read only | This field does not appear if Congestion - RTP resources - combined status is set to Unavailable. The overall congestion level of RTP resources. This congestion level may be determined by the gateway's resource usage or by the Call Agent configuration, as indicated by the field Congestion - RTP resources - combined status. |
Alarm state | Read only | Specifies whether any alarms are currently raised for this object. Values:
|
Alarm log correlator | Read only | Identifier of the log message for the event that caused the last Attention Required or Attend To Dependent alarm state for this object. This field is reset when the Attention Required alarm events or Attend To Dependent alarm events is reset to zero. |
Attention Required alarm events | Read only / Reset | Number of times (since the alarm count was reset) that this object's alarm state has gone to Attention Required. |
Attend To Dependent alarm events | Read only / Reset | Number of times (since the alarm count was reset) that this object's alarm state has gone to Attend To Dependent. |
Alarm state changed timestamp | Read only | The time at which the Alarm state last changed. |
Alarm events reset timestamp | Read only | The time at which the Attention Required alarm events or Attend To Dependent alarm events was last reset to zero. |
Access Device Attention Required alarms | Read only | The total number of Access Devices (and their child objects) that are in Attention Required state. |
Access Device Attention Required alarm events | Read only / Reset | The total number of times that the alarm state for an Access Device child object has gone to Attention Required. |
Access Device Attend To Dependent alarms | Read only | The total number of Access Devices (and their child objects) that are in Attend To Dependent state. |
Access Device Attend To Dependent alarm events | Read only / Reset | The total number of times that the alarm state for an Access Device child object has gone to Attend To Dependent. |
Summary child alarm state | Read only | Summarizes the alarm status for all children of this object. Values:
|
Diagnostics - API trace - enabled | Change | Specifies whether API tracing is enabled for this object. Values:
|
Diagnostics - API trace - trace tag | Change | An optional text string inserted into API tracing and PD logging for this object. (This string can include accented / international characters as defined in ISO 8859-1.) If you want to filter on this tag in the craft interface, do not include spaces or any of the characters ^ \ $ * + ? | ( ) , . ' ' " [ ] { }. |
Deactivation mode | Change | Specifies how child objects should be deactivated when deactivating this object. Values:
|
Import - number of objects imported | Read only | The total number of objects (including child objects) read from the import file so far in the current or most recent import operation. |
Import - status | Read only | The status of the current or most recent import operation, if any. Values:
|
Import - mode | Change | Whether the imported information is to replace existing EMS objects or to add new ones. This field provides additional checking on the import operation if required. Values:
|
Import - file | Change | The name of the text file (in the EMS User's home directory on the EMS Server) from which configuration information for this object will be imported. The maximum length of the filename is 32 characters. |
Import - log correlator | Read only | If the import 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. |
Import - correlator metaswitch | Read only | If the import 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. |
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 activate the Subscriber Gateway. Values:
|
Actual status | Read only | Specifies the current status of the Subscriber Gateway. Values:
|