OCF_HEARTBEAT_ISCSIT(7)

πŸŽ€ NAME πŸŽ€

Hiii bestie πŸ’– welcome to OCF_HEARTBEAT_ISCSIT(7) from the OCF resource agents crew. This is the page for ocf_heartbeat_iSCSITarget β€” iSCSI target export agent.

✨ SYNOPSIS ✨

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

πŸ’« DESCRIPTION πŸ’«

Okay so this one manages iSCSI targets. An iSCSI target is a collection of SCSI Logical Units (LUs) exported via a daemon that speaks the iSCSI protocol. That's the whole vibe.

🌸 SUPPORTED PARAMETERS 🌸

Here are all the knobs, no skips:

  • implementation β€” the iSCSI target daemon implementation. Must be one of "iet", "tgt", "lio", "lio-t", or "scst". If it’s unspecified, an implementation gets selected 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 it’s 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 implementations. (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 target implementation allows. If this parameter is empty or not set, access to this target will be allowed from any initiator. (optional, string, no default)
  • incoming_username β€” a username used for incoming initiator authentication. If it’s unspecified, allowed initiators will be able to log in without authentication. This one is unique β€” you’re 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 interface. 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 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 🐚

Here’s an example config for an 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 πŸŽ€

Same energy, but with pcs(8):

pcs resource create p_iSCSITarget ocf:heartbeat:iSCSITarget \
  iqn=string \
  op monitor timeout="10s" interval="10s" OCF_CHECK_LEVEL="0"

🌈 SEE ALSO 🌈

The one and only link, bestie: http://clusterlabs.org/

πŸ’œ AUTHOR πŸ’œ

ClusterLabs contributors (see the resource agent source for information about individual authors).


source/version: resource-agents UNKNOWN Β· date: 10/01/2026 β€” k bye bestie, go slay those iSCSI targets πŸ«ΆπŸ’…βœ¨

πŸ“¦ where this page comes from