clarify information on time waited for a response
[asterisk/asterisk.git] / configs / dundi.conf.sample
1 ;
2 ; DUNDi configuration file
3 ;
4 ;
5 [general]
6 ;
7 ; The "general" section contains general parameters relating
8 ; to the operation of the dundi client and server.
9 ;
10 ; The first part should be your complete contact information
11 ; should someone else in your peer group need to contact you.
12 ;
13 ;department=Your Department
14 ;organization=Your Company, Inc.
15 ;locality=Your City
16 ;stateprov=ST
17 ;country=US
18 ;email=your@email.com
19 ;phone=+12565551212
20 ;
21 ;
22 ; Specify bind address and port number.  Default is
23 ; 4520
24 ;
25 ;bindaddr=0.0.0.0
26 ;port=4520
27 ;
28 ; Our entity identifier (Should generally be the MAC address of the
29 ; machine it's running on.  Defaults to the first eth address, but you
30 ; can override it here, as long as you set it to the MAC of *something*
31 ; you own!)
32 ;
33 ;entityid=00:07:E9:3B:76:60
34 ;
35 ; This defines the max depth in which to search the DUNDi system.
36 ; Note that the maximum time that we will wait for a response is
37 ; (2000 + 200 * ttl) ms.
38 ;
39 ttl=32
40 ;
41 ; If we don't get ACK to our DPDISCOVER within 2000ms, and autokill is set
42 ; to yes, then we cancel the whole thing (that's enough time for one 
43 ; retransmission only).  This is used to keep things from stalling for a long
44 ; time for a host that is not available, but would be ill advised for bad 
45 ; connections.  In addition to 'yes' or 'no' you can also specify a number
46 ; of milliseconds.  See 'qualify' for individual peers to turn on for just
47 ; a specific peer.
48 ;
49 autokill=yes
50 ;
51 ; pbx_dundi creates a rotating key called "secret", under the family
52 ; 'secretpath'.  The default family is dundi (resulting in 
53 ; the key being held at dundi/secret).
54 ;
55 ;secretpath=dundi
56 ;
57 ; The 'storehistory' option (also changeable at runtime with
58 ; 'dundi store history' and 'dundi no store history') will
59 ; cause the DUNDi engine to keep track of the last several
60 ; queries and the amount of time each query took to execute
61 ; for the purpose of tracking slow nodes.  This option is
62 ; off by default due to performance impacts.
63 ;
64 ;storehistory=yes
65
66 [mappings]
67 ;
68 ; The "mappings" section maps DUNDi contexts
69 ; to contexts on the local asterisk system.  Remember
70 ; that numbers that are made available under the e164 
71 ; DUNDi context are regulated by the DUNDi General Peering 
72 ; Agreement (GPA) if you are a member of the DUNDi E.164
73 ; Peering System.
74 ;
75 ; dundi_context => local_context,weight,tech,dest[,options]]
76 ;
77 ; dundi_context is the name of the context being requested
78 ; within the DUNDi request
79 ;
80 ; local_context is the name of the context on the local system
81 ; in which numbers can be looked up for which responses shall be given.
82 ;
83 ; tech is the technology to use (IAX, SIP, H323)
84 ;
85 ; dest is the destination to supply for reaching that number.  The
86 ; following variables can be used in the destination string and will
87 ; be automatically substituted:
88 ; ${NUMBER}: The number being requested
89 ; ${IPADDR}: The IP address to connect to
90 ; ${SECRET}: The current rotating secret key to be used
91 ;
92 ; Further options may include:
93 ;
94 ; nounsolicited:  No unsolicited calls of any type permitted via this 
95 ;                 route
96 ; nocomunsolicit: No commercial unsolicited calls permitted via 
97 ;                 this route
98 ; residential:    This number is known to be a residence
99 ; commercial:     This number is known to be a business
100 ; mobile:         This number is known to be a mobile phone
101 ; nocomunsolicit: No commercial unsolicited calls permitted via 
102 ;                 this route
103 ; nopartial:      Do not search for partial matches
104 ;
105 ; There *must* exist an entry in mappings for DUNDi to respond
106 ; to any request, although it may be empty.
107 ;
108 ;e164 => dundi-e164-canonical,0,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
109 ;e164 => dundi-e164-customers,100,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
110 ;e164 => dundi-e164-via-pstn,400,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
111
112 ;digexten => default,0,IAX2,guest@lappy/${NUMBER}
113 ;asdf =>
114
115
116 ;
117 ;
118 ; The remaining sections represent the peers
119 ; that we fundamentally trust.  The section name
120 ; represents the name and optionally at a specific
121 ; DUNDi context if you want the trust to be established
122 ; for only a specific DUNDi context.
123 ;
124 ; inkey - What key they will be authenticating to us with
125 ;
126 ; outkey - What key we use to authenticate to them
127 ;
128 ; host - What their host is
129 ;
130 ; order - What search order to use.  May be 'primary', 'secondary', 
131 ;         'tertiary' or 'quartiary'.  In large systems, it is beneficial
132 ;         to only query one up-stream host in order to maximize caching
133 ;         value.  Adding one with primary and one with secondary gives you
134 ;         redundancy without sacraficing performance.
135 ;
136 ; include - Includes this peer when searching a particular context
137 ;           for lookup (set "all" to perform all lookups with that
138 ;           host.  This is also the context in which peers are permitted
139 ;           to precache.
140 ;
141 ; noinclude - Disincludes this peer when searching a particular context
142 ;             for lookup (set "all" to perform no lookups with that
143 ;             host.
144 ;
145 ; permit - Permits this peer to search a given DUNDi context on
146 ;          the local system.  Set "all" to permit this host to
147 ;          lookup all contexts.  This is also a context for which
148 ;          we will create/forward PRECACHE commands.
149 ;
150 ; deny -   Denies this peer to search a given DUNDi context on
151 ;          the local system.  Set "all" to deny this host to
152 ;          lookup all contexts.
153 ;
154 ; model - inbound, outbound, or symmetric for whether we receive 
155 ;         requests only, transmit requests only, or do both.
156 ;
157 ; precache - Utilize/Permit precaching with this peer (to pre
158 ;            cache means to provide an answer when no request
159 ;            was made and is used so that machines with few
160 ;            routes can push those routes up a to a higher level).
161 ;            outgoing means we send precache routes to this peer,
162 ;            incoming means we permit this peer to send us
163 ;            precache routes.  symmetric means we do both.
164 ;
165 ; Note: You cannot mix symmetric/outbound model with symmetric/inbound
166 ; precache, nor can you mix symmetric/inbound model with symmetric/outbound
167 ; precache.
168 ;
169 ;
170 ; The '*' peer is special and matches an unspecified entity
171 ;
172
173 ;
174 ; Sample Primary e164 DUNDi peer
175 ;
176 ;[00:50:8B:F3:75:BB]
177 ;model = symmetric
178 ;host = 64.215.96.114
179 ;inkey = digium
180 ;outkey = misery
181 ;include = e164
182 ;permit = e164
183 ;qualify = yes
184
185 ;
186 ; Sample Secondary e164 DUNDi peer
187 ;
188 ;[00:A0:C9:96:92:84]
189 ;model = symmetric
190 ;host = misery.digium.com
191 ;inkey = misery
192 ;outkey = ourkey
193 ;include = e164
194 ;permit = e164
195 ;qualify = yes
196 ;order = secondary
197
198 ;
199 ; Sample "push mode" downstream host
200 ;
201 ;[00:0C:76:96:75:28]
202 ;model = inbound
203 ;host = dynamic
204 ;precache = inbound
205 ;inkey = littleguy
206 ;outkey = ourkey
207 ;include = e164 ; In this case used only for precaching
208 ;permit = e164      
209 ;qualify = yes
210
211 ;
212 ; Sample "push mode" upstream host
213 ;
214 ;[00:07:E9:3B:76:60]
215 ;model = outbound
216 ;precache = outbound
217 ;host = 216.207.245.34
218 ;register = yes
219 ;inkey = dhcp34
220 ;permit = all ; In this case used only for precaching
221 ;include = all 
222 ;qualify = yes
223 ;outkey=foo
224
225 ;[*]
226 ;