SIP Trunk

Each SIP Trunk object is a child of the SIP Trunks object.

The object contains configuration parameters and status information for a connection to a remote SIP exchange.

For initial configuration of a SIP Trunk, you need to do the following:


Parameter

Access

Description
SIP Trunk name Change Unique user-friendly name identifying the SIP Trunk.
Description Change A text field that can be used to store information about the SIP Trunk. Specify a string of up to 64 characters.
Local trunk group number Change Inactive The Trunk Group ID of the SIP Trunk. Specify a numeric value in the range 0 - 9999. This field is used in the SIP Trunk's display name in the EMS, and also 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.
Network number Change Inactive An identifier for the remote network, which will appear in transit billing records for outgoing calls over this trunk. Specify a different number for each remote network, so that all remote exchanges on the same network have the same network number.
Configured SIP Binding Change Inactive A set of parameters defining the connection between the MetaSwitch NE and the SIP device. Select from the drop-down list of Configured SIP Bindings with Usage set to Trunk.
Force echo cancellation on inbound calls Change Inactive Specifies whether the MetaSwitch NE or the remote system should provide echo cancellation for incoming calls on this trunk. 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.
Force echo cancellation on outbound calls Change Inactive Specifies whether the MetaSwitch NE or the remote system should provide echo cancellation for outgoing calls on this trunk. 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 Specifies whether this trunk can be used for incoming calls, outgoing calls, or both. Values:
  • Incoming only
  • Outgoing only
  • Incoming and Outgoing
% utilization Read only Percentage utilization of the trunk; the number of currently active calls as a percentage of the maximum concurrent calls permitted for the trunk.
Deactivation mode Change Specifies how to deactivate this object. Values:
  • Normal (default)
    End all calls using this SIP Trunk before deactivating the object.
  • Quiesce
    Deactivating the SIP Trunk in quiesce mode will wait for all calls using it to finish before deactivation. No new calls can use this SIP Trunk during this deactivation period.
  • Abort
    Deactivate the object immediately, whether or not any calls are using it. (This may result in errors at remote systems.)
Billing - incoming terminating CDR type Change This field is hidden if Supported call directions is set to Outgoing only. Specifies what CDR (if any) is output for incoming calls terminating on this NE using this SIP Trunk. Values:
  • None (default)
  • FGD (119/0625)
  • FGB (135/0653)
  • CNA (720/0625) upon LNP query
  • CNA (720/0625) always
  • TT (710/0625)
Billing - generate additional incoming call CDR Change This field is hidden if Supported call directions is set to Outgoing only. 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 Supported call directions is set to Outgoing only. Specifies what CDR (if any) is output for a tandem call routed through this NE using this SIP Trunk 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)
Billing - outgoing originating CDR type Change This field is hidden if Supported call directions is set to Incoming only. Specifies what CDR (if any) is output for outgoing calls originating from this NE using this SIP Trunk. Values:
  • None (default)
  • FGD (110/0625)
  • FGB (134/0625)
  • TT (711/0625)
Billing - outgoing tandem CDR type Change This field is hidden if Supported call directions is set to Incoming only. Specifies what CDR (if any) is output for a tandem call routed through this NE using this SIP Trunk for the outgoing leg. Values:
  • None (default)
  • FGD (110/0625)
  • FGB (134/0625)
  • TT (711/0625)
  • 119/0625
CNA billing for incoming calls - CIC Change This field is visible only if Supported call directions is not set to Outgoing only, 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 SIP Trunk. Range: 0 - 9999.
CNA billing for incoming calls - CNA billing number Change This field is visible only if Supported call directions is not set to Outgoing only, 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 Supported call directions is not set to Outgoing only, 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 log correlator Read only Identifier of the log message for the event that caused the last 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.
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 was last reset to zero.
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.
Requested status Read only Specifies whether an administrator has attempted to activate the SIP Trunk. 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 SIP Trunk. 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.
  • Waiting For Parent
    The object cannot be used because its parent object is not yet active.
  • Parent Failed
    The object cannot be used because its parent object has failed.