ocf_pacemaker_ifspeed - Man Page

Network interface speed monitor

Synopsis

[OCF_RESKEY_name=string] [OCF_RESKEY_iface=string] [OCF_RESKEY_ip=string] [OCF_RESKEY_bridge_ports=string] [OCF_RESKEY_weight_base=integer] [OCF_RESKEY_dampen=integer] [OCF_RESKEY_debug=string]

ifspeed [start | stop | monitor | meta-data | validate-all]

Description

This agent's monitor action records the speed of a specified network interface as a node attribute. The attribute can be used in rules to prefer nodes based on network speeds. This agent can monitor physical interfaces, bonded interfaces, bridges, VLANs, or any combination thereof. For example: *) 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 agent tries to determine the network topology, and by default looks only on ports which are connected to an upstream switch. This can be overridden by 'bridge_ports' parameter. Active interfaces in this case are those in "forwarding" state. For balancing bonded interfaces, this agent uses 80% of the sum of the speeds of underlying "up" ports. For non-balancing bonded interfaces ("active-backup" and probably "broadcast"), only the speed of the currently active port is considered.

Supported Parameters

OCF_RESKEY_name = string [ifspeed]

Attribute name

Name of the node attribute to set

OCF_RESKEY_iface = string []

Network interface

If this is set, monitor this network interface. One of iface or ip must be set.

OCF_RESKEY_ip = string []

IPv4 or IPv6 address

If this is set instead of iface, monitor the interface that holds this IP address. The address may be specified in dotted-quad notation for IPv4 (for example, 192.168.1.1) or hexadecimal notation for IPv6 (for example, 2001:db8:DC28:0:0:FC57:D4C8:1FFF). One of iface or ip must be set.

OCF_RESKEY_bridge_ports = string [detect]

Bridge ports

If set and iface is a bridge, consider these bridge ports (by default, all ports which have designated_bridge=root_id)

OCF_RESKEY_weight_base = integer [1000]

Weight of 1Gbps

Relative weight of 1Gbps in interface speed. Can be used to tune how big attribute value will be.

OCF_RESKEY_dampen = integer [5]

Dampening interval

The time to wait (dampening) for further changes to occur.

OCF_RESKEY_debug = string [false]

Verbose logging

Log more verbosely.

Author

Andrew Beekhof <andrew@beekhof.net>

Author.

Info

01/19/2023 Pacemaker Configuration