The previous attempt at using a pipe to guarantee astcanary shutdown did not work.
[asterisk/asterisk.git] / configs / 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 qos.tex or Quality of Service section of asterisk.pdf for a description of the tos parameter.
31 ;tos=ef
32 ;
33 ; Our entity identifier (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 ; given in seconds. Default is 3600.
43 ;
44 ;cachetime=3600
45 ;
46 ; This defines the max depth 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' and 'dundi no store history') 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 (IAX, SIP, H323)
101 ;
102 ; 'dest' is the destination to supply for reaching that number.  The
103 ; following variables can be used in the destination string and will
104 ; be automatically substituted:
105 ; ${NUMBER}: The number being requested
106 ; ${IPADDR}: The IP address to connect to
107 ; ${SECRET}: The current 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 ;e164 => dundi-e164-canonical,0,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
126 ;e164 => dundi-e164-customers,100,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
127 ;e164 => dundi-e164-via-pstn,400,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
128
129 ;digexten => default,0,IAX2,guest@lappy/${NUMBER}
130 ;asdf =>
131
132 ;
133 ; Weights for mappings can be set a few different ways:
134 ;
135 ; 1) It can be set as a static number.
136 ;testmap1 => context1,222,IAX2,guest@peer1/${NUMBER}
137 ;
138 ; 2) It can be an Asterisk global variable.
139 ;testmap2 => context2,${DUNDITESTVAR},IAX2,guest@peer2${NUMBER}
140 ;
141 ; 3) It can be retrieved using a dialplan function.  This can be extremely
142 ;    useful if you want to let an external script decide what the weight
143 ;    in a response shouuld be.
144 ;testmap3 => context3,${SHELL(echo 123)},IAX2,guest@peer3/${NUMBER}
145 ;
146 ; Note than when using a global variable or dialplan function to set the
147 ; weight for a mapping, that response caching should be disabled if you
148 ; plan for these values to change frequently at all.  If the results are
149 ; cached, then any change in value will not take effect until the cache
150 ; has expired.
151 ;
152
153 ;
154 ; The remaining sections represent the peers
155 ; that we fundamentally trust.  The section name
156 ; represents the name and optionally at a specific
157 ; DUNDi context if you want the trust to be established
158 ; for only a specific DUNDi context.
159 ;
160 ; inkey - What key they will be authenticating to us with
161 ;
162 ; outkey - What key we use to authenticate to them
163 ;
164 ; host - What their host is
165 ;
166 ; order - What search order to use.  May be 'primary', 'secondary',
167 ;         'tertiary' or 'quartiary'.  In large systems, it is beneficial
168 ;         to only query one up-stream host in order to maximize caching
169 ;         value.  Adding one with primary and one with secondary gives you
170 ;         redundancy without sacrificing performance.
171 ;
172 ; include - Includes this peer when searching a particular context
173 ;           for lookup (set "all" to perform all lookups with that
174 ;           host.  This is also the context in which peers are permitted
175 ;           to precache.
176 ;
177 ; noinclude - Disincludes this peer when searching a particular context
178 ;             for lookup (set "all" to perform no lookups with that
179 ;             host.
180 ;
181 ; permit - Permits this peer to search a given DUNDi context on
182 ;          the local system.  Set "all" to permit this host to
183 ;          lookup all contexts.  This is also a context for which
184 ;          we will create/forward PRECACHE commands.
185 ;
186 ; deny -   Denies this peer to search a given DUNDi context on
187 ;          the local system.  Set "all" to deny this host to
188 ;          lookup all contexts.
189 ;
190 ; model - inbound, outbound, or symmetric for whether we receive
191 ;         requests only, transmit requests only, or do both.
192 ;
193 ; precache - Utilize/Permit precaching with this peer (to pre
194 ;            cache means to provide an answer when no request
195 ;            was made and is used so that machines with few
196 ;            routes can push those routes up a to a higher level).
197 ;            outgoing means we send precache routes to this peer,
198 ;            incoming means we permit this peer to send us
199 ;            precache routes.  symmetric means we do both.
200 ;
201 ; Note: You cannot mix symmetric/outbound model with symmetric/inbound
202 ; precache, nor can you mix symmetric/inbound model with symmetric/outbound
203 ; precache.
204 ;
205 ;
206 ; The '*' peer is special and matches an unspecified entity
207 ;
208
209 ;
210 ; Sample Primary e164 DUNDi peer
211 ;
212 ;[00:50:8B:F3:75:BB]
213 ;model = symmetric
214 ;host = 64.215.96.114
215 ;inkey = digium
216 ;outkey = misery
217 ;include = e164
218 ;permit = e164
219 ;qualify = yes
220
221 ;
222 ; Sample Secondary e164 DUNDi peer
223 ;
224 ;[00:A0:C9:96:92:84]
225 ;model = symmetric
226 ;host = misery.digium.com
227 ;inkey = misery
228 ;outkey = ourkey
229 ;include = e164
230 ;permit = e164
231 ;qualify = yes
232 ;order = secondary
233
234 ;
235 ; Sample "push mode" downstream host
236 ;
237 ;[00:0C:76:96:75:28]
238 ;model = inbound
239 ;host = dynamic
240 ;precache = inbound
241 ;inkey = littleguy
242 ;outkey = ourkey
243 ;include = e164 ; In this case used only for precaching
244 ;permit = e164
245 ;qualify = yes
246
247 ;
248 ; Sample "push mode" upstream host
249 ;
250 ;[00:07:E9:3B:76:60]
251 ;model = outbound
252 ;precache = outbound
253 ;host = 216.207.245.34
254 ;register = yes
255 ;inkey = dhcp34
256 ;permit = all ; In this case used only for precaching
257 ;include = all
258 ;qualify = yes
259 ;outkey=foo
260
261 ;[*]
262 ;