1 kumpf 1.3 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1m.Z/cimconfig.1m,v 1.2 2003/03/13 17:25:16 kumpf Exp $
|
2 kumpf 1.2 .TA c \" lowercase initial leter of .TH name
|
3 kumpf 1.3 .TH cimconfig 8
|
4 kumpf 1.2 .SH NAME
5 cimconfig - get, set, unset, or list CIM Server configuration properties
6 .SH SYNOPSIS
7
8 \fBcimconfig\fP \fB-g\fP configuration_property [ \fB-c\fP ] [ \fB-p\fP ] [ \fB-d\fP ]
9
10 \fBcimconfig\fP
11 \fB-s\fP configuration_property=value
12 [ \fB-c\fP ]
13 [ \fB-p\fP ]
14
15 \fBcimconfig\fP
16 \fB-u\fP configuration_property
17 [ \fB-c\fP ]
18 [ \fB-p\fP ]
19
20 .B cimconfig
21 .B -l
22 [ \fB-c\fP
23 | \fB-p\fP ]
24 .SH DESCRIPTION
25 kumpf 1.2 .PP
26 The
27 .B cimconfig
28 command manages
29 CIM Server configuration properties. The operations are executed on the local
30 host by submitting requests to the CIM Server.
31 An operation on a current configuration property takes effect immediately,
32 and an operation on a planned configuration property takes effect the next time
33 the CIM Server is started with
|
34 kumpf 1.3 .B "cimserver (8)" .
|
35 kumpf 1.2 Modifications to a configuration property via
36 .B cimconfig
37 remain in effect
38 until changed via another
39 .B cimconfig
40 command. Configuration properties may also be modified temporarily via the
|
41 kumpf 1.3 .B "cimserver (8)"
|
42 kumpf 1.2 command, in which case, the modification of the configuration
43 property remains in effect for that execution of the
|
44 kumpf 1.3 .B "cimserver (8)"
|
45 kumpf 1.2 command only. A default value is associated with each configuration property.
46 Each configuration property is initially
47 assigned its default value, until modified by a
48 .B cimconfig
49 command or
|
50 kumpf 1.3 .B "cimserver (8)"
|
51 kumpf 1.2 command. Dynamic configuration
52 properties are those whose current values may be set while the CIM server is
53 running.
54 .PP
55 The following configuration properties are available:
56 .PP
|
57 kumpf 1.3 .B enableAssociationTraversal
58 .IP
59 .BR Description: " If True, the CIM Server will support the four association traversal operators:
60 Associators, AssociatorNames, References, and ReferenceNames.
61 .PD 0
62 .IP
63 .BR "Default Value: " True
64 .IP
65 .BR Dynamic: \0No
66 .PD
67 .PP
68 .B enableIndicationService
69 .IP
70 .BR Description: " If True, the CIM Server will support CIM Indications."
71 .PD 0
72 .IP
73 .BR "Default Value: " True
74 .IP
75 .BR Dynamic: \0No
76 .PD
77 .PP
78 kumpf 1.3 .B enableHttpConnection
79 .IP
80 .BR Description: " If True, allows connections to the CIM Server
81 using the HTTP protocol
82 .PD 0
83 .IP
84 .BR "Default Value: " False
85 .IP
86 .BR Dynamic: \0No
87 .PD
88 .PP
89 .B enableHttpsConnection
90 .IP
91 .BR Description: " If True, allows connections to the CIM Server
92 using the HTTPS protocol (HTTP using Secure Socket Layer encryption)
93 .PD 0
94 .IP
95 .BR "Default Value: " True
96 .IP
97 .BR Dynamic: \0No
98 .PD
99 kumpf 1.3 .PP
|
100 kumpf 1.2 .B enableNamespaceAuthorization
101 .IP
102 .BR Description: " If True, the CIM Server restricts access to
103 namespaces based on configured user authorizations [user authorizations may
104 be configured using
|
105 kumpf 1.3 .B "cimauth (8)"
106 ]
|
107 kumpf 1.2 .PD 0
108 .IP
109 .BR "Default Value: " False
110 .IP
111 .BR Dynamic: \0No
112 .PD
113 .PP
114 .B enableRemotePrivilegedUserAccess
115 .IP
116 .BR Description: " If True, the CIM Server allows access by a
117 privileged user from a remote system
118 .PD 0
119 .IP
|
120 kumpf 1.3 .BR "Default Value: " True
|
121 kumpf 1.2 .IP
122 .BR Dynamic: \0No
123 .PD
124 .PP
|
125 kumpf 1.3 .B enableSubscriptionsForNonprivilegedUsers
|
126 kumpf 1.2 .IP
|
127 kumpf 1.3 .BR Description: " If True, nonprivileged user of the system will be
128 allowed to create Indication Subscription, otherwise privileged access
129 is required.
|
130 kumpf 1.2 .PD 0
131 .IP
132 .BR "Default Value: " True
133 .IP
134 .BR Dynamic: \0No
135 .PD
136 .PP
|
137 kumpf 1.3 .B logLevel
|
138 kumpf 1.2 .IP
|
139 kumpf 1.3 .BR Description: " Defines the desired level of logging. Valid values include:
140 TRACE, INFORMATION, WARNING, SEVERE, FATAL
|
141 kumpf 1.2 .PD 0
142 .IP
|
143 kumpf 1.3 .BR "Default Value: " INFORMATION
|
144 kumpf 1.2 .IP
|
145 kumpf 1.3 .BR Dynamic: \0Yes
|
146 kumpf 1.2 .PD
147 .PP
148 .B shutdownTimeout
149 .IP
150 .BR Description: " When a
151 .B cimserver -s
|
152 kumpf 1.3 shutdown command is
|
153 kumpf 1.2 issued, specifies the maximum time in seconds for the CIM Server to complete
154 outstanding CIM operation requests before shutting down; if the specified
155 timeout period expires, the CIM Server will shut down, even if there are
156 still CIM operations in progress.
157 Minimum value is 2 seconds.
158 .PD 0
159 .IP
160 .BR "Default Value: " 10
161 .IP
|
162 kumpf 1.3 .BR Dynamic: \0No
|
163 kumpf 1.2 .PD
164 .PP
165 If both the
166 .B enableHttpsConnection
167 and
168 .B enableHttpConnection
169 properties are set to
170 .B True ,
171 only HTTPS connections
172 will be allowed. If both the
173 .B enableHttpsConnection
174 and
175 .B enableHttpConnection
176 properties are set to
177 .B False ,
178 neither HTTP nor HTTPS connections will be allowed, and the CIM Server will be
179 shut down and disabled from automatically being re-started.
180 .PP
181 The current and planned
182 values of the configuration properties are stored in the files
|
183 kumpf 1.3 .B /etc/pegasus/cimserver_current.conf
|
184 kumpf 1.2 and
|
185 kumpf 1.3 .B /etc/pegasus/cimserver_planned.conf ,
|
186 kumpf 1.2 respectively. The configuration
187 properties may only be modified via the
188 .B cimconfig
189 and
|
190 kumpf 1.3 .B "cimserver (8)"
|
191 kumpf 1.2 commands;
192 the files must not be edited directly.
193 .SS Options
194 .PP
195 The
196 .B cimconfig
197 command recognizes the following options:
198 .RS
199 .TP 15
200 \fB-g\fP configuration_property
201 Gets the specified value (current, planned and/or default) of the specified
202 configuration property. By default, gets the current value.
203 .TP
204 \fB-s\fP configuration_property = value
205 Sets the specified value (current and/or planned) of the specified configuration
206 property to
207 .IR value .
208 By default, sets the current value.
209 .TP
210 \fB-u\fP configuration_property
211 Unsets the specified
212 kumpf 1.2 value (current and/or planned) of the specified configuration property, and
213 resets it to its default value. By
214 default, unsets the current value and resets it to its default value.
215 .TP
216 .B -l
217 Lists all the specified (current or planned) configuration property name and
218 value pairs in the CIM Server. By default,
219 lists only the names of all the current configuration properties.
220 .TP
221 .B -c
222 Specifies that the operation (get, set, unset, or list) be performed on the
223 current configuration properties. For set or
224 unset operations, returns an error when the CIM Server is not running or the
225 specified property is not a dynamic property.
226 .TP
227 .B -p
228 Specifies that the operation (get, set, unset, or list) be performed on the
229 planned configuration properties. For set and
230 unset operations, operates on the value of the specified property in the
231 planned configuration file if the CIM Server is not running.
232 .TP
233 kumpf 1.2 .B -d
234 Specifies that the get operation be performed on the default configuration
235 properties. Returns an error when the CIM Server is not running.
236 .RE
237 .PP
238 If no options are specified,
239 .B cimconfig
240 displays a usage message.
241 .SH EXIT STATUS
242 .PP
243 When an error occurs, an
244 error message is written to stderr and an error value of 1 is returned. The
245 following return values are returned:
246 .RS
247 .TP
248 .B 0
249 Successful completion
250 .PD 0
251 .TP
252 .B 1
253 Error
254 kumpf 1.2 .PD
255 .RE
256 .SH EXAMPLES
257 .PP
258 Get the current value for the configuration property
259 .B shutdownTimeout .
260 .IP
261 .B cimconfig -g shutdownTimeout -c
262 .PP
263 Get the planned value for the configuration property
264 .B shutdownTimeout .
265 .IP
266 .B cimconfig -g shutdownTimeout -p
267 .PP
268 Get the default value for the configuration property
269 .B shutdownTimeout .
270 .IP
271 .B cimconfig -g shutdownTimeout -d
272 .PP
273 Set the current value of the property
274 .B shutdownTimeout
275 kumpf 1.2 to the new value 15.
276 .IP
277 .B cimconfig -s shutdownTimeout=15 -c
278 .PP
279 Set the planned value of the property
280 .B shutdownTimeout ,
281 to the new value 5.
282 .IP
283 .B cimconfig -s shutdownTimeout=5 -p
284 .PP
285 Reset the current value of the property
286 .B shutdownTimeout
287 to its default value.
288 .IP
289 .B cimconfig -u shutdownTimeout -c
290 .PP
291 Reset the planned value of the property
292 .B shutdownTimeout
293 to its default value.
294 .IP
295 .B cimconfig -u shutdownTimeout -p
296 kumpf 1.2 .PP
297 List all the current configuration property names.
298 .IP
299 .B cimconfig -l
300 .PP
301 List all the current configuration property names and their values.
302 .IP
303 .B cimconfig -l -c
304 .PP
305 List all the planned configuration property names and their values.
306 .IP
307 .B cimconfig -l -p
308 .SH FILES
309 .TP 30
310 .PD 0
|
311 kumpf 1.3 .B /etc/pegasus/cimserver_current.conf
|
312 kumpf 1.2 Current configuration
313 .TP
|
314 kumpf 1.3 .B /etc/pegasus/cimserver_planned.conf
|
315 kumpf 1.2 Planned configuration
316 .PD
317 .SH SEE ALSO
318 .PP
|
319 kumpf 1.3 cimserver (8), cimauth (8).
|