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
74 installation. The default value is 300 seconds.
75 context <context>
77 Specifies the context that IPA is being executed in. IPA may
78 operate differently depending on the context. The current
79 defined contexts are cli and server. Additionally this value is
80 used to load /etc/ipa/context.conf to provide context-specific
81 configuration. For example, if you want to always perform client
82 requests 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
110 default 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
126 default 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
133 default.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
136 expired, 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_uri <URI>
141 Specifies the URI of the IPA LDAP server to connect to. The URI
142 scheme may be one of ldap or ldapi. The default is to use ldapi,
143 e.g. ldapi://%2fvar%2frun%2fslapd-EXAMPLE-COM.socket
144 log_logger_XXX <comma separated list of regexps>
146 loggers matching regexp will be assigned XXX level.
147 Logger levels can be explicitly specified for specific loggers
149 as opposed to a global logging level. Specific loggers are indi‐
150 cated by a list of regular expressions bound to a level. If a
151 logger's name matches the regexp then it is assigned that level.
152 This config item must begin with "log_logger_level_" and then be
153 followed by a symbolic or numeric log level, for example:
154 log_logger_level_debug = ipalib\.dn\..*
156 log_logger_level_35 = ipalib\.plugins\.dogtag
158 The first line says any logger belonging to the ipalib.dn module
160 will have it's level configured to debug.
161 The second line say the ipa.plugins.dogtag logger will be con‐
163 figured to level 35.
164 This config item is useful when you only want to see the log
166 output from one or more selected loggers. Turning on the global
167 debug flag will produce an enormous amount of output. This
168 allows you to leave the global debug flag off and selectively
169 enable output from a specific logger. Typically loggers are
170 bound to classes and plugins.
171 Note: logger names are a dot ('.') separated list forming a path
173 in the logger tree. The dot character is also a regular expres‐
174 sion metacharacter (matches any character) therefore you will
175 usually need to escape the dot in the logger names by preceding
176 it with a backslash.
177 mode <mode>
179 Specifies the mode the server is running in. The currently sup‐
180 port values are production and developer. When running in pro‐
181 duction mode some self-tests are skipped to improve performance.
182 mount_ipa <URI>
184 Specifies the mount point that the development server will reg‐
185 ister. The default is /ipa/
186 prompt_all <boolean>
188 Specifies that all options should be prompted for in the IPA
189 client, even optional values. Default is False.
190 ra_plugin <name>
192 Specifies the name of the CA back end to use. The current
193 options are dogtag and none. This is a server-side setting.
194 Changing this value is not recommended as the CA back end is
195 only set up during initial installation.
196 realm <realm>
198 Specifies the Kerberos realm.
199 replication_wait_timeout <seconds>
201 The time to wait for a new entry to be replicated during replica
202 installation. The default value is 300 seconds.
203 server <hostname>
205 Specifies the IPA Server hostname.
206 skip_version_check <boolean>
208 Skip client vs. server API version checking. Can lead to
209 errors/strange behavior when newer clients talk to older
210 servers. Use with caution.
211 startup_timeout <time in seconds>
213 Controls the amount of time waited when starting a service. The
214 default value is 120 seconds.
215 startup_traceback <boolean>
217 If the IPA server fails to start and this value is True the
218 server will attempt to generate a python traceback to make iden‐
219 tifying the underlying problem easier.
220 validate_api <boolean>
222 Used internally in the IPA source package to verify that the API
223 has not changed. This is used to prevent regressions. If it is
224 true then some errors are ignored so enough of the IPA framework
225 can be loaded to verify all of the API, even if optional compo‐
226 nents are not installed. The default is False.
227 verbose <boolean>
229 When True provides more information. Specifically this sets the
230 global log level to "info".
231 wait_for_dns <number of attempts>
233 Controls whether the IPA commands dnsrecord-{add,mod,del} work
234 synchronously or not. The DNS commands will repeat DNS queries
235 up to the specified number of attempts until the DNS server
236 returns an up-to-date answer to a query for modified records.
237 Delay between retries is one second.
238 The DNS commands will raise a DNSDataMismatch exception if the
240 answer doesn't match the expected value even after the specified
241 number of attempts.
242 The DNS queries will be sent to the resolver configured in
244 /etc/resolv.conf on the IPA server.
245 Do not enable this in production! This will cause problems if
247 the resolver on IPA server uses a caching server instead of a
248 local authoritative server or e.g. if DNS answers are modified
249 by DNS64. The default is disabled (the option is not present).
250 xmlrpc_uri <URI>
252 Specifies the URI of the XML-RPC server for a client. This may
253 be used by IPA, and is used by some external tools, such as
254 ipa-getcert. Example: https://ipa.example.com/ipa/xml
255 jsonrpc_uri <URI>
257 Specifies the URI of the JSON server for a client. This is used
258 by IPA. If not given, it is derived from xmlrpc_uri. Example:
259 https://ipa.example.com/ipa/json
260 rpc_protocol <URI>
262 Specifies the type of RPC calls IPA makes: 'jsonrpc' or 'xml‐
263 rpc'. Defaults to 'jsonrpc'.
264 The following define the containers for the IPA server. Containers
266 define where in the DIT that objects can be found. The full location is
267 the value of container + basedn.
268 container_accounts: cn=accounts
269 container_applications: cn=applications,cn=configs,cn=policies
270 container_automount: cn=automount
271 container_configs: cn=configs,cn=policies
272 container_dns: cn=dns
273 container_group: cn=groups,cn=accounts
274 container_hbac: cn=hbac
275 container_hbacservice: cn=hbacservices,cn=hbac
276 container_hbacservicegroup: cn=hbacservicegroups,cn=hbac
277 container_host: cn=computers,cn=accounts
278 container_hostgroup: cn=hostgroups,cn=accounts
279 container_netgroup: cn=ng,cn=alt
280 container_permission: cn=permissions,cn=pbac
281 container_policies: cn=policies
282 container_policygroups: cn=policygroups,cn=configs,cn=policies
283 container_policylinks: cn=policylinks,cn=configs,cn=policies
284 container_privilege: cn=privileges,cn=pbac
285 container_rolegroup: cn=roles,cn=accounts
286 container_roles: cn=roles,cn=policies
287 container_service: cn=services,cn=accounts
288 container_sudocmd: cn=sudocmds,cn=sudo
289 container_sudocmdgroup: cn=sudocmdgroups,cn=sudo
290 container_sudorule: cn=sudorules,cn=sudo
291 container_user: cn=users,cn=accounts
292 container_vault: cn=vaults,cn=kra
293 container_virtual: cn=virtual operations,cn=etc
294
297 /etc/ipa/default.conf
298 system-wide IPA configuration file
299 $HOME/.ipa/default.conf
301 user IPA configuration file
302 It is also possible to define context-specific configuration files. The
304 context is set when the IPA api is initialized. The two currently
305 defined contexts in IPA are cli and server. This is helpful, for exam‐
306 ple, if you only want debug enabled on the server and not in the
307 client. If this is set to True in default.conf it will affect both the
308 ipa client tool and the IPA server. If it is only set in server.conf
309 then only the server will have debug set. These files will be loaded if
310 they exist:
311 /etc/ipa/cli.conf
313 system-wide IPA client configuration file
314 /etc/ipa/server.conf
316 system-wide IPA server configuration file
317
319 ipa(1)
320IPA Feb 21 2011 default.conf(5)