ocf_heartbeat_iface-bridge(7)

1OCF_HEARTBEAT_IFACE()                                    OCF_HEARTBEAT_IFACE()
2
3
4

NAME

6       ocf_heartbeat_iface-bridge - Manages Bridge network interfaces.
7

SYNOPSIS

9       iface-bridge [start | stop | status | monitor | meta-data |
10                    validate-all]
11

DESCRIPTION

13       This resource manages Bridge network interfaces. It can add, remove,
14       configure bridges and spanning-tree.
15

SUPPORTED PARAMETERS

17       bridge_name
18           Define the name of the bridge (max 15 charaters).
19
20           (unique, required, string, no default)
21
22       bridge_slaves
23           Define the list of interfaces, space separated, to add to the
24           bridge. The list can be empty.
25
26           (unique, optional, string, no default)
27
28       bridge_ageing
29           Set the ethernet (MAC) address ageing time in seconds.
30
31           (optional, integer, no default)
32
33       port_hairpin
34           Set hairpin forwarding mode. A list of ports that should have
35           hairpin enabled can be specified using the following Example: eth0
36           eth1
37
38           (optional, string, no default)
39
40       stp
41           Enable or disable Spanning Tree Protocol on the bridge.
42
43           (optional, boolean, default false)
44
45       stp_bridgeprio
46           Set the bridge's priority to defined value. The priority value is a
47           number between 0 and 65535), and has no dimension. Lower priority
48           values are preferred. The bridge with the lowest priority will be
49           elected as root bridge.
50
51           (optional, integer, no default)
52
53       stp_fd
54           Set the bridge forward delay (in seconds).
55
56           (optional, integer, default 0)
57
58       stp_maxage
59           Set the bridge maximum message age (in seconds).
60
61           (optional, integer, no default)
62
63       stp_hello
64           Set the bridge hello time (in seconds).
65
66           (optional, integer, no default)
67
68       stp_pathcost
69           Set the port cost. This is a dimensionless metric. A list of
70           port/cost can be specified using the following format: slave cost
71           slave cost. Example: eth0 100 eth1 1000
72
73           (optional, string, no default)
74
75       stp_portprio
76           Set the port priority. This is a number between 0 and 63. brctl man
77           page reports a value between 0 and 255, but tests show a limit of
78           63 on a live system. This metric is used in the designated port and
79           root port selection algorithms. A list of port/priority can be
80           specified using the following format: slave cost slave cost.
81           Example: eth0 10 eth1 60
82
83           (optional, string, no default)
84
85       multicast_router
86           Enable or disable multicast routing on the bridge.
87
88           (optional, boolean, default 1)
89
90       multicast_snooping
91           Enable or disable multicast snooping on the bridge.
92
93           (optional, boolean, default 1)
94
95       multicast_port_router
96           Enable or disable a port from the multicast router. Kernel enables
97           all port by default. A list of port can be specified using the
98           following format: slave 0|1 slave 0|1. Example: eth0 1 eth1 0
99
100           (optional, string, no default)
101

SUPPORTED ACTIONS

103       This resource agent supports the following actions (operations):
104
105       start
106           Starts the resource. Suggested minimum timeout: 30s.
107
108       stop
109           Stops the resource. Suggested minimum timeout: 20s.
110
111       status
112           Performs a status check. Suggested minimum timeout: 20s. Suggested
113           interval: 10s.
114
115       monitor
116           Performs a detailed status check. Suggested minimum timeout: 20s.
117           Suggested interval: 10s.
118
119       meta-data
120           Retrieves resource agent metadata (internal use only). Suggested
121           minimum timeout: 5s.
122
123       validate-all
124           Performs a validation of the resource configuration. Suggested
125           minimum timeout: 20s.
126

EXAMPLE CRM SHELL

128       The following is an example configuration for a iface-bridge resource
129       using the crm(8) shell:
130
131           primitive p_iface-bridge ocf:heartbeat:iface-bridge \
132             params \
133               bridge_name=string \
134             op monitor timeout="20s" depth="0" interval="10s"
135

EXAMPLE PCS

137       The following is an example configuration for a iface-bridge resource
138       using pcs(8)
139
140           pcs resource create p_iface-bridge ocf:heartbeat:iface-bridge \
141             bridge_name=string \
142             op monitor timeout="20s" depth="0" interval="10s"
143

AUTHOR

148       ClusterLabs contributors (see the resource agent source for information
149       about individual authors)
150
151
152
153                                                         OCF_HEARTBEAT_IFACE()