'\" t
.\"     Title: ocf_pacemaker_ifspeed
.\"    Author: Andrew Beekhof <andrew@beekhof.net>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 01/08/2021
.\"    Manual: Pacemaker Configuration
.\"    Source: Pacemaker Configuration
.\"  Language: English
.\"
.TH "OCF_PACEMAKER_IFSPEE" "7" "01/08/2021" "Pacemaker Configuration" "Pacemaker Configuration"
.\" -----------------------------------------------------------------
.\" * 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_pacemaker_ifspeed \- Network interface speed monitor
.SH "SYNOPSIS"
.PP
\fBOCF_RESKEY_name\fR=string [\fBOCF_RESKEY_iface\fR=string] [\fBOCF_RESKEY_ip\fR=string] [\fBOCF_RESKEY_bridge_ports\fR=string] [\fBOCF_RESKEY_weight_base\fR=integer] [\fBOCF_RESKEY_dampen\fR=integer] [\fBOCF_RESKEY_debug\fR=string]

\fBifspeed\fR
[start | stop | monitor | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Every time the monitor action is run, this resource agent records (in the CIB) (relative) speed of network interface it monitors\&. This RA can monitor physical interfaces, bonds, bridges, vlans and (hopefully) any combination of them\&. Examples: *) Bridge on top of one 10Gbps interface (eth2) and 802\&.3ad bonding (bond0) built on two 1Gbps interfaces (eth0 and eth1)\&. *) Active\-backup bonding built on top of one physical interface and one vlan on another interface\&. For STP\-enabled bridges this RA tries to some\-how guess network topology and by default looks only on ports which are connected to upstream switch\&. This can be overridden by \*(Aqbridge_ports\*(Aq parameter\&. Active interfaces in this case are those in "forwarding" state\&. For balancing bonds this RA summs speeds of underlying "up" slave interfaces (and applies coefficient 0\&.8 to result)\&. For non\-balancing bonds (\*(Aqactive\-backup\*(Aq and probably \*(Aqbroadcast\*(Aq), only the speed of the currently active slave is used\&.
.SH "SUPPORTED PARAMETERS"
.PP
\fBOCF_RESKEY_name\fR = string [ifspeed]
.RS 4
Attribute name
.sp
The name of the attribute to set\&. This is the name to be used in the constraints\&.
.RE
.PP
\fBOCF_RESKEY_iface\fR = string []
.RS 4
Network interface
.sp
Network interface to monitor\&.
.RE
.PP
\fBOCF_RESKEY_ip\fR = string []
.RS 4
IPv4 or IPv6 address
.sp
Try to detect interface name by detecting the interface that holds the IP address\&. The IPv4 (dotted quad notation) or IPv6 address (colon hexadecimal notation) example IPv4 "192\&.168\&.1\&.1"\&. example IPv6 "2001:db8:DC28:0:0:FC57:D4C8:1FFF"\&.
.RE
.PP
\fBOCF_RESKEY_bridge_ports\fR = string [detect]
.RS 4
Bridge ports
.sp
If not null and OCF_RESKEY_iface is a bridge, list of bridge ports to consider\&. Default is all ports which have designated_bridge=root_id\&.
.RE
.PP
\fBOCF_RESKEY_weight_base\fR = integer [1000]
.RS 4
Weight of 1Gbps
.sp
Relative weight of 1Gbps in interface speed\&. Can be used to tune how big attribute value will be\&.
.RE
.PP
\fBOCF_RESKEY_dampen\fR = integer [5]
.RS 4
Dampening interval
.sp
The time to wait (dampening) for further changes to occur\&.
.RE
.PP
\fBOCF_RESKEY_debug\fR = string [false]
.RS 4
Verbose logging
.sp
Log what have been done more verbosely\&.
.RE
.SH "AUTHOR"
.PP
\fBAndrew Beekhof\fR <\&andrew@beekhof\&.net\&>
.RS 4
Author.
.RE