Documentation

cl_license - Install licenses fo Cumulus Linux

New in version 2.1.

DEPRECATED

Deprecated in 2.3.

Synopsis

Options

parameter required default choices comments
force
 no
  • True
  • False
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.
src
 yes
The full path to the license. Can be local path or HTTP URL.

Examples

# 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

# Force all switches to accept a new license. Typically not needed
# ansible -m cl_license -a "src='http://10.1.1.1/new_lic' force=yes" -u root all

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

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


Notes

Note

  • To activate a license for the FIRST time, the switchd service must be restarted. This action is disruptive. The license renewal process occurs via the Cumulus Networks Customer Portal - http://customers.cumulusnetworks.com.
  • A non-EULA license is REQUIRED for automation. Manually install the license on a test switch, using the command “cl-license -i <license_file>” to confirm the license is a Non-EULA license. See EXAMPLES, for the proper way to issue this notify action.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.