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