cimconfig(1M)cimconfig(1M)NAMEcimconfig - get, set, unset, or list CIM Server configuration proper‐
ties
SYNOPSISDESCRIPTION
The command manages CIM Server configuration properties. The operations
are executed on the local host by submitting requests to the CIM
Server. An operation on a current configuration property takes effect
immediately, and an operation on a planned configuration property takes
effect the next time the CIM Server is started with Modifications to a
configuration property via remain in effect until changed via another
command. Configuration properties may also be modified temporarily via
the command, in which case, the modification of the configuration prop‐
erty remains in effect for that execution of the command only. A
default value is associated with each configuration property. Each
configuration property is initially assigned its default value, until
modified by a command or command. Dynamic configuration properties are
those whose current values may be set while the CIM server is running.
The following configuration properties are available:
Description: If True, the CIM Server restricts access to names‐
paces based on configured user authorizations [user authoriza‐
tions may be configured using
Default Value: False
Dynamic: No
Description: If set, the value is interpreted as a list of
comma-separated user groups whose members may issue CIM
requests. A user who is not a member of any of these groups is
restricted from issuing CIM requests, with the exception of
privileged users (superuser). If unset, any user may issue CIM
requests. Note: This configuration property operates in conjunc‐
tion with other CIM request authorization conditions rather than
overriding them.
Default Value: (None)
Dynamic: No
Description: If True, the CIM Server allows access by a privi‐
leged user from a remote system
Default Value: True
Dynamic: No
Description: If True, any user may create Indication Subscrip‐
tions. If False, only a privileged user (superuser) may create
Indication Subscriptions.
Default Value: False
Dynamic: No
Description: If True, allows connections to the CIM Server using
the HTTPS protocol (HTTP using Secure Socket Layer encryption)
Default Value: True
Dynamic: No
Description: If True, allows connections to the CIM Server using
the HTTP protocol
Default Value: False
Dynamic: No
Description: Describes the desired level of support for certifi‐
cate-based authentication. This property is only used if is
required: The server requires certificate-based client authenti‐
cation. A client MUST present a trusted certificate in order to
access the CIM Server. If the client fails to send a certifi‐
cate or sends an untrusted certificate, the connection will be
rejected.
optional: The server supports, but does not require, certifi‐
cate-based client authentication. The server will request and
attempt to validate a client certificate, however the connection
will be accepted even if no certificate is sent or an untrusted
certificate is sent. The server will then seek to authenticate
the client via an authentication header.
disabled: The server does not support certificate-based client
authentication.
Default Value: disabled
Dynamic: No
Description: If set to a positive integer, this value specifies
a minimum timeout value for idle client connections. If set to
zero, idle client connections do not time out. A client connec‐
tion is considered idle when it is not in the process of sending
a request and the CIM Server is not processing a request from
that connection. An idle connection timeout allows reclamation
of the system resources allocated for idle CIM Server connec‐
tions. Note that the CIM Server may allow an idle connection to
persist longer than the configured timeout value based on server
activity. Some client applications may not behave correctly if
a connection timeout is introduced. Client compatibility should
be considered when configuring an idle connection timeout value.
The idle connection time is computed using the system clock.
Thus, resetting the system clock may cause unexpected timeout
behavior.
Default Value: 0
Dynamic: No
Description: When a shutdown command is issued, specifies the
maximum time in seconds for the CIM Server to complete outstand‐
ing CIM operation requests before shutting down; if the speci‐
fied timeout period expires, the CIM Server will shut down, even
if there are still CIM operations in progress. Minimum value is
2 seconds.
Default Value: 30
Dynamic: Yes
Description: Specifies the number of seconds the CIM Server will
wait for a client connection to be ready to receive data. If
the CIM Server is unable to write to a connection in this time,
the connection is closed. A client connection can become unable
to receive data if the client fails to read the data that has
already been sent. This timeout allows the CIM Server to
reclaim resources that are allocated to a malfunctioning client.
One might consider increasing this timeout value if the CIM
Server prematurely closes connections with well-behaved clients.
Default Value: 20
Dynamic: Yes
If both the and properties are set to neither HTTP nor HTTPS connec‐
tions will be allowed.
The current and planned values of the configuration properties are
stored in the files and respectively. The configuration properties may
only be modified via the and commands; the files must not be edited
directly.
Options
The command recognizes the following options:
Gets the specified value (current, planned and/or default) of
the specified
configuration property. By default, gets the
current value.
Sets the specified value (current and/or planned) of the speci‐
fied configuration
property to value. By default, sets the current
value.
Unsets the specified
value (current and/or planned) of the specified
configuration property, and resets it to its
default value. By default, unsets the current
value and resets it to its default value.
Lists all the specified (current or planned) configuration prop‐
erty name and
value pairs in the CIM Server. By default, lists
only the names of all the current configuration
properties.
Specifies that the operation (get, set, unset, or list) be per‐
formed on the
current configuration properties. For set or
unset operations, returns an error when the CIM
Server is not running or the specified property
is not a dynamic property.
Specifies that the operation (get, set, unset, or list) be per‐
formed on the
planned configuration properties. For set and
unset operations, operates on the value of the
specified property in the planned configuration
file if the CIM Server is not running.
Specifies that the get operation be performed on the default
configuration
properties. Returns an error when the CIM Server
is not running.
If no options are specified, displays a usage message.
EXIT STATUS
When an error occurs, an error message is written to stderr and an
error value of 1 is returned. The following return values are returned:
Successful completion
Error
EXAMPLES
Get the current value for the configuration property
Get the planned value for the configuration property
Get the default value for the configuration property
Set the current value of the property to the new value 15.
Set the planned value of the property to the new value 5.
Reset the current value of the property to its default value.
Reset the planned value of the property to its default value.
List all the current configuration property names.
List all the current configuration property names and their values.
List all the planned configuration property names and their values.
FILES
Current configuration
Planned configuration
AUTHOR
was developed by the Open Group OpenPegasus Open Source Software
project.
SEE ALSO
cimserver (1M), cimauth (1M).
cimconfig(1M)
