cnos_image – Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cnos_image – Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module allows you to work with switch firmware images. It provides a way to download a firmware image to a network device from a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the image’s location. Authentication details required by the remote server must be provided as well. By default, this method makes the newly downloaded firmware image the active image, which will be used by the switch during the next restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named ‘results’ that must be created by the user in their local directory to where the playbook is run.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
deviceType string / required | Choices: g8272_cnos g8296_cnos g8332_cnos NE0152T NE1072T NE1032 NE1032T NE10032 NE2572 | This specifies the type of device where the method is executed. The choices NE1072T,NE1032,NE1032T,NE10032,NE2572 are added since Ansible 2.4. The choice NE0152T is added since 2.8
enablePassword string |  | Configures the password used to enter Global Configuration command mode on the switch. If the switch does not request this password, the parameter is ignored.While generally the value should come from the inventory file, you can also specify it as a variable. This parameter is optional. If it is not specified, no default value will be used.
host string / required |  | This is the variable used to search the hosts file at /etc/ansible/hosts and identify the IP address of the device on which the template is going to be applied. Usually the Ansible keyword {{ inventory_hostname }} is specified in the playbook as an abstraction of the group of network elements that need to be configured.
imgpath - / required |  | This specifies the full file path of the image located on the remote server. In case the relative path is used as the variable value, the root folder for the user of the server needs to be specified.
imgtype - / required | Choices: all boot os onie | This specifies the firmware image type to be downloaded
outputfile string / required |  | This specifies the file path where the output of each command execution is saved. Each command that is specified in the merged template file and each response from the device are saved here. Usually the location is the results folder, but you can choose another location based on your write permission.
password string / required |  | Configures the password used to authenticate the connection to the remote device. The value of the password parameter is used to authenticate the SSH session. While generally the value should come from the inventory file, you can also specify it as a variable. This parameter is optional. If it is not specified, no default value will be used.
protocol - / required | Choices: SFTP SCP FTP TFTP | This refers to the protocol used by the network device to interact with the remote server from where to download the firmware image. The choices are FTP, SFTP, TFTP, or SCP. Any other protocols will result in error. If this parameter is not specified there is no default value to be used.
serverip - / required |  | This specifies the IP Address of the remote server from where the software image will be downloaded.
serverpassword - |  | Specify the password for the server relating to the protocol used
serverusername - / required |  | Specify the username for the server relating to the protocol used
username string / required |  | Configures the username used to authenticate the connection to the remote device. The value of the username parameter is used to authenticate the SSH session. While generally the value should come from the inventory file, you can also specify it as a variable. This parameter is optional. If it is not specified, no default value will be used.

## Notes

Note

- For more information on using Ansible to manage Lenovo Network devices see https://www.ansible.com/ansible-lenovo.

## Examples

    Tasks : The following are examples of using the module cnos_image. These are
      written in the main.yml file of the tasks directory.
    ---
    - name: Test Image transfer
      cnos_image:
          deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
          outputfile: "./results/test_image_{{ inventory_hostname }}_output.txt"
          protocol: "sftp"
          serverip: "10.241.106.118"
          imgpath: "/root/cnos_images/G8272-10.1.0.112.img"
          imgtype: "os"
          serverusername: "root"
          serverpassword: "root123"

    - name: Test Image tftp
      cnos_image:
          deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
          outputfile: "./results/test_image_{{ inventory_hostname }}_output.txt"
          protocol: "tftp"
          serverip: "10.241.106.118"
          imgpath: "/anil/G8272-10.2.0.34.img"
          imgtype: "os"
          serverusername: "root"
          serverpassword: "root123"

## Return Values

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

Key | Returned | Description
--- | --- | ---
msg string | always | Success or failure message Sample: Image file transferred to device

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Anil Kumar Muraleedharan (@amuraleedhar)

Hint

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