<p>George Joseph <strong>merged</strong> this change.</p><p><a href="https://gerrit.asterisk.org/9938">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Benjamin Keith Ford: Looks good to me, but someone else must approve
Joshua Colp: Looks good to me, but someone else must approve
George Joseph: Looks good to me, approved; Approved for Submit
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">pbx_dundi: Update sample config documentation.<br><br>Change-Id: I33d0ad0611c2124ca3440f0f811fa0f45e4e2849<br>---<br>M configs/samples/dundi.conf.sample<br>1 file changed, 34 insertions(+), 27 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/configs/samples/dundi.conf.sample b/configs/samples/dundi.conf.sample</span><br><span>index 70f97d4..b97d3b2 100644</span><br><span>--- a/configs/samples/dundi.conf.sample</span><br><span>+++ b/configs/samples/dundi.conf.sample</span><br><span>@@ -30,27 +30,27 @@</span><br><span> ; See https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service for a description of the tos parameter.</span><br><span> ;tos=ef</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; Our entity identifier (Should generally be the MAC address of the</span><br><span style="color: hsl(120, 100%, 40%);">+; Our entity identifier. (It should generally be the MAC address of the</span><br><span> ; machine it's running on. Defaults to the first eth address, but you</span><br><span> ; can override it here, as long as you set it to the MAC of *something*</span><br><span style="color: hsl(0, 100%, 40%);">-; you own!) The EID can be overridden by a setting in asterisk.conf,</span><br><span style="color: hsl(120, 100%, 40%);">+; you own!) The EID can be overridden by a setting in asterisk.conf</span><br><span> ; or by setting this option.</span><br><span> ;</span><br><span> ;entityid=00:07:E9:3B:76:60</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; Peers shall cache our query responses for the specified time,</span><br><span style="color: hsl(0, 100%, 40%);">-; given in seconds. Default is 3600.</span><br><span style="color: hsl(120, 100%, 40%);">+; Peers shall cache our query responses for the specified time</span><br><span style="color: hsl(120, 100%, 40%);">+; in seconds. Default is 3600.</span><br><span> ;</span><br><span> ;cachetime=3600</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; This defines the max depth in which to search the DUNDi system.</span><br><span style="color: hsl(120, 100%, 40%);">+; This defines the max depth (hops) in which to search the DUNDi system.</span><br><span> ; Note that the maximum time that we will wait for a response is</span><br><span> ; (2000 + 200 * ttl) ms.</span><br><span> ;</span><br><span> ttl=32</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; If we don't get ACK to our DPDISCOVER within 2000ms, and autokill is set</span><br><span style="color: hsl(0, 100%, 40%);">-; to yes, then we cancel the whole thing (that's enough time for one</span><br><span style="color: hsl(120, 100%, 40%);">+; If we don't get ACK to our DPDISCOVER within 2000ms and autokill is set</span><br><span style="color: hsl(120, 100%, 40%);">+; to yes then we cancel the whole thing (that's enough time for one</span><br><span> ; retransmission only). This is used to keep things from stalling for a long</span><br><span> ; time for a host that is not available, but would be ill advised for bad</span><br><span> ; connections. In addition to 'yes' or 'no' you can also specify a number</span><br><span>@@ -66,7 +66,7 @@</span><br><span> ;secretpath=dundi</span><br><span> ;</span><br><span> ; The 'storehistory' option (also changeable at runtime with</span><br><span style="color: hsl(0, 100%, 40%);">-; 'dundi store history' and 'dundi no store history') will</span><br><span style="color: hsl(120, 100%, 40%);">+; 'dundi store history on' and 'dundi store history off') will</span><br><span> ; cause the DUNDi engine to keep track of the last several</span><br><span> ; queries and the amount of time each query took to execute</span><br><span> ; for the purpose of tracking slow nodes. This option is</span><br><span>@@ -83,7 +83,7 @@</span><br><span> ; Agreement (GPA) if you are a member of the DUNDi E.164</span><br><span> ; Peering System.</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; dundi_context => local_context,weight,tech,dest[,options]]</span><br><span style="color: hsl(120, 100%, 40%);">+; dundi_context => [local_context,weight,tech,dest{,options}]</span><br><span> ;</span><br><span> ; 'dundi_context' is the name of the context being requested</span><br><span> ; within the DUNDi request</span><br><span>@@ -97,14 +97,14 @@</span><br><span> ; with a lower weight are tried first. Note that the weight has a</span><br><span> ; special meaning in the e164 context - see the GPA for more details.</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; 'tech' is the technology to use (IAX, SIP, H323)</span><br><span style="color: hsl(120, 100%, 40%);">+; 'tech' is the technology to use (IAX2, SIP, H323)</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; 'dest' is the destination to supply for reaching that number. The</span><br><span style="color: hsl(0, 100%, 40%);">-; following variables can be used in the destination string and will</span><br><span style="color: hsl(0, 100%, 40%);">-; be automatically substituted:</span><br><span style="color: hsl(120, 100%, 40%);">+; 'dest' is the Dial application's channel technology resource destination</span><br><span style="color: hsl(120, 100%, 40%);">+; to supply for reaching that number. The following variables can be used</span><br><span style="color: hsl(120, 100%, 40%);">+; in the destination string and will be automatically substituted:</span><br><span> ; ${NUMBER}: The number being requested</span><br><span> ; ${IPADDR}: The IP address to connect to</span><br><span style="color: hsl(0, 100%, 40%);">-; ${SECRET}: The current rotating secret key to be used</span><br><span style="color: hsl(120, 100%, 40%);">+; ${SECRET}: The current IAX2 rotating secret key to be used</span><br><span> ;</span><br><span> ; Further options may include:</span><br><span> ;</span><br><span>@@ -122,12 +122,13 @@</span><br><span> ; There *must* exist an entry in mappings for DUNDi to respond</span><br><span> ; to any request, although it may be empty.</span><br><span> ;</span><br><span style="color: hsl(120, 100%, 40%);">+;empty_context =></span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span> ;e164 => dundi-e164-canonical,0,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial</span><br><span> ;e164 => dundi-e164-customers,100,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial</span><br><span> ;e164 => dundi-e164-via-pstn,400,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span> ;digexten => default,0,IAX2,guest@lappy/${NUMBER}</span><br><span style="color: hsl(0, 100%, 40%);">-;asdf =></span><br><span> </span><br><span> ;</span><br><span> ; Weights for mappings can be set a few different ways:</span><br><span>@@ -140,35 +141,35 @@</span><br><span> ;</span><br><span> ; 3) It can be retrieved using a dialplan function. This can be extremely</span><br><span> ; useful if you want to let an external script decide what the weight</span><br><span style="color: hsl(0, 100%, 40%);">-; in a response shouuld be.</span><br><span style="color: hsl(120, 100%, 40%);">+; in a response should be.</span><br><span> ;testmap3 => context3,${SHELL(echo 123)},IAX2,guest@peer3/${NUMBER}</span><br><span> ;</span><br><span> ; The built in variables ${SECRET}, ${IPADDR} and ${NUMBER} can also be</span><br><span> ; passed to the weight. For example, you could pass the ${NUMBER} value</span><br><span> ; to your SHELL() script and use that to dynamically return a weight.</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; Note than when using a global variable or dialplan function to set the</span><br><span style="color: hsl(0, 100%, 40%);">-; weight for a mapping, that response caching should be disabled if you</span><br><span style="color: hsl(120, 100%, 40%);">+; Note when using a global variable or dialplan function to set the</span><br><span style="color: hsl(120, 100%, 40%);">+; weight for a mapping that response caching should be disabled if you</span><br><span> ; plan for these values to change frequently at all. If the results are</span><br><span style="color: hsl(0, 100%, 40%);">-; cached, then any change in value will not take effect until the cache</span><br><span style="color: hsl(120, 100%, 40%);">+; cached then any change in value will not take effect until the cache</span><br><span> ; has expired.</span><br><span> ;</span><br><span> </span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; The remaining sections represent the peers</span><br><span style="color: hsl(0, 100%, 40%);">-; that we fundamentally trust. The section name</span><br><span style="color: hsl(0, 100%, 40%);">-; represents the name and optionally at a specific</span><br><span style="color: hsl(0, 100%, 40%);">-; DUNDi context if you want the trust to be established</span><br><span style="color: hsl(0, 100%, 40%);">-; for only a specific DUNDi context.</span><br><span style="color: hsl(120, 100%, 40%);">+; The remaining sections represent the peers that we fundamentally trust.</span><br><span style="color: hsl(120, 100%, 40%);">+; The section name specifies the peer's entityid. You can specify which</span><br><span style="color: hsl(120, 100%, 40%);">+; DUNDi contexts with which you want the trust to be established.</span><br><span> ;</span><br><span> ; inkey - What key they will be authenticating to us with</span><br><span> ;</span><br><span> ; outkey - What key we use to authenticate to them</span><br><span> ;</span><br><span style="color: hsl(0, 100%, 40%);">-; host - What their host is</span><br><span style="color: hsl(120, 100%, 40%);">+; host - What their host is (DNS name, IP address, or dynamic)</span><br><span> ;</span><br><span> ; port - The port where their host is listening (default: 4520)</span><br><span> ;</span><br><span style="color: hsl(120, 100%, 40%);">+; ustothem - Explicitly specify the entityid we use with this peer.</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span> ; order - What search order to use. May be 'primary', 'secondary',</span><br><span> ; 'tertiary' or 'quartiary'. In large systems, it is beneficial</span><br><span> ; to only query one up-stream host in order to maximize caching</span><br><span>@@ -199,7 +200,7 @@</span><br><span> ; precache - Utilize/Permit precaching with this peer (to pre</span><br><span> ; cache means to provide an answer when no request</span><br><span> ; was made and is used so that machines with few</span><br><span style="color: hsl(0, 100%, 40%);">-; routes can push those routes up a to a higher level).</span><br><span style="color: hsl(120, 100%, 40%);">+; routes can push those routes up to a higher level).</span><br><span> ; outgoing means we send precache routes to this peer,</span><br><span> ; incoming means we permit this peer to send us</span><br><span> ; precache routes. symmetric means we do both.</span><br><span>@@ -208,6 +209,12 @@</span><br><span> ; precache, nor can you mix symmetric/inbound model with symmetric/outbound</span><br><span> ; precache.</span><br><span> ;</span><br><span style="color: hsl(120, 100%, 40%);">+; qualify - Enable qualifying the peer to determine reachable status.</span><br><span style="color: hsl(120, 100%, 40%);">+; Set to yes, no, or number of milliseconds for qualifying</span><br><span style="color: hsl(120, 100%, 40%);">+; the peer's reachable status.</span><br><span style="color: hsl(120, 100%, 40%);">+;</span><br><span style="color: hsl(120, 100%, 40%);">+; register - Enable registering with the peer. This presupposes that the</span><br><span style="color: hsl(120, 100%, 40%);">+; peer's host option for us is dynamic. (yes/no value)</span><br><span> ;</span><br><span> ; The '*' peer is special and matches an unspecified entity</span><br><span> ;</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/9938">change 9938</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/9938"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: 16 </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I33d0ad0611c2124ca3440f0f811fa0f45e4e2849 </div>
<div style="display:none"> Gerrit-Change-Number: 9938 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: Richard Mudgett <rmudgett@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Benjamin Keith Ford <bford@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: George Joseph <gjoseph@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins2 </div>
<div style="display:none"> Gerrit-Reviewer: Joshua Colp <jcolp@digium.com> </div>
<div style="display:none"> Gerrit-Reviewer: Richard Mudgett <rmudgett@digium.com> </div>