Class: Ansible::Ruby::Modules::Cl_bond

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Cl_bond

Defined in:

lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb

Overview

Configures a bond interface on Cumulus Linux To configure a bridge port use the cl_bridge module. To configure any other type of interface use the cl_interface module. Follow the guidelines for bonding found in the Cumulus User Guide at docs.cumulusnetworks.com

Instance Method Summary

• #addr_method ⇒ :dhcp^?

  Configures the port to use DHCP.

• #alias_name ⇒ Object^?

  Add a port description.

• #clag_id ⇒ Object^?

  Specify a unique clag_id for every dual connected bond on each peer switch.

• #ipv4 ⇒ Object^?

  List of IPv4 addresses to configure on the interface.

• #ipv6 ⇒ Object^?

  List of IPv6 addresses to configure on the interface.

• #lacp_bypass_all_active ⇒ Object^?

  Activate all interfaces for bypass.

• #lacp_bypass_allow ⇒ Object^?

  Enable LACP bypass.

• #lacp_bypass_period ⇒ Object^?

  Period for enabling LACP bypass.

• #lacp_bypass_priority ⇒ Object^?

  List of ports and priorities.

• #lacp_rate ⇒ Integer^?

  Lacp rate.

• #location ⇒ String^?

  Interface directory location.

• #miimon ⇒ Integer^?

  Mii link monitoring interval.

• #min_links ⇒ Integer^?

  Minimum number of links.

• #mode ⇒ String^?

  Bond mode.

• #mstpctl_bpduguard ⇒ Object^?

  Enables BPDU Guard on a port in vlan-aware mode.

• #mstpctl_portadminedge ⇒ Object^?

  Enables admin edge port.

• #mstpctl_portnetwork ⇒ Object^?

  Enables bridge assurance in vlan-aware mode.

• #mtu ⇒ Object^?

  Set MTU.

• #name ⇒ Object

  Name of the interface.

• #pvid ⇒ Object^?

  In vlan aware mode, defines vlan that is the untagged vlan.

• #slaves ⇒ Object

  Bond members.

• #vids ⇒ Object^?

  In vlan aware mode, lists vlans defined under the interface.

• #virtual_ip ⇒ Object^?

  Define IPv4 virtual IP used by the Cumulus Linux VRR feature.

• #virtual_mac ⇒ Object^?

  Define Ethernet mac associated with Cumulus Linux VRR feature.

• #xmit_hash_policy ⇒ String^?

  Transmit load balancing algorithm.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#addr_method ⇒ :dhcp^?

Returns configures the port to use DHCP. To enable this feature use the option ‘dhcp’.

Returns:

• (:dhcp, nil) —

  configures the port to use DHCP. To enable this feature use the option ‘dhcp’

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 24

attribute :addr_method

#alias_name ⇒ Object^?

Returns add a port description.

Returns:

• (Object, nil) —

  add a port description

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 15

attribute :alias_name

#clag_id ⇒ Object^?

Returns specify a unique clag_id for every dual connected bond on each peer switch. The value must be between 1 and 65535 and must be the same on both peer switches in order for the bond to be considered dual-connected.

Returns:

• (Object, nil) —

  specify a unique clag_id for every dual connected bond on each peer switch. The value must be between 1 and 65535 and must be the same on both peer switches in order for the bond to be considered dual-connected

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 49

attribute :clag_id

#ipv4 ⇒ Object^?

Returns list of IPv4 addresses to configure on the interface. use X.X.X.X/YY syntax.

Returns:

• (Object, nil) —

  list of IPv4 addresses to configure on the interface. use X.X.X.X/YY syntax.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 18

attribute :ipv4

#ipv6 ⇒ Object^?

Returns list of IPv6 addresses to configure on the interface. use X:X:X::X/YYY syntax.

Returns:

• (Object, nil) —

  list of IPv6 addresses to configure on the interface. use X:X:X::X/YYY syntax

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 21

attribute :ipv6

#lacp_bypass_all_active ⇒ Object^?

Returns Activate all interfaces for bypass. It is recommended to configure all_active instead of using bypass_priority.

Returns:

• (Object, nil) —

  Activate all interfaces for bypass. It is recommended to configure all_active instead of using bypass_priority.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 76

attribute :lacp_bypass_all_active

#lacp_bypass_allow ⇒ Object^?

Returns Enable LACP bypass.

Returns:

• (Object, nil) —

  Enable LACP bypass.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 67

attribute :lacp_bypass_allow

#lacp_bypass_period ⇒ Object^?

Returns Period for enabling LACP bypass. Max value is 900.

Returns:

• (Object, nil) —

  Period for enabling LACP bypass. Max value is 900.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 70

attribute :lacp_bypass_period

#lacp_bypass_priority ⇒ Object^?

Returns List of ports and priorities. Example “swp1=10, swp2=20”.

Returns:

• (Object, nil) —

  List of ports and priorities. Example “swp1=10, swp2=20”

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 73

attribute :lacp_bypass_priority

#lacp_rate ⇒ Integer^?

Returns lacp rate.

Returns:

• (Integer, nil) —

  lacp rate

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 79

attribute :lacp_rate

#location ⇒ String^?

Returns interface directory location.

Returns:

• (String, nil) —

  interface directory location

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 91

attribute :location

#miimon ⇒ Integer^?

Returns mii link monitoring interval.

Returns:

• (Integer, nil) —

  mii link monitoring interval

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 55

attribute :miimon

#min_links ⇒ Integer^?

Returns minimum number of links.

Returns:

• (Integer, nil) —

  minimum number of links

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 63

attribute :min_links

#mode ⇒ String^?

Returns bond mode. as of Cumulus Linux 2.5 only LACP bond mode is supported.

Returns:

• (String, nil) —

  bond mode. as of Cumulus Linux 2.5 only LACP bond mode is supported

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 59

attribute :mode

#mstpctl_bpduguard ⇒ Object^?

Returns Enables BPDU Guard on a port in vlan-aware mode.

Returns:

• (Object, nil) —

  Enables BPDU Guard on a port in vlan-aware mode

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 40

attribute :mstpctl_bpduguard

#mstpctl_portadminedge ⇒ Object^?

Returns Enables admin edge port.

Returns:

• (Object, nil) —

  Enables admin edge port

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 46

attribute :mstpctl_portadminedge

#mstpctl_portnetwork ⇒ Object^?

Returns Enables bridge assurance in vlan-aware mode.

Returns:

• (Object, nil) —

  Enables bridge assurance in vlan-aware mode

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 43

attribute :mstpctl_portnetwork

#mtu ⇒ Object^?

Returns set MTU. Configure Jumbo Frame by setting MTU to 9000.

Returns:

• (Object, nil) —

  set MTU. Configure Jumbo Frame by setting MTU to 9000.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 28

attribute :mtu

#name ⇒ Object

Returns name of the interface.

Returns:

• (Object) —

  name of the interface

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 11

attribute :name

#pvid ⇒ Object^?

Returns in vlan aware mode, defines vlan that is the untagged vlan.

Returns:

• (Object, nil) —

  in vlan aware mode, defines vlan that is the untagged vlan

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 52

attribute :pvid

#slaves ⇒ Object

Returns bond members.

Returns:

• (Object) —

  bond members

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 83

attribute :slaves

#vids ⇒ Object^?

Returns in vlan aware mode, lists vlans defined under the interface.

Returns:

• (Object, nil) —

  in vlan aware mode, lists vlans defined under the interface

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 37

attribute :vids

#virtual_ip ⇒ Object^?

Returns define IPv4 virtual IP used by the Cumulus Linux VRR feature.

Returns:

• (Object, nil) —

  define IPv4 virtual IP used by the Cumulus Linux VRR feature

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 31

attribute :virtual_ip

#virtual_mac ⇒ Object^?

Returns define Ethernet mac associated with Cumulus Linux VRR feature.

Returns:

• (Object, nil) —

  define Ethernet mac associated with Cumulus Linux VRR feature

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 34

attribute :virtual_mac

#xmit_hash_policy ⇒ String^?

Returns transmit load balancing algorithm. As of Cumulus Linux 2.5 only layer3+4 policy is supported.

Returns:

• (String, nil) —

  transmit load balancing algorithm. As of Cumulus Linux 2.5 only layer3+4 policy is supported

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_bond.rb', line 87

attribute :xmit_hash_policy