1cimconfig(8) cimconfig(8)
2
6 cimconfig - get, set, unset, or list CIM Server configuration proper‐
7 ties
8
10 cimconfig -g name [ -c ] [ -d ] [ -p ]
11 cimconfig -s name=value [ -c ] [ -p ]
13 cimconfig -u name [ -c ] [ -p ]
15 cimconfig -l [ -c | -p ]
17 cimconfig -h
19 cimconfig --help
21 cimconfig --H name
23 cimconfig --version
25
28 The cimconfig command manages CIM Server configuration properties. The
29 operations are executed on the local host by submitting requests to the
30 CIM Server. An operation on a current configuration property takes
31 effect immediately, and an operation on a planned configuration prop‐
32 erty takes effect the next time the CIM Server is started with cim‐
33 server (8) . Modifications to a configuration property via cimconfig
34 remain in effect until changed via another cimconfig command. Configu‐
35 ration properties may also be modified temporarily via the cimserver
36 [1m(8) command, in which case, the modification of the configuration prop‐
37 erty remains in effect for that execution of the cimserver (8) command
38 only. A default value is associated with each configuration property.
39 Each configuration property is initially assigned its default value,
40 until modified by a cimconfig command or cimserver (8) command.
41 Dynamic configuration properties are those whose current values may be
42 set while the CIM server is running.
43 The following configuration properties are available:
45 authorizedUserGroups
47 Description: If set, the value is interpreted as a list of
49 comma-separated user groups whose members may issue CIM
50 requests. A user who is not a member of any of these groups is
51 restricted from issuing CIM requests, with the exception of
52 privileged users (superuser). If unset, any user may issue CIM
53 requests. Note: This configuration property operates in conjunc‐
54 tion with other CIM request authorization conditions rather than
55 overriding them.
56 Default Value: (None)
57 Dynamic: No
58 enableAssociationTraversal
60 Description: If True, the CIM Server will support the four asso‐
62 ciation traversal operators: Associators, AssociatorNames, Ref‐
63 erences, and ReferenceNames.
64 Default Value: True
65 Dynamic: No
66 enableAuditLog
68 Description: If True, audit log entries for certain types of CIM
70 Server activities will be written to the system log. Examples
71 of audited activities include a CIM Server configuration change,
72 a Provider registration change, an authentication attempt and a
73 modification to the CIM Schema or a CIM Instance. An audit log
74 entry describes the who, what, and when associated with an
75 audited activity.
76 Default Value: False
77 Dynamic: Yes
78 enableIndicationService
80 Description: If True, the CIM Server will support CIM Indica‐
82 tions.
83 Default Value: True
84 Dynamic: No
85 enableHttpConnection
87 Description: If True, allows connections to the CIM Server using
89 the HTTP protocol
90 Default Value: False
91 Dynamic: No
92 enableHttpsConnection
94 Description: If True, allows connections to the CIM Server using
96 the HTTPS protocol (HTTP using Secure Socket Layer encryption)
97 Default Value: True
98 Dynamic: No
99 enableNamespaceAuthorization
101 Description: If True, the CIM Server restricts access to names‐
103 paces based on configured user authorizations [user authoriza‐
104 tions may be configured using cimauth (8) ]
105 Default Value: False
106 Dynamic: No
107 enableRemotePrivilegedUserAccess
109 Description: If True, the CIM Server allows access by a privi‐
111 leged user from a remote system
112 Default Value: True
113 Dynamic: No
114 enableSubscriptionsForNonprivilegedUsers
116 Description: If True, nonprivileged user of the system will be
118 allowed to create Indication Subscription, otherwise privileged
119 access is required.
120 Default Value: False
121 Dynamic: No
122 forceProviderProcesses
124 Description: If true, the CIM Server runs Providers in separate
126 processes rather than loading and calling Provider libraries
127 directly within the CIM Server process.
128 Default Value: True
129 Dynamic: No
130 hostname
132 Description: Can be used to override the local system supplied
134 hostname without domain the CIM Server is using to build
135 objects. Ifnotset,queryingthisconfigurationoptionwillreport‐
136 thesystem supplied hostname and behavior is not changed. Set‐
137 tingthisvaluetoavalidhostnameonCIMServerstartuporas planned
138 value will force the server to assume the configured name as the
139 local hosts name. Setting this allows the administrator to set
140 the name that operations such as associator, reference etc.
141 return with object paths. Incommonsetupsitisnotrecommendedtoex‐
142 plicitlysetthisvalue.
143 Default Value: (blank)
144 Dynamic: No
145 fullyQualifiedHostName
147 Description: Can be used to override the local system supplied
149 fully qualified hostname (with domain) the CIM Server is using
150 to build objects. Ifnotset,queryingthisconfigurationoptionwill‐
151 reportthesystem supplied fully qualified hostname and behavior
152 is not changed. SettingthisvaluetoavalidhostnameonCIMServer‐
153 startuporasplanned value will force the server to assume the
154 configured name as the local hosts name with domain. Setting
155 this allows the administrator to set the name that indication
156 operations and the CIM_ObjectManager assume for SystemName
157 returned as instance and key properties. Incommonsetupsitis‐
158 notrecommendedtoexplicitlysetthisvalue.
159 Default Value: (blank)
160 Dynamic: No
161 idleConnectionTimeout
163 Description: If set to a positive integer, this value specifies
165 a minimum timeout value for idle client connections. If set to
166 zero, idle client connections do not time out. A client con‐
167 nection is considered idle when it is not in the process of
168 sending a request and the CIM Server is not processing a request
169 from that connection. An idle connection timeout allows recla‐
170 mation of the system resources allocated for idle CIM Server
171 connections. Note that the CIM Server may allow an idle connec‐
172 tion to persist longer than the configured timeout value based
173 on server activity. Someclientapplicationsmaynotbehavecorrect‐
174 lyifaconnectiontimeout is introduced. Client compatibility
175 should be considered when configuring an idle connection timeout
176 value. Theidleconnectiontimeiscomputedusingthesystemclock.Thus,
177 resetting the system clock may cause unexpected timeout behav‐
178 ior.
179 Default Value: 0
180 Dynamic: No
181 listenAddress
183 Description: Network interfaces, if specified, cimserver(8)
185 should listen to for connection requests. It accepts a coma
186 seperated list(without space) of network interfaces. Both ipv4
187 and ipv6 addresses is accepted. Default value of "All" make cim‐
188 server to listen to all the available network interfaces. For
189 instance listenAddress=All or listenAddress=121.12.33.112 or
190 listenAddress=121.33.21.26,127.0.0.1,fe80::fe62:9346%eth0
191 Default Value: All
192 Dynamic: No
193 maxFailedProviderModuleRestarts
196 Description: If set to a positive integer, this value specifies
198 the number of times the failed provider module with indications
199 enabled are restarted automatically before being moved to
200 Degraded state. If set to zero, failed provider module is not
201 restarted with indications enabled automatically and will be
202 moved to Degraded state immediately. This option controls the
203 automatic re-enabling of the failed provider module with indica‐
204 tions enabled. If the provider module with indications enabled
205 fails very frequently, it affects the CIMServer normal opera‐
206 tions because CIMServer would be busy with reloading the
207 provider module every time it fails. This option would be help‐
208 ful if the long running indication provider crashes and the man‐
209 agement application want to receive the indications from the
210 provider while provider fix is being delivered. In case of
211 provider module grouping, if one of the indication provider
212 crashes, it affects all indication providers in the provider
213 modules of the group. Note that this is the facility provided
214 by the CIMServer for temporary recovery of the provider and the
215 ultimate goal SHALL be fixing the faulty provider.
216 Default Value: 3
217 Dynamic: Yes
218 maxIndicationDeliveryRetryAttempts
220 Description:If set to a positive integer, this value defines the
222 number of times that the indication service will try to deliver
223 an indication to a particular listener destination. This does
224 not effect the original delivery attempt, thus if set to 0, cim‐
225 server will only try to deliver the indication once. This value
226 is used to set the CIM_IndicationService.DeliveryRetryAttempts
227 property. See CIM_IndicationService.DeliveryRetryAttempts prop‐
228 erty for more details.
229 Default Value: 3
230 Dynamic: No
231 minIndicationDeliveryRetryInterval
233 Description:If set to a positive integer, this value defines the
235 minimal time interval in seconds for the indication service to
236 wait before retrying to deliver an indication to a listener des‐
237 tination that previously failed. Cimserver may take longer due
238 to QoS or other processing. This value is used to initialize
239 the property CIM_IndicationService.DeliveryRetryInterval. See
240 CIM_IndicationService.DeliveryRetryInterval property for more
241 details.
242 Default Value: 30
243 Dynamic: No
244 shutdownTimeout
246 Description: When a cimserver -s shutdown command is issued,
248 specifies the maximum time in seconds for the CIM Server to com‐
249 plete outstanding CIM operation requests before shutting down;
250 if the specified timeout period expires, the CIM Server will
251 shut down, even if there are still CIM operations in progress.
252 Minimum value is 2 seconds.
253 Default Value: 30
254 Dynamic: Yes
255 socketWriteTimeout
257 Description: Specifies the number of seconds the CIM Server will
259 wait for a client connection to be ready to receive data. If
260 the CIM Server is unable to write to a connection in this time,
261 the connection is closed. Aclientconnectioncanbecomeunabletore‐
262 ceivedataiftheclientfails to read the data that has already been
263 sent. This timeout allows the CIM Server to reclaim resources
264 that are allocated to a malfunctioning client. Onemightconsid‐
265 erincreasingthistimeoutvalueiftheCIMServer prematurely closes
266 connections with well-behaved clients.
267 Default Value: 20
268 Dynamic: Yes
269 sslClientVerificationMode
271 Description: Defines the desired level of support for certifi‐
273 cate-based authentication. It can be set to required, optional
274 or disabled. If set to required, the CIM Server will require
275 all clients connecting over HTTPS to authenticate using a cer‐
276 tificate. If the client certificate is not sent or not trusted
277 the connection will be rejected. If set to optional, the CIM
278 Server will allow, but not require, HTTPS clients to authenti‐
279 cate using a certificate. If the client does not send a certifi‐
280 cate, the CIM Server will attempt to authenticate the client
281 using HTTP basic authentication. If set to disabled, the CIM
282 Server will not allow HTTPS clients to authenticate using a cer‐
283 tificate. Basic authentication will be used to authenticate all
284 HTTPS clients. This property is only used if enableHttpsConnec‐
285 tion is true.
286 Default Value: disabled
287 Dynamic: No
288 sslCipherSuite
290 Description: String containing OpenSSL cipher specifications to
292 configure the cipher suite the client is permitted to negotiate
293 with the server during the SSL handshake phase. The value should
294 be mentioned between single quotes since it can contain special
295 characters like .+, !, -.
296 Default Value: DEFAULT (The default cipher list of OpenSSL)
297 Dynamic: No
298 sslBackwardCompatibility
300 Description:This setting specifies whether the ssl supports
302 SSLv3. Ideally for security Compilance purposes it is by
303 default set to false.
304 Default Value: false
305 Dynamic: No
306 If both the enableHttpsConnection and enableHttpConnection properties
308 are set to False , neither HTTP nor HTTPS connections will be allowed.
309 On some platforms, the OpenPegasus CIM Server has been enhanced to
310 include support for a local (single system), non-standard protocol.
311 This allows the OpenPegasus CIM Server to continue to receive and
312 process requests from local OpenPegasus CIM Clients even if both HTTP
313 ports are disabled. If a local protocol is not supported, the CIM
314 Server will be shut down and disabled from automatically being
315 re-started.
316 The current and planned values of the configuration properties are
318 stored in the files /var/opt/tog-pegasus/cimserver_current.conf and
319 /var/opt/tog-pegasus/cimserver_planned.conf , respectively. The con‐
320 figuration properties may only be modified via the cimconfig and cim‐
321 server (8) commands; the files must not be edited directly.
322 Options
324 The cimconfig command recognizes the following options:
325 -g configuration_property
327 Gets the specified value (current, planned and/or
328 default) of the specified configuration property.
329 By default, gets the current value.
330 -s configuration_property = value
332 Sets the specified value (current and/or planned)
333 of the specified configuration property to R
334 value . By default, sets the current value.
335 -u configuration_property
337 Unsets the specified value (current and/or
338 planned) of the specified configuration property,
339 and resets it to its default value. By default,
340 unsets the current value and resets it to its
341 default value.
342 -l Lists all the specified (current or planned) con‐
344 figuration property name and value pairs in the
345 CIM Server. By default, lists only the names of
346 all the current configuration properties.
347 -c Specifies that the operation (get, set, unset, or
349 list) be performed on the current configuration
350 properties. For set or unset operations, returns
351 an error when the CIM Server is not running or
352 the specified property is not a dynamic property.
353 -p Specifies that the operation (get, set, unset, or
355 list) be performed on the planned configuration
356 properties. For set and unset operations, oper‐
357 ates on the value of the specified property in
358 the planned configuration file if the CIM Server
359 is not running.
360 -d Specifies that the get operation be performed on
362 the default configuration properties. Returns an
363 error when the CIM Server is not running.
364 -h, --help Display the command usage message.
366 -H name Display detailed help information on the configu‐
368 raton property defined by the name parameter.
369
371 When an error occurs, an error message is written to stderr and an
372 error value of 1 is returned. The following return values are returned:
373 0 Successful completion
375 1 Error
376
378 Get the current value for the configuration property shutdownTimeout .
379 cimconfig -g shutdownTimeout -c
381 Get the planned value for the configuration property shutdownTimeout .
383 cimconfig -g shutdownTimeout -p
385 Get the default value for the configuration property shutdownTimeout .
387 cimconfig -g shutdownTimeout -d
389 Set the current value of the property shutdownTimeout to the new value
391 15.
392 cimconfig -s shutdownTimeout=15 -c
394 Set the planned value of the property shutdownTimeout , to the new
396 value 5.
397 cimconfig -s shutdownTimeout=5 -p
399 Reset the current value of the property shutdownTimeout to its default
401 value.
402 cimconfig -u shutdownTimeout -c
404 Reset the planned value of the property shutdownTimeout to its default
406 value.
407 cimconfig -u shutdownTimeout -p
409 List all the current configuration property names.
411 cimconfig -l
413 List all the current configuration property names and their values.
415 cimconfig -l -c
417 List all the planned configuration property names and their values.
419 cimconfig -l -p
421
423 /var/opt/tog-pegasus/cimserver_current.conf
424 Current configuration
425 /var/opt/tog-pegasus/cimserver_planned.conf
426 Planned configuration
427
429 cimserver (8), cimauth (8).
430 cimconfig(8)