Documentation

cl_img_install - Install a different Cumulus Linux version.

New in version 2.1.

Synopsis

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

Requirements (on host that executes module)

  • Cumulus Linux OS

Options

parameter required default choices comments
src
yes
    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.
    switch_slot
    no no
    • yes
    • no
    Switch slots after installing the image. To run the installed code, reboot the switch
    version
    no
      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.

      Examples

      Example playbook entries using the cl_img_install module
      
      ## 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
      
      ## 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
      
          - name: install image from local filesystem. Get version from the filename
            cl_img_install:  src='/root/CumulusLinux-2.0.1.bin'
      
      
      ## 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
      
          - name: install image and switch slots. only reboot needed
            cl_img_install: version=2.0.1 src=/root/image.bin switch_slot=yes'
      

      Return Values

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

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


      This is a Core Module

      For more information on what this means please read Core Modules

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