NAME

       ocf_heartbeat_iface-vlan - Manages VLAN network interfaces.

SYNOPSIS

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

DESCRIPTION

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

SUPPORTED PARAMETERS

       vlan_interface
           Define the interface where VLAN should be attached.

           (required, string, no default)

       vlan_id
           Define the VLAN ID. It has to be a value between 0 and 4094.

           (required, integer, no default)

       vlan_name
           Define the name of the VLAN interface (max 15 charaters).

           (unique, optional, string, default ".")

       vlan_reorder_hdr
           Enable or disable header reordering.

           (optional, boolean, default 1)

       vlan_gvrp
           Enable or disable GARP VLAN registration protocol.

           (optional, boolean, default 0)

       vlan_mvrp
           Enable or disable Multiple VLAN Registration Protocol. Please note that most distributions do not
           ship a version of iproute2 that supports mvrp yet, even if the kernel has support for it. Check
           output of link add type vlan --help in the FLAG section to verify if mvrp support is available.

           (optional, boolean, default 0)

       vlan_loose_binding
           Enable or disable VLAN loose bind. By default the VLAN interface admin status (UP/DOWN) follows the
           underneath interface status. Enabling loose bind allows the VLAN to disconnect from the interface
           status. Be very careful that enabling loose binding could invalidate this agent monitor operations.
           Please note that most distributions do not ship a version of iproute2 that supports loose_binding
           yet, even if the kernel has support for it. Check output of link add type vlan --help in the FLAG
           section to verify if loose_binding support is available.

           (optional, boolean, default 0)

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 30s.

       stop
           Stops the resource. Suggested minimum timeout: 20s.

       status
           Performs a status check. Suggested minimum timeout: 20s. Suggested interval: 10s.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 20s. Suggested interval: 10s.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5s.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

EXAMPLE CRM SHELL

       The following is an example configuration for a iface-vlan resource using the crm(8) shell:

           primitive p_iface-vlan ocf:heartbeat:iface-vlan \
             params \
               vlan_interface=string \
               vlan_id=integer \
             op monitor timeout="20s" depth="0" interval="10s"

EXAMPLE PCS

       The following is an example configuration for a iface-vlan resource using pcs(8)

           pcs resource create p_iface-vlan ocf:heartbeat:iface-vlan \
             vlan_interface=string \
             vlan_id=integer \
             op monitor timeout="20s" OCF_CHECK_LEVEL="0" interval="10s"

SEE ALSO

       http://clusterlabs.org/

AUTHOR

       ClusterLabs contributors (see the resource agent source for information about individual authors)

resource-agents 4.13.0-1ubuntu                     04/01/2024                             OCF_HEARTBEAT_IFACE(7)