ocf_heartbeat_nvmet-port(7)

1OCF_HEARTBEAT_NVMET()                                    OCF_HEARTBEAT_NVMET()
2
3
4

NAME

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

SYNOPSIS

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

DESCRIPTION

12       Manages NVMe-oF ports. An NVMe-oF port is part of an NVMe-oF target. A
13       port must be created after the subsystem. It exposes one or multiple
14       subsystem(s) including the enclosed namespace(s) to the network.
15

SUPPORTED PARAMETERS

17       port_id
18           The NVMe port number is a 16 bit number.
19
20           (unique, optional, integer, default 0)
21
22       type
23           The NVMe transport type. Should be one of 'tcp', 'rdma', 'fc' or
24           'loop'.
25
26           (optional, string, default "tcp")
27
28       addr_fam
29           The address family of the address. Should be 'ipv4', 'ipv6' or
30           'fc'.
31
32           (optional, string, default "ipv4")
33
34       svcid
35           The transport service identifier. The TCP/IP port number this
36           target binds to, or its RDMA protocol equivalent.
37
38           (optional, integer, default 4420)
39
40       addr
41           The transport address. The TCP/IP address this targets binds to, or
42           its RDMA protocol equivalent.
43
44           (required, string, no default)
45
46       nqns
47           A space-separated list of NQNs that should be exported through this
48           NVMe-oF-Target port. This list needs to have at least one entry.
49
50           (required, string, no default)
51

SUPPORTED ACTIONS

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

EXAMPLE CRM SHELL

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

EXAMPLE PCS

88       The following is an example configuration for a nvmet-port resource
89       using pcs(8)
90
91           pcs resource create p_nvmet-port ocf:heartbeat:nvmet-port \
92             addr=string \
93             nqns=string \
94             op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"
95

AUTHOR

100       ClusterLabs contributors (see the resource agent source for information
101       about individual authors)
102
103
104
105                                                         OCF_HEARTBEAT_NVMET()