Configured SIP Binding

The Configured SIP Binding object describes a configured connection to a SIP device (Application Server or SIP PBX Line), or to a remote SIP exchange (SIP Trunk). It represents a fixed connection, rather than a dynamic connection created when a device such as a SIP phone registers with the NE.

The Configured SIP Binding is a child of the Configured SIP Bindings object.


Some fields can be changed while the object is active and calls are in progress. Some SIP devices will not recognize these changes during a call, and this may cause an active call to be dropped. These fields are:
  • Use DN for identification
  • SIP authentication required
  • SIP user name
  • SIP domain name
  • New SIP password
  • Confirm new SIP password
  • Transport protocol
  • Use static NAT mapping


Parameter

Access

Description
Name Change A text string used in the EMS System Explorer to identify this Configured SIP Binding. Specify a string of up to 64 characters.
Customer information Change A text field that can be used to store information about the Configured SIP Binding, 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 Configured SIP Binding. 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 Configured SIP Binding. 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 Configured SIP Binding. 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 Configured SIP Binding. 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 Configured SIP Binding. 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 Change Specifies the type of SIP device that uses this binding. Values:
  • Subscriber
  • Application Server
  • Trunk
You cannot change this field if there is an active SIP device using this Configured SIP Binding.
Use DN for identification Change Specifies whether the SIP device is identified in outgoing SIP INVITE requests by its SIP user name or its directory number. Values:
  • True
    The SIP device is identified by its directory number.
  • False
    The SIP device is identified by its SIP user name.
Changing this value while there are any active calls may cause those call to be dropped. The NE ignores this option when matching received SIP requests to a Configured SIP Binding. Instead, it searches for a match using the following parameters in order:
  • The IP address and port in the SIP Contact header (matching against a Configured SIP Binding)
  • The directory number in the SIP From header (matching against a subscriber using a Configured SIP Binding)
  • The SIP user name and domain name in the SIP From header (matching against a Configured SIP Binding).
SIP authentication required Change Specifies whether this SIP device uses SIP authentication (and must supply authentication parameters in SIP signaling messages). Values:
  • True (default)
  • False
Changing this value while there are any active calls may cause those call to be dropped. If you enable SIP authentication for an existing SIP device, you must also specify the SIP user's name, domain name and password in the SIP user name, SIP domain name, New SIP password and Confirm new SIP password fields. Either ask for the user's preferred password, or specify a new password and provide it to the user for future use.
SIP user name Change The user name of the SIP device. This field must be specified if SIP authentication required is True or if Use DN for identification is False. Set this field to the user part of the SIP URI, not including the prefix or domain name. This is a string of 1 - 32 characters, which must not match any other SIP user name with the same domain name; the first character must be a letter (either uppercase or lowercase). Changing this value while there are any active calls may cause those call to be dropped. If you change this field and SIP authentication required is True, you must fill in the New SIP password and Confirm new SIP password fields.
SIP domain name Change The SIP domain name of the SIP device. This field must be specified if SIP authentication required is True. Set this field to match the domain name configured on the SIP device; typically this is a DNS hostname that resolves to the MetaSwitch NE's virtual IP address, or the IP address of a Session Border Controller through which the device accesses the NE. Changing this value while there are any active calls may cause those call to be dropped. If you change this field and SIP authentication required is True, you must fill in the New SIP password and Confirm new SIP password fields.
New SIP password Change The password that the SIP device uses for authentication. If you change SIP authentication required to True, or if you change the SIP user name or domain name, you must fill in this field. 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. Changing this value while there are any active calls may cause those call to be dropped. If you use the Refresh pushbutton to refresh the object's status, any characters you have typed will be discarded without changing the password.
Confirm new SIP password Change If you change SIP authentication required to True, or if you change the SIP user name or domain name, you must fill in this field. To confirm that you have typed the new password correctly, type it again in this field. The characters you type must exactly match the characters you typed in the New SIP password field. Changing this value while there are any active calls may cause those call to be dropped. If you use the Refresh pushbutton to refresh the object's status, any characters you have typed will be discarded without changing the password.
Contact IP address Change Inactive The IP address that the NE uses to contact this device. Specify a standard dotted-decimal IPv4 address. If the Configured SIP Binding will be used by an Application Server or a SIP Trunk, the combination of Contact IP address and Contact IP port must not match those used for any other Configured SIP Binding. If it will be used by a SIP PBX, there is no restriction, because the MetaSwitch NE will determine the correct PBX based on the calling number and the PBX's setting for calling number screening.
Contact IP port Change Inactive The IP port number (0 - 65535) that the NE uses to contact this device.
Proxy IP address Change Inactive If the MetaSwitch NE communicates with the SIP device through a proxy (such as a Session Border Controller), this field specifies the IP address of the proxy. Specify a standard dotted-decimal IPv4 address.
Proxy IP port Change Inactive If the MetaSwitch NE communicates with the SIP device through a proxy (such as a Session Border Controller), this field specifies the IP port number (0 - 65535) used to communicate with the proxy.
Transport protocol Change The transport protocol used to send SIP requests to the device. Values:
  • UDP
  • TCP
Changing this value while there are any active calls may cause those call to be dropped.
Media Gateway model Change The Remote Media Gateway model used by the SIP device. Click on the ellipsis symbol at the end of the field to select from all SIP Remote Media Gateway Models. If you change the model while this binding is enabled, note that your changes may affect service to subscribers using the binding. 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.
Trusted Change Specifies whether the NE should send the calling directory number (DN) to the SIP device if the caller withholds it. Values:
  • True
    The withheld calling DN is transmitted in the 'P-Asserted-Identity', and a 'Privacy' header is also included.
  • False
    The withheld calling DN is not transmitted.
Use static NAT mapping Change Specifies whether the NE should perform Network Address Translation on the contents of messages sent to this SIP device. Values:
  • True
    Select this value if the device 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 device 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.
Changing this value while there are any active calls may cause those call to be dropped.
Maximum call appearances Change The maximum number of simultaneous call branches in which the SIP device can participate. The default is 1024. If the Configured SIP Binding is used by one or more PBX Lines (which must be on different PBXs), this value controls the total maximum call appearances across all these lines; the lower of the two values applies. If there are active calls on this SIP device and you decrease this value below the number of active calls, those calls will not be dropped. However, new calls will not be possible until the number of current call appearances drops below this value.
Maximum concurrent high bandwidth call appearances allowed Change The maximum number of simultaneous high bandwidth call branches in which the SIP device can participate. This value must not exceed Maximum call appearances. A value of zero (the default) indicates that the number of streams is limited only by Maximum call appearances. Changing this value changes the maximum IP bandwidth that may be taken up by calls associated with this device. If there are active calls on this SIP device and you decrease this value below the current bandwidth usage, those calls will not be dropped. However, new calls will not be possible until the bandwidth usage drops below this value.
Poll peer device Change Specifies whether the MetaSwitch NE should poll the peer device at intervals (specified by the Polling interval field) to check network connectivity. Values:
  • True
  • False
Polling interval Change The interval between poll messages sent to the peer device. This field appears, and a value must be specified, only if Poll peer device is set to True. Range: 1 - 3600 seconds (1 second - 1 hour).
Current number of call appearances in use Read only Current number of call appearances in use on this Configured SIP Binding.
Current number of high bandwidth call appearances in use Read only Current number of high bandwidth call appearances in use on this Configured SIP Binding.
Suppress redirection information Change This field appears only if Usage is set to Trunk. Specifies whether redirection information provided on this trunk should be included when the call is forwarded. Values:
  • True
  • False (default)
Force validation of redirection number Change This field appears only if Usage is set to Trunk. Specifies whether a call which is redirected should pass through Number Validation again, using the new number. Values:
  • True
  • False (default)
Deactivation mode Change Specifies how to deactivate this object. Values:
  • Normal (default)
    End all calls using this Configured SIP Binding before deactivating the object.
  • Quiesce
    Deactivating the Configured SIP Binding in quiesce mode will wait for all calls using it to finish before deactivation. No new calls can use this Configured SIP Binding 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.)
If a Normal or Quiesce deactivation is already in progress, you can force a faster deactivation by changing the value from Normal to Quiesce or from Quiesce to Abort.
SIP protocol options - SIP type Change This field appears only if Usage is set to Trunk. Specifies whether the trunk supports Basic SIP or SIP-T. The remaining SIP protocol options fields, which control the contents of an ISUP IAM encapsulated within the SIP INVITE, appear only if this field is set to SIP-T. Values:
  • Basic SIP (default)
  • SIP-T
You cannot change this field if there is an active SIP device using this Configured SIP Binding.
SIP protocol options - accept TNS parameter Change Specifies whether the Transit Network Selection parameter may be received on an encapsulated incoming IAM. Values:
  • True
  • False (default)
Last call failure - cause Read only The error cause for the most recent failure of a SIP call using this Configured SIP Binding. Possible values:
  • No failure
    No call failure has occurred since registration.
  • Call redirected
    The call could not be completed because the SIP device (or a proxy) reported that the subscriber has moved. This may be caused by a misconfiguration on the SIP device or elsewhere in the device's IP network.
  • SIP authorization failed
    The authorization data supplied by the SIP device was incorrect. There may be additional information in the error log identified by the Call failure log correlator field.
  • Subscriber Busy
    The SIP device was successfully contacted, but is not accepting calls at this time.
  • Invalid SIP address
    The SIP address specified for this device is not valid. This may be because the device's configuration has been changed in the EMS.
  • Invalid or missing SDP body
    The NE received a SIP request that contained an incorrect or missing description of the media requirements for the call. This may be caused by a misconfiguration on the SIP device.
  • Invalid ISUP body
    The NE received a SIP request that contained an incorrect encapsulated IAM. This may be caused by a misconfiguration on the SIP device.
  • Maximum call appearance limit reached
    The SIP device has reached its maximum number of simultaneous calls.
  • Maximum trunk call limit reached
    The NE has reached its maximum number of simultaneous SIP trunk calls.
  • SIP authorization error
    The authentication parameters did not match those supplied on the original challenge. This may be the result of a misconfigured or incompatible SIP device.
  • Media renegotiation failed
    The SIP device was unable to fulfil a request to renegotiate the media in the call. This may be caused by an incompatible SIP device, or by transient conditions on the IP network.
  • Subscriber not contactable
    The SIP device may be switched off or disconnected; there may be errors in the IP network to which the SIP device is connected; or the SIP device may be using an incorrect contact IP address. There may be additional information in the error log identified by the Call failure log correlator field.
  • Unspecified
    The call failed for a reason other than those above. See the log message identified by Last call failure - log correlator for additional information about the error.
Last call failure - timestamp Read only Timestamp at which the most recent call failure occurred.
Last call failure - log correlator Read only Identifier of the log message for the event that caused the last call failure.
Alarm state Read only Specifies whether any alarms are currently raised for the Configured SIP Binding. 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 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.
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 alarm count was last reset to zero.
Diagnostics - logging - 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 - 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 ^ \ $ * + ? | ( ) , . ' ' " [ ] { }.
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.
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 Configured SIP Binding. 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 Configured SIP Binding. 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.