Class: Ansible::Ruby::Modules::Nclu

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

Overview

Interface to the Network Command Line Utility, developed to make it easier to configure operating systems running ifupdown2 and Quagga, such as Cumulus Linux. Command documentation is available at U(docs.cumulusnetworks.com/display/DOCS/Network+Command+Line+Utility)

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

#abort ⇒ Boolean?

Returns Boolean. When true, perform a ‘net abort’ before the block. This cleans out any uncommitted changes in the buffer. Mutually exclusive with I(atomic).

Returns:

  • (Boolean, nil) —

    Boolean. When true, perform a ‘net abort’ before the block. This cleans out any uncommitted changes in the buffer. Mutually exclusive with I(atomic).



24
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 24

attribute :abort

#atomic ⇒ Boolean?

Returns When true, equivalent to both I(commit) and I(abort) being true. Mutually exclusive with I(commit) and I(atomic).

Returns:

  • (Boolean, nil) —

    When true, equivalent to both I(commit) and I(abort) being true. Mutually exclusive with I(commit) and I(atomic).



28
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 28

attribute :atomic

#commands ⇒ Array<String>, ...

Returns A list of strings containing the net commands to run. Mutually exclusive with I(template).

Returns:

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

    A list of strings containing the net commands to run. Mutually exclusive with I(template).



12
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 12

attribute :commands

#commit ⇒ Boolean?

Returns When true, performs a ‘net commit’ at the end of the block. Mutually exclusive with I(atomic).

Returns:

  • (Boolean, nil) —

    When true, performs a ‘net commit’ at the end of the block. Mutually exclusive with I(atomic).



20
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 20

attribute :commit

#description ⇒ String?

Returns Commit description that will be recorded to the commit log if I(commit) or I(atomic) are true.

Returns:

  • (String, nil) —

    Commit description that will be recorded to the commit log if I(commit) or I(atomic) are true.



32
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 32

attribute :description

#template ⇒ Array<String>, ...

Returns A single, multi-line string with jinja2 formatting. This string will be broken by lines, and each line will be run through net. Mutually exclusive with I(commands).

Returns:

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

    A single, multi-line string with jinja2 formatting. This string will be broken by lines, and each line will be run through net. Mutually exclusive with I(commands).



16
 
# File 'lib/ansible/ruby/modules/generated/network/cumulus/nclu.rb', line 16

attribute :template