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

  
 
  

home | help
OCF_HEARTBEAT_ISCSIT(7)        OCF resource agents	 OCF_HEARTBEAT_ISCSIT(7)

NAME
     ocf_heartbeat_iSCSITarget - iSCSI target export agent

SYNOPSIS
     iSCSITarget [start | stop | status | monitor | meta-data | validate-all]

DESCRIPTION
     Manages  iSCSI  targets.  An  iSCSI  target is a collection of SCSI Logical
     Units (LUs) exported via a daemon that speaks the iSCSI protocol.

SUPPORTED PARAMETERS
     implementation
	 The iSCSI target daemon implementation. Must be one  of  "iet",  "tgt",
	 "lio",  "lio-t",  or  "scst".	If unspecified, an implementation is se-
	 lected based on the availability of management  utilities,  with  "iet"
	 being tried first, then "tgt", then "lio", then "lio-t", then "scst".

	 (optional, string, no default)

     iqn
	 The  target  iSCSI Qualified Name (IQN). Should follow the conventional
	 "iqn.yyyy-mm.<reversed domain name>[:identifier]" syntax.

	 (unique, required, string, no default)

     tid
	 The iSCSI target ID. Required for tgt.

	 (unique, optional, integer, no default)

     portals
	 iSCSI network portal addresses. Not supported by  all	implementations.
	 If unset, the default is to create one portal that listens on .

	 (optional, string, default "0.0.0.0:3260")

     iser_portals
	 iSCSI	iSER  network portal addresses. Not supported by all implementa-
	 tions.

	 (optional, string, no default)

     allowed_initiators
	 Allowed initiators. A space-separated list  of  initiators  allowed  to
	 connect to this target. Initiators may be listed in any syntax the tar-
	 get  implementation  allows. If this parameter is empty or not set, ac-
	 cess to this target will be allowed from any initiator.

	 (optional, string, no default)

     incoming_username
	 A username used for incoming initiator authentication. If  unspecified,
	 allowed  initiators will be able to log in without authentication. This
	 is a unique parameter, as it not allowed to re-use  a	single	username
	 across multiple target instances.

	 (unique, optional, string, no default)

     incoming_password
	 A password used for incoming initiator authentication.

	 (optional, string, no default)

     additional_parameters
	 Additional  target  parameters.  A space-separated list of "name=value"
	 pairs which will be passed through to the iSCSI daemon's management in-
	 terface. The supported parameters are implementation dependent. Neither
	 the name nor the value may contain whitespace.

	 (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  in-
	 terval: 10s.

     monitor
	 Performs  a detailed status check. Suggested minimum timeout: 10s. Sug-
	 gested interval: 10s.

     meta-data
	 Retrieves resource agent metadata (internal use only). Suggested  mini-
	 mum 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 iSCSITarget resource  using
     the crm(8) shell:

	 primitive p_iSCSITarget ocf:heartbeat:iSCSITarget \
	   params \
	     iqn=string \
	   op monitor timeout="10s" interval="10s" depth="0"

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

	 pcs resource create p_iSCSITarget ocf:heartbeat:iSCSITarget \
	   iqn=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)

resource-agents 4.13.0		   08/27/2026		 OCF_HEARTBEAT_ISCSIT(7)

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

home | help