surrogate-agent
The surrogate-agent configuration element allows you to configure the Oracle Communications Session Border Controller for surrogate registration. This feature lets the Oracle Communications Session Border Controller explicitly register on behalf of Internet Protocol Branch Exchange (IP-PBX).
Parameters
- register-host
- Enter the registrar’s hostname to be used in the Request-URI of the REGISTER request
- register-user
- Enter the user portion of the Address of Record
- state
- Enable or disable this surrogate agent
- Default: enabled
- Values: enabled | disabled
- realm-id
- Enter the name of the realm where the surrogate agent resides
- description
- Describe the surrogate agent. This parameter is optional.
- customer-host
- 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. This parameter is optional.
- customer-next-hop
- Enter the next hop to this surrogate agent
Note:
Even though the customer-next-hop field allows specification of a SAG or FQDN, the functionality will only support these values if they resolve to a single IP address. Multiple IP addresses, via SAG, NAPTR, SRV, or DNS record lookup, are not allowed. - register-contact-host
- Enter the hostname to be used in the Contact-URI sent in the REGISTER request. This should always point to the Oracle Communications Session Border Controller. 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 Oracle Communications Session Border Controller generates
- password
- Enter the password to be used for this agent
- register-expires
- Enter the expire time in seconds to be used in the REGISTER
- Default: 600,000 (1 week)
- Values: Min: 0 / Max: 999999999
- replace-contact
- Specify whether the
Oracle Communications Session Border Controller needs to replace the Contact in the requests coming from the surrogate agent
- Default: disabled
- Values: enabled | disabled
- route-to-registrar
- Enable or disable requests coming from the surrogate agent being routed to the registrar if they are not explicitly addressed to the
Oracle Communications Session Border Controller
- Default: enabled
- Values: enabled | disabled
- aor-count
- Enter the number of registrations to do on behalf of this IP-PBX
- Default: 1
- Values: Min: 0 / Max: 999999999
- auth-user
- Enter the authentication user name you want to use for the surrogate agent
- max-register-attempt
- Enter the number of times to attempt registration; a 0 value means registration attempts are unlimited
- Default: 3
- Values: Min: 0 / Max: 10
- register-retry-time
- Enter the amount of time in seconds to wait before reattempting registration
- Default: 300
- Values: Min: 10 / Max: 3600
- count-start
- Enter the number of registrations to do on behalf of this IP-PBX
- Default: 1
- Values: Min: 0 / Max: 999999999
- options
- Enter non-standard options or features
Path
surrogate-agent is an element under the session-router path. The full path from the topmost ACLI prompt is: