ISDN Primary Rate Interface

The ISDN Primary Rate Interface object is a child of the ISDN Primary Rate Interfaces object. It describes one of the following:

An ISDN Primary Rate Interface requires a DS1 carrying a D-channel (for ISDN signaling), or two such DS1s if it is an NFAS interface requiring D-channel backup. These DS1s must use a TDM port on a PB3000, PB3100 or PB4000/4500/5000 adaptor, must be configured using the NE CRAFT interface to support a D-channel, and must not be used for any other type of access (for example ISUP or GR-303).


For a PB3000 adaptor, setting up or changing the DS1 configuration in the NE CRAFT interface requires restarting the adaptor, which ends any active calls using it. This restriction does not apply to the PB3100 or PB4000/4500/5000 adaptor. You are strongly recommended to plan your ISDN configuration on PB3000 adaptors to take account of the likely future usage of D-channel DS1s as well as your initial requirements, and to set up all the required DS1s when you first configure ISDN and keep track of their current and proposed allocation to ISDN Primary Rate Interfaces. This helps to avoid the disruption that may be caused by future configuration changes. Configure these DS1s using the CRAFT interface before you begin the EMS configuration of the ISDN Primary Rate Interfaces that use them. For instructions on using the CRAFT interface, refer to the Network Element Installation and Maintenance Guide.

For initial configuration of an ISDN Primary Rate Interface, you need to do the following.

Object-Specific Actions
Export To export the configuration of the ISDN Primary Rate Interface to a text file, click on the 'Export' pushbutton. See MetaSwitch Class 5 Softswitch Operations Manual: Overview for more details of exporting configuration information.

Parameter

Access

Description
Description Change A text string used in the EMS System Explorer to identify this ISDN Primary Rate Interface. Specify a string of up to 64 characters, which must not match the description of any other ISDN Primary Rate Interface.
Customer information Change A text field that can be used to store information about the ISDN Primary Rate Interface, 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 ISDN Primary Rate Interface. 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 ISDN Primary Rate Interface. 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 ISDN Primary Rate Interface. 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 ISDN Primary Rate Interface. 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 ISDN Primary Rate Interface. 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.
Usage Create Specifies whether this PRI is used for access or trunk ISDN. Values:
  • Access (default)
    The PRI connects ISDN telephony equipment such as a PBX or RAS Server to the NE.
  • Trunk
    The PRI is a trunk to a remote exchange.
Primary Rate Interface Profile Change Inactive The ISDN Interface Profile used by this interface. Select from the displayed list of ISDN Interface Profiles. If Usage is Access, the list shows only network side profiles because the NE must act as network side on an access PRI.
Local trunk group number Change Inactive This field appears only if Usage is Trunk. The Trunk Group number of the ISDN PRI, used in billing records. When a call is set up using a circuit on this trunk group, the billing record output will indicate the trunk group's number. Range: 0 - 9999.
Network number Change Inactive This field appears only if Usage is Trunk. An identifier for the remote network, which will appear in transit billing records for outgoing calls to the remote exchange. Specify a different number for each remote network, so that all remote exchanges on the same network have the same network number. Range: 0 - 999999.
Force echo cancellation on inbound calls Change Inactive This field appears only if Usage is Trunk. Specifies whether the MetaSwitch NE or the remote system should provide echo cancellation for incoming calls on this PRI. Values:
  • True
    The MetaSwitch NE provides echo cancellation.
  • False (default)
    The MetaSwitch NE does not provide echo cancellation, and assumes that it is provided by the remote system if required.
Supported call directions Change Inactive This field appears only if Usage is Trunk. Specifies whether this PRI can be used for incoming calls, outgoing calls, or both. Values:
  • Incoming only
  • Outgoing only
  • Incoming and Outgoing (default)
Direct IXC connection Change Inactive This field appears only if Usage is Trunk. Specifies whether the remote exchange is a directly connected IXC. Values:
  • True
  • False (default)
NFAS interface Change Inactive Specifies whether this is an NFAS (Non Facility Associated Signaling) interface. This supports multiple T1 connections with their signaling information sharing the same D-channel, for increased interface capacity. Values:
  • True
    This is an NFAS interface.
  • False (default)
    This is not an NFAS interface. There can be only one child DS1 object; you will not be able to activate the interface if it has two or more child DS1 objects.
If the Primary Rate Interface Profile associated with this interface uses the protocol variant 5ESS Custom, this parameter must be set to False.
D-channel backup available Change Inactive Specifies whether this interface supports two D-channels on different DS1s, to provide a backup if the primary channel fails. This parameter is used only if NFAS interface is set to True. Values:
  • True
  • False (default)
Primary D-channel DS1 Change Inactive The ISDN PRI DS1 used for the primary D-channel. This parameter is used only if NFAS interface is set to True. Select from the displayed list of child ISDN PRI DS1 objects. This list shows only DS1s with Network-side ISDN D-channel available or only DS1s with User-side ISDN D-channel available, depending on the setting of Usage in the ISDN Interface Profile used by this PRI.
Primary D-channel LAPD resource Read only The LAPD resource associated with the DS1 selected for the primary D-channel; that is, the LAPD resource on the same adaptor as the TDM port associated with the primary D-channel.
Primary D-channel status Read only Status of the primary D-channel. This parameter is used only if NFAS interface is set to True. Values:
  • Unknown
  • Inactive (media down)
  • Inactive (signaling failure)
  • Active
Secondary D-channel DS1 Change Inactive The ISDN PRI DS1 used for the secondary D-channel. This parameter is used only if NFAS interface and D-channel backup available are both set to True. Select from the displayed list of child ISDN PRI DS1 objects. This list shows only DS1s with Network-side ISDN D-channel available or only DS1s with User-side ISDN D-channel available, depending on the setting of Usage in the ISDN Interface Profile used by this PRI.
Secondary D-channel LAPD resource Read only The LAPD resource associated with the DS1 selected for the secondary D-channel. This parameter is used only if NFAS interface and D-channel backup available are both set to True.
Secondary D-channel status Read only Status of the secondary D-channel. This parameter is used only if NFAS interface and D-channel backup available are both set to True. Values:
  • Unknown
  • Inactive (media down)
  • Inactive (signaling failure)
  • Active
Overall D-channel status Read only Overall status of the D-channel. This parameter is used only if NFAS interface and D-channel backup available are both set to True. Values:
  • Unknown
  • Primary channel active
  • Secondary channel active
  • Inactive
Supported bearer capabilities Change Inactive This field appears only if Usage is Access. Types of ISDN call supported by this interface. Select one or more of the following values. The default is all values selected.
  • Speech or 3.1kHz audio
  • 64kbps data
  • 64kbps restricted
  • 56kbps data
Bearer capabilities with no primary subscriber Read only This field appears only if Usage is Access. Supported bearer capabilities on this interface for which there is no primary subscriber (that is, values listed in Supported bearer capabilities for which no subscriber line using this interface has ISDN default bearer capabilities set). Possible values:
  • Speech or 3.1kHz audio
  • 64kbps data
  • 64kbps restricted
  • 56kbps data
Channel allocation policy Change Inactive Channel allocation algorithm on this interface. This should be set to the opposite of the algorithm used by the remote equipment using this interface, to minimize possible conflicts. Values:
  • Lowest available channel
    Use the lowest available channel in the lowest available DS1.
  • Highest available channel
    Use the highest available channel in the highest available DS1.
  • Most idle
    Use the available channel that has been idle for the longest time.
  • Least idle
    Use the available channel that has been idle for the shortest time.
The default is Lowest available channel if Usage in the ISDN Interface Profile used by this PRI is Network side, and Highest available channel if it is User side.
Far end play ringback Change Inactive This field appears only if Usage is Access. Specifies whether the connected Class II equipment provides audible ringing tone to the caller on voice calls. Values:
  • True (default)
    The connected equipment provides ringback.
  • False
    The switch must provide the audible ringing tone, and the call is not cut through to the connected equipment until it is answered.
Calling number required Change This field appears only if Usage is Access. Specifies whether the connected Class II equipment must provide a calling number (for use in Calling Number Delivery) on call origination attempts over this interface. If you change this parameter while the interface is active, the change does not take effect until the next attempt to originate a call. Values:
  • True
    The connected equipment must provide a calling number.
  • False (default)
    A calling number is not required.
Override calling number verification Change This field appears only if Usage is Access. If the connected Class II equipment supplies a calling number on call origination attempts over this interface, the NE normally verifies that it owns this number before sending it out as the Caller ID; if it does not own the number, it sends the subscriber's directory number instead. This field allows you to turn off this verification so that the supplied calling number is always used. Values:
  • True
    The supplied calling number is always used as the Caller ID for the call, whether or not it is a number owned by the NE.
  • False (default)
    The NE uses the supplied calling number only if it can be verified as a number owned by the NE.
You may need to set this option to True if the ISDN PRI is used by a PBX providing outbound long-distance service to non-local numbers; the PBX is configured in the NE with local numbers, but the real calling number must be sent as the Caller ID to allow calls to be returned. You should be aware that setting True allows subscribers connected over the ISDN PRI to falsify their Caller ID, which may be a security issue.
Number of referencing subscribers Read only This field appears only if Usage is Access. Count of the Individual Lines, Business Group Lines, PBX Lines and Voicemail System Lines that refer to this ISDN Primary Rate Interface.
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 object in quiesce mode will wait for all existing child objects to be deactivated before this object is deactivated. No new child objects can be activated during this deactivation period.
  • Abort
    Deactivate the object and all its child objects immediately. (This may result in errors at remote systems.)
Configured primary D-channel IUA / SCTP identifier Read only Interface identifier for the primary D-channel configured for use with this interface. This value is used in the Interface Identifier field in IUA messages.
Actual primary D-channel IUA / SCTP identifier Read only Interface identifier for the primary D-channel currently in use. This value is used in the Interface Identifier field in IUA messages.
Configured secondary D-channel IUA / SCTP identifier Read only Interface identifier for the secondary D-channel configured for use with this interface. This value is used in the Interface Identifier field in IUA messages. This parameter is used only if both NFAS interface and D-channel backup available are set to True.
Actual secondary D-channel IUA / SCTP identifier Read only Interface identifier for the secondary D-channel currently in use. This value is used in the Interface Identifier field in IUA messages. This parameter is used only if both NFAS interface and D-channel backup available are set to True.
Billing - incoming terminating CDR type Change This field is hidden if Usage is set to Access, or Supported call directions is set to Outgoing. Specifies what CDR (if any) is output for incoming calls terminating on this NE using this ISDN PRI. Values:
  • None (default)
  • FGD (119/0625)
  • FGB (135/0653)
  • CNA (720/0625) upon LNP query
  • CNA (720/0625) always
  • TT (710/0625)
  • ISDN (045/0001)
Billing - generate additional incoming call CDR Change This field is hidden if Usage is set to Access, or Supported call directions is set to Outgoing. Specifies whether an additional 119/0625 billing record should be output for incoming calls that are terminated locally, in addition to any CDR configured using the Billing - incoming terminating CDR type field. Values:
  • True
  • False (default)
Billing - incoming tandem CDR type Change This field is hidden if Usage is set to Access, or Supported call directions is set to Outgoing. Specifies what CDR (if any) is output for a tandem call routed through this NE using this ISDN PRI for the incoming leg. Values:
  • None (default)
  • FGD (119/0625)
  • FGB (135/0653)
  • CNA (720/0625) upon LNP query
  • CNA (720/0625) always
  • TT (710/0625)
  • ISDN (045/0001)
Billing - outgoing originating CDR type Change This field is hidden if Usage is set to Access, or Supported call directions is set to Incoming. Specifies what CDR (if any) is output for outgoing calls originating from this NE using this ISDN PRI. Values:
  • None (default)
  • FGD (110/0625)
  • FGB (134/0625)
  • TT (711/0625)
  • ISDN (045/0001)
Billing - outgoing tandem CDR type Change This field is hidden if Usage is set to Access, or Supported call directions is set to Incoming. Specifies what CDR (if any) is output for a tandem call routed through this NE using this ISDN PRI for the outgoing leg. Values:
  • None (default)
  • FGD (110/0625)
  • FGB (134/0625)
  • TT (711/0625)
  • ISDN (045/0001)
  • 119/0625
CNA billing for incoming calls - CIC Change This field is visible only if Usage is set to Trunk, Supported call directions is not set to Outgoing, and either Billing - incoming terminating CDR type or Billing - incoming tandem CDR type is set to CNA (720/0625) upon LNP query or CNA (720/0625) always. Specifies the Carrier Identification Code to use in CNA billing records generated for incoming calls on this ISDN PRI. Range: 0 - 9999.
CNA billing for incoming calls - CNA billing number Change This field is visible only if Usage is set to Trunk, Supported call directions is not set to Outgoing, and either Billing - incoming terminating CDR type or Billing - incoming tandem CDR type is set to CNA (720/0625) upon LNP query or CNA (720/0625) always. Specifies the billing number which may be output in CNA billing records generated for incoming calls on this ISDN PRI. Either leave this field blank, or specify a ten digit number.
CNA billing for incoming calls - include calling number Change This field is visible only if Usage is set to Trunk, Supported call directions is not set to Outgoing, and either Billing - incoming terminating CDR type or Billing - incoming tandem CDR type is set to CNA (720/0625) upon LNP query or CNA (720/0625) always. Specifies whether the calling number should be included in CNA billings records for incoming calls on this ISDN PRI. Values:
  • True
  • False (default)
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 state changed timestamp Read only The time at which the Alarm state last changed.
Alarm log correlator - Attention Required Read only Identifier of the log message for the event that caused the last Attention Required alarm state for this object. This field is reset when the Attention Required alarm events is reset to zero.
Additional alarm log correlator - Attention Required Read only If available, the identifier of the log message for the original event that caused the last Attention Required alarm state for this object. This field is reset when the Attention Required alarm events field 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.
Attention Required alarm events reset timestamp Read only The time at which the Attention Required alarm events was last reset to zero.
Alarm log correlator - Attend To Dependent Read only Identifier of the log message for the event that caused the last Attend To Dependent alarm state for this object. This field is reset when the Attend To Dependent alarm events field is reset to zero.
Additional alarm log correlator - Attend To Dependent Read only If available, the identifier of the log message for the original event that caused the last Attend To Dependent alarm state for this object. This field is reset when the Attend To Dependent alarm events field is reset to zero.
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.
Attend To Dependent alarm events reset timestamp Read only The time at which the Attend To Dependent alarm events was last reset to zero.
ISDN PRI DS1 Attention Required alarms Read only The total number of ISDN PRI DS1 objects (and their child objects) associated with this object that are in Attention Required state.
ISDN PRI DS1 Attention Required alarm events Read only / Reset The total number of times that the alarm state for an ISDN PRI DS1 child object has gone to Attention Required.
ISDN PRI DS1 Attend To Dependent alarms Read only The total number of ISDN PRI DS1 objects (and their child objects) associated with this object that are in Attend To Dependent state.
ISDN PRI DS1 Attend To Dependent alarm events Read only / Reset The total number of times that the alarm state for an ISDN PRI DS1 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 - log level Change Specifies the level of logs recorded for this object. Logs with a priority equal to or greater than the priority specified are recorded. Set to Default level to use the system-wide default level. Values:
  • Level 10 (diagnostics)
  • Level 20 (verbose statistics)
  • Level 30 (verbose operational)
  • Level 40 (statistics)
  • Level 50 (audit)
  • Level 60 (operational)
  • Level 70 (unexpected)
  • Level 80 (error)
  • Level 90 (fatal)
  • Default level (default)
Diagnostics - API trace enabled Change Specifies whether API tracing is enabled for this object. Values:
  • True
  • False (default)
Diagnostics - trace tag Change An optional diagnostics tag inserted into API tracing and PD logging for this object. This tag may include any ASCII characters.
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
  • In progress
  • Succeeded
  • Failed
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 ISDN Primary Rate Interface. 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 ISDN Primary Rate Interface. 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.