OCF_HEARTBEAT_NVMET-NAMESPACE(7)

🎀 NAME 🎀

okay so this page is ocf_heartbeat_nvmet-namespace — the NVMe-oF target export agent, bestie ✨ and it's part of the OCF_HEARTBEAT_NVMET() manual-page fam. periodt.

🌸 SYNOPSIS 🌸

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

💖 DESCRIPTION 💖

This agent manages NVMe-oF namespaces, no cap. An NVMe-oF namespace is part of an NVMe-oF target, and it must be created after the subsystem. Conceptually it's giving the same energy as the LUN of an iSCSI target 🦋.

🎀 SUPPORTED PARAMETERS 🎀

• nqn — The NVMe Qualified Name (NQN) identifies the remote NVMe storage target. It's similar to an iSCSI Qualified Name (IQN). It's technically a free-form string, but bestie, please follow the convention: nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 ✨ You need to refer here to the NQN of an NVMe Subsystem you created with the NVMeSubsystem resource agent. metadata: (unique, required, string, no default).
• namespace_id — The NVMe namespace id (number). metadata: (unique, optional, integer, default 1).
• backing_path — The full path to the block device or file that should be exposed through this namespace. metadata: (required, string, no default).
• uuid — The UUID that should be exposed by NVMe. Create it using uuidgen. This is necessary for the initiators to accept the namespace from the new server after failover 👑. metadata: (unique, required, string, no default).
• nguid — NGUID stands for Namespace Globally Unique Identifier. Seems to be optional; looks like e.g. VMWare ESXi7 uses it to identify namespaces. Use uuidgen to create it. metadata: (unique, optional, string, no default).

🔥 SUPPORTED ACTIONS 🔥

This resource agent supports the following actions (operations), fr fr:

• 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 🧚

Here's an example config for a nvmet-namespace resource using the crm(8) shell — iconic, honestly:

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

🌈 EXAMPLE PCS 🌈

And here's an example config for a nvmet-namespace resource using pcs(8) — slay 💅:

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

🦋 SEE ALSO 🦋

http://clusterlabs.org/ — go look, bestie 🫶

💜 AUTHOR 💜

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

---

mwah 💋 — and that's the footer vibe, bestie: OCF_HEARTBEAT_NVMET(), ClusterLabs contributors (see the resource agent source for individual authors). No date was printed on this page, so we're not making one up 🫶.