Cleanup references to sipusers and sipfriends dynamic realtime families
[asterisk/asterisk.git] / configs / res_ldap.conf.sample
1 ;
2 ; Configuration file for res_config_ldap
3 ;
4
5 ; Realtime configuration
6 ; ----------------------
7 ; In order to use this module, you start 
8 ; in extconfig.conf with a configuration like this:
9 ;
10 ;       sippeers = ldap,"dc=myDomain,dc=myDomainExt",sip
11 ;       extensions = ldap,"dc=myDomain,dc=myDomainExt",extensions
12 ;       sip.conf = ldap,"dc=myDomain,dc=myDomainExt",config
13 ;
14 ; In the case of LDAP the last keyword in each line above specifies
15 ; a section in this file.
16
17 ; TLS support
18 ; -----------
19 ; Note that you can configure an ldaps: url here to get TLS support.
20 ; Detailed configuration of certificates and supported CAs is done in your 
21 ; ldap.conf file for OpenLDAP clients on your system.
22 ; This requires that you have OpenLDAP libraries compiled with TLS support
23
24 ; *********************************************************************************
25 ; NOTE: res_ldap.conf should be chmod 600 because it contains the plain-text LDAP
26 ;       password to an account with WRITE access to the asterisk configuration. 
27 ; *********************************************************************************
28
29 [_general]
30 ;
31 ; Specify one of either host and port OR url.  URL is preferred, as you can
32 ; use more options.
33 ;host=192.168.1.1                    ; LDAP host
34 ;port=389
35 ;url=ldap://ldap3.mydomain.com:3890
36 ;protocol=3                          ; Version of the LDAP protocol to use; default is 3.
37 ;basedn=dc=example,dc=tld            ; Base DN
38 ;user=cn=asterisk,dc=example,dc=tld  ; Bind DN
39 ;pass=MyPassword                     ; Bind password
40
41 ; Configuration Table
42 [config]
43 ;
44 ; additionalFilter - This specifies an additional set of criteria to be used
45 ; when querying the LDAP server.
46 ;
47 additionalFilter=(objectClass=AstConfig)
48 ;
49 ; Attributes mapping (asterisk variable name = ldap attribute name)
50 ; When Asterisk requests the variable by the name of the value on the left,
51 ; this module will look up the attribute listed on the right.
52 ;
53 filename = AstConfigFilename
54 category = AstConfigCategory
55 variable_name = AstConfigVariableName
56 variable_value = AstConfigVariableValue
57 cat_metric = AstConfigCategoryMetric
58 commented = AstConfigCommented
59
60 ;
61 ; Extensions Table
62 ;
63 [extensions]
64 context  =  AstExtensionContext
65 exten  =  AstExtensionExten
66 priority = AstExtensionPriority
67 app = AstExtensionApplication
68 appdata = AstExtensionApplicationData
69 additionalFilter=(objectClass=AstExtension)
70
71 ;
72 ; Sip Users Table
73 ;
74 [sip]
75 name = cn       ; We use the "cn" as the default value for name on the line above
76                 ; because objectClass=AsteriskSIPUser does not include a uid as an allowed field
77                 ; If your entry combines other objectClasses and uid is available, you may
78                 ; prefer to change the line to be name = uid, especially if your LDAP entries
79                 ; contain spaces in the cn field.
80                 ; You may also find it appropriate to use something completely different.
81                 ; This is possible by changing the line above to name = AstAccountName (or whatever you
82                 ; prefer).
83                 ;
84 amaflags = AstAccountAMAFlags
85 callgroup = AstAccountCallGroup
86 callerid = AstAccountCallerID
87 directmedia = AstAccountDirectMedia
88 context = AstAccountContext
89 dtmfmode = AstAccountDTMFMode
90 fromuser = AstAccountFromUser
91 fromdomain = AstAccountFromDomain
92 fullcontact = AstAccountFullContact
93 fullcontact = gecos
94 host = AstAccountHost
95 insecure = AstAccountInsecure
96 mailbox = AstAccountMailbox
97 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
98                                                 ; {md5} but it is not required.
99                                                 ; Generate the password via the md5sum command, e.g.
100                                                 ; echo "my_password" | md5sum
101 nat = AstAccountNAT
102 deny = AstAccountDeny
103 permit = AstAccountPermit
104 pickupgroup = AstAccountPickupGroup
105 port = AstAccountPort
106 qualify = AstAccountQualify
107 restrictcid = AstAccountRestrictCID
108 rtptimeout = AstAccountRTPTimeout
109 rtpholdtimeout = AstAccountRTPHoldTimeout
110 type = AstAccountType
111 disallow = AstAccountDisallowedCodec
112 allow = AstAccountAllowedCodec
113 MusicOnHold = AstAccountMusicOnHold
114 regseconds = AstAccountExpirationTimestamp
115 regcontext = AstAccountRegistrationContext
116 regexten = AstAccountRegistrationExten
117 CanCallForward = AstAccountCanCallForward
118 ipaddr = AstAccountIPAddress
119 defaultuser = AstAccountDefaultUser
120 regserver = AstAccountRegistrationServer
121 lastms = AstAccountLastQualifyMilliseconds
122 additionalFilter=(objectClass=AsteriskSIPUser)
123
124 ;
125 ; IAX Users Table
126 ;
127 [iax]
128 amaflags = AstAccountAMAFlags
129 callerid = AstAccountCallerID
130 context = AstAccountContext
131 fullcontact = AstAccountFullContact
132 fullcontact = gecos
133 host = AstAccountHost
134 mailbox = AstAccountMailbox
135 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
136                                                 ; {md5} but it is not required.
137                                                 ; Generate the password via the md5sum command, e.g.
138                                                 ; echo "my_password" | md5sum
139 deny = AstAccountDeny
140 permit = AstAccountPermit
141 port = AstAccountPort
142 qualify = AstAccountQualify
143 type = AstAccountType
144 disallow = AstAccountDisallowedCodec
145 allow = AstAccountAllowedCodec
146 regseconds = AstAccountExpirationTimestamp
147 regcontext = AstAccountRegistrationContext
148 regexten = AstAccountRegistrationExten
149 notransfer = AstAccountNoTransfer
150 lastms = AstAccountLastQualifyMilliseconds
151 additionalFilter=(objectClass=AstAccountIAX)
152
153 ;
154 ; A Test Family
155 ;
156 [testfamily]
157 MyUSERID = uid
158 additionalFilter=(objectClass=*)
159
160 [accounts]
161 amaflags = AstAccountAMAFlags
162 callgroup = AstAccountCallGroup
163 callerid = AstAccountCallerID
164 directmedia = AstAccountDirectMedia
165 context = AstAccountContext
166 dtmfmode = AstAccountDTMFMode
167 fromuser = AstAccountFromUser
168 fromdomain = AstAccountFromDomain
169 fullcontact = AstAccountFullContact
170 fullcontact = gecos
171 host = AstAccountHost
172 insecure = AstAccountInsecure
173 mailbox = AstAccountMailbox
174 md5secret = AstAccountRealmedPassword           ; Must be an MD5 hash. Field value can start with
175                                                 ; {md5} but it is not required.
176                                                 ; Generate the password via the md5sum command, e.g.
177                                                 ; echo "my_password" | md5sum
178 nat = AstAccountNAT
179 deny = AstAccountDeny
180 permit = AstAccountPermit
181 pickupgroup = AstAccountPickupGroup
182 port = AstAccountPort
183 qualify = AstAccountQualify
184 restrictcid = AstAccountRestrictCID
185 rtptimeout = AstAccountRTPTimeout
186 rtpholdtimeout = AstAccountRTPHoldTimeout
187 type = AstAccountType
188 disallow = AstAccountDisallowedCodec
189 allow = AstAccountAllowedCodec
190 MusicOnHold = AstAccountMusicOnHold
191 regseconds = AstAccountExpirationTimestamp
192 regcontext = AstAccountRegistrationContext
193 regexten = AstAccountRegistrationExten
194 CanCallForward = AstAccountCanCallForward
195 additionalFilter=(objectClass=AstAccount)
196