Configure Surrogate Agents

A surrogate agent is a SBC configuration object that corresponds to an IP-PBX. You configure surrogate agents so that the SBC can perform surrogate registration and routing calls to and from the IP-PBX.

Set the system to Super User mode.

Configure a surrogate agent for each IP-PBX proxy that you want the SBC to register.

Note:

To view all surrogate agent configuration parameters, enter a ? at the surrogate-agent prompt.

1. Access the surrogate-agent configuration element.

   ORACLE# configure terminal
   ORACLE(configure)# session-router
   ORACLE(session-router)# surrogate-agent
   ORACLE(surrogate-agent)# 

2. On the Add Surrogate Agent page, do the following:
   • Register host—Enter the registrar’s hostname to be used in the Request-URI of the REGISTER request. This name is also used as the host portion of the AoR To and From headers.
   • Register user—Enter the user portion of the AoR (Address of Record).
   • Description—Optional. Enter a description of this surrogate agent.
   • Realm ID—Enter the name of realm where the surrogate agent resides (where the IP-PBX proxy resides). There is no default.
   • State—Set the state of the surrogate agent to indicate whether the surrogate agent is used by the application. The default value is enabled.
   • Customer host—Optional. Enter the domain or IP address of the IP-PBX, which is used to determine whether it is different than the one used by the registrar.
   • Customer next hop—Enter the next hop to this surrogate agent:
     • session agent group: <session agent group name>
     • session agent: <hostname> or <IPV4>
   • Register contact host—Enter the hostname to be used in the Contact-URI sent in the REGISTER request. This should always point to the SBC. If specifying a IP address, use the egress interface’s address. If there is a SIP NAT on the registrar’s side, use the home address in the SIP NAT.
   • Register contact user—Enter the user part of the Contact-URI that the SBC generates.
   • Password—If you are configuring the auth-user parameter, you need to enter the password used when the registrar sends the 401 or 407 response to the REGISTER request.
   • Register expires—Enter the expires in seconds for the REGISTER requests. The default value is 600,000 (1 week). The valid range is 0-999999999.
   • Replace contact—This specifies whether the SBC needs to replace the Contact in the requests coming from the surrogate agent. If this is enabled, Contact will be replaced with the Contact-URI the SBC sent in the REGISTER request. The default value is disabled. The valid values are enabled and disabled.
   • Options—Optional. Enter non-standard options or features.
   • Route to registrar—This indicates whether requests coming from the surrogate agent should be routed to the registrar if they are not explicitly addressed to the SBC. The default value is enabled. The valid values are enabled and disabled.
   • AoR count—Enter the number of registrations to do on behalf of this IP-PBX. If you enter a value greater than 1, the SBC increments the register-user and the register-contact-user values by that number. For example, if this count is 3 and register-user is john then users for three different register messages will be john, john1, john2. It does the same for the register-contact-user values. The default value is 1. The valid range is 0-999999999.
   • Auth user—Enter the authentication user name you want to use for the surrogate agent. This name is used when the SBC receives a 401or 407 response to the REGISTER request and has to send the REGISTER request again with the Authorization or Proxy-Authorization header. The name you enter here is used in the Digest username parameter. If you do not enter a name, the SBC uses the value of the register-user parameter.
   • Max register attempts—Enter the total number of times to attempt registration until success. Range 1-10
   • Register retry time—Enter the time to wait after an unsuccessful registration before re-attempting. Range 30-3600
   • Count start—Enter the starting value for numbering when performing multiple registrations. Range 0-9999999999
   • Register mode—Select automatic (default) or triggered (upon trigger from PBX).
   • Triggered inactivity interval—Enter the maximum time with no traffic from the corresponding PBX. (Valid only with Triggered inactivity interval.) Range 5 -300
   • Triggered OoS response—503 (Default. Send 503 response for core network failure) or drop response (Do not respond to PBX or core network failure
   • Source IP Prefix—Contains a list of IP address/prefixes that specify the source addressing of endpoints the system can authenticate using this surrogate-agent. Valid entries include any number of IP addresses and IP address prefixes in the format <ip>/<subnet>. If you set multiple values, separate them with a space and enclose them with parenthesis (). Addressing can be IPv4, IPv6 or a combination of both. The default configuration is null (no entry).
   • Auth User Lookup—If you intend to authenticate register requests using a realm configuration, enter the name of the target Auth Attribute configuration in that realm. This name must match an Auth User Lookup name in the realm's Auth Attribute list. When configured, the SBC uses those credentials to authenticate challenged register requests.
   • Proxy Name—If you have configured the Registrar that validates this surrogate agent's register requests as a session agent, enter the name of that session agent here.
   • Un-register—Enable this parameter to cause the register requests from this surrogate agent to specify Expires:0 and to remove each of this surrogate agents entries from the registration cache.
3. Save and activate your configuration.