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.
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 Inactive | Specifies the type of SIP device that uses this binding. Values:
|
Use DN for identification | Change Inactive | Specifies whether the SIP device is identified in outgoing SIP INVITE requests by its SIP user name or its directory number. Values:
|
SIP authentication required | Change Inactive | Specifies whether this SIP device uses SIP authentication (and must supply authentication parameters in SIP signaling messages). Values:
|
SIP user name | Change Inactive | 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). 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 Inactive | 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. 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 Inactive | 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. 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 Inactive | 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. 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. |
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 Inactive | The transport protocol used to send SIP requests to the device. Values:
|
Media Gateway model | Change Inactive | 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. |
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 locally). Select from the displayed list of available Location objects or None (no location). The value defaults to None. |
Trusted | Change Inactive | Specifies whether the NE should send the calling directory number (DN) to the SIP device if the caller withholds it. Values:
|
Use static NAT mapping | Change Inactive | Specifies whether the NE should perform Network Address Translation on the contents of messages sent to this SIP device. Values:
|
Maximum call appearances | Change Inactive | The maximum number of simultaneous call branches in which the SIP device can participate. The default is 1024. |
Maximum concurrent high bandwidth call appearances allowed | Change Inactive | 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. |
Poll peer device | Change Inactive | Specifies whether the MetaSwitch NE should poll the peer device at intervals (specified by the Polling interval field) to check network connectivity. Values:
|
Polling interval | Change Inactive | 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. |
Deactivation mode | Change | Specifies how to deactivate this object. Values:
|
SIP protocol options - SIP type | Change Inactive | 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:
|
SIP protocol options - disallow signaling for LRN | Change | Specifies whether the LRN or ported number is signaled in an IAM to the peer exchange for calls to ported numbers.
Normally, for a call to a ported number after LNP lookup, the called address parameter contains the LRN of the recipient exchange and the generic address (ported number) parameter contains the called address. However, if this option is set to True, the generic address parameter is removed and the called address parameter is changed to be the actual called address rather than the LRN. The signaled IAM in this case is identical to the case where the NP lookup had not been done on this exchange but, importantly, it will still have been routed on the LRN rather than on the actual called address. Values:
|
SIP protocol options - use ISUP called address prefix information | Change | Specifies whether the NE supports called address prefixes (NXZZ codes) for calls on this trunk. These prefixes may be required in Canada if this trunk supports long-distance locally-originated calls or tandem calls, but are not required for deployments elsewhere. Values:
|
SIP protocol options - active hop counting | Change | Specifies whether the hop count is added to an encapsulated outgoing message. Values:
|
SIP protocol options - accept TNS parameter | Change | Specifies whether the Transit Network Selection parameter may be received on an encapsulated incoming IAM. Values:
|
SIP protocol options - USI parameter coding type | Change | Specifies the coding of the USI parameter on an encapsulated outgoing IAM for voice calls at the originating or interworking exchange. Values:
|
SIP protocol options - include charge number and outgoing line information | Change | Specifies whether the Charge Number and the Outgoing Line Information parameters are allowed as a pair in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include jurisdiction information parameter | Change | Specifies whether the Jurisdiction Information parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include redirecting number parameter | Change | Specifies whether the Redirecting Number parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include redirection information parameter | Change | Specifies whether the Redirection Information parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include original called number parameter | Change | Specifies whether the Original Called Number parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include access transport parameter | Change | Specifies whether the Access Transport parameter is allowed in any encapsulated outgoing message. Values:
|
SIP protocol options - include generic address parameter | Change | Specifies whether the Generic Address parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include generic name parameter | Change | Specifies whether the Generic Name parameter (containing the calling name) is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include party information parameter | Change | Specifies whether the Party Information parameter (containing the calling name) is allowed in an encapsulated outgoing IAM. This parameter is typically used only in Canada. Values:
|
SIP protocol options - include redirect capability parameter | Change | Specifies whether the Redirect Capability Parameter is allowed in an encapsulated outgoing IAM. Values:
|
SIP protocol options - include CIP parameter | Change | Specifies whether the CIP parameter is allowed in an encapsulated outgoing IAM. Values:
|
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:
|
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:
|
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:
|
Diagnostics - API trace - enabled | Change | Specifies whether API tracing is enabled for this object. Values:
|
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. |
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. |
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:
|
Actual status | Read only | Specifies the current status of the Configured SIP Binding. Values:
|