'\" t
.\"     Title: ocf_heartbeat_iface-bridge
.\"    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: 06/07/2017
.\"    Manual: OCF resource agents
.\"    Source: resource-agents 4.0.0~rc1-4~bpo8+1
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_IFACE\" "7" "06/07/2017" "resource-agents 4.0.0~rc1-4~bp" "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-bridge \- Manages Bridge network interfaces\&.
.SH "SYNOPSIS"
.HP \w'\fBiface\-bridge\fR\ 'u
\fBiface\-bridge\fR [start | stop | status | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
This resource manages Bridge network interfaces\&. It can add, remove, configure bridges and spanning\-tree\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBbridge_name\fR
.RS 4
Define the name of the bridge (max 15 charaters)\&.
.sp
(unique, required, string, no default)
.RE
.PP
\fBbridge_slaves\fR
.RS 4
Define the list of interfaces, space separated, to add to the bridge\&. The list can be empty\&.
.sp
(unique, optional, string, no default)
.RE
.PP
\fBbridge_ageing\fR
.RS 4
Set the ethernet (MAC) address ageing time in seconds\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBport_hairpin\fR
.RS 4
Set hairpin forwarding mode\&. A list of ports that should have hairpin enabled can be specified using the following Example: eth0 eth1
.sp
(optional, string, no default)
.RE
.PP
\fBstp\fR
.RS 4
Enable or disable Spanning Tree Protocol on the bridge\&.
.sp
(optional, boolean, default
false)
.RE
.PP
\fBstp_bridgeprio\fR
.RS 4
Set the bridge\*(Aqs priority to defined value\&. The priority value is a number between 0 and 65535), and has no dimension\&. Lower priority values are preferred\&. The bridge with the lowest priority will be elected as root bridge\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBstp_fd\fR
.RS 4
Set the bridge forward delay (in seconds)\&.
.sp
(optional, integer, default
0)
.RE
.PP
\fBstp_maxage\fR
.RS 4
Set the bridge maximum message age (in seconds)\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBstp_hello\fR
.RS 4
Set the bridge hello time (in seconds)\&.
.sp
(optional, integer, no default)
.RE
.PP
\fBstp_pathcost\fR
.RS 4
Set the port cost\&. This is a dimensionless metric\&. A list of port/cost can be specified using the following format: slave cost slave cost\&. Example: eth0 100 eth1 1000
.sp
(optional, string, no default)
.RE
.PP
\fBstp_portprio\fR
.RS 4
Set the port priority\&. This is a number between 0 and 63\&. brctl man page reports a value between 0 and 255, but tests show a limit of 63 on a live system\&. This metric is used in the designated port and root port selection algorithms\&. A list of port/priority can be specified using the following format: slave cost slave cost\&. Example: eth0 10 eth1 60
.sp
(optional, string, no default)
.RE
.PP
\fBmulticast_router\fR
.RS 4
Enable or disable multicast routing on the bridge\&.
.sp
(optional, boolean, default
1)
.RE
.PP
\fBmulticast_snooping\fR
.RS 4
Enable or disable multicast snooping on the bridge\&.
.sp
(optional, boolean, default
1)
.RE
.PP
\fBmulticast_port_router\fR
.RS 4
Enable or disable a port from the multicast router\&. Kernel enables all port by default\&. A list of port can be specified using the following format: slave 0|1 slave 0|1\&. Example: eth0 1 eth1 0
.sp
(optional, string, no default)
.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\-bridge resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_iface\-bridge ocf:heartbeat:iface\-bridge \e
  params \e
    bridge_name=\fIstring\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\-bridge resource using
\fBpcs\fR(8)
.sp
.if n \{\
.RS 4
.\}
.nf
pcs resource create p_iface\-bridge ocf:heartbeat:iface\-bridge \e
  bridge_name=\fIstring\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