sip-config
The sip-config element is used to define the parameters for this protocol specific to the Oracle Communications Session Border Controllercommunicating with SIP.
Parameters
- state
- Enable or disable the SIP operations
- Default: enabled
- Values: enabled | disabled
- operation-mode
- Select the SIP operation mode
- Default: dialog
- Values:
- disabled—SIP operation disabled
- stateless—Stateless proxy forwarding. SIP requests are forwarded based on the Request-URI and local policy. No transaction, session or dialog state is maintained. No media state is maintained, and session descriptions in the SIP messages are not modified.
- transaction—Transaction stateful proxy mode. SIP requests are forwarded based on the Request-URI and local policy. The Oracle Communications Session Border Controller maintains transaction state in accordance with RFC 3261. No session or dialog state is maintained. No media state is maintained, and session descriptions in the SIP messages are not modified.
- session—Session stateful proxy mode. SIP requests are forwarded based on the Request-URI and local policy. The Oracle Communications Session Border Controller maintains transaction state in accordance with RFC 3261. The SD also maintains session state information. A Record-Route header is inserted in requests so that the Oracle Communications Session Border Controller will remain in the path. No media state is maintained, and session descriptions in the SIP messages are not modified.
- dialog—Dialog stateful B2BUA mode. The Oracle Communications Session Border Controller maintains full transaction, session, and dialog state. If media management is enabled, full media state is also maintained and the Oracle Communications Session Border Controller modifies session descriptions in SIP messages to cause the media to flow through the Oracle Communications Session Border Controller.
- dialog-transparency
- Enable or disable SIP dialog transparency service to prevent the
Oracle Communications Session Border Controller from generating a unique Call-ID and modifying dialog
tags
- Default: enabled
- Values: enabled | disabled
- home-realm-id
- Enter the identifier of the home realm. This is the network to which the Oracle Communications Session Border Controller’s SIP proxy (B2BUA) is logically connected. If configured, this field must correspond to a valid identifier field entry in a realm-config.
- egress-realm-id
- Enter the default egress realm identifier
- nat-mode
- Select the home realm NAT mode. This is used to indicate whether
the home realm is "public" or "private" address space for application of the
SIP-NAT function.
- Default: none
- Values:
- none—No SIP-NAT is necessary
- private—Indicates that the home realm is private address space, and all other external realms are public address space. Addresses in the home realm will be encoded in SIP URIs sent into the external realm. The addresses are decoded when the URIs enter the home realm.
- public—Indicates that the home realm is public address space. Addresses from external realms are encoded in SIP URIs as they enter the home realm. Addresses are decoded as they enter the external realm that the address originated in.
- registrar-domain
- Enter the domain name for identifying which requests for which Hosted NAT Traversal (HNT) or registration caching applies. The right-most portion of the "host" part of the Request-URI is matched against this value. An asterisk "*" is used to indicate any domain.
- registrar-host
- Enter the hostname or IP address of the SIP registrar for the HNT and registration caching function. An asterisk "*" is used when there are multiple SIP registrars and normal routing using the Request-URI or local policy is to be applied.
- registrar-port
- Enter the port number of the SIP registrar server
- Defaul:t 0
- Values: Min: 1024 / Max: 65535
- register-service-route
- Select the service-route usage for REGISTER requests.
- Default: always
- Values:
- never—Never use service-route for REGISTER
- always—Always user service-route for REGISTER
- removal—Use service-route for de-registration
- session—Use service-route when the UA has a session
- session+removal—Use service-route for de-registration and for when the UA has a session
- init-timer
- Enter the initial timeout value in milliseconds for a response to
an INVITE request, and it applies to any SIP request in UDP. In RFC 3261, this
value is also referred to as TIMER_T1.
- Default: 500
- Values: Min: 0 / Max: 999999999
- max-timer
- Enter the maximum retransmission timeout in milliseconds for SIP.
In RFC 3261, this value is also referred to as TIMER_T2.
- Default: 4000
- Values: Min: 0 / Max: 999999999
- trans-expire
- Enter the number of seconds used by the system to determine when
to time-out SIP transactions. This timer is equivalent to TIMER_B in RFC 3261,
and the same value is used for TIMER_D, TIMER_F, TIMER_H, and TIMER_J as set
out in the same RFC.
- Default: 32
- Values: Min: 0 / Max: 999999999
- initial-inv-trans-expire
-
Establishes a global, default transaction timeout value (expressed in seconds) used exclusively for initial INVITE transactions. The default value, 0, indicates that a dedicated INVITE Timer B is not enabled. Non-default integer values enable a dedicated Timer B and set the timer value.
- Default: 0
- Values: Min: 0 / Max: 999999999
- invite-expire
- Enter the TTL in seconds for a SIP client transaction after
receiving a provisional response. This timer is equivalent to TIMER_C in RFC
3261.
- Default:: 180
- Values: Min: 0 / Max: 999999999
- inactive-dynamic-conn
- Enter the time limit in seconds for inactive dynamic connections
- Default: 32
- Values Min: 1 / Max: 999999999
- enforcement-profile
- Enter the name of the enforcement profile (SIP allowed methods).
- red-sip-port
- Enter the port for sending or receiving SIP checkpoint messages.
Setting this to 0 disables SIP HA on the
Oracle Communications Session Border Controller.
- Default: 1988
- Values: Min: 1024 /
Max: 65535; 0
Note:
This parameter is not RTC supported.
- red-max-trans
- Enter the size of the SIP signaling transaction list in entries
stored in memory
- Default: 10000
- Values: Min: 0 /
Max: 999999999
Note:
This parameter is not RTC supported.
- red-sync-start-time
- Enter the time in milliseconds before the HA
Oracle Communications Session Border Controller begins SIP signaling state checkpointing. As long as
this HA
Oracle Communications Session Border Controller is healthy and active, it remains in a constant cycle
of (re)setting this field’s timer and checking to see if it has become standby.
- Default: 5000
- Values: Min: 0 /
Max: 999999999
Note:
This parameter is not RTC supported.
- red-sync-comp-time
- Enter the time in milliseconds the standby
Oracle Communications Session Border Controller waits before checkpointing with the active
Oracle Communications Session Border Controller to obtain the latest SIP signaling transaction
information once the initial checkpointing process is complete
- Default: 1000
- Values: Min: 0 /
Max: 999999999
Note:
This parameter is not RTC supported.
- add-reason-header
- Enable or disable adding the reason header for rfc 3326 support
- Default: disabled
- Values: enabled | disabled
- sip-message-len
- Set the size constraint in bytes on a SIP message
- Default: 4096
- Values: Min: 0 / Max: 65535
- enum-sag-match
- Enable or disable matching this SAG’s group name to hostname
portions of ENUM NAPTR or LRT replacement URIs.
- Default: disabled
- Values: enabled | disabled
- extra-method-stats
- Enable or disable the expansion SIP Method tracking feature.
- Default: disabled
- Values: enabled | disabled
- extra-enum-stats
- Enable or disable the ENUM extra statistics tracking feature.
- Default: disabled
- enabled | disabled
- mps-volte
- Enable or disable the MPS feature.
- Default: disabled
- enabled | disabled
- rph-feature
- Set the state of NSEP support for the global SIP configuration
- Default: disabled
- Values: enabled | disabled
- nsep-user-sessions-rate
- Set the CPS for call rates on a per user basis for NSEP. A value
of 0 disables the call admission control on a per user basis.
- Default: 50
- Values: 0-999999999
- nsep-sa-sessions-rate
- Enter maximum acceptable number of SIP INVITES (NSEP sessions)
per second to allow for SIP session agents. 0 means there is no limit.
- Default: 0
- Values Min: 0 / Max: 999999999
- registration-cache-limit
- Set the maximum number of SIP registrations that you want to keep
in the registration cache. A value of 0 means there is no limit on the
registration cache, therefore disabling this feature.
- Default: 0
- Values: Min: 0 / Max: 999999999
- register-use-to-for-lp
- Enable or disable the use of an ENUM query to return the SIP URI
of the Registrar for a SIP REGISTER message for routing purposes
- Default: disabled
- Values: enabled | disabled
- options
- Enter customer-specific features and/or parameters. This optional field allows for a comma separated list of “feature=<value>" or "feature" parameters for the sip-config element.
- refer-src-routing
- Enable or disable the use of the referring party’s source realm
lookup policy to route subsequent INVITEs after static or dynamic REFER
handling has been terminated. When disabled, the system derives the lookup from
the source realm of the calling party.
- Default: disabled
- Values: enabled | disabled
- add-ucid-header
- Enable or disable the using the UCID to correlate replicated SIP
message information when you use SRR.
- Default: disabled
- Values enabled | disabled
- proxy-sub-events
- Configured list of SIP event package names that you want the Oracle Communications Session Border Controller to proxy (rather than maintain state) to the destination. You can enter more than one value by enclosing multiple values in quotations marks
- allow-pani-for-trusted-only
-
Allow PANI header only for trusted domains
- Default: disabled
- Values enabled | disabled
- atcf-stn-sr
- Enter the value of the Session Transfer Interface, Single Radio (STN-SR).
- atcf-psi-dn
- Enter the value to use for the Public Service Identity Domain Name (PSI-DN).
- atcf-route-to-sccas
- When set to disabled (default), the handover update, an INVITE,
is routed to the IMS Core. When enabled, the INVITE is routed directly to the
SCCAS.
- disabled
- enabled | disabled
- eatf-stn-sr
- E-STN-SR allocated by EATF in INVITE handover message.
- pass-gruu-contact
- Enable or disable the sip-config to parse for GR URI parameter in
the contact header in non-registered endpoints' messages.
- Default: disabled
- Values enabled |disabled
- sag-lookup-on-redirect
- Enable/disable lookup of SAG name on a redirect
- Default: enabled
- Values enabled | disabled
- set-disconnect-time-on-bye
- Sets the disconnect time reflected in a RADIUS CDR to when the
Oracle Communications Session Border Controller receives a BYE message.
- Default: disabled
- Values: enabled | disabled
- msrp-delayed-bye-timer
- Enables the delayed transmission of SIP BYE requests, for active
MSRP sessions. This parameter specifies the maximum delay period allowed before
transmitting the delayed BYE request.
- Default 15
- Min: 1 / Max: 60
Note:
A value of 0 disables this parameter.
- transcoding-realm
-
Name of a configured realm designated as the separate realm for the public SIP interface, to be used only for communication with the T-SBC in pooled transcoding deployments.
- transcoding-agents
- IP address, IP address and port combination, session agent
hostname, or SAG name in this list if you want them to be used as transcoding
agents. You can make multiple entries in any combination of these values. For
example, you might list an IPv6 address and port, a session agent, and a SAG.
To make multiple entries in the list using in one command line, enclose the
entire list of value in parentheses ( ( ) ), separating each with a Space.
- To add a transcoding agent to an existing list, put a plus sign before the value you want to add, e.g. +154.124.2.8.
- To remove a transcoding agent from an existing list, put a minus sign before the value you want to remove, e.g. -154.124.2.8.
- create-dynamic-sa
-
To support the creation of dynamic session agents for remote S-CSCFs on in-coming service routes, change this parameter from disabled (default) to enabled.
- node-functionality
- a global value to insert into the Node-Functionality AVP when the
Oracle Communications Session Border Controller sends ACRs over the Rf interface to an appropriate
destination.
- Default: P-CSCF
- Values: P-CSCF | BGCF | IBCF | E-CSCF
- match-sip-instance
- Enables the use of the
+sip-instance-id when
matching incoming calls with the registration cache.
- Default: disabled
- Values: enabled | disabled
- sa-routes-stats
- This enables collecting session agent statistics for DNS-resolved
session agents.
- Default: disabled
- Values: enabled | disabled
- rx-sip-reason-mapping
- This enables the Rx Interface Reason Header Usage mapping
feature.
- Default: disabled
- Values: enabled | disabled
- add-ue-location-in-pani
- Set this to add UE Location string in PANI header when available.
- Default: disabled
- Values: enabled | disabled
- hold-emergency-calls-for-loc-info
- Timer to hold emergency calls until the system receives location
information from the PCRF.
- Default: 0
- Values: 0-4294969295
- npli-upon-register
- This adds the ability to capture Network Provided Location
Information during the Registration process .
- Default: disabled
- Values: enabled | disabled
- msg-hold-for-loc-info
- Maximum number of seconds that the system will hold MESSAGEs for
location information for the NPLI for Short Message feature.
- Default: 0; disabled
- Values: 1-30 seconds
- cache-loc-info-expire
- Maximum number of seconds after which the system will drop
network location information for the NPLI for Short Message feature, unless the
keep-cached-loc-info-after-timeout
parameter is enabled.
- Default: 32
- Values: 1-4294967295 seconds
- keep-cached-loc-info-after-timeout
- If this option is enabled, the location information will be left
in the cache and used in subsequent MESSAGEs after the
cache-loc-info-expire time expires.
- Default: disabled
- Values: enabled | disabled
- atcf-icsi-match
- ATCF ISCI matching rule for the ATCF ISCI Invite Matching
feature.
- Value: enter the ICS string you want to match.
Path
sip-config is an element under the session-router path. The full path from the topmost ACLI prompt is:
Note:
This is a single instance configuration element.