Deprecated

Removed in 2.5

i

Reason:The image slot system no longer exists in Cumulus Linux. | Alternative:n/a

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

Install a different Cumulus Linux version.

| "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

install a different version of Cumulus Linux in the inactive slot. For more details go the Image Management User Guide at U(http://docs.cumulusnetworks.com/).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
## Download and install the image from a webserver.
- name: Install image using using http url. Switch slots so the subsequent will load the new version
  cl_img_install:
    version: 2.0.1
    src: http://10.1.1.1/CumulusLinux-2.0.1.bin
    switch_slot: yes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
## Copy the software from the ansible server to the switch.
## The module will get the code version from the filename
## The code will be installed in the alternate slot but the slot will not be primary
## A subsequent reload will not run the new code

- name: Download cumulus linux to local system
  get_url:
    src: ftp://cumuluslinux.bin
    dest: /root/CumulusLinux-2.0.1.bin
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Install image from local filesystem. Get version from the filename.
  cl_img_install:
    src: /root/CumulusLinux-2.0.1.bin
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
## If the image name has been changed from the original name, use the `version` option
## to inform the module exactly what code version is been installed

- name: Download cumulus linux to local system
  get_url:
    src: ftp://CumulusLinux-2.0.1.bin
    dest: /root/image.bin
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: install image and switch slots. Only reboot needed
  cl_img_install:
    version: 2.0.1
    src: /root/image.bin
    switch_slot: yes

Inputs

    
src:
    description:
    - The full path to the Cumulus Linux binary image. Can be a local path, http or https
      URL. If the code version is in the name of the file, the module will assume this
      is the version of code you wish to install.
    required: true

version:
    description:
    - Inform the module of the exact version one is installing. This overrides the automatic
      check of version in the file name. For example, if the binary file name is called
      CumulusLinux-2.2.3.bin, and version is set to '2.5.0', then the module will assume
      it is installing '2.5.0' not '2.2.3'. If version is not included, then the module
      will assume '2.2.3' is the version to install.

switch_slot:
    description:
    - Switch slots after installing the image. To run the installed code, reboot the switch.
    type: bool

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