NAME

       ocf_heartbeat_nvmet-namespace - NVMe-oF target export agent

SYNOPSIS

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

DESCRIPTION

       Manages NVMe-oF namespaces. An NVMe-oF namespace is part of an NVMe-oF target. A namespace
       must be created after the subsystem. It is similar in concept to the LUN of an iSCSI
       target.

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 You
           need to refer here to the NQN of an NVMe Subsystem your created with the NVMeSubsystem
           resource agent.

           (unique, required, string, no default)

       namespace_id
           The NVMe namespace id (number).

           (unique, optional, integer, default 1)

       backing_path
           The full path to the block device or file that should be exposed through this
           namespace.

           (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.

           (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.

           (unique, 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-namespace resource using the crm(8)
       shell:

           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

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

           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/

AUTHOR

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