ocf_heartbeat_nvmet-subsystem(7)

1OCF_HEARTBEAT_NVMET()                                    OCF_HEARTBEAT_NVMET()
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

13       Manages NVMe-oF subsystems. An NVMe-oF subsystem is part of an NVMe-oF
14       target. A subsystem must be created first, before namespace(s) and
15       port(s).
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
23
24           (unique, required, string, no default)
25
26       allowed_initiators
27           Allowed initiators. A space-separated list of initiators allowed to
28           connect to this target. Initiators are identified by their NQN. If
29           the list is empty, any initiator will be allowed to connect.
30
31           (optional, string, no default)
32
33       serial
34           The serial of the subsystem. Set it to a random 16 character hex
35           value. Use hexdump -n 8 -e '4/4 "%08x" 1 "\n"' /dev/urandom
36
37           (optional, string, no default)
38

SUPPORTED ACTIONS

40       This resource agent supports the following actions (operations):
41
42       start
43           Starts the resource. Suggested minimum timeout: 10s.
44
45       stop
46           Stops the resource. Suggested minimum timeout: 10s.
47
48       status
49           Performs a status check. Suggested minimum timeout: 10s. Suggested
50           interval: 10s.
51
52       monitor
53           Performs a detailed status check. Suggested minimum timeout: 10s.
54           Suggested interval: 10s.
55
56       meta-data
57           Retrieves resource agent metadata (internal use only). Suggested
58           minimum timeout: 5s.
59
60       validate-all
61           Performs a validation of the resource configuration. Suggested
62           minimum timeout: 10s.
63

EXAMPLE CRM SHELL

65       The following is an example configuration for a nvmet-subsystem
66       resource using the crm(8) shell:
67
68           primitive p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \
69             params \
70               nqn=string \
71             op monitor timeout="10s" interval="10s" depth="0"
72

EXAMPLE PCS

74       The following is an example configuration for a nvmet-subsystem
75       resource using pcs(8)
76
77           pcs resource create p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \
78             nqn=string \
79             op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
80

AUTHOR

85       ClusterLabs contributors (see the resource agent source for information
86       about individual authors)
87
88
89
90                                                         OCF_HEARTBEAT_NVMET()