ansible.builtin.nclu (v2.3.2.0-1) — module

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

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(https://docs.cumulusnetworks.com/display/DOCS/Network+Command+Line+Utility)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add two interfaces without committing any changes
  nclu:
    commands:
        - add int swp1
        - add int swp2

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add 48 interfaces and commit the change.
  nclu:
    template: |
        {% for iface in range(1,49) %}
        add int swp{{iface}}
        {% endfor %}
    commit: true
    description: "Ansible - add swps1-48"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Atomically add an interface
  nclu:
    commands:
        - add int swp1
    atomic: true
    description: "Ansible - add swp1"

Inputs

    
abort:
    default: false
    description:
    - Boolean. When true, perform a 'net abort' before the block. This cleans out any
      uncommitted changes in the buffer. Mutually exclusive with I(atomic).

atomic:
    default: false
    description:
    - When true, equivalent to both I(commit) and I(abort) being true. Mutually exclusive
      with I(commit) and I(atomic).

commit:
    default: false
    description:
    - When true, performs a 'net commit' at the end of the block. Mutually exclusive with
      I(atomic).

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

template:
    description:
    - 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).

description:
    default: Ansible-originated commit
    description:
    - Commit description that will be recorded to the commit log if I(commit) or I(atomic)
      are true.

Outputs

changed:
  description: whether the interface was changed
  returned: changed
  sample: true
  type: bool
msg:
  description: human-readable report of success or failure
  returned: always
  sample: interface bond0 config updated
  type: string