1 aruran.ms 1.3 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man1m.Z/cimserver.1m,v 1.2 2003/03/13 17:25:16 kumpf Exp $

  2 kumpf     1.2 .TA c \" lowercase initial letter of .TH name
  3               .TH cimserver 1M
  4               .SH NAME
  5               cimserver \- start or stop the CIM Server; display the version number of the CIM Server
  6               .SH SYNOPSIS
  7               
  8               .B cimserver
  9               .RI [ configProperty\c
 10               .RI = value ] \ ...
 11               
 12               \fBcimserver -s\fP [ \fBshutdownTimeout\fP = value ]
 13               
 14               .B cimserver -v
 15               
 16               .B cimserver -h
 17               .SS Remarks
 18               This command can only be executed by a privileged user.
 19               .SH DESCRIPTION
 20               .PP
 21               The 
 22               .B cimserver 
 23 kumpf     1.2 command provides a command line interface to stop
 24               and start the CIM Server, as well as to display the version number
 25               of the CIM Server. 
 26               .PP
 27               After installation, the CIM Server must be started using the
 28               .B cimserver 
 29               command.  If the system is rebooted, the CIM Server
 30               will automatically restart, with the exception of the case
 31               where the CIM Server was shutdown prior to the reboot. Generally, once
 32               the CIM Server is started, it is expected to be always running and
 33               ready to serve CIM requests.  However, if the CIM Server must be 
 34               stopped and restarted, the 
 35               .B cimserver 
 36               command can be used to shutdown 
 37               the CIM Server gracefully and restart it at a later time.
 38               .SS Starting the CIM Server
 39               .PP
 40               Issuing the 
 41               .B cimserver 
 42               command without any options starts the
 43               CIM Server process.
 44 kumpf     1.2 .PP
 45               When starting the CIM Server using the 
 46               .B cimserver 
 47               command, the
 48               .RI < configProperty\c
 49               .RI = value > 
 50               syntax can be used to set the configuration properties to be used by the CIM Server.
 51               It is important to know that the values specified in the 
 52               .B cimserver
 53               command apply only to the current CIM Server process
 54               that gets started.  The default values for the configuration
 55               properties do not change.  For a list of the CIM Server configuration
 56               properties, see the man page for the 
 57               .B cimconfig
 58               command or the HP WBEM Services Administrator's Guide.
 59               .SS Shutting down the CIM Server
 60               .PP
 61               Issuing the 
 62               .B cimserver 
 63               command with the 
 64               .B -s
 65 kumpf     1.2 option stops the CIM Server.  Optionally, a timeout value can be specified
 66               by setting the 
 67               .B shutdownTimeout
 68               configuration property.
 69               .PP
 70               Under normal operation, CIM Server should be able to be shutdown
 71               fairly quickly without problem.  There are, however, situations
 72               that may prevent CIM Server from shutting down within a reasonable
 73               amount of time.  For example, a provider that is not responding
 74               to requests, or a provider that is servicing a long-running CIM
 75               request.  To handle such situations and to ensure that the CIM Server
 76               can be shutdown without having the user wait a long period of time
 77               (or indefinitely), a shutdown timeout value is used.
 78               .PP
 79               The shutdown timeout value is the maximum amount of time (in seconds) 
 80               the user is willing to wait for the CIM Server to complete all the 
 81               outstanding CIM operation requests before shutting down the CIM Server.
 82               If the specified shutdown timeout period expires, the CIM Server will be 
 83               shutdown even if there are CIM operations in progress.  
 84               The shutdown timeout value is a CIM Server configuration property
 85               (\c
 86 kumpf     1.2 .B shutdownTimeout )
 87               that can be changed using the 
 88               .CR cimconfig
 89               command.  The default shutdown timeout value is 10 seconds.  
 90               .PP
 91               A timeout value (in seconds) can be specified in the 
 92               .B cimserver
 93               command to shutdown the CIM Server using the 
 94               .RC < shutdownTimeout\c
 95               .RI = value > 
 96               syntax.  This overrides the
 97               default shutdown timeout value.  The minimum timeout value is 2 seconds.
 98               .PP
 99               While CIM Server is shutting down, a client connection request
100               will result in a connection error (the same as if the CIM Server
101               were not running).  For clients who have already established a
102               connection to the CIM Server, new CIM requests will be rejected
103               with a CIM error indicating that the CIM Server is shutting down.
104               .PP
105               When a client receives a response containing a CIM error indicating
106               that the CIM Server is shutting down, it should close the
107 kumpf     1.2 connection and reconnect to CIM Server at a later time.
108               .SS Options
109               .PP
110               The 
111               .B cimserver
112               command recognizes the following options:
113               .RS
114               .TP 15
115               .B -v
116               Display the version number of the CIM Server.
117               .TP
118               .B -h
119               Display the command usage.
120               .TP
121               .B -s
122               Stop the CIM Server. 
123               .TP
124               .CI shutdownTimeout= value
125               Specify the timeout value for shutting down the CIM Server.
126               This can only be used in conjunction with the 
127               .B -s 
128 kumpf     1.2 option.  The
129               minimum timeout value is 2 seconds.  If this is not specified,
130               the default configurable timeout value will be used.
131               .TP
132               .IR configProperty=value
133               Set the value for the specified configuration property to be used in
134               starting the CIM Server.  
135               .SH EXIT STATUS
136               .PP
137               The 
138               .B cimserver 
139               command returns one of the following values:
140               .RS
141               .TP
142               .B 0
143               Success
144               .PD 0
145               .TP
146               .B 1 
147               Error
148               .PD
149 kumpf     1.2 .RE
150               .PP
151               When an error occurs, an error message is written to stderr and an error
152               value of 1 is returned.
153               .SH DIAGNOSTICS
154               .PP
155               .B "unable to connect to CIM Server.  CIM Server may not be running."
156               .IP
157               The 
158               .B cimserver
159               command was issued to stop the CIM Server when CIM Server was not running.

160 aruran.ms 1.3 An exit status value of 1 is returned.  

161 kumpf     1.2 .PP
162               .B "Error: Bind failed: Failed to bind socket." 
163               .IP
164               The 
165               .B cimserver
166               command was issued to start the CIM Server and the CIM Server was already running.

167 aruran.ms 1.3 An exit status value of 1 is returned.

168 kumpf     1.2 .SH EXAMPLES 
169               .PP
170               Stop the CIM Server with the default timeout value of 10 seconds.
171               .IP
172               .B "cimserver -s"
173               .PP
174               Stop the CIM Server with a timeout value of 5 seconds.
175               .IP
176               .B "cimserver -s shutdownTimeout=5"
177               .PP
178               Start the CIM Server.
179               .IP
180               .B cimserver
181               .PP
182               Start the CIM Server with the configuration
183               property 
184               .B enableNamespaceAuthorization
185               set to true.
186               .IP
187               .B "cimserver enableNamespaceAuthorization=true"
188               .PP
189 kumpf     1.2 Display the version number of the CIM Server.  This version number is used
190               to identify the release version of the CIM Server in the HP WBEM Services
191               product.
192               .IP
193               .B "cimserver -v"
194               .PP
195               Display the command usage.
196               .IP
197               .B "cimserver -h"
198               .SH SEE ALSO 
199               .PP
200               cimconfig(1M).