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