- User's Guide
- Agent Configuration
- Configure a Session Agent
Configure a Session Agent
You can enable and configure a variety of constraints that the Oracle Enterprise Communications Broker (OECB) applies to regulate session activity with the session agent.
Configure the following before you configure a session agent.
- Media profile
- Out Translation ID
- Local Response Maps
- Codec Policy
- Session Recording Server
- TLS profile
- SIP header manipulation IDs
- LDAP
- One or more target groups
The following procedure lists all of the possible parameters that you can set on a session agent. The parameters that the OECB allows you to set depends on your deployment configuration, the licenses that you own, whether or not you configured the prerequisite that a particular parameter requires, and whether or not you enabled a requisite function. Within those guidelines, you can choose which parameters that you want to set for your deployment.
- On the
Agents
page, do the following:
Hostname Enter the name of the host associated with the agent in host name, FQDN, or IP address format. This field is required and the name cannot include blank spaces. The value entered here must be unique to this agent because no two agents can use the same host name. - If you enter the host name as an IP address, you do not have to enter an IP address in the optional IP address parameter.
- If you enter the host name in FQDN format, and you want to specify an IP address, enter it in the optional IP address parameter.
IP address (Optional) Enter the IP address for the host name that you entered in FQDN format if you want to specify the IP address. Otherwise, you can leave this parameter blank to allow a DNS query to resolve the host name. Port Enter the number of the port associated with this agent. - 0. If you enter zero, the OECB cannot initiate communication with this agent (although it will accept calls).
- 1025-65535.
- The default value is 5060.
If the transport method value is TCP, the OECB will initiate communication on the TCP port of the agent.
State Select State to enable this agent. RURI with Hostname - Select to resolve all outgoing requests to the Session Agent to the Session Agent name in the RURI.
- Deselect to resolve all outgoing requests to the Session Agent to the Session Agent IP address in the RURI.
Transport method Select the transport protocol for communicating with this agent. Valid values: - UDP - Default
- UDP+TCP
- Dynamic TCP
- Static TCP
- Dynamic TLS
- Static TLS
- DTLS
- TLS+DTLS
- Static SCTP
TLS profile Select a TLS profile from the drop-down list. Realm ID Enter the name of the realm in which this agent resides. Description Enter descriptive text to identify this agent. Source context Select the dialing context the OECB uses when receiving a call from this agent. Egress URI mode Select the method you want for sending the outbound call from this agent. Default: no-conversion. Valid values: - no-conversion—The OECB adds only the IP address of the Home Agent in the outbound call.
- convert-to-aor—When the incoming URI is a number, the OECB replaces it with the configured address of record in the outbound call.
- convert-to-number—When the incoming URI is an Address of Record, the OECB replaces it with the configured number in the outbound call.
Egress number translation mode Select a number translation code from the drop-down list. Default: E164. Valid values: - E164—Example: +14445551234
- E164 no plus—Example: 14445551234
- no country code—Example: 4445551234
- pattern only—Use only the portion matching the dial pattern. Example: 1234
- n digit dialing—Use the specified number of digits. Example: 5551234
Number of digits for n digit dialog Specify the number of digits to use for translation mode (n-digit dialing). Default: 4. Range: 0-25. Prepend prefix on egress Specify the characters to prepend to the outbound number after translation. Valid values: Telephony characters 0-9, start, hash sign, and A-D. Maximum: 25 characters. Outbound translate from number Select to apply outbound translation to the FROM number in addition to the request-URI. Default: Disabled. Stop recurse Enter one or more response codes that you want to cause this session agent to stop route recursion. Default: 401,407. Valid range: 300-599. You can enter individual response codes separated by a comma, such as 301,305 or a range such as 300-380. Constraints Select to enable the use of constraints on this agent. Max sessions Enter the maximum number of sessions allowed for this constraint. Default: 0. Range: 0-999999999. Max inbound sessions Enter the maximum number of inbound sessions allowed from this session agent. Default: 0. Range: 0-999999999. Max outbound sessions Enter the maximum number of outbound sessions allowed for this constraint. Default: 0. Range: 0-999999999. Max burst rate Enter the maximum number of invites allowed in a burst time period. Default: 0. Range: 0-999999999. Max inbound burst rate Enter the maximum inbound burst rate in INVITEs per second from this session agent. Default: 0. Range: 0-999999999. Max outbound burst rate Enter the maximum outbound burst rate in INVITEs per second from this session agent. Default: 0. Range: 0-999999999. Max sustain rate Enter the number of sustained INVITEs per second. Default: 0. Range: 0-999999999. Max inbound sustain rate Enter the maximum inbound sustain rate of session invitations allowed within the current time period for this constraint. Default: 0. Range: 0-999999999. Max outbound sustain rate Enter the maximum outbound sustain rate of session invitations allowed within the current time period for this constraint. Default: 0. Range: 0-999999999. Session max life limit Enter the maximum time you want a session to stay active. Default: 0, which means disabled. Range: 0-2073600 Time to resume Set the delay, in seconds, after which the SIP proxy resumes sending session invitations to this session agent. Default: 0. Range: 0-999999999. In service period Set the amount of time, in seconds, that the session agent must be operational after communication is re-established before it is declared as being in service. Default: 0. Range: 0-999999999. Burst rate window Set the window period, in seconds, that the system uses to measure the burst rate. Default: 0. Range: 0-999999999. Sustain rate window Set the sustained window period, in seconds, that the system uses to measure the sustained rate. This value must be greater than the one set for "maximum sustain rate". Default: 0. Range: 0-999999999. Ping interval (SIP only) Set the time, in seconds, for how often to ping the session agent. Range: 0-4294967295. Default: 0. SPL options You can add features or parameters here. For example:
- feature=<value feature>
You can include the original address in the SIP message from the ECB to the proxy in the Via header parameter by entering the following option:
via-origin=<parameter-name>
The original parameter is included in the Via of the requests sent to the session agent. The via origin feature can take a value that is the parameter name to include in the Via. If the value is not specified for via origin, the parameter name is origin.
Note:
If the feature value is a comma separated list, enclose it in quotation marks.Apply outbound manipulation on Specify when to apply outbound header manipulation. Default: next-hop-only. Valid values: last-hop-only, next-and-last-hop. In manipulation ID Enter the name of the SIP header manipulation configuration that you want to apply to the traffic entering the OECB through this session agent. No default. Out manipulation ID Enter the name of the SIP header manipulation configuration that you want to apply to the traffic exiting the OECB through this session agent. No default. Early media inhibit Select to inhibit early media. Default: disabled. Valid values: Disabled, enabled. Enable options ping Select to enable the use of OPTIONS pings to determine the status of this agent. LDAP Select the name of the ldap-group or ldap-config-group that you want this agent to use. Additional target group Select an additional target group from the drop-down list. Fork group Enter the number for the fork group number, which determines this session agent's priority in a target list. The lower the number, the higher the priority. Default: 1. Refer call transfer Select to enable the REFER method for call transfer. Default: disabled. Valid values: Disabled, enabled. Refer notify provisional Select when to send a NOTIFY for REFER provisional responses. - None—The system sends no intermediate NOTIFY message.
- Initial—The system sends an intermediate 100 Trying NOTIFY message.
- All—The system sends an intermediate 100 Trying NOTIFY message, plus a NOTIFY for each non-100 provisional received by the OECB.
Monitoring filters Click Add to add one or more monitoring filters. - Click OK.
- Save the configuration.