1. ACLI Reference Guide
  2. ACLI Configuration Elements N-Z
  3. surrogate-agent

surrogate-agent

The surrogate-agent configuration element allows you to configure the SBC for surrogate registration. This feature lets the SBC 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 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
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 SBC 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 SBC
  • 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: 30 / Max: 3600
count-start
Enter the number of registrations to do on behalf of this IP-PBX
  • Default: 1
  • Values: Min: 0 / Max: 999999999
register-mode
Enter the registration mode.
  • Default: automatic
  • Values:
    • automatic - Send automatically
    • triggered - Send upon trigger from Private Branch Exchange.
triggered-inactivity-interval
Enter the maximum time in seconds without any traffic from corresponding Private Branch Exchange. This is valid only if registered-mode is triggered.
  • Default: 30
  • Values: Min: 5 / Max: 300
triggered-oos-response
Specifies the response by the SBC to the Private Branch Exchange on detecting a failure.
  • Default: 503
  • Values:
    • 503 - Response for core network failure.
    • dropresponse - No response sent to Private Branch Exchange for core network failure.
source-ip-prefix
Can contain a list of IP address/prefixes that specify the source addressing of endpoints for which the system can authenticate calls 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.
  • Default: Empty
  • Values: List of entries
options
Enter non-standard options or features
un-register
Enable or disable whether the system generates register requests from this surrogate agent that specify Expires:0 and removes each of this surrogate agent's entries from the registration cache.
  • Default: Disabled
  • Enabled
auth-user-lookup
Enter the name of an auth-user-lookup in a realm's auth-attributes list so that the SBC uses those credentials to authenticate challenged register requests.
  • Default: Empty
  • string
proxy-name
Enter the name of the session agent you have configured as the Registrar that validates this surrogate agent's register requests for the purpose of routing to that session agent.
  • Default: Empty
  • string
un-register
Set the de-registration state
  • Default: disabled
  • Values: enabled | disabled
source-ip-prefix
Enter the list of IP address (with optional prefix) to validate the source IP. Multiple entries should be surrounded with parentheses. For example:
ORACLE(surrogate-agent)# source-ip-prefix (172.16.0.9 192.168.4.5/16)

Path

surrogate-agent is an element under the session-router path. The full path from the topmost ACLI prompt is: configure terminal , and then session-router , and then surrogate-agent.