mmmsgqueue command
Manages the IBM Spectrum Scale™ message queue.
Synopsis
mmmsgqueue enable { -N NodeName[,NodeName...] | NodeFile | NodeClass } [-q]or
mmmsgqueue disable [-q]or
mmmsgqueue status [-q]or
mmmsgqueue list { --topics | --servers} [-q]or
mmmsgqueue config --remove [-q]Availability
Available with IBM Spectrum Scale Advanced Edition or IBM Spectrum Scale Data Management Edition. Available on Linux X86 and Linux PPC LE.
Description
The mmmsgqueue command is used to manage the IBM Spectrum Scale message queue. The queue is based on the Kafka open source queue and is contained in the Kafka rpms. The message queue is used by the file audit logging function to track events. Error and informational messages are written to the /var/adm/ras/mmmsgqueue.log file on the node from which the command is issued and any nodes where sub-commands are executed.
Parameters
- mmmsgqueue enable
- Enables the IBM Spectrum Scale message
queue. The message queue ZooKeeper daemons are started on the nodes defined by the
kafkaZookeeperServers node class.
This defaults to Linux nodes in the cluster that are defined as quorum nodes that have the message queue packages installed.
There must be at least three Linux quorum nodes with the message queue packages installed. The message queue broker daemons will be started on the nodes
defined by the kafkaBrokerServers node class. This defaults to the nodes
defined by the cesNodes node class. There must be at least three nodes defined.
If your environment does not have the cesNodes node class defined or it has
fewer than three nodes defined, you can specify the nodes to start the broker daemons by using the
-N option. The -N option supports a comma separated list
of nodes, a full pathname to a file containing node names, or a predefined node class. No matter how they are defined, you must specify a minimum of three nodes as message queue servers/brokers nodes. These nodes must be Linux-based and have the message queue packages installed on them. There are four callbacks defined to manage the message queue
daemons. - mmmsgqueue disable
- Disables the IBM Spectrum Scale message queue. All file systems must be disabled for file audit logging. Stops any broker or ZooKeeper daemons that might be running. Deletes message queue callbacks. Node classes and configuration files remain defined. To completely remove all configuration data, issue mmmsgqueue config --remove.
- mmmsgqueue status
- Provides the status of all broker and ZooKeeper daemons and shows which nodes contain which daemons.
- mmmsqueue list { --topics | --servers }
- Lists all message queue topics currently configured or a comma-separated list of the broker nodes with their respective ports. You should see a topic defined for every file system that is enabled for file audit logging. The message queue uses an internal topic called __consumer_offsets.
- mmmsgqueue config --remove
- Disables the message queue if enabled. All file systems
must be disabled for file audit logging. Removes the node classes and message queue
configuration files that were created to support the message queue.
- -q
- Suppresses all [I] informational messages.
Exit status
- 0
- Successful completion.
- nonzero
- A failure has occurred.
Security
You must have root authority to run the mmmsgqueue command.
The node on which the command is issued must be able to execute remote shell commands on any other node in the cluster without the use of a password and without producing any extraneous messages.
Examples
- To enable the message queue on a cluster that does not have the cesNodes
node class defined or has fewer than three nodes defined, issue this
command:
# mmmsgqueue enable -N hs22n55,hs22n56,c6f2bc3n10,c6f2bc3n2 [I] The kafkaZookeeperServers node class was successfully created with 3 member nodes. [I] The kafkaBrokerServers node class was successfully created with 4 member nodes. [I] Successfully created Kafka broker configuration file and added to CCR. [I] Successfully created Kafka ZooKeeper configuration file and added to CCR. [I] Enabling MsgQueue daemons. [I] Creating callbacks to control starting and stopping the MsgQueue daemons. [I] MsgQueue successfully enabled. - To display the current status of the message queue daemons, issue this
command:
# mmmsgqueue status Node Contains Broker Contains ZooKeeper Name Broker Status ZooKeeper Status c6f2bc3n10.gpfs.net yes good yes good c6f2bc3n2.gpfs.net yes good no hs22n55.gpfs.net yes good yes good hs22n56.gpfs.net yes good yes good - To display the defined message queue topics, issue this
command:
# mmmsgqueue list --topics 154_6372129557625143312_audit __consumer_offsets [I] Successfully completed running topic command: list. - To disable the message queue, issue this
command:
# mmmsgqueue disable [I] Disabling MsgQueue daemons. [I] Removing callbacks that control starting and stopping the MsgQueue daemons. [I] MsgQueue successfully disabled. - To disable and remove message queue node classes, callbacks, and configuration files, issue this
command:
# mmmsgqueue config --remove [I] Attempting to disable the MsgQueue. This may take some time. [I] Disabling MsgQueue daemons. [I] Removing callbacks that control starting and stopping the MsgQueue daemons. [I] MsgQueue successfully disabled. [I] Removing MsgQueue node classes and configuration information. [I] MsgQueue successfully disabled and configuration removed.