pegasus/rpm/manLinux/man8.Z/cimserver.8 - annotate

Return to cimserver.8 CVS log

Up to [Pegasus] / pegasus / rpm / manLinux / man8.Z

1 aruran.ms 1.3 .\" $Header: /cvs/MSB/pegasus/rpm/manLinux/man8.Z/cimserver.8,v 1.2 2005/01/03 11:11:35 a.arora Exp $
2 denise.eckstein 1.1 .TA c \" lowercase initial letter of .TH name 3 .TH cimserver 8 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 a.arora 1.2 18 .B cimserver --help 19 20 .B cimserver --version
21 denise.eckstein 1.1 .SS Remarks 22 This command can only be executed by a privileged user. 23 .SH DESCRIPTION 24 .PP 25 The 26 .B cimserver 27 command provides a command line interface to stop 28 and start the CIM Server, as well as to display the version number 29 of the CIM Server. 30 .PP 31 After installation, the CIM Server must be started using the 32 .B cimserver 33 command. If the system is rebooted, the CIM Server 34 will automatically restart, with the exception of the case 35 where the CIM Server was shutdown prior to the reboot. Generally, once 36 the CIM Server is started, it is expected to be always running and 37 ready to serve CIM requests. However, if the CIM Server must be 38 stopped and restarted, the 39 .B cimserver 40 command can be used to shutdown 41 the CIM Server gracefully and restart it at a later time. 42 denise.eckstein 1.1 .SS Starting the CIM Server 43 .PP 44 Issuing the 45 .B cimserver 46 command without any options starts the 47 CIM Server process. 48 .PP 49 When starting the CIM Server using the 50 .B cimserver 51 command, the 52 .RI < configProperty\c 53 .RI = value > 54 syntax can be used to set the configuration properties to be used by the CIM Server. 55 It is important to know that the values specified in the 56 .B cimserver 57 command apply only to the current CIM Server process 58 that gets started. The default values for the configuration 59 properties do not change. For a list of the CIM Server configuration 60 properties, see the man page for the 61 .B cimconfig 62 command. 63 denise.eckstein 1.1 .SS Shutting down the CIM Server 64 .PP 65 Issuing the 66 .B cimserver 67 command with the 68 .B -s 69 option stops the CIM Server. Optionally, a timeout value can be specified 70 by setting the 71 .B shutdownTimeout 72 configuration property. 73 .PP 74 Under normal operation, CIM Server should be able to be shutdown 75 fairly quickly without problem. There are, however, situations 76 that may prevent CIM Server from shutting down within a reasonable 77 amount of time. For example, a provider that is not responding 78 to requests, or a provider that is servicing a long-running CIM 79 request. To handle such situations and to ensure that the CIM Server 80 can be shutdown without having the user wait a long period of time 81 (or indefinitely), a shutdown timeout value is used. 82 .PP 83 The shutdown timeout value is the maximum amount of time (in seconds) 84 denise.eckstein 1.1 the user is willing to wait for the CIM Server to complete all the 85 outstanding CIM operation requests before shutting down the CIM Server. 86 If the specified shutdown timeout period expires, the CIM Server will be 87 shutdown even if there are CIM operations in progress. 88 The shutdown timeout value is a CIM Server configuration property 89 (\c 90 .B shutdownTimeout ) 91 that can be changed using the 92 .CR cimconfig 93 command. The default shutdown timeout value is 10 seconds. 94 .PP 95 A timeout value (in seconds) can be specified in the 96 .B cimserver 97 command to shutdown the CIM Server using the 98 .RC < shutdownTimeout\c 99 .RI = value > 100 syntax. This overrides the 101 default shutdown timeout value. The minimum timeout value is 2 seconds. 102 .PP 103 While CIM Server is shutting down, a client connection request 104 will result in a connection error (the same as if the CIM Server 105 denise.eckstein 1.1 were not running). For clients who have already established a 106 connection to the CIM Server, new CIM requests will be rejected 107 with a CIM error indicating that the CIM Server is shutting down. 108 .PP 109 When a client receives a response containing a CIM error indicating 110 that the CIM Server is shutting down, it should close the 111 connection and reconnect to CIM Server at a later time. 112 .SS Options 113 .PP 114 The 115 .B cimserver 116 command recognizes the following options: 117 .RS 118 .TP 15
119 a.arora 1.2 .B -v, --version
120 denise.eckstein 1.1 Display the version number of the CIM Server. 121 .TP
122 a.arora 1.2 .B -h, --help
123 denise.eckstein 1.1 Display the command usage. 124 .TP 125 .B -s 126 Stop the CIM Server. 127 .TP 128 .CI shutdownTimeout= value 129 Specify the timeout value for shutting down the CIM Server. 130 This can only be used in conjunction with the 131 .B -s 132 option. The 133 minimum timeout value is 2 seconds. If this is not specified, 134 the default configurable timeout value will be used. 135 .TP 136 .IR configProperty=value 137 Set the value for the specified configuration property to be used in 138 starting the CIM Server. 139 .SH EXIT STATUS 140 .PP 141 The 142 .B cimserver 143 command returns one of the following values: 144 denise.eckstein 1.1 .RS 145 .TP 146 .B 0 147 Success 148 .PD 0 149 .TP 150 .B 1 151 Error 152 .PD 153 .RE 154 .PP 155 When an error occurs, an error message is written to stderr and an error 156 value of 1 is returned. 157 .SH DIAGNOSTICS 158 .PP 159 .B "unable to connect to CIM Server. CIM Server may not be running." 160 .IP 161 The 162 .B cimserver 163 command was issued to stop the CIM Server when CIM Server was not running.
164 aruran.ms 1.3 An exit status value of 1 is returned.
165 denise.eckstein 1.1 .PP 166 .B "Error: Bind failed: Failed to bind socket." 167 .IP 168 The 169 .B cimserver 170 command was issued to start the CIM Server and the CIM Server was already running.
171 aruran.ms 1.3 An exit status value of 1 is returned.
172 denise.eckstein 1.1 .SH EXAMPLES 173 .PP 174 Stop the CIM Server with the default timeout value of 10 seconds. 175 .IP 176 .B "cimserver -s" 177 .PP 178 Stop the CIM Server with a timeout value of 5 seconds. 179 .IP 180 .B "cimserver -s shutdownTimeout=5" 181 .PP 182 Start the CIM Server. 183 .IP 184 .B cimserver 185 .PP 186 Start the CIM Server with the configuration 187 property 188 .B enableNamespaceAuthorization 189 set to true. 190 .IP 191 .B "cimserver enableNamespaceAuthorization=true" 192 .PP 193 denise.eckstein 1.1 Display the version number of the CIM Server. This version number is used 194 to identify the release version of the CIM Server in the OpenPegasus 195 release. 196 .IP 197 .B "cimserver -v" 198 .PP 199 Display the command usage. 200 .IP 201 .B "cimserver -h" 202 .SH SEE ALSO 203 .PP 204 cimconfig(8).

No CVS admin address has been configured