community.general.cnos_backup (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module allows you to work with switch configurations. It provides a way to back up the running or startup configurations of a switch to a remote server. This is achieved by periodically saving a copy of the startup or running configuration of the network device to 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 location where the configuration will be backed up. Authentication details required by the remote server must be provided as well. 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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

Tasks : The following are examples of using the module cnos_backup.
 These are written in the main.yml file of the tasks directory.
---
- name: Test Running Config Backup
  cnos_backup:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
      configType: running-config
      protocol: "sftp"
      serverip: "10.241.106.118"
      rcpath: "/root/cnos/G8272-running-config.txt"
      serverusername: "root"
      serverpassword: "root123"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test Startup Config Backup
  cnos_backup:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
      configType: startup-config
      protocol: "sftp"
      serverip: "10.241.106.118"
      rcpath: "/root/cnos/G8272-startup-config.txt"
      serverusername: "root"
      serverpassword: "root123"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test Running Config Backup -TFTP
  cnos_backup:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
      configType: running-config
      protocol: "tftp"
      serverip: "10.241.106.118"
      rcpath: "/anil/G8272-running-config.txt"
      serverusername: "root"
      serverpassword: "root123"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Test Startup Config Backup - TFTP
  cnos_backup:
      deviceType: "{{ hostvars[inventory_hostname]['deviceType'] }}"
      outputfile: "./results/test_backup_{{ inventory_hostname }}_output.txt"
      configType: startup-config
      protocol: "tftp"
      serverip: "10.241.106.118"
      rcpath: "/anil/G8272-startup-config.txt"
      serverusername: "root"
      serverpassword: "root123"

Inputs

    
host:
    description:
    - 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.
    required: true
    type: str

rcpath:
    default: null
    description:
    - This specifies the full file path where the configuration file will be copied 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.
    required: true

password:
    description:
    - 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.
    required: true
    type: str

protocol:
    choices:
    - SFTP
    - SCP
    - FTP
    - TFTP
    default: null
    description:
    - This refers to the protocol used by the network device to interact with the remote
      server to where to upload the backup configuration. 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.
    required: true

username:
    description:
    - 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.
    required: true
    type: str

configType:
    choices:
    - running-config
    - startup-config
    default: null
    description:
    - This specifies what type of configuration will be backed up. The choices are the
      running or startup configurations. There is no default value, so it will result
      in an error if the input is incorrect.
    required: true

deviceType:
    choices:
    - g8272_cnos
    - g8296_cnos
    - g8332_cnos
    - NE0152T
    - NE1072T
    - NE1032
    - NE1032T
    - NE10032
    - NE2572
    description:
    - 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
    required: true
    type: str

outputfile:
    description:
    - 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.
    required: true
    type: str

rcserverip:
    default: null
    description: -This specifies the IP Address of the remote server to where the configuration
      will be backed up.
    required: true

enablePassword:
    description:
    - 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.
    type: str

serverpassword:
    default: null
    description:
    - Specify the password for the server relating to the protocol used.
    required: true

serverusername:
    default: null
    description:
    - Specify the username for the server relating to the protocol used.
    required: true

Outputs

msg:
  description: Success or failure message
  returned: always
  sample: Config file transferred to server
  type: str