1cimserver(8) System Manager's Manual cimserver(8)
2
6 cimserver - start or stop the CIM Server; display the version number of
7 the CIM Server
8
10 cimserver [configProperty=value] ...
11 cimserver -s [ shutdownTimeout = value ]
13 cimserver -v
15 cimserver -h
17 cimserver --help
19 cimserver --version
21 Remarks
23 This command can only be executed by a privileged user.
24
26 The cimserver command provides a command line interface to stop and
27 start the CIM Server, as well as to display the version number of the
28 CIM Server.
29 After installation, the CIM Server must be started using the cimserver
31 command. If the system is rebooted, the CIM Server will automatically
32 restart, with the exception of the case where the CIM Server was shut‐
33 down prior to the reboot. Generally, once the CIM Server is started, it
34 is expected to be always running and ready to serve CIM requests. How‐
35 ever, if the CIM Server must be stopped and restarted, the cimserver
36 command can be used to shutdown the CIM Server gracefully and restart
37 it at a later time.
38 Starting the CIM Server
40 Issuing the cimserver command without any options starts the CIM Server
41 process.
42 When starting the CIM Server using the cimserver command, the <config‐
44 Property=value> syntax can be used to set the configuration properties
45 to be used by the CIM Server. It is important to know that the values
46 specified in the cimserver command apply only to the current CIM Server
47 process that gets started. The default values for the configuration
48 properties do not change. For a list of the CIM Server configuration
49 properties, see the man page for the cimconfig command.
50 Shutting down the CIM Server
52 Issuing the cimserver command with the -s option stops the CIM Server.
53 Optionally, a timeout value can be specified by setting the shutdown‐
54 Timeout configuration property.
55 Under normal operation, CIM Server should be able to be shutdown fairly
57 quickly without problem. There are, however, situations that may pre‐
58 vent CIM Server from shutting down within a reasonable amount of time.
59 For example, a provider that is not responding to requests, or a
60 provider that is servicing a long-running CIM request. To handle such
61 situations and to ensure that the CIM Server can be shutdown without
62 having the user wait a long period of time (or indefinitely), a shut‐
63 down timeout value is used.
64 The shutdown timeout value is the maximum amount of time (in seconds)
66 the user is willing to wait for the CIM Server to complete all the out‐
67 standing CIM operation requests before shutting down the CIM Server.
68 If the specified shutdown timeout period expires, the CIM Server will
69 be shutdown even if there are CIM operations in progress. The shutdown
70 timeout value is a CIM Server configuration property (shutdownTimeout )
71 that can be changed using the command. The default shutdown timeout
72 value is 10 seconds.
73 A timeout value (in seconds) can be specified in the cimserver command
75 to shutdown the CIM Server using the =value> syntax. This overrides
76 the default shutdown timeout value. The minimum timeout value is 2
77 seconds.
78 While CIM Server is shutting down, a client connection request will
80 result in a connection error (the same as if the CIM Server were not
81 running). For clients who have already established a connection to the
82 CIM Server, new CIM requests will be rejected with a CIM error indicat‐
83 ing that the CIM Server is shutting down.
84 When a client receives a response containing a CIM error indicating
86 that the CIM Server is shutting down, it should close the connection
87 and reconnect to CIM Server at a later time.
88 Options
90 The cimserver command recognizes the following options:
91 -v, --version Display the version number of the CIM Server.
93 -h, --help Display the command usage.
95 -s Stop the CIM Server.
97 Specify the timeout value for shutting down the CIM Server.
99 This can only be used in conjunction with the -s
100 option. The minimum timeout value is 2 seconds.
101 If this is not specified, the default config‐
102 urable timeout value will be used.
103 configProperty=value
105 Set the value for the specified configuration
106 property to be used in starting the CIM Server.
107
109 The cimserver command returns one of the following values:
110 0 Success
112 1 Error
113 When an error occurs, an error message is written to stderr and an
115 error value of 1 is returned.
116
118 unable to connect to CIM Server. CIM Server may not be running.
119 The cimserver command was issued to stop the CIM Server when CIM
121 Server was not running. An exit status value of 1 is returned.
122 Error: Bind failed: Failed to bind socket.
124 The cimserver command was issued to start the CIM Server and the
126 CIM Server was already running. An exit status value of 1 is
127 returned.
128
130 Stop the CIM Server with the default timeout value of 10 seconds.
131 cimserver -s
133 Stop the CIM Server with a timeout value of 5 seconds.
135 cimserver -s shutdownTimeout=5
137 Start the CIM Server.
139 cimserver
141 Start the CIM Server with the configuration property enableNamespaceAu‐
143 thorization set to true.
144 cimserver enableNamespaceAuthorization=true
146 Display the version number of the CIM Server. This version number is
148 used to identify the release version of the CIM Server in the OpenPega‐
149 sus release.
150 cimserver -v
152 Display the command usage.
154 cimserver -h
156
158 cimconfig(8).
159 cimserver(8)