'\" t
.\"     Title: ocf_heartbeat_AoEtarget
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/13/2023
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.12.0-2
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_AOETAR" "7" "04/13/2023" "resource-agents 4.12.0-2" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_AoEtarget \- Manages ATA\-over\-Ethernet (AoE) target exports
.SH "SYNOPSIS"
.HP \w'\fBAoEtarget\fR\ 'u
\fBAoEtarget\fR [start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource agent manages an ATA\-over\-Ethernet (AoE) target using vblade\&. It exports any block device, or file, as an AoE target using the specified Ethernet device, shelf, and slot number\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBdevice\fR
.RS 4
The local block device (or file) to export as an AoE target\&.
.sp
(required, string, no default)
.RE
.PP
\fBnic\fR
.RS 4
The local Ethernet interface to use for exporting this AoE target\&.
.sp
(required, string, default "eth0")
.RE
.PP
\fBshelf\fR
.RS 4
The AoE shelf number to use when exporting this target\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBslot\fR
.RS 4
The AoE slot number to use when exporting this target\&.
.sp
(required, integer, no default)
.RE
.PP
\fBpid\fR
.RS 4
The file to record the daemon pid to\&.
.sp
(unique, optional, string, default "/run/resource\-agents/AoEtarget\-RESOURCE_ID\&.pid")
.RE
.PP
\fBbinary\fR
.RS 4
Location of the vblade binary\&.
.sp
(optional, string, default "/usr/sbin/vblade")
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 15s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 15s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 15s\&. Suggested interval: 10s\&.
.RE
.PP
\fBreload\fR
.RS 4
Suggested minimum timeout: 15s\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5s\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 15s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a AoEtarget resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_AoEtarget ocf:heartbeat:AoEtarget \e
  params \e
    device=\fIstring\fR \e
    nic="eth0" \e
    slot=\fIinteger\fR \e
  op monitor timeout="15s" interval="10s" depth="0" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a AoEtarget resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_AoEtarget ocf:heartbeat:AoEtarget \e
  device=\fIstring\fR \e
  nic="eth0" \e
  slot=\fIinteger\fR \e
  op monitor timeout="15s" interval="10s" OCF_CHECK_LEVEL="0" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\m[blue]\fB\%http://clusterlabs.org/\fR\m[]
.SH "AUTHOR"
.PP
\fBClusterLabs contributors (see the resource agent source for information about individual authors)\fR