Class: Ansible::Ruby::Modules::Nxos_linkagg

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

Overview

This module provides declarative management of link aggregation groups on Cisco NXOS 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

#aggregate ⇒ Array<Hash>, ...

Returns List of link aggregation definitions.

Returns:

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

    List of link aggregation definitions.



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

attribute :aggregate

#force ⇒ :yes, ...

Returns When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members.

Returns:

  • (:yes, :no, nil) —

    When true it forces link aggregation group members to match what is declared in the members param. This can be used to remove members.



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

attribute :force

#group ⇒ Integer

Returns Channel-group number for the port-channel Link aggregation group.

Returns:

  • (Integer) —

    Channel-group number for the port-channel Link aggregation group.



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

attribute :group

#members ⇒ Array<String>, ...

Returns List of interfaces that will be managed in the link aggregation group.

Returns:

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

    List of interfaces that will be managed in the link aggregation group.



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

attribute :members

#min_links ⇒ Integer?

Returns Minimum number of ports required up before bringing up the link aggregation group.

Returns:

  • (Integer, nil) —

    Minimum number of ports required up before bringing up the link aggregation group.



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

attribute :min_links

#mode ⇒ :active, ...

Returns Mode for the link aggregation group.

Returns:

  • (:active, :on, :passive, nil) —

    Mode for the link aggregation group.



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

attribute :mode

#purge ⇒ :yes, ...

Returns Purge links not defined in the I(aggregate) parameter.

Returns:

  • (:yes, :no, nil) —

    Purge links not defined in the I(aggregate) parameter.



40
 
# File 'lib/ansible/ruby/modules/generated/network/nxos/nxos_linkagg.rb', line 40

attribute :purge

#state ⇒ :present, ...

Returns State of the link aggregation group.

Returns:

  • (:present, :absent, nil) —

    State of the link aggregation group.



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

attribute :state