1cimserver(8)                System Manager's Manual               cimserver(8)
2
3
4

NAME

6       cimserver - start or stop the CIM Server; display the version number or
7       running status of the CIM Server
8

SYNOPSIS

10       cimserver [configProperty=value] ...
11
12       cimserver -s [ shutdownTimeout = value ]
13
14       cimserver -v
15
16       cimserver -h
17
18       cimserver --help
19
20       cimserver --version
21
22       cimserver --status
23
24   Remarks
25       This command can only be executed by a privileged user.
26

DESCRIPTION

28       The cimserver command provides a command line  interface  to  stop  and
29       start  the CIM Server, as well as to display the version number or run‐
30       ning status of the CIM Server.
31
32       After installation, the CIM Server must be started using the  cimserver
33       command.   If the system is rebooted, the CIM Server will automatically
34       restart, with the exception of the case where the CIM Server was  shut‐
35       down prior to the reboot. Generally, once the CIM Server is started, it
36       is expected to be always running and ready to serve CIM requests.  How‐
37       ever,  if  the  CIM Server must be stopped and restarted, the cimserver
38       command can be used to shutdown the CIM Server gracefully  and  restart
39       it at a later time.
40
41   Starting the CIM Server
42       Issuing the cimserver command without any options starts the CIM Server
43       process.
44
45       When starting the CIM Server using the cimserver command, the  <config‐
46       Property=value>  syntax can be used to set the configuration properties
47       to be used by the CIM Server.  It is important to know that the  values
48       specified in the cimserver command apply only to the current CIM Server
49       process that gets started.  The default values  for  the  configuration
50       properties  do  not change.  For a list of the CIM Server configuration
51       properties, see the man page for the cimconfig command.
52
53   Shutting down the CIM Server
54       Issuing the cimserver command with the -s option stops the CIM  Server.
55       Optionally,  a  timeout value can be specified by setting the shutdown‐
56       Timeout configuration property.
57
58       Under normal operation, CIM Server should be able to be shutdown fairly
59       quickly  without problem.  There are, however, situations that may pre‐
60       vent CIM Server from shutting down within a reasonable amount of  time.
61       For  example,  a  provider  that  is  not  responding to requests, or a
62       provider that is servicing a long-running CIM request.  To handle  such
63       situations  and  to  ensure that the CIM Server can be shutdown without
64       having the user wait a long period of time (or indefinitely),  a  shut‐
65       down timeout value is used.
66
67       The  shutdown  timeout value is the maximum amount of time (in seconds)
68       the user is willing to wait for the CIM Server to complete all the out‐
69       standing  CIM  operation  requests before shutting down the CIM Server.
70       If the specified shutdown timeout period expires, the CIM  Server  will
71       be shutdown even if there are CIM operations in progress.  The shutdown
72       timeout value is a CIM Server configuration property (shutdownTimeout )
73       that  can  be  changed using the command.  The default shutdown timeout
74       value is 10 seconds.
75
76       A timeout value (in seconds) can be specified in the cimserver  command
77       to  shutdown  the  CIM Server using the =value> syntax.  This overrides
78       the default shutdown timeout value.  The minimum  timeout  value  is  2
79       seconds.
80
81       While  CIM  Server  is  shutting down, a client connection request will
82       result in a connection error (the same as if the CIM  Server  were  not
83       running).  For clients who have already established a connection to the
84       CIM Server, new CIM requests will be rejected with a CIM error indicat‐
85       ing that the CIM Server is shutting down.
86
87       When  a  client  receives  a response containing a CIM error indicating
88       that the CIM Server is shutting down, it should  close  the  connection
89       and reconnect to CIM Server at a later time.
90
91   Options
92       The cimserver command recognizes the following options:
93
94              -v, --version  Display  the  version number or running status of
95                             the CIM Server.
96
97              -h, --help     Display the command usage.
98
99              --status       Display the running status of the CIM Server.
100
101              -s             Stop the CIM Server.
102
103              Specify the timeout value for shutting down the CIM Server.
104                             This can only be used in conjunction with the  -s
105                             option.   The minimum timeout value is 2 seconds.
106                             If this is not  specified,  the  default  config‐
107                             urable timeout value will be used.
108
109              configProperty=value
110                             Set  the  value  for  the specified configuration
111                             property to be used in starting the CIM Server.
112

EXIT STATUS

114       The cimserver command returns one of the following values:
115
116              0      Success
117              1      Error
118
119       The cimserver --status command returns one of the following values:
120
121              0      The CIM Server is running
122              1      Error
123              2      The CIM Server is not running
124
125       When an error occurs, an error message is  written  to  stderr  and  an
126       error value of 1 is returned.
127

DIAGNOSTICS

129       unable to connect to CIM Server.  CIM Server may not be running.
130
131              The cimserver command was issued to stop the CIM Server when CIM
132              Server was not running.  An exit status value of 1 is returned.
133
134       Error: Bind failed: Failed to bind socket.
135
136              The cimserver command was issued to start the CIM Server and the
137              CIM  Server  was  already running.  An exit status value of 1 is
138              returned.
139

EXAMPLES

141       Stop the CIM Server with the default timeout value of 10 seconds.
142
143              cimserver -s
144
145       Stop the CIM Server with a timeout value of 5 seconds.
146
147              cimserver -s shutdownTimeout=5
148
149       Start the CIM Server.
150
151              cimserver
152
153       Start the CIM Server with the configuration property enableNamespaceAu‐
154       thorization set to true.
155
156              cimserver enableNamespaceAuthorization=true
157
158       Display  the  version number of the CIM Server.  This version number is
159       used to identify the release version of the CIM Server in the OpenPega‐
160       sus release.
161
162              cimserver -v
163
164       Display the command usage.
165
166              cimserver -h
167

SEE ALSO

169       cimconfig(8).
170
171
172
173                                                                  cimserver(8)
Impressum