Class: Ansible::Ruby::Modules::Cl_interface

Inherits:

Base

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

Defined in:

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

Overview

Configures a front panel, sub-interface, SVI, management or loopback port on a Cumulus Linux switch. For bridge ports use the cl_bridge module. For bond ports use the cl_bond module. When configuring bridge related features like the “vid” option, please follow the guidelines for configuring “vlan aware” bridging. For more details review the Layer2 Interface Guide at docs.cumulusnetworks.com

Instance Method Summary

• #addr_method ⇒ Object^?

  Can be loopback for loopback interfaces or dhcp for dhcp interfaces.

• #alias_name ⇒ Object^?

  Add a port description.

• #clagd_enable ⇒ Object^?

  Enables the clagd daemon.

• #clagd_peer_ip ⇒ Object^?

  IP address of the directly connected peer switch interface.

• #clagd_priority ⇒ Object^?

  Integer that changes the role the switch has in the clag domain.

• #clagd_sys_mac ⇒ Object^?

  Clagd system mac address.

• #ipv4 ⇒ Object^?

  List of IPv4 addresses to configure on the interface.

• #ipv6 ⇒ Object^?

  List of IPv6 addresses to configure on the interface.

• #location ⇒ String^?

  Interface directory location.

• #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.

• #speed ⇒ Object^?

  Set speed of the swp(front panel) or management(eth0) interface.

• #vids ⇒ Object^?

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

• #virtual_ip ⇒ Object^?

  Define IPv4 virtual IP used by the Cumulus VRR feature.

• #virtual_mac ⇒ Object^?

  Define Ethernet mac associated with Cumulus VRR feature.

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 ⇒ Object^?

Returns can be loopback for loopback interfaces or dhcp for dhcp interfaces.

Returns:

• (Object, nil) —

  can be loopback for loopback interfaces or dhcp for dhcp interfaces.

# File 'lib/ansible/ruby/modules/generated/core/network/cumulus/cl_interface.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_interface.rb', line 15

attribute :alias_name

#clagd_enable ⇒ Object^?

Returns Enables the clagd daemon. This command should only be applied to the clag peerlink interface.

Returns:

• (Object, nil) —

  Enables the clagd daemon. This command should only be applied to the clag peerlink interface

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

attribute :clagd_enable

#clagd_peer_ip ⇒ Object^?

Returns IP address of the directly connected peer switch interface.

Returns:

• (Object, nil) —

  IP address of the directly connected peer switch interface

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

attribute :clagd_peer_ip

#clagd_priority ⇒ Object^?

Returns Integer that changes the role the switch has in the clag domain. The lower priority switch will assume the primary role. The number can be between 0 and 65535.

Returns:

• (Object, nil) —

  Integer that changes the role the switch has in the clag domain. The lower priority switch will assume the primary role. The number can be between 0 and 65535

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

attribute :clagd_priority

#clagd_sys_mac ⇒ Object^?

Returns Clagd system mac address. Recommended to use the range starting with 44:38:39:ff. Needs to be the same between 2 Clag switches.

Returns:

• (Object, nil) —

  Clagd system mac address. Recommended to use the range starting with 44:38:39:ff. Needs to be the same between 2 Clag switches

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

attribute :clagd_sys_mac

#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_interface.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_interface.rb', line 21

attribute :ipv6

#location ⇒ String^?

Returns interface directory location.

Returns:

• (String, nil) —

  interface directory location

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

attribute :location

#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_interface.rb', line 42

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_interface.rb', line 48

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_interface.rb', line 45

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_interface.rb', line 30

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_interface.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_interface.rb', line 63

attribute :pvid

#speed ⇒ Object^?

Returns set speed of the swp(front panel) or management(eth0) interface. speed is in MB.

Returns:

• (Object, nil) —

  set speed of the swp(front panel) or management(eth0) interface. speed is in MB

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

attribute :speed

#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_interface.rb', line 39

attribute :vids

#virtual_ip ⇒ Object^?

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

Returns:

• (Object, nil) —

  define IPv4 virtual IP used by the Cumulus VRR feature

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

attribute :virtual_ip

#virtual_mac ⇒ Object^?

Returns define Ethernet mac associated with Cumulus VRR feature.

Returns:

• (Object, nil) —

  define Ethernet mac associated with Cumulus VRR feature

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

attribute :virtual_mac