cl_license - Install licenses for Cumulus Linux¶

New in version 2.1.

DEPRECATED
Synopsis
Parameters
Notes
Examples
Return Values
Status
- Author

DEPRECATED ¶

Removed in Ansible:
	version: 2.5
Why:	The 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 nclu instead.

Synopsis ¶

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 http://docs.cumulusnetwork.com and the Licensing KB Site at https://support.cumulusnetworks.com/hc/en-us/sections/200507688

Parameters ¶

Parameter	Choices/Defaults	Comments
force	Choices: yes no	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 required		The full path to the license. Can be local path or HTTP URL.

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.

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, the following are the fields unique to this module:

Key	Returned	Description
changed bool	changed	whether the interface was changed Sample: True
msg string	always	human-readable report of success or failure Sample: interface bond0 config updated

Status ¶

This module is flagged as deprecated and will be removed in version { deprecated[‘removed_in’] | default(‘’) | string | convert_symbols_to_format }@. For more information see DEPRECATED.

Author ¶

Cumulus Networks (@CumulusNetworks)

Hint

If you notice any issues in this documentation you can edit this document to improve it.