ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity
community.general/plugins/modules/network/cnos/cnos_image.py
Ansible Core Team aebc1b03fd Initial commit
2020-03-09 09:11:07 +00:00

241 lines
8.8 KiB
Python
Raw Blame History

#!/usr/bin/python
# -*- coding: utf-8 -*-
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
#
# Copyright (C) 2017 Lenovo, Inc.
#
# This file is part of Ansible
#
# Ansible is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Ansible is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
#
# Module to download new image to Lenovo Switches
# Lenovo Networking
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'}
DOCUMENTATION = '''
---
module: cnos_image
author: "Anil Kumar Muraleedharan (@amuraleedhar)"
short_description: Perform firmware upgrade/download from a remote server on
devices running Lenovo CNOS
description:
- 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.
extends_documentation_fragment:
- community.general.cnos
options:
protocol:
description:
- 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.
required: true
choices: [SFTP, SCP, FTP, TFTP]
serverip:
description:
- This specifies the IP Address of the remote server from where the
software image will be downloaded.
required: true
imgpath:
description:
- 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.
required: true
imgtype:
description:
- This specifies the firmware image type to be downloaded
required: true
choices: [all, boot, os, onie]
serverusername:
description:
- Specify the username for the server relating to the protocol used
required: true
serverpassword:
description:
- Specify the password for the server relating to the protocol used
'''
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 = '''
msg:
description: Success or failure message
returned: always
type: str
sample: "Image file transferred to device"
'''
import sys
import time
import socket
import array
import json
import time
import re
import os
try:
from ansible_collections.community.general.plugins.module_utils.network.cnos import cnos
HAS_LIB = True
except Exception:
HAS_LIB = False
from ansible.module_utils.basic import AnsibleModule
from collections import defaultdict
def doImageDownload(module, prompt, answer):
protocol = module.params['protocol'].lower()
server = module.params['serverip']
imgPath = module.params['imgpath']
imgType = module.params['imgtype']
username = module.params['serverusername']
password = module.params['serverpassword']
retVal = ''
command = "copy " + protocol + " " + protocol + "://" + username + "@"
command = command + server + "/" + imgPath + " system-image "
command = command + imgType + " vrf management"
cmd = []
if(protocol == "scp"):
prompt = ['timeout', 'Confirm download operation', 'Password',
'Do you want to change that to the standby image']
answer = ['240', 'y', password, 'y']
scp_cmd = [{'command': command, 'prompt': prompt, 'answer': answer,
'check_all': True}]
cmd.extend(scp_cmd)
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
elif(protocol == "sftp"):
prompt = ['Confirm download operation', 'Password',
'Do you want to change that to the standby image']
answer = ['y', password, 'y']
sftp_cmd = [{'command': command, 'prompt': prompt, 'answer': answer,
'check_all': True}]
cmd.extend(sftp_cmd)
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
elif(protocol == "ftp"):
prompt = ['Confirm download operation', 'Password',
'Do you want to change that to the standby image']
answer = ['y', password, 'y']
ftp_cmd = [{'command': command, 'prompt': prompt, 'answer': answer,
'check_all': True}]
cmd.extend(ftp_cmd)
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
elif(protocol == "tftp"):
command = "copy " + protocol + " " + protocol + "://" + server
command = command + "/" + imgPath + " system-image " + imgType
command = command + " vrf management"
prompt = ['Confirm download operation',
'Do you want to change that to the standby image']
answer = ['y', 'y']
tftp_cmd = [{'command': command, 'prompt': prompt, 'answer': answer,
'check_all': True}]
cmd.extend(tftp_cmd)
retVal = retVal + str(cnos.run_cnos_commands(module, cmd))
else:
return "Error-110"
return retVal
# EOM
def main():
module = AnsibleModule(
argument_spec=dict(
outputfile=dict(required=True),
host=dict(required=False),
username=dict(required=False),
password=dict(required=False, no_log=True),
enablePassword=dict(required=False, no_log=True),
deviceType=dict(required=True),
protocol=dict(required=True),
serverip=dict(required=True),
imgpath=dict(required=True),
imgtype=dict(required=True),
serverusername=dict(required=False),
serverpassword=dict(required=False, no_log=True),),
supports_check_mode=False)
outputfile = module.params['outputfile']
protocol = module.params['protocol'].lower()
output = ''
# Invoke method for image transfer from server
if(protocol == "tftp" or protocol == "ftp" or protocol == "sftp" or
protocol == "scp"):
transfer_status = doImageDownload(module, None, None)
else:
transfer_status = "Invalid Protocol option"
output = output + "\n Image Transfer status \n" + transfer_status
# Save it into the file
path = outputfile.rsplit('/', 1)
if not os.path.exists(path[0]):
os.makedirs(path[0])
file = open(outputfile, "a")
file.write(output)
file.close()
# Logic to check when changes occur or not
errorMsg = cnos.checkOutputForError(output)
if(errorMsg is None):
module.exit_json(changed=True, msg="Image file transferred to device")
else:
module.fail_json(msg=errorMsg)
if __name__ == '__main__':
main()
View git blame Copy permalink