'\" t
.\"     Title: ocf_heartbeat_iface-vlan
.\"    Author: ClusterLabs contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 03/20/2024
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IFACE\" "7" "03/20/2024" "resource-agents UNKNOWN" "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_iface-vlan \- Manages VLAN network interfaces\&.
.SH "SYNOPSIS"
.HP \w'\fBiface\-vlan\fR\ 'u
\fBiface\-vlan\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource manages VLAN network interfaces\&. It can add, remove, configure VLANs\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBvlan_interface\fR
.RS 4
Define the interface where VLAN should be attached\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBvlan_id\fR
.RS 4
Define the VLAN ID\&. It has to be a value between 0 and 4094\&.
.sp
(unique, required, integer, no default)
.RE
.PP
\fBvlan_name\fR
.RS 4
Define the name of the VLAN interface (max 15 charaters)\&.
.sp
(unique, optional, string, default "vlan_interface\&.vlan\&.id")
.RE
.PP
\fBvlan_reorder_hdr\fR
.RS 4
Enable or disable header reordering\&.
.sp
(optional, boolean, default
1)
.RE
.PP
\fBvlan_gvrp\fR
.RS 4
Enable or disable GARP VLAN registration protocol\&.
.sp
(optional, boolean, default
0)
.RE
.PP
\fBvlan_mvrp\fR
.RS 4
Enable or disable Multiple VLAN Registration Protocol\&. Please note that most distributions do not ship a version of iproute2 that supports mvrp yet, even if the kernel has support for it\&. Check output of link add type vlan \-\-help in the FLAG section to verify if mvrp support is available\&.
.sp
(optional, boolean, default
0)
.RE
.PP
\fBvlan_loose_binding\fR
.RS 4
Enable or disable VLAN loose bind\&. By default the VLAN interface admin status (UP/DOWN) follows the underneath interface status\&. Enabling loose bind allows the VLAN to disconnect from the interface status\&. Be very careful that enabling loose binding could invalidate this agent monitor operations\&. Please note that most distributions do not ship a version of iproute2 that supports loose_binding yet, even if the kernel has support for it\&. Check output of link add type vlan \-\-help in the FLAG section to verify if loose_binding support is available\&.
.sp
(optional, boolean, default
0)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 30s\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 20s\&.
.RE
.PP
\fBstatus\fR
.RS 4
Performs a status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 20s\&. Suggested interval: 10s\&.
.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: 20s\&.
.RE
.SH "EXAMPLE CRM SHELL"
.PP
The following is an example configuration for a iface\-vlan resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_iface\-vlan ocf:heartbeat:iface\-vlan \e
  params \e
    vlan_interface=\fIstring\fR \e
    vlan_id=\fIinteger\fR \e
  op monitor timeout="20s" depth="0" interval="10s" 
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLE PCS"
.PP
The following is an example configuration for a iface\-vlan resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_iface\-vlan ocf:heartbeat:iface\-vlan \e
  vlan_interface=\fIstring\fR \e
  vlan_id=\fIinteger\fR \e
  op monitor timeout="20s" depth="0" interval="10s" 
.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
