1default.conf(5) IPA Manual Pages default.conf(5)
2
6 default.conf - IPA configuration file
7
9 /etc/ipa/default.conf, ~/.ipa/default.conf, /etc/ipa/server.conf,
10 /etc/ipa/cli.conf
11
13 The default.conf configuration file is used to set system-wide defaults
14 to be applied when running IPA clients and servers.
15 Users may create an optional configuration file in ~/.ipa/default.conf
17 which will be merged into the system-wide defaults file.
18 The following files are read, in order:
20 ~/.ipa/default.conf
21 /etc/ipa/<context>.conf
22 /etc/ipa/default.conf
23 built-in constants
24 The IPA server does not read ~/.ipa/default.conf.
26 The first setting wins.
28
30 The configuration options are not case sensitive. The values may be
31 case sensitive, depending on the option.
32 Blank lines are ignored. Lines beginning with # are comments and are
34 ignored.
35 Valid lines consist of an option name, an equals sign and a value. Spa‐
37 ces surrounding equals sign are ignored. An option terminates at the
38 end of a line.
39 Values should not be quoted, the quotes will not be stripped.
41 # Wrong - don't include quotes
43 verbose = "True"
44 # Right - Properly formatted options
46 verbose = True
47 verbose=True
48 Options must appear in the section named [global]. There are no other
50 sections defined or used currently.
51 Options may be defined that are not used by IPA. Be careful of mis‐
53 spellings, they will not be rejected.
54
56 The following options are relevant for the server:
57 basedn <base>
59 Specifies the base DN to use when performing LDAP operations.
60 The base must be in DN format (dc=example,dc=com).
61 ca_agent_port <port>
63 Specifies the secure CA agent port. The default is 8443.
64 ca_host <hostname>
66 Specifies the hostname of the dogtag CA server. The default is
67 the hostname of the IPA server.
68 ca_port <port>
70 Specifies the insecure CA end user port. The default is 8080.
71 certmonger_wait_timeout <seconds>
73 The time to wait for a certmonger request to complete during in‐
74 stallation. The default value is 300 seconds.
75 context <context>
77 Specifies the context that IPA is being executed in. IPA may op‐
78 erate differently depending on the context. The current defined
79 contexts are cli and server. Additionally this value is used to
80 load /etc/ipa/context.conf to provide context-specific configu‐
81 ration. For example, if you want to always perform client re‐
82 quests in verbose mode but do not want to have verbose enabled
83 on the server, add the verbose option to /etc/ipa/cli.conf.
84 debug <boolean>
86 When True provides detailed information. Specifically this set
87 the global log level to "debug". Default is False.
88 dogtag_version <version>
90 Stores the version of Dogtag. Value 9 is assumed if not speci‐
91 fied otherwise.
92 domain <domain>
94 The domain of the IPA server e.g. example.com.
95 enable_ra <boolean>
97 Specifies whether the CA is acting as an RA agent, such as when
98 dogtag is being used as the Certificate Authority. This setting
99 only applies to the IPA server configuration.
100 fallback <boolean>
102 Specifies whether an IPA client should attempt to fall back and
103 try other services if the first connection fails.
104 host <hostname>
106 Specifies the local system hostname.
107 http_timeout <seconds>
109 Timeout for HTTP blocking requests (e.g. connection). The de‐
110 fault value is 30 seconds.
111 in_server <boolean>
113 Specifies whether requests should be forwarded to an IPA server
114 or handled locally. This is used internally by IPA in a similar
115 way as context. The same IPA framework is used by the ipa com‐
116 mand-line tool and the server. This setting tells the framework
117 whether it should execute the command as if on the server or
118 forward it via XML-RPC to a remote server.
119 in_tree <boolean>
121 This is used in development and is generally a detected value.
122 It means that the code is being executed within a source tree.
123 interactive <boolean>
125 Specifies whether values should be prompted for or not. The de‐
126 fault is True.
127 kinit_lifetime <time duration spec>
129 Controls the lifetime of ticket obtained by users authenticating
130 to the WebGUI using login/password. The expected format is a
131 time duration string. Examples are "2 hours", "1h:30m", "10 min‐
132 utes", "5min, 30sec". When the parameter is not set in de‐
133 fault.conf, the ticket will have a duration inherited from the
134 default value for kerberos clients, that can be set as
135 ticket_lifetime in krb5.conf. When the ticket lifetime has ex‐
136 pired, the ticket is not valid anymore and the GUI will prompt
137 to re-login with a message "Your session has expired. Please re-
138 login."
139 ldap_cache <boolean>
141 Enable a per-request LDAP cache. The default is True.
142 ldap_cache_size <integer>
144 The maximum number of entries cached if ldap_cache is True.
145 Since this cache is per-request it is not expected to be very
146 large. The default is 100. Setting the value < 1 effectively
147 disables the cache regardless of the ldap_cache setting
148 ldap_uri <URI>
150 Specifies the URI of the IPA LDAP server to connect to. The URI
151 scheme may be one of ldap or ldapi. The default is to use ldapi,
152 e.g. ldapi://%2fvar%2frun%2fslapd-EXAMPLE-COM.socket
153 log_logger_XXX <comma separated list of regexps>
155 loggers matching regexp will be assigned XXX level.
156 Logger levels can be explicitly specified for specific loggers
158 as opposed to a global logging level. Specific loggers are indi‐
159 cated by a list of regular expressions bound to a level. If a
160 logger's name matches the regexp then it is assigned that level.
161 This config item must begin with "log_logger_level_" and then be
162 followed by a symbolic or numeric log level, for example:
163 log_logger_level_debug = ipalib\.dn\..*
165 log_logger_level_35 = ipalib\.plugins\.dogtag
167 The first line says any logger belonging to the ipalib.dn module
169 will have it's level configured to debug.
170 The second line say the ipa.plugins.dogtag logger will be con‐
172 figured to level 35.
173 This config item is useful when you only want to see the log
175 output from one or more selected loggers. Turning on the global
176 debug flag will produce an enormous amount of output. This al‐
177 lows you to leave the global debug flag off and selectively en‐
178 able output from a specific logger. Typically loggers are bound
179 to classes and plugins.
180 Note: logger names are a dot ('.') separated list forming a path
182 in the logger tree. The dot character is also a regular expres‐
183 sion metacharacter (matches any character) therefore you will
184 usually need to escape the dot in the logger names by preceding
185 it with a backslash.
186 mode <mode>
188 Specifies the mode the server is running in. The currently sup‐
189 port values are production and developer. When running in pro‐
190 duction mode some self-tests are skipped to improve performance.
191 mount_ipa <URI>
193 Specifies the mount point that the development server will reg‐
194 ister. The default is /ipa/
195 prompt_all <boolean>
197 Specifies that all options should be prompted for in the IPA
198 client, even optional values. Default is False.
199 ra_plugin <name>
201 Specifies the name of the CA back end to use. The current op‐
202 tions are dogtag and none. This is a server-side setting. Chang‐
203 ing this value is not recommended as the CA back end is only set
204 up during initial installation.
205 realm <realm>
207 Specifies the Kerberos realm.
208 replication_wait_timeout <seconds>
210 The time to wait for a new entry to be replicated during replica
211 installation. The default value is 300 seconds.
212 schema_ttl <seconds>
214 The number of seconds for the ipa tool to cache the IPA API and
215 help schema. Reducing this value during development is helpful
216 so that API changes are seen sooner in the tool. Setting this on
217 a server will define the TTL for all client versions > 4.3.1.
218 Client versions > 4.3.1 that connect to IPA servers older than
219 4.3.1 will use the client-side configuration value. The default
220 is 3600 seconds. 0 disables the cache. A change in the ttl will
221 not be immediately recognized by clients. They will use the new
222 value once their current cache expires.
223 server <hostname>
225 Specifies the IPA Server hostname.
226 skip_version_check <boolean>
228 Skip client vs. server API version checking. Can lead to er‐
229 rors/strange behavior when newer clients talk to older servers.
230 Use with caution.
231 startup_timeout <time in seconds>
233 Controls the amount of time waited when starting a service. The
234 default value is 120 seconds.
235 startup_traceback <boolean>
237 If the IPA server fails to start and this value is True the
238 server will attempt to generate a python traceback to make iden‐
239 tifying the underlying problem easier.
240 validate_api <boolean>
242 Used internally in the IPA source package to verify that the API
243 has not changed. This is used to prevent regressions. If it is
244 true then some errors are ignored so enough of the IPA framework
245 can be loaded to verify all of the API, even if optional compo‐
246 nents are not installed. The default is False.
247 verbose <boolean>
249 When True provides more information. Specifically this sets the
250 global log level to "info".
251 wait_for_dns <number of attempts>
253 Controls whether the IPA commands dnsrecord-{add,mod,del} work
254 synchronously or not. The DNS commands will repeat DNS queries
255 up to the specified number of attempts until the DNS server re‐
256 turns an up-to-date answer to a query for modified records. De‐
257 lay between retries is one second.
258 The DNS commands will raise a DNSDataMismatch exception if the
260 answer doesn't match the expected value even after the specified
261 number of attempts.
262 The DNS queries will be sent to the resolver configured in
264 /etc/resolv.conf on the IPA server.
265 Do not enable this in production! This will cause problems if
267 the resolver on IPA server uses a caching server instead of a
268 local authoritative server or e.g. if DNS answers are modified
269 by DNS64. The default is disabled (the option is not present).
270 xmlrpc_uri <URI>
272 Specifies the URI of the XML-RPC server for a client. This may
273 be used by IPA, and is used by some external tools, such as
274 ipa-getcert. Example: https://ipa.example.com/ipa/xml
275 jsonrpc_uri <URI>
277 Specifies the URI of the JSON server for a client. This is used
278 by IPA. If not given, it is derived from xmlrpc_uri. Example:
279 https://ipa.example.com/ipa/json
280 rpc_protocol <URI>
282 Specifies the type of RPC calls IPA makes: 'jsonrpc' or 'xml‐
283 rpc'. Defaults to 'jsonrpc'.
284 The following define the containers for the IPA server. Containers de‐
286 fine where in the DIT that objects can be found. The full location is
287 the value of container + basedn.
288 container_accounts: cn=accounts
289 container_applications: cn=applications,cn=configs,cn=policies
290 container_automount: cn=automount
291 container_configs: cn=configs,cn=policies
292 container_dns: cn=dns
293 container_group: cn=groups,cn=accounts
294 container_hbac: cn=hbac
295 container_hbacservice: cn=hbacservices,cn=hbac
296 container_hbacservicegroup: cn=hbacservicegroups,cn=hbac
297 container_host: cn=computers,cn=accounts
298 container_hostgroup: cn=hostgroups,cn=accounts
299 container_netgroup: cn=ng,cn=alt
300 container_permission: cn=permissions,cn=pbac
301 container_policies: cn=policies
302 container_policygroups: cn=policygroups,cn=configs,cn=policies
303 container_policylinks: cn=policylinks,cn=configs,cn=policies
304 container_privilege: cn=privileges,cn=pbac
305 container_rolegroup: cn=roles,cn=accounts
306 container_roles: cn=roles,cn=policies
307 container_service: cn=services,cn=accounts
308 container_sudocmd: cn=sudocmds,cn=sudo
309 container_sudocmdgroup: cn=sudocmdgroups,cn=sudo
310 container_sudorule: cn=sudorules,cn=sudo
311 container_user: cn=users,cn=accounts
312 container_vault: cn=vaults,cn=kra
313 container_virtual: cn=virtual operations,cn=etc
314
317 /etc/ipa/default.conf
318 system-wide IPA configuration file
319 $HOME/.ipa/default.conf
321 user IPA configuration file
322 It is also possible to define context-specific configuration files. The
324 context is set when the IPA api is initialized. The two currently de‐
325 fined contexts in IPA are cli and server. This is helpful, for example,
326 if you only want debug enabled on the server and not in the client. If
327 this is set to True in default.conf it will affect both the ipa client
328 tool and the IPA server. If it is only set in server.conf then only the
329 server will have debug set. These files will be loaded if they exist:
330 /etc/ipa/cli.conf
332 system-wide IPA client configuration file
333 /etc/ipa/server.conf
335 system-wide IPA server configuration file
336
338 ipa(1)
339IPA Feb 21 2011 default.conf(5)