Class: Ansible::Ruby::Modules::Iosxr_interface

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

Overview

This module provides declarative management of Interfaces on Cisco IOS XR network devices.

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

#active ⇒ :active, ...

Returns Whether the interface is C(active) or C(preconfigured). Preconfiguration allows you to configure modular services cards before they are inserted into the router. When the cards are inserted, they are instantly configured. Active cards are the ones already inserted.

Returns:

  • (:active, :preconfigure, nil) —

    Whether the interface is C(active) or C(preconfigured). Preconfiguration allows you to configure modular services cards before they are inserted into the router. When the cards are inserted, they are instantly configured. Active cards are the ones already inserted.



24
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 24

attribute :active

#aggregate ⇒ Array<Hash>, ...

Returns List of Interface definitions. Include multiple interface configurations together, one each on a separate line.

Returns:

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

    List of Interface definitions. Include multiple interface configurations together, one each on a separate line



46
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 46

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), I(tx_rate) and I(rx_rate).

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), I(tx_rate) and I(rx_rate).



50
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 50

attribute :delay

#description ⇒ String?

Returns Description of Interface being configured.

Returns:

  • (String, nil) —

    Description of Interface being configured.



16
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 16

attribute :description

#duplex ⇒ :full, ...

Returns Configures the interface duplex mode. Default is auto-negotiation when not configured.

Returns:

  • (:full, :half, nil) —

    Configures the interface duplex mode. Default is auto-negotiation when not configured.



36
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 36

attribute :duplex

#enabled ⇒ Boolean?

Returns Removes the shutdown configuration, which removes the forced administrative down on the interface, enabling it to move to an up or down state.

Returns:

  • (Boolean, nil) —

    Removes the shutdown configuration, which removes the forced administrative down on the interface, enabling it to move to an up or down state.



20
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 20

attribute :enabled

#mtu ⇒ Integer?

Returns Sets the MTU value for the interface. Range is between 64 and 65535’.

Returns:

  • (Integer, nil) —

    Sets the MTU value for the interface. Range is between 64 and 65535’



32
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 32

attribute :mtu

#name ⇒ String

Returns Name of the interface to configure in C(type + path) format. e.g. C(GigabitEthernet0/0/0/0).

Returns:

  • (String) —

    Name of the interface to configure in C(type + path) format. e.g. C(GigabitEthernet0/0/0/0)



12
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 12

attribute :name

#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)



43
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 43

attribute :rx_rate

#speed ⇒ 10, ...

Returns Configure the speed for an interface. Default is auto-negotiation when not configured.

Returns:

  • (10, 100, 1000, nil) —

    Configure the speed for an interface. Default is auto-negotiation when not configured.



28
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 28

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)



54
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 54

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)



40
 
# File 'lib/ansible/ruby/modules/generated/network/iosxr/iosxr_interface.rb', line 40

attribute :tx_rate