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 --version
23
26 The cimconfig command manages CIM Server configuration properties. The
27 operations are executed on the local host by submitting requests to the
28 CIM Server. An operation on a current configuration property takes
29 effect immediately, and an operation on a planned configuration prop‐
30 erty takes effect the next time the CIM Server is started with cim‐
31 server (8) . Modifications to a configuration property via cimconfig
32 remain in effect until changed via another cimconfig command. Configu‐
33 ration properties may also be modified temporarily via the cimserver
34 [1m(8) command, in which case, the modification of the configuration prop‐
35 erty remains in effect for that execution of the cimserver (8) command
36 only. A default value is associated with each configuration property.
37 Each configuration property is initially assigned its default value,
38 until modified by a cimconfig command or cimserver (8) command.
39 Dynamic configuration properties are those whose current values may be
40 set while the CIM server is running.
41 The following configuration properties are available:
43 authorizedUserGroups
45 Description: If set, the value is interpreted as a list of
47 comma-separated user groups whose members may issue CIM
48 requests. A user who is not a member of any of these groups is
49 restricted from issuing CIM requests, with the exception of
50 privileged users (superuser). If unset, any user may issue CIM
51 requests. Note: This configuration property operates in conjunc‐
52 tion with other CIM request authorization conditions rather than
53 overriding them.
54 Default Value: (None)
55 Dynamic: No
56 enableAssociationTraversal
58 Description: If True, the CIM Server will support the four asso‐
60 ciation traversal operators: Associators, AssociatorNames, Ref‐
61 erences, and ReferenceNames.
62 Default Value: True
63 Dynamic: No
64 enableAuditLog
66 Description: If True, audit log entries for certain types of CIM
68 Server activities will be written to the system log. Examples
69 of audited activities include a CIM Server configuration change,
70 a Provider registration change, an authentication attempt and a
71 modification to the CIM Schema or a CIM Instance. An audit log
72 entry describes the who, what, and when associated with an
73 audited activity.
74 Default Value: False
75 Dynamic: Yes
76 enableIndicationService
78 Description: If True, the CIM Server will support CIM Indica‐
80 tions.
81 Default Value: True
82 Dynamic: No
83 enableHttpConnection
85 Description: If True, allows connections to the CIM Server using
87 the HTTP protocol
88 Default Value: False
89 Dynamic: No
90 enableHttpsConnection
92 Description: If True, allows connections to the CIM Server using
94 the HTTPS protocol (HTTP using Secure Socket Layer encryption)
95 Default Value: True
96 Dynamic: No
97 enableNamespaceAuthorization
99 Description: If True, the CIM Server restricts access to names‐
101 paces based on configured user authorizations [user authoriza‐
102 tions may be configured using cimauth (8) ]
103 Default Value: False
104 Dynamic: No
105 enableRemotePrivilegedUserAccess
107 Description: If True, the CIM Server allows access by a privi‐
109 leged user from a remote system
110 Default Value: True
111 Dynamic: No
112 enableSubscriptionsForNonprivilegedUsers
114 Description: If True, nonprivileged user of the system will be
116 allowed to create Indication Subscription, otherwise privileged
117 access is required.
118 Default Value: False
119 Dynamic: No
120 forceProviderProcesses
122 Description: If true, the CIM Server runs Providers in separate
124 processes rather than loading and calling Provider libraries
125 directly within the CIM Server process.
126 Default Value: True
127 Dynamic: No
128 idleConnectionTimeout
130 Description: If set to a positive integer, this value specifies
132 a minimum timeout value for idle client connections. If set to
133 zero, idle client connections do not time out. Aclientconnec‐
134 tionisconsideredidlewhenitisnotintheprocessof sending a request
135 and the CIM Server is not processing a request from that connec‐
136 tion. An idle connection timeout allows reclamation of the sys‐
137 tem resources allocated for idle CIM Server connections. Note
138 that the CIM Server may allow an idle connection to persist
139 longer than the configured timeout value based on server activ‐
140 ity. Someclientapplicationsmaynotbehavecorrectlyifaconnection‐
141 timeout is introduced. Client compatibility should be consid‐
142 ered when configuring an idle connection timeout value. Thei‐
143 dleconnectiontimeiscomputedusingthesystemclock.Thus, resetting
144 the system clock may cause unexpected timeout behavior.
145 Default Value: 0
146 Dynamic: No
147 shutdownTimeout
149 Description: When a cimserver -s shutdown command is issued,
151 specifies the maximum time in seconds for the CIM Server to com‐
152 plete outstanding CIM operation requests before shutting down;
153 if the specified timeout period expires, the CIM Server will
154 shut down, even if there are still CIM operations in progress.
155 Minimum value is 2 seconds.
156 Default Value: 30
157 Dynamic: Yes
158 socketWriteTimeout
160 Description: Specifies the number of seconds the CIM Server will
162 wait for a client connection to be ready to receive data. If
163 the CIM Server is unable to write to a connection in this time,
164 the connection is closed. Aclientconnectioncanbecomeunabletore‐
165 ceivedataiftheclientfails to read the data that has already been
166 sent. This timeout allows the CIM Server to reclaim resources
167 that are allocated to a malfunctioning client. Onemightconsid‐
168 erincreasingthistimeoutvalueiftheCIMServer prematurely closes
169 connections with well-behaved clients.
170 Default Value: 20
171 Dynamic: Yes
172 sslClientVerificationMode
174 Description: Defines the desired level of support for certifi‐
176 cate-based authentication. It can be set to required, optional
177 or disabled. If set to required, the CIM Server will require
178 all clients connecting over HTTPS to authenticate using a cer‐
179 tificate. If the client certificate is not sent or not trusted
180 the connection will be rejected. If set to optional, the CIM
181 Server will allow, but not require, HTTPS clients to authenti‐
182 cate using a certificate. If the client does not send a certifi‐
183 cate, the CIM Server will attempt to authenticate the client
184 using HTTP basic authentication. If set to disabled, the CIM
185 Server will not allow HTTPS clients to authenticate using a cer‐
186 tificate. Basic authentication will be used to authenticate all
187 HTTPS clients. This property is only used if enableHttpsConnec‐
188 tion is true.
189 Default Value: disabled
190 Dynamic: No
191 If both the enableHttpsConnection and enableHttpConnection properties
193 are set to False , neither HTTP nor HTTPS connections will be allowed.
194 On some platforms, the OpenPegasus CIM Server has been enhanced to
195 include support for a local (single system), non-standard protocol.
196 This allows the OpenPegasus CIM Server to continue to receive and
197 process requests from local OpenPegasus CIM Clients even if both HTTP
198 ports are disabled. If a local protocol is not supported, the CIM
199 Server will be shut down and disabled from automatically being
200 re-started.
201 The current and planned values of the configuration properties are
203 stored in the files /var/opt/tog-pegasus/cimserver_current.conf and
204 /var/opt/tog-pegasus/cimserver_planned.conf , respectively. The con‐
205 figuration properties may only be modified via the cimconfig and cim‐
206 server (8) commands; the files must not be edited directly.
207 Options
209 The cimconfig command recognizes the following options:
210 -g configuration_property
212 Gets the specified value (current, planned and/or
213 default) of the specified configuration property.
214 By default, gets the current value.
215 -s configuration_property = value
217 Sets the specified value (current and/or planned)
218 of the specified configuration property to R
219 value . By default, sets the current value.
220 -u configuration_property
222 Unsets the specified value (current and/or
223 planned) of the specified configuration property,
224 and resets it to its default value. By default,
225 unsets the current value and resets it to its
226 default value.
227 -l Lists all the specified (current or planned) con‐
229 figuration property name and value pairs in the
230 CIM Server. By default, lists only the names of
231 all the current configuration properties.
232 -c Specifies that the operation (get, set, unset, or
234 list) be performed on the current configuration
235 properties. For set or unset operations, returns
236 an error when the CIM Server is not running or
237 the specified property is not a dynamic property.
238 -p Specifies that the operation (get, set, unset, or
240 list) be performed on the planned configuration
241 properties. For set and unset operations, oper‐
242 ates on the value of the specified property in
243 the planned configuration file if the CIM Server
244 is not running.
245 -d Specifies that the get operation be performed on
247 the default configuration properties. Returns an
248 error when the CIM Server is not running.
249 If no options are specified, cimconfig displays a usage message.
251
253 When an error occurs, an error message is written to stderr and an
254 error value of 1 is returned. The following return values are returned:
255 0 Successful completion
257 1 Error
258
260 Get the current value for the configuration property shutdownTimeout .
261 cimconfig -g shutdownTimeout -c
263 Get the planned value for the configuration property shutdownTimeout .
265 cimconfig -g shutdownTimeout -p
267 Get the default value for the configuration property shutdownTimeout .
269 cimconfig -g shutdownTimeout -d
271 Set the current value of the property shutdownTimeout to the new value
273 15.
274 cimconfig -s shutdownTimeout=15 -c
276 Set the planned value of the property shutdownTimeout , to the new
278 value 5.
279 cimconfig -s shutdownTimeout=5 -p
281 Reset the current value of the property shutdownTimeout to its default
283 value.
284 cimconfig -u shutdownTimeout -c
286 Reset the planned value of the property shutdownTimeout to its default
288 value.
289 cimconfig -u shutdownTimeout -p
291 List all the current configuration property names.
293 cimconfig -l
295 List all the current configuration property names and their values.
297 cimconfig -l -c
299 List all the planned configuration property names and their values.
301 cimconfig -l -p
303
305 /var/opt/tog-pegasus/cimserver_current.conf
306 Current configuration
307 /var/opt/tog-pegasus/cimserver_planned.conf
308 Planned configuration
309
311 cimserver (8), cimauth (8).
312 cimconfig(8)