Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
OCF_HEARTBEAT_NVMET()					 OCF_HEARTBEAT_NVMET()

NAME
       ocf_heartbeat_nvmet-subsystem - NVMe-oF target export agent

SYNOPSIS

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

DESCRIPTION
       Manages NVMe-oF subsystems. An NVMe-oF subsystem	is part	of an NVMe-oF
       target. A subsystem must	be created first, before namespace(s) and
       port(s).

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

	   (unique, required, string, no default)

       allowed_initiators
	   Allowed initiators. A space-separated list of initiators allowed to
	   connect to this target. Initiators are identified by	their NQN. If
	   the list is empty, any initiator will be allowed to connect.

	   (optional, string, no default)

       serial
	   The serial of the subsystem.	Set it to a random 16 character	hex
	   value. Use hexdump -n 8 -e '4/4 "%08x" 1 "\n"' /dev/urandom

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

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

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

	   pcs resource	create p_nvmet-subsystem ocf:heartbeat:nvmet-subsystem \
	     nqn=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)

							 OCF_HEARTBEAT_NVMET()

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_nvmet-subsystem&sektion=7&manpath=FreeBSD+Ports+14.3.quarterly>

home | help