pbx_dundi: Update sample config documentation.
[asterisk/asterisk.git] / configs / samples / dundi.conf.sample
1 ;
2 ; DUNDi configuration file
3 ;
4 ; For more information about DUNDi, see http://www.dundi.com
5 ;
6 ;
7 [general]
8 ;
9 ; The "general" section contains general parameters relating
10 ; to the operation of the dundi client and server.
11 ;
12 ; The first part should be your complete contact information
13 ; should someone else in your peer group need to contact you.
14 ;
15 ;department=Your Department
16 ;organization=Your Company, Inc.
17 ;locality=Your City
18 ;stateprov=ST
19 ;country=US
20 ;email=your@email.com
21 ;phone=+12565551212
22 ;
23 ;
24 ; Specify bind address and port number.  Default is
25 ; 4520
26 ;
27 ;bindaddr=0.0.0.0
28 ;port=4520
29 ;
30 ; See https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service for a description of the tos parameter.
31 ;tos=ef
32 ;
33 ; Our entity identifier.  (It should generally be the MAC address of the
34 ; machine it's running on.  Defaults to the first eth address, but you
35 ; can override it here, as long as you set it to the MAC of *something*
36 ; you own!)  The EID can be overridden by a setting in asterisk.conf
37 ; or by setting this option.
38 ;
39 ;entityid=00:07:E9:3B:76:60
40 ;
41 ; Peers shall cache our query responses for the specified time
42 ; in seconds. Default is 3600.
43 ;
44 ;cachetime=3600
45 ;
46 ; This defines the max depth (hops) in which to search the DUNDi system.
47 ; Note that the maximum time that we will wait for a response is
48 ; (2000 + 200 * ttl) ms.
49 ;
50 ttl=32
51 ;
52 ; If we don't get ACK to our DPDISCOVER within 2000ms and autokill is set
53 ; to yes then we cancel the whole thing (that's enough time for one
54 ; retransmission only).  This is used to keep things from stalling for a long
55 ; time for a host that is not available, but would be ill advised for bad
56 ; connections.  In addition to 'yes' or 'no' you can also specify a number
57 ; of milliseconds.  See 'qualify' for individual peers to turn on for just
58 ; a specific peer.
59 ;
60 autokill=yes
61 ;
62 ; pbx_dundi creates a rotating key called "secret", under the family
63 ; 'secretpath'.  The default family is dundi (resulting in
64 ; the key being held at dundi/secret).
65 ;
66 ;secretpath=dundi
67 ;
68 ; The 'storehistory' option (also changeable at runtime with
69 ; 'dundi store history on' and 'dundi store history off') will
70 ; cause the DUNDi engine to keep track of the last several
71 ; queries and the amount of time each query took to execute
72 ; for the purpose of tracking slow nodes.  This option is
73 ; off by default due to performance impacts.
74 ;
75 ;storehistory=yes
76
77 [mappings]
78 ;
79 ; The "mappings" section maps DUNDi contexts
80 ; to contexts on the local asterisk system.  Remember
81 ; that numbers that are made available under the e164
82 ; DUNDi context are regulated by the DUNDi General Peering
83 ; Agreement (GPA) if you are a member of the DUNDi E.164
84 ; Peering System.
85 ;
86 ; dundi_context => [local_context,weight,tech,dest{,options}]
87 ;
88 ; 'dundi_context' is the name of the context being requested
89 ; within the DUNDi request
90 ;
91 ; 'local_context' is the name of the context on the local system
92 ; in which numbers can be looked up for which responses shall be given.
93 ;
94 ; 'weight' is the weight to use for the responses provided from this
95 ; mapping.  The number must be >= 0 and < 60000.  Since it is totally
96 ; valid to receive multiple responses to a query, responses received
97 ; with a lower weight are tried first.  Note that the weight has a
98 ; special meaning in the e164 context - see the GPA for more details.
99 ;
100 ; 'tech' is the technology to use (IAX2, SIP, H323)
101 ;
102 ; 'dest' is the Dial application's channel technology resource destination
103 ; to supply for reaching that number.  The following variables can be used
104 ; in the destination string and will be automatically substituted:
105 ; ${NUMBER}: The number being requested
106 ; ${IPADDR}: The IP address to connect to
107 ; ${SECRET}: The current IAX2 rotating secret key to be used
108 ;
109 ; Further options may include:
110 ;
111 ; nounsolicited:  No unsolicited calls of any type permitted via this
112 ;                 route
113 ; nocomunsolicit: No commercial unsolicited calls permitted via
114 ;                 this route
115 ; residential:    This number is known to be a residence
116 ; commercial:     This number is known to be a business
117 ; mobile:         This number is known to be a mobile phone
118 ; nocomunsolicit: No commercial unsolicited calls permitted via
119 ;                 this route
120 ; nopartial:      Do not search for partial matches
121 ;
122 ; There *must* exist an entry in mappings for DUNDi to respond
123 ; to any request, although it may be empty.
124 ;
125 ;empty_context =>
126 ;
127 ;e164 => dundi-e164-canonical,0,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
128 ;e164 => dundi-e164-customers,100,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
129 ;e164 => dundi-e164-via-pstn,400,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
130 ;
131 ;digexten => default,0,IAX2,guest@lappy/${NUMBER}
132
133 ;
134 ; Weights for mappings can be set a few different ways:
135 ;
136 ; 1) It can be set as a static number.
137 ;testmap1 => context1,222,IAX2,guest@peer1/${NUMBER}
138 ;
139 ; 2) It can be an Asterisk global variable.
140 ;testmap2 => context2,${DUNDITESTVAR},IAX2,guest@peer2${NUMBER}
141 ;
142 ; 3) It can be retrieved using a dialplan function.  This can be extremely
143 ;    useful if you want to let an external script decide what the weight
144 ;    in a response should be.
145 ;testmap3 => context3,${SHELL(echo 123)},IAX2,guest@peer3/${NUMBER}
146 ;
147 ; The built in variables ${SECRET}, ${IPADDR} and ${NUMBER} can also be
148 ; passed to the weight. For example, you could pass the ${NUMBER} value
149 ; to your SHELL() script and use that to dynamically return a weight.
150 ;
151 ; Note when using a global variable or dialplan function to set the
152 ; weight for a mapping that response caching should be disabled if you
153 ; plan for these values to change frequently at all.  If the results are
154 ; cached then any change in value will not take effect until the cache
155 ; has expired.
156 ;
157
158 ;
159 ; The remaining sections represent the peers that we fundamentally trust.
160 ; The section name specifies the peer's entityid.  You can specify which
161 ; DUNDi contexts with which you want the trust to be established.
162 ;
163 ; inkey - What key they will be authenticating to us with
164 ;
165 ; outkey - What key we use to authenticate to them
166 ;
167 ; host - What their host is (DNS name, IP address, or dynamic)
168 ;
169 ; port - The port where their host is listening (default: 4520)
170 ;
171 ; ustothem - Explicitly specify the entityid we use with this peer.
172 ;
173 ; order - What search order to use.  May be 'primary', 'secondary',
174 ;         'tertiary' or 'quartiary'.  In large systems, it is beneficial
175 ;         to only query one up-stream host in order to maximize caching
176 ;         value.  Adding one with primary and one with secondary gives you
177 ;         redundancy without sacrificing performance.
178 ;
179 ; include - Includes this peer when searching a particular context
180 ;           for lookup (set "all" to perform all lookups with that
181 ;           host.  This is also the context in which peers are permitted
182 ;           to precache.
183 ;
184 ; noinclude - Disincludes this peer when searching a particular context
185 ;             for lookup (set "all" to perform no lookups with that
186 ;             host.
187 ;
188 ; permit - Permits this peer to search a given DUNDi context on
189 ;          the local system.  Set "all" to permit this host to
190 ;          lookup all contexts.  This is also a context for which
191 ;          we will create/forward PRECACHE commands.
192 ;
193 ; deny -   Denies this peer to search a given DUNDi context on
194 ;          the local system.  Set "all" to deny this host to
195 ;          lookup all contexts.
196 ;
197 ; model - inbound, outbound, or symmetric for whether we receive
198 ;         requests only, transmit requests only, or do both.
199 ;
200 ; precache - Utilize/Permit precaching with this peer (to pre
201 ;            cache means to provide an answer when no request
202 ;            was made and is used so that machines with few
203 ;            routes can push those routes up to a higher level).
204 ;            outgoing means we send precache routes to this peer,
205 ;            incoming means we permit this peer to send us
206 ;            precache routes.  symmetric means we do both.
207 ;
208 ; Note: You cannot mix symmetric/outbound model with symmetric/inbound
209 ; precache, nor can you mix symmetric/inbound model with symmetric/outbound
210 ; precache.
211 ;
212 ; qualify - Enable qualifying the peer to determine reachable status.
213 ;           Set to yes, no, or number of milliseconds for qualifying
214 ;           the peer's reachable status.
215 ;
216 ; register - Enable registering with the peer.  This presupposes that the
217 ;            peer's host option for us is dynamic.  (yes/no value)
218 ;
219 ; The '*' peer is special and matches an unspecified entity
220 ;
221
222 ;
223 ; Sample Primary e164 DUNDi peer
224 ;
225 ;[00:50:8B:F3:75:BB]
226 ;model = symmetric
227 ;host = 64.215.96.114
228 ;inkey = digium
229 ;outkey = misery
230 ;include = e164
231 ;permit = e164
232 ;qualify = yes
233
234 ;
235 ; Sample Secondary e164 DUNDi peer
236 ;
237 ;[00:A0:C9:96:92:84]
238 ;model = symmetric
239 ;host = misery.digium.com
240 ;inkey = misery
241 ;outkey = ourkey
242 ;include = e164
243 ;permit = e164
244 ;qualify = yes
245 ;order = secondary
246
247 ;
248 ; Sample "push mode" downstream host
249 ;
250 ;[00:0C:76:96:75:28]
251 ;model = inbound
252 ;host = dynamic
253 ;precache = inbound
254 ;inkey = littleguy
255 ;outkey = ourkey
256 ;include = e164 ; In this case used only for precaching
257 ;permit = e164
258 ;qualify = yes
259
260 ;
261 ; Sample "push mode" upstream host
262 ;
263 ;[00:07:E9:3B:76:60]
264 ;model = outbound
265 ;precache = outbound
266 ;host = 216.207.245.34
267 ;register = yes
268 ;inkey = dhcp34
269 ;permit = all ; In this case used only for precaching
270 ;include = all
271 ;qualify = yes
272 ;outkey=foo
273
274 ;[*]
275 ;