cimserver(8)

💖 cimserver — System Manager's Manual 🎀

okay bestie, this one lives in the System Manager's Manual and it's literally called cimserver. It's the girl who starts and stops the CIM Server, and also tells you her version number and whether she's currently running. 💅

---

✨ NAME ✨

cimserver — start or stop the CIM Server; display the version number or running status of the CIM Server 🦋

---

🌸 SYNOPSIS 🌸

cimserver [configProperty=value] ...

cimserver -s [ shutdownTimeout = value ]

cimserver -v

cimserver -h

cimserver --help

cimserver --version

cimserver --status

🎀 Remarks 🎀

no cap, this command can only be executed by a privileged user. like, that's the vibe check and you have to pass it. 👑

---

💜 DESCRIPTION 💜

The cimserver command is your little command line bestie for stopping and starting the CIM Server, plus showing off the version number or the running status of the CIM Server. she does it all. 💅

After installation, the CIM Server must be started using the cimserver command. If the system gets rebooted, the CIM Server will automatically restart — except in the case where the CIM Server was shutdown before the reboot. Generally, once the CIM Server is started, it's expected to be always running and ready to serve CIM requests. That's her main character era, always on, always serving. ✨ But if the CIM Server has to be stopped and restarted, you can use the cimserver command to shutdown the CIM Server gracefully and restart it at a later time. so polite of her. 🫶

🌈 Starting the CIM Server 🌈

Issuing the cimserver command with no options at all starts the CIM Server process. just raw, no extra. 💖

When you start the CIM Server with the cimserver command, you can use the <configProperty=value> syntax to set the configuration properties the CIM Server will use. Important bestie info incoming: the values you specify in the cimserver command apply only to the current CIM Server process that gets started. The default values for the configuration properties do not change. Not even a little. If you want the list of CIM Server configuration properties, go read the man page for the cimconfig command. iykyk. 📖

🦋 Shutting down the CIM Server 🦋

Issuing the cimserver command with the -s option stops the CIM Server. Optionally you can specify a timeout value by setting the shutdownTimeout configuration property. ✨

Under normal operation, CIM Server should be able to be shutdown fairly quickly without any problem. But — and there's always a but — there are situations that may prevent CIM Server from shutting down within a reasonable amount of time. For example, a provider that is not responding to requests, or a provider that is servicing a long-running CIM request. 🙈 To handle those situations and to make sure the CIM Server can be shutdown without making the user wait a long period of time (or forever, honestly), a shutdown timeout value is used.

The shutdown timeout value is the maximum amount of time (in seconds) the user is willing to wait for the CIM Server to complete all the outstanding CIM operation requests before shutting down the CIM Server. If the specified shutdown timeout period expires, the CIM Server will be shutdown even if there are CIM operations in progress. The shutdown timeout value is a CIM Server configuration property (shutdownTimeout) that can be changed using the command. The default shutdown timeout value is 10 seconds.

A timeout value (in seconds) can be specified in the cimserver command to shutdown the CIM Server using the shutdownTimeout=value syntax. This overrides the default shutdown timeout value. The minimum timeout value is 2 seconds. ⏳

While CIM Server is shutting down, a client connection request will result in a connection error — the same as if the CIM Server were not running at all. For clients who already have a connection established to the CIM Server, new CIM requests will be rejected with a CIM error indicating that the CIM Server is shutting down. 💀

When a client receives a response containing a CIM error saying the CIM Server is shutting down, it should close the connection and reconnect to CIM Server at a later time. like, read the room and come back later bestie. 🫶

💅 Options 💅

The cimserver command recognizes the following options:

• -v, --version — Display the version number or running status of the CIM Server.
• -h, --help — Display the command usage.
• --status — Display the running status of the CIM Server.
• -s — Stop the CIM Server.
• shutdownTimeout=value — Specify the timeout value for shutting down the CIM Server. This can only be used in conjunction with the -s option. The minimum timeout value is 2 seconds. If this is not specified, the default configurable timeout value will be used.
• configProperty=value — Set the value for the specified configuration property to be used in starting the CIM Server.

---

⭐ EXIT STATUS ⭐

The cimserver command returns one of the following values:

• 0 — Success 🎉
• 1 — Error 😭

The cimserver --status command returns one of the following values:

• 0 — The CIM Server is running ✨
• 1 — Error 😭
• 2 — The CIM Server is not running 💀

When an error occurs, an error message is written to stderr and an error value of 1 is returned.

---

🔥 DIAGNOSTICS 🔥

unable to connect to CIM Server. CIM Server may not be running.

• The cimserver command was issued to stop the CIM Server when CIM Server was not running. An exit status value of 1 is returned.

Error: Bind failed: Failed to bind socket.

• The cimserver command was issued to start the CIM Server and the CIM Server was already running. An exit status value of 1 is returned.

---

🌸 EXAMPLES 🌸

Stop the CIM Server with the default timeout value of 10 seconds.

cimserver -s

Stop the CIM Server with a timeout value of 5 seconds.

cimserver -s shutdownTimeout=5

Start the CIM Server.

cimserver

Start the CIM Server with the configuration property enableNamespaceAuthorization set to true.

cimserver enableNamespaceAuthorization=true

Display the version number of the CIM Server. This version number is used to identify the release version of the CIM Server in the OpenPegasus release.

cimserver -v

Display the command usage.

cimserver -h

---

🫶 SEE ALSO 🫶

cimconfig(8).

---

and that's the whole page bestie, footer and all — it's from the System Manager's Manual, and down at the very bottom it just says cimserver(8) again because she's iconic like that. slay, periodt. 👑✨