Class: Ansible::Ruby::Modules::Onyx_interface

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb

Overview

This module provides declarative management of Interfaces on Mellanox ONYX network devices.

Instance Method Summary

• #aggregate ⇒ Object^?

  List of Interfaces definitions.

• #delay ⇒ Integer^?

  Time in seconds to wait before checking for the operational state on remote device.

• #description ⇒ String^?

  Description of Interface.

• #duplex ⇒ :full, ...

  Interface link status.

• #enabled ⇒ Symbol^?

  Interface link status.

• #mtu ⇒ Integer^?

  Maximum size of transmit packet.

• #name ⇒ String

  Name of the Interface.

• #purge ⇒ Symbol^?

  Purge Interfaces not defined in the aggregate parameter.

• #rx_rate ⇒ Object^?

  Receiver rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

• #speed ⇒ :"1G", ...

  Interface link speed.

• #state ⇒ :present, ...

  State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down).

• #tx_rate ⇒ Object^?

  Transmit rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#aggregate ⇒ Object^?

Returns List of Interfaces definitions.

Returns:

• (Object, nil) —

  List of Interfaces definitions.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 32

attribute :aggregate

#delay ⇒ Integer^?

Returns Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down).

Returns:

• (Integer, nil) —

  Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are I(state) with values C(up)/C(down).

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 45

attribute :delay

#description ⇒ String^?

Returns Description of Interface.

Returns:

• (String, nil) —

  Description of Interface.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 16

attribute :description

#duplex ⇒ :full, ...

Returns Interface link status.

Returns:

• (:full, :half, :auto, nil) —

  Interface link status

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 35

attribute :duplex

#enabled ⇒ Symbol^?

Returns Interface link status.

Returns:

• (Symbol, nil) —

  Interface link status.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 20

attribute :enabled

#mtu ⇒ Integer^?

Returns Maximum size of transmit packet.

Returns:

• (Integer, nil) —

  Maximum size of transmit packet.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 28

attribute :mtu

#name ⇒ String

Returns Name of the Interface.

Returns:

• (String) —

  Name of the Interface.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 12

attribute :name

#purge ⇒ Symbol^?

Returns Purge Interfaces not defined in the aggregate parameter. This applies only for logical interface.

Returns:

• (Symbol, nil) —

  Purge Interfaces not defined in the aggregate parameter. This applies only for logical interface.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 49

attribute :purge

#rx_rate ⇒ Object^?

Returns Receiver rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

Returns:

• (Object, nil) —

  Receiver rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 42

attribute :rx_rate

#speed ⇒ :"1G", ...

Returns Interface link speed.

Returns:

• (:"1G", :"10G", :"25G", :"40G", :"50G", :"56G", :"100G", nil) —

  Interface link speed.

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 24

attribute :speed

#state ⇒ :present, ...

Returns State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down).

Returns:

• (:present, :absent, :up, :down, nil) —

  State of the Interface configuration, C(up) means present and operationally up and C(down) means present and operationally C(down)

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 53

attribute :state

#tx_rate ⇒ Object^?

Returns Transmit rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html).

Returns:

• (Object, nil) —

  Transmit rate in bits per second (bps).,This is state check parameter only.,Supports conditionals, see L(Conditionals in Networking Modules,../network/user_guide/network_working_with_command_output.html)

# File 'lib/ansible/ruby/modules/generated/network/onyx/onyx_interface.rb', line 39

attribute :tx_rate