OCF_HEARTBEAT_NVMET-SUBSYSTEM(7)

✨ NAME ✨

ocf_heartbeat_nvmet-subsystem — the NVMe-oF target export agent. Also hi bestie, this is the OCF_HEARTBEAT_NVMET(7) manual page energy, with the header/title OCF_HEARTBEAT_NVMET() folded right in here so we don't have to do a whole boring first line, periodt 👑.

🦋 SYNOPSIS 🦋

nvmet-subsystem [start | stop | status | monitor | meta-data |
                validate-all]

🌸 DESCRIPTION 🌸

This agent manages NVMe-oF subsystems. An NVMe-oF subsystem is part of an NVMe-oF target. A subsystem must be created first, before namespace(s) and port(s) — that's the required order, bestie 💅.

🎀 SUPPORTED PARAMETERS 🎀

• nqn — The NVMe Qualified Name (NQN) is used to identify the remote NVMe storage target. It is similar to an iSCSI Qualified Name (IQN). While it is a free-form string, you should follow the convention:

nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345

This one is (unique, required, string, no default) — required, no default, no cap 💖.

• allowed_initiators — Allowed initiators. A space-separated list of initiators allowed to connect to this target. Initiators are identified by their NQN. If the list is empty, any initiator will be allowed to connect. This one is (optional, string, no default) 🦋.
• serial — The serial of the subsystem. Set it to a random 16 character hex value. Use hexdump -n 8 -e '4/4 "%08x" 1 "\n"' /dev/urandom. This one is (optional, string, no default) ✨.

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations):

• start — Starts the resource. Suggested minimum timeout: 10s.
• stop — Stops the resource. Suggested minimum timeout: 10s.
• status — Performs a status check. Suggested minimum timeout: 10s. Suggested interval: 10s.
• monitor — Performs a detailed status check. Suggested minimum timeout: 10s. Suggested interval: 10s.
• meta-data — Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.
• validate-all — Performs a validation of the resource configuration. Suggested minimum timeout: 10s.

💖 EXAMPLE CRM SHELL 💖

The following is an example configuration for a nvmet-subsystem resource using the crm(8) shell:

primitive p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \
  params \
    nqn=string \
  op monitor timeout="10s" interval="10s" depth="0"

🌈 EXAMPLE PCS 🌈

The following is an example configuration for a nvmet-subsystem resource using pcs(8)

pcs resource create p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \
  nqn=string \
  op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"

🫶 SEE ALSO 🫶

http://clusterlabs.org/

👑 AUTHOR 👑

ClusterLabs contributors (see the resource agent source for information about individual authors)

---

Okay, that's the whole page, bestie! The manual name is OCF_HEARTBEAT_NVMET, and the footer in this copy is just OCF_HEARTBEAT_NVMET() — no separate source, version, or date text appears beyond that, so that's the cute sign-off 💖🎀🦋.