Class: Ansible::Ruby::Modules::Nxos_interface

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb

Overview

Manages physical attributes of interfaces of NX-OS switches.

Instance Method Summary collapse

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

#admin_state ⇒ :up, ...

Returns Administrative state of the interface.

Returns:

  • (:up, :down, nil) —

    Administrative state of the interface.



24
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 24

attribute :admin_state

#aggregate ⇒ Array<Hash>, ...

Returns List of Interfaces definitions.

Returns:

  • (Array<Hash>, Hash, nil) —

    List of Interfaces definitions.



63
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 63

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 arguments.

Returns:

  • (Integer, nil) —

    Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.



71
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 71

attribute :delay

#description ⇒ String?

Returns Interface description.

Returns:

  • (String, nil) —

    Interface description.



28
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 28

attribute :description

#duplex ⇒ :full, ...

Returns Interface link status. Applicable for ethernet interface only.

Returns:

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

    Interface link status. Applicable for ethernet interface only.



47
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 47

attribute :duplex

#fabric_forwarding_anycast_gateway ⇒ Symbol?

Returns Associate SVI with anycast gateway under VLAN configuration mode. Applicable for SVI interface only.

Returns:

  • (Symbol, nil) —

    Associate SVI with anycast gateway under VLAN configuration mode. Applicable for SVI interface only.



43
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 43

attribute :fabric_forwarding_anycast_gateway

#interface_type ⇒ :loopback, ...

Returns Interface type to be unconfigured from the device.

Returns:

  • (:loopback, :portchannel, :svi, :nve, nil) —

    Interface type to be unconfigured from the device.



16
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 16

attribute :interface_type

#ip_forward ⇒ :enable, ...

Returns Enable/Disable ip forward feature on SVIs.

Returns:

  • (:enable, :disable, nil) —

    Enable/Disable ip forward feature on SVIs.



39
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 39

attribute :ip_forward

#mode ⇒ :layer2, ...

Returns Manage Layer 2 or Layer 3 state of the interface. This option is supported for ethernet and portchannel interface. Applicable for ethernet and portchannel interface only.

Returns:

  • (:layer2, :layer3, nil) —

    Manage Layer 2 or Layer 3 state of the interface. This option is supported for ethernet and portchannel interface. Applicable for ethernet and portchannel interface only.



32
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 32

attribute :mode

#mtu ⇒ Object?

Returns MTU for a specific interface. Must be an even number between 576 and 9216. Applicable for ethernet interface only.

Returns:

  • (Object, nil) —

    MTU for a specific interface. Must be an even number between 576 and 9216. Applicable for ethernet interface only.



36
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 36

attribute :mtu

#name ⇒ String

Returns Full name of interface, i.e. Ethernet1/1, port-channel10.

Returns:

  • (String) —

    Full name of interface, i.e. Ethernet1/1, port-channel10.



12
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 12

attribute :name

#neighbors ⇒ Array<Hash>, ...

Returns Check the operational state of given interface C(name) for LLDP neighbor.,The following suboptions are available. This is state check parameter only.

Returns:

  • (Array<Hash>, Hash, nil) —

    Check the operational state of given interface C(name) for LLDP neighbor.,The following suboptions are available. This is state check parameter only.



59
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 59

attribute :neighbors

#rx_rate ⇒ String?

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:

  • (String, 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)



55
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 55

attribute :rx_rate

#speed ⇒ Integer?

Returns Interface link speed. Applicable for ethernet interface only.

Returns:

  • (Integer, nil) —

    Interface link speed. Applicable for ethernet interface only.



20
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 20

attribute :speed

#state ⇒ :present, ...

Returns Specify desired state of the resource.

Returns:

  • (:present, :absent, :default, nil) —

    Specify desired state of the resource.



67
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 67

attribute :state

#tx_rate ⇒ String?

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:

  • (String, 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)



51
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_interface.rb', line 51

attribute :tx_rate