ocf_heartbeat_iface-vlan(7)

1OCF_HEARTBEAT_IFACE()                                    OCF_HEARTBEAT_IFACE()
2
3
4

NAME

6       ocf_heartbeat_iface-vlan - Manages VLAN network interfaces.
7

SYNOPSIS

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

DESCRIPTION

12       This resource manages VLAN network interfaces. It can add, remove,
13       configure VLANs.
14

SUPPORTED PARAMETERS

16       vlan_interface
17           Define the interface where VLAN should be attached.
18
19           (unique, required, string, no default)
20
21       vlan_id
22           Define the VLAN ID. It has to be a value between 0 and 4094.
23
24           (unique, required, integer, no default)
25
26       vlan_name
27           Define the name of the VLAN interface (max 15 charaters).
28
29           (unique, optional, string, default ".")
30
31       vlan_reorder_hdr
32           Enable or disable header reordering.
33
34           (optional, boolean, default 1)
35
36       vlan_gvrp
37           Enable or disable GARP VLAN registration protocol.
38
39           (optional, boolean, default 0)
40
41       vlan_mvrp
42           Enable or disable Multiple VLAN Registration Protocol. Please note
43           that most distributions do not ship a version of iproute2 that
44           supports mvrp yet, even if the kernel has support for it. Check
45           output of link add type vlan --help in the FLAG section to verify
46           if mvrp support is available.
47
48           (optional, boolean, default 0)
49
50       vlan_loose_binding
51           Enable or disable VLAN loose bind. By default the VLAN interface
52           admin status (UP/DOWN) follows the underneath interface status.
53           Enabling loose bind allows the VLAN to disconnect from the
54           interface status. Be very careful that enabling loose binding could
55           invalidate this agent monitor operations. Please note that most
56           distributions do not ship a version of iproute2 that supports
57           loose_binding yet, even if the kernel has support for it. Check
58           output of link add type vlan --help in the FLAG section to verify
59           if loose_binding support is available.
60
61           (optional, boolean, default 0)
62

SUPPORTED ACTIONS

64       This resource agent supports the following actions (operations):
65
66       start
67           Starts the resource. Suggested minimum timeout: 30s.
68
69       stop
70           Stops the resource. Suggested minimum timeout: 20s.
71
72       status
73           Performs a status check. Suggested minimum timeout: 20s. Suggested
74           interval: 10s.
75
76       monitor
77           Performs a detailed status check. Suggested minimum timeout: 20s.
78           Suggested interval: 10s.
79
80       meta-data
81           Retrieves resource agent metadata (internal use only). Suggested
82           minimum timeout: 5s.
83
84       validate-all
85           Performs a validation of the resource configuration. Suggested
86           minimum timeout: 20s.
87

EXAMPLE CRM SHELL

89       The following is an example configuration for a iface-vlan resource
90       using the crm(8) shell:
91
92           primitive p_iface-vlan ocf:heartbeat:iface-vlan \
93             params \
94               vlan_interface=string \
95               vlan_id=integer \
96             op monitor timeout="20s" depth="0" interval="10s"
97

EXAMPLE PCS

99       The following is an example configuration for a iface-vlan resource
100       using pcs(8)
101
102           pcs resource create p_iface-vlan ocf:heartbeat:iface-vlan \
103             vlan_interface=string \
104             vlan_id=integer \
105             op monitor timeout="20s" depth="0" interval="10s"
106

AUTHOR

111       ClusterLabs contributors (see the resource agent source for information
112       about individual authors)
113
114
115
116                                                         OCF_HEARTBEAT_IFACE()