res_pjsip_outbound_registration: SIP resource for outbound registrations¶
This configuration documentation is for functionality provided by res_pjsip_outbound_registration.
Overview¶
Outbound Registration
This module allows 'res_pjsip' to register to other SIP servers.
Configuration File: pjsip.conf¶
[registration]: The configuration for outbound registration¶
Since¶
12.0.0
Registration is COMPLETELY separate from the rest of 'pjsip.conf'. A minimal configuration consists of setting a 'server_uri'and a 'client_uri'.
Configuration Option Reference¶
| Option Name | Type | Default Value | Regular Expression | Description | Since |
|---|---|---|---|---|---|
| auth_rejection_permanent | Boolean | yes | false | Determines whether failed authentication challenges are treated as permanent failures. | 12.0.0 |
| client_uri | String | false | Client SIP URI used when attemping outbound registration | 12.0.0 | |
| contact_header_params | String | false | Header parameters to place in the Contact header | 17.0.0 | |
| contact_user | String | false | Contact User to use in request. If this value is not set, this defaults to 's' | 12.0.0 | |
| endpoint | String | false | Endpoint to use for incoming related calls | 13.4.0 | |
| expiration | Unsigned Integer | 3600 | false | Expiration time for registrations in seconds | 12.0.0 |
| fatal_retry_interval | Unsigned Integer | 0 | false | Interval used when receiving a Fatal response. | 13.7.0 |
| forbidden_retry_interval | Unsigned Integer | 0 | false | Interval used when receiving a 403 Forbidden response. | 11.7.0 |
| line | Boolean | no | false | Whether to add a 'line' parameter to the Contact for inbound call matching | 13.4.0 |
| max_random_initial_delay | Unsigned Integer | 10 | false | Maximum interval in seconds for which an initial registration may be randomly delayed | 16.27.0, 18.13.0, 19.5.0 |
| max_retries | Unsigned Integer | 10 | false | Maximum number of registration attempts. | 12.0.0 |
| outbound_auth | Custom | false | Authentication object(s) to be used for outbound registrations. | 12.2.0 | |
| outbound_proxy | String | false | Full SIP URI of the outbound proxy used to send registrations | 12.0.0 | |
| retry_interval | Unsigned Integer | 60 | false | Interval in seconds between retries if outbound registration is unsuccessful | 12.0.0 |
| security_mechanisms | Custom | false | List of security mechanisms supported. | 21.0.0 | |
| security_negotiation | Custom | no | false | The kind of security agreement negotiation to use. Currently, only mediasec is supported. | 21.0.0 |
| server_uri | String | false | SIP URI of the server to register against | 12.0.0 | |
| support_outbound | Boolean | no | false | Enables advertising SIP Outbound support (RFC5626) for outbound REGISTER requests. | 17.0.0 |
| support_path | Boolean | no | false | Enables advertising SIP Path support for outbound REGISTER requests. | 12.1.0 |
| transport | String | false | Transport used for outbound authentication | 12.0.0 | |
| type | None | false | Must be of type 'registration'. | 12.0.0 |
Configuration Option Descriptions¶
auth_rejection_permanent¶
Since: 12.0.0
If this option is enabled and an authentication challenge fails, registration will not be attempted again until the configuration is reloaded.
client_uri¶
Since: 12.0.0
This is the address-of-record for the outbound registration (i.e. the URI in the To header of the REGISTER).
For registration with an ITSP, the client SIP URI may need to consist of an account name or number and the provider's hostname for their registrar, e.g. client_uri=1234567890@example.com. This may differ between providers.
For registration to generic registrars, the client SIP URI will depend on networking specifics and configuration of the registrar.
endpoint¶
Since: 13.4.0
When line support is enabled this configured endpoint name is used for incoming calls that are related to the outbound registration.
fatal_retry_interval¶
Since: 13.7.0
If a fatal response is received, chan_pjsip will wait fatal_retry_interval seconds before attempting registration again. If 0 is specified, chan_pjsip will not retry after receiving a fatal (non-temporary 4xx, 5xx, 6xx) response. Setting this to a non-zero value may go against a "SHOULD NOT" in RFC3261, but can be used to work around buggy registrars.
Note
if also set the forbidden_retry_interval takes precedence over this one when a 403 is received. Also, if auth_rejection_permanent equals 'yes' then a 401 and 407 become subject to this retry interval.
forbidden_retry_interval¶
Since: 11.7.0
If a 403 Forbidden is received, chan_pjsip will wait forbidden_retry_interval seconds before attempting registration again. If 0 is specified, chan_pjsip will not retry after receiving a 403 Forbidden response. Setting this to a non-zero value goes against a "SHOULD NOT" in RFC3261, but can be used to work around buggy registrars.
line¶
Since: 13.4.0
When enabled this option will cause a 'line' parameter to be added to the Contact header placed into the outgoing registration request. If the remote server sends a call this line parameter will be used to establish a relationship to the outbound registration, ultimately causing the configured endpoint to be used.
max_random_initial_delay¶
Since: 16.27.0, 18.13.0, 19.5.0
By default, registrations are randomly delayed by a small amount to prevent too many registrations from being made simultaneously.
Depending on your system usage, it may be desirable to set this to a smaller or larger value to have fine grained control over the size of this random delay.
max_retries¶
Since: 12.0.0
This sets the maximum number of registration attempts that are made before stopping any further attempts. If set to 0 then upon failure no further attempts are made.
outbound_auth¶
Since: 12.2.0
This is a comma-delimited list of auth sections defined in pjsip.conf used to respond to outbound authentication challenges.
Note
Using the same auth section for inbound and outbound authentication is not recommended. There is a difference in meaning for an empty realm setting between inbound and outbound authentication uses. See the auth realm description for details.
security_mechanisms¶
Since: 21.0.0
This is a comma-delimited list of security mechanisms to use. Each security mechanism must be in the form defined by RFC 3329 section 2.2.
security_negotiation¶
Since: 21.0.0
-
no -
mediasec
server_uri¶
Since: 12.0.0
This is the URI at which to find the registrar to send the outbound REGISTER. This URI is used as the request URI of the outbound REGISTER request from Asterisk.
For registration with an ITSP, the setting may often be just the domain of the registrar, e.g. sip:sip.example.com.
support_path¶
Since: 12.1.0
When this option is enabled, outbound REGISTER requests will advertise support for Path headers so that intervening proxies can add to the Path header as necessary.
transport¶
Since: 12.0.0
Note
A transport configured in 'pjsip.conf'. As with other 'res_pjsip' modules, this will use the first available transport of the appropriate type if unconfigured.
Generated Version¶
This documentation was generated from Asterisk branch 20 using version GIT