Subscriber Gateway

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, 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.
  • If you specify a domain name, this name (rather than the IP address) is used in messages to the Media Gateway, unless the selected Media Gateway Model's Fix bits parameter includes the value Use IP Address, not domain name.
  • If this fix bit is set, or if you do not specify a domain name, the IP address is used instead.
Both relative and absolute domain names are supported in this field. A relative domain name is made up of letters A-Z (either uppercase or lowercase), digits, and hyphens. The first character must be a letter or a number. An absolute domain name is a list of one or more relative domain names separated by dot (period) characters. Note that the domain name is used in calculating the HTTP digest used for authentication. If the Subscriber Gateway uses authentication and you change the domain name, you will need to specify the password again to force the EMS to create a new HTTP Digest.
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.
CMTS Change This field appears only if the selected Remote Media Gateway Model's Control protocol is set to MGCP and Control protocol variant is set to MGCP NCS V1.0, or if you have not yet selected a Remote Media Gateway Model. It applies only if the gateway is being used for voice over cable calls for which Dynamic QoS is required. Specifies the Cable Modem Termination System that provides IP Over Cable service to subscribers using this gateway. Click on the ellipsis symbol at the right-hand end of the field to select from the list of all configured CMTS objects.
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.
ESA Protection Domain Change This field appears only if the selected Remote Media Gateway Model's Control protocol is set to MGCP. Specifies whether this gateway supports Emergency Standalone function.
  • To provide Emergency Standalone service for the gateway, select the name of its ESA Protection Domain from the drop-down list. The selected Remote Media Gateway Model must have the option Supports NotifiedEntity selected in the field Fix bits (MGCP) 2.
  • To indicate that Emergency Standalone service is not required, select None.
Call Agent control status Read only This field appears only if Status - actual status is Active and an ESA Protection domain is selected. The Call Agent's view of whether it has control of this gateway. Values:
  • Controlling
    The Call Agent is controlling the gateway.
  • Cautiously controlling
    Either the Call Agent is controlling the gateway but the ESA Server can take over control if necessary, or the Call Agent is ready to resume control after switchover but switchback has not yet occurred.
  • Abandoned
    The Call Agent is not controlling the gateway.
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:
  • True
    Select this value if the Subscriber Gateway is on a separate IP network from the NE and there is no Session Border Controller to provide the translation.
  • False
    Select this value if the Subscriber Gateway is on the same IP network as the NE, or if they are on separate networks and there is a Session Border Controller associated with the firewall between the networks.
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:
  • True
  • False (default)
You can change this field only if the Remote Media Gateway Model specifies that authentication is optional. If the Remote Media Gateway Model specifies that authentication is mandatory, or that it is not required, this field is read-only and set to True or False respectively. If this field is set to True, you must specify the Domain name.
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:
  • Unavailable
  • Available
  • Inactive
  • Active
  • Out of service
  • Quiescing
  • Unconfigured
  • Pending available
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:
  • Reported by Gateway
    The media gateway is reporting congestion status.
  • Unavailable
    The media gateway supports congestion status reporting but is not currently reporting it (for example because it has only just started).
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:
  • Reported by Gateway
    The media gateway is reporting RTP congestion status.
  • Unavailable
    The media gateway supports congestion status reporting but is not currently reporting it (for example because it has only just started).
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:
  • Limited by Gateway
  • Limited by Call Agent
  • Unavailable
    Information on RTP resource constraints is not currently available.
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:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - the object is not operating normally, and needs operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which this object depends is not operating normally.
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:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - one or more child objects are not operating normally, and need operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which one or more child objects depend is not operating normally.
Diagnostics - API trace - enabled Change Specifies whether API tracing is enabled for this object. Values:
  • True
  • False (default)
Diagnostics - API trace - trace tag Change An optional diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII characters. However, 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:
  • Normal (default)
    Shut down child objects normally before deactivating the object.
  • Quiesce
    Deactivating the Subscriber Gateway object in quiesce mode will wait for all existing child objects using the object to be completed before deactivation. No new child objects using this Subscriber Gateway object will be accepted during this deactivation period.
  • Abort
    Deactivate the object and all its child objects immediately. (This may result in errors at remote systems.)
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:
  • None
  • In progress
  • Succeeded
  • Failed
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:
  • Do not overwrite
    The imported information is to add new objects. If the file contains objects that already exist in the EMS, the import operation will fail and will not overwrite them.
  • Do not create
    The imported information is to update existing objects. If the file contains objects that do not already exist in the EMS, the import operation will fail and will not create them.
  • Overwrite or create
    No checking. The import operation will create or update objects as required.
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:
  • None
    No export has been attempted. Use the export pushbutton to start it.
  • In progress
    Export is in progress. Do not attempt to access the export file until the status has changed to Succeeded.
  • Succeeded
    Export completed successfully.
  • Failed
    Export failed. Check the Export - log correlator field for more details.
  • Partially failed
    A field in the configuration of the exported object or one of its child objects was not valid. Typically this is because a referenced object has been deleted. Either check and correct the configuration before retrying the export, or correct the error in the exported file before attempting to re-import it.
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:
  • Active
    The object has been activated.
  • Inactive
    The object has not been activated or has been deactivated.
  • Disabled
    The object has been disabled.
Actual status Read only Specifies the current status of the Subscriber Gateway. Values:
  • Active
    The object is active.
  • Activating
    Activation is in progress.
  • Deactivating
    Deactivation is in progress.
  • Inactive
    The object is inactive.
  • Disabled
    The object has been disabled.
  • Activation Failed
    The object is inactive because an activation attempt has failed.
  • Failed
    The object was active but has failed.
  • Quiescing
    The object is preparing for normal deactivation. It is operating normally but will not accept any new users.