ocf_heartbeat_nvmet-namespace(7)

1OCF_HEARTBEAT_NVMET()                                    OCF_HEARTBEAT_NVMET()
2
3
4

NAME

6       ocf_heartbeat_nvmet-namespace - NVMe-oF target export agent
7

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

18       nqn
19           The NVMe Qualified Name (NQN) is used to identify the remote NVMe
20           storage target. It is similar to an iSCSI Qualified Name (IQN).
21           While it is a free-form string, you should follow the convention:
22           nqn.2014-08.com.vendor:nvme:nvm-subsystem-sn-12345 You need to
23           refer here to the NQN of an NVMe Subsystem your created with the
24           NVMeSubsystem resource agent.
25
26           (unique, required, string, no default)
27
28       namespace_id
29           The NVMe namespace id (number).
30
31           (unique, optional, integer, default 1)
32
33       backing_path
34           The full path to the block device or file that should be exposed
35           through this namespace.
36
37           (required, string, no default)
38
39       uuid
40           The UUID that should be exposed by NVMe. Create it using uuidgen.
41           This is necessary for the initiators to accept the namespace from
42           the new server after failover.
43
44           (unique, required, string, no default)
45
46       nguid
47           NGUID stands for Namespace Globally Unique Identifier. Seems to be
48           optional, looks like e.g. VMWare ESXi7 uses it to identify
49           namespaces. Use 'uuidgen' to create it.
50
51           (unique, optional, string, no default)
52

SUPPORTED ACTIONS

54       This resource agent supports the following actions (operations):
55
56       start
57           Starts the resource. Suggested minimum timeout: 10s.
58
59       stop
60           Stops the resource. Suggested minimum timeout: 10s.
61
62       status
63           Performs a status check. Suggested minimum timeout: 10s. Suggested
64           interval: 10s.
65
66       monitor
67           Performs a detailed status check. Suggested minimum timeout: 10s.
68           Suggested interval: 10s.
69
70       meta-data
71           Retrieves resource agent metadata (internal use only). Suggested
72           minimum timeout: 5s.
73
74       validate-all
75           Performs a validation of the resource configuration. Suggested
76           minimum timeout: 10s.
77

EXAMPLE CRM SHELL

79       The following is an example configuration for a nvmet-namespace
80       resource using the crm(8) shell:
81
82           primitive p_nvmet-namespace ocf:heartbeat:nvmet-namespace \
83             params \
84               nqn=string \
85               backing_path=string \
86               uuid=string \
87             op monitor timeout="10s" interval="10s" depth="0"
88

EXAMPLE PCS

90       The following is an example configuration for a nvmet-namespace
91       resource using pcs(8)
92
93           pcs resource create p_nvmet-namespace ocf:heartbeat:nvmet-namespace \
94             nqn=string \
95             backing_path=string \
96             uuid=string \
97             op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
98

AUTHOR

103       ClusterLabs contributors (see the resource agent source for information
104       about individual authors)
105
106
107
108                                                         OCF_HEARTBEAT_NVMET()