Deprecated

Removed in 2.5

i

Reason:The M(nclu) module is designed to be easier to use for individuals who are new to Cumulus Linux by exposing the NCLU interface in an automatable way. | Alternative:Use M(nclu) instead.

ansible.builtin._cl_license (v2.6.20) — module

Install licenses for Cumulus Linux

| "added in version" 2.1 of ansible.builtin"

Authors: Cumulus Networks (@CumulusNetworks)

deprecated | supported by community

Install Ansible via pip

Install with pip install ansible==2.6.20

Description

Installs a Cumulus Linux license. The module reports no change of status when a license is installed. For more details go the Cumulus Linux License Documentation at U(http://docs.cumulusnetwork.com) and the Licensing KB Site at U(https://support.cumulusnetworks.com/hc/en-us/sections/200507688)

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Example playbook using the cl_license module to manage licenses on Cumulus Linux

- hosts: all
  tasks:
    - name: install license using http url
      cl_license:
        src: http://10.1.1.1/license.txt
      notify: restart switchd

    - name: Triggers switchd to be restarted right away, before play, or role
            is over. This is desired behaviour
      meta: flush_handlers

    - name: Configure interfaces
      template:
        src: interfaces.j2
        dest: /etc/network/interfaces
      notify: restart networking

  handlers:
   - name: restart switchd
     service:
      name: switchd
      state: restarted
   - name: restart networking
     service:
      name: networking
      state: reloaded

Inputs

    
src:
    description:
    - The full path to the license. Can be local path or HTTP URL.
    required: true

force:
    choices:
    - true
    - false
    description:
    - Force installation of a license. Typically not needed. It is recommended to manually
      run this command via the ansible command. A reload of switchd is not required. Running
      the force option in a playbook will break the idempotent state machine of the module
      and cause the switchd notification to kick in all the time, causing a disruption.

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