mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-22 12:50:22 -07:00
Lenovo image refactor (#44953)
* Refactoring code to adhere to persistence connection. * Update cnos_rollback.py * Updating license for the refactored method * Update cnos_rollback.py * Removing the BSD License as suggested by Legal * Adding cnos_image after testing on sftp. Test code is also added * Removing debug comments * adding space
This commit is contained in:
Anil Kumar Muraleedharan
Ganesh Nalawade
parent
c0326aea2f
commit
fbf55a09cc
8 changed files with 256 additions and 200 deletions
|
|
@ -74,7 +74,8 @@ cnos_argument_spec = {
|
|||
command_spec = {
|
||||
'command': dict(key=True),
|
||||
'prompt': dict(),
|
||||
'answer': dict()
|
||||
'answer': dict(),
|
||||
'check_all': dict()
|
||||
}
|
||||
|
||||
|
||||
|
|
@ -1327,137 +1328,6 @@ def interfaceLevel2Config(module, cmd, prompt, answer):
|
|||
# EOM
|
||||
|
||||
|
||||
# Utility Method to download an image from FTP/TFTP server to device.
|
||||
# This method supports only FTP or TFTP
|
||||
# Tuning of timeout parameter is pending
|
||||
|
||||
|
||||
def doImageTransfer(
|
||||
protocol, timeout, imgServerIp, imgPath, imgType, imgServerUser,
|
||||
imgServerPwd, obj):
|
||||
# server = "10.241.106.118"
|
||||
server = imgServerIp
|
||||
# username = "root"
|
||||
username = imgServerUser
|
||||
# password = "root123"
|
||||
password = imgServerPwd
|
||||
|
||||
type = "os"
|
||||
if(imgType is not None):
|
||||
type = imgType.lower()
|
||||
|
||||
if((imgPath is None) or (imgPath is "")):
|
||||
imgPath = "cnos_images"
|
||||
|
||||
retVal = ""
|
||||
|
||||
# Image transfer command happens here
|
||||
if(protocol == "ftp"):
|
||||
command = "cp " + protocol + " " + protocol + "://" + username + \
|
||||
"@" + server + "/" + imgPath + " system-image " + type + \
|
||||
" vrf management\n"
|
||||
elif(protocol == "tftp"):
|
||||
command = "cp " + protocol + " " + protocol + "://" + server + \
|
||||
"/" + imgPath + " system-image " + type + " vrf management\n"
|
||||
else:
|
||||
return "Error-110"
|
||||
# debugOutput(command)
|
||||
response = waitForDeviceResponse(command, "[n]", 3, obj)
|
||||
if(response.lower().find('error-101')):
|
||||
retVal = retVal
|
||||
else:
|
||||
retVal = retVal + response
|
||||
|
||||
# Confirmation command happens here
|
||||
command = "y\n"
|
||||
# debugOutput(command)
|
||||
if(protocol == "ftp"):
|
||||
retVal = retVal + waitForDeviceResponse(command, "Password:", 3, obj)
|
||||
# Password entry happens here Only for FTP
|
||||
command = password + " \n"
|
||||
# debugOutput(command)
|
||||
# Change to standby image y
|
||||
retVal = retVal + waitForDeviceResponse(command, "[n]", timeout, obj)
|
||||
command = "y\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "#", timeout, obj)
|
||||
return retVal
|
||||
# EOM
|
||||
|
||||
# Utility Method to download an image from SFTP/SCP server to device.
|
||||
# This method supports only SCP or SFTP
|
||||
# Tuning of timeout parameter is pending
|
||||
|
||||
|
||||
def doSecureImageTransfer(
|
||||
protocol, timeout, imgServerIp, imgPath, imgType, imgServerUser,
|
||||
imgServerPwd, obj):
|
||||
# server = "10.241.105.214"
|
||||
server = imgServerIp
|
||||
# username = "pbhosale"
|
||||
username = imgServerUser
|
||||
# password = "Lab4man1"
|
||||
password = imgServerPwd
|
||||
|
||||
type = "scp"
|
||||
if(imgType is not None):
|
||||
type = imgType.lower()
|
||||
|
||||
if((imgPath is None) or (imgPath is "")):
|
||||
imgPath = "cnos_images"
|
||||
|
||||
retVal = ""
|
||||
|
||||
# Image transfer command happens here
|
||||
command = "cp " + protocol + " " + protocol + "://" + username + "@" + \
|
||||
server + "/" + imgPath + " system-image " + type + " vrf management \n"
|
||||
# debugOutput(command)
|
||||
response = waitForDeviceResponse(command, "[n]", 3, obj)
|
||||
if(response.lower().find('error-101')):
|
||||
retVal = retVal
|
||||
else:
|
||||
retVal = retVal + response
|
||||
# Confirmation command happens here
|
||||
if(protocol == "scp"):
|
||||
command = "y\n"
|
||||
# debugOutput(command)
|
||||
response = waitForDeviceResponse(command, "(yes/no)?", 3, obj)
|
||||
if(response.lower().find('error-101')):
|
||||
retVal = retVal
|
||||
else:
|
||||
retVal = retVal + response
|
||||
command = "Yes\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "timeout:", 3, obj)
|
||||
command = "0\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "Password:", 3, obj)
|
||||
elif(protocol == "sftp"):
|
||||
command = "y\n"
|
||||
# debugOutput(command)
|
||||
response = waitForDeviceResponse(command, "(yes/no)?", 3, obj)
|
||||
if(response.lower().find('error-101')):
|
||||
retVal = retVal
|
||||
else:
|
||||
retVal = retVal + response
|
||||
|
||||
command = "Yes\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "Password:", 3, obj)
|
||||
else:
|
||||
return "Error-110"
|
||||
|
||||
# Password entry happens here
|
||||
command = password + "\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "[n]", timeout, obj)
|
||||
# Change to standby image y
|
||||
command = "y\n"
|
||||
# debugOutput(command)
|
||||
retVal = retVal + waitForDeviceResponse(command, "#", timeout, obj)
|
||||
return retVal
|
||||
# EOM
|
||||
|
||||
# Method Method for enter enable mode
|
||||
#
|
||||
|
||||
|
|
|
|||
|
|
@ -33,37 +33,47 @@ DOCUMENTATION = '''
|
|||
---
|
||||
module: cnos_image
|
||||
author: "Anil Kumar Muraleedharan (@amuraleedhar)"
|
||||
short_description: Perform firmware upgrade/download from a remote server on devices running Lenovo CNOS
|
||||
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 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.
|
||||
For more information about this module from Lenovo and customizing it usage for your
|
||||
use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_image.html)
|
||||
that must be created by the user in their local directory to where the
|
||||
playbook is run.
|
||||
For more information about this module from Lenovo and customizing it
|
||||
usage for your use cases, please visit
|
||||
U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_image.html)
|
||||
version_added: "2.3"
|
||||
extends_documentation_fragment: 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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:
|
||||
|
|
@ -72,14 +82,15 @@ options:
|
|||
choices: [all, boot, os, onie]
|
||||
serverusername:
|
||||
description:
|
||||
- Specify the username for the server relating to the protocol used.
|
||||
- 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.
|
||||
- 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.
|
||||
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:
|
||||
|
|
@ -120,17 +131,13 @@ msg:
|
|||
'''
|
||||
|
||||
import sys
|
||||
try:
|
||||
import paramiko
|
||||
HAS_PARAMIKO = True
|
||||
except ImportError:
|
||||
HAS_PARAMIKO = False
|
||||
import time
|
||||
import socket
|
||||
import array
|
||||
import json
|
||||
import time
|
||||
import re
|
||||
import os
|
||||
try:
|
||||
from ansible.module_utils.network.cnos import cnos
|
||||
HAS_LIB = True
|
||||
|
|
@ -140,6 +147,60 @@ 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(
|
||||
|
|
@ -157,58 +218,23 @@ def main():
|
|||
serverpassword=dict(required=False, no_log=True),),
|
||||
supports_check_mode=False)
|
||||
|
||||
username = module.params['username']
|
||||
password = module.params['password']
|
||||
enablePassword = module.params['enablePassword']
|
||||
outputfile = module.params['outputfile']
|
||||
host = module.params['host']
|
||||
deviceType = module.params['deviceType']
|
||||
protocol = module.params['protocol'].lower()
|
||||
imgserverip = module.params['serverip']
|
||||
imgpath = module.params['imgpath']
|
||||
imgtype = module.params['imgtype']
|
||||
imgserveruser = module.params['serverusername']
|
||||
imgserverpwd = module.params['serverpassword']
|
||||
output = ""
|
||||
timeout = 120
|
||||
tftptimeout = 600
|
||||
if not HAS_PARAMIKO:
|
||||
module.fail_json(msg='paramiko is required for this module')
|
||||
output = ''
|
||||
|
||||
# Create instance of SSHClient object
|
||||
remote_conn_pre = paramiko.SSHClient()
|
||||
|
||||
# Automatically add untrusted hosts (make sure okay for security policy in your environment)
|
||||
remote_conn_pre.set_missing_host_key_policy(paramiko.AutoAddPolicy())
|
||||
|
||||
# initiate SSH connection with the switch
|
||||
remote_conn_pre.connect(host, username=username, password=password)
|
||||
time.sleep(2)
|
||||
|
||||
# Use invoke_shell to establish an 'interactive session'
|
||||
remote_conn = remote_conn_pre.invoke_shell()
|
||||
time.sleep(2)
|
||||
|
||||
# Enable and then send command
|
||||
output = output + cnos.waitForDeviceResponse("\n", ">", 2, remote_conn)
|
||||
|
||||
output = output + cnos.enterEnableModeForDevice(enablePassword, 3, remote_conn)
|
||||
|
||||
# Make terminal length = 0
|
||||
output = output + cnos.waitForDeviceResponse("terminal length 0\n", "#", 2, remote_conn)
|
||||
|
||||
transfer_status = ""
|
||||
# Invoke method for image transfer from server
|
||||
if(protocol == "tftp" or protocol == "ftp"):
|
||||
transfer_status = cnos.doImageTransfer(protocol, tftptimeout, imgserverip, imgpath, imgtype, imgserveruser, imgserverpwd, remote_conn)
|
||||
elif(protocol == "sftp" or protocol == "scp"):
|
||||
transfer_status = cnos.doSecureImageTransfer(protocol, timeout, imgserverip, imgpath, imgtype, imgserveruser, imgserverpwd, remote_conn)
|
||||
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()
|
||||
|
|
|
|||
|
|
@ -80,8 +80,8 @@ class Cliconf(CliconfBase):
|
|||
for cmd in chain([b'configure terminal'], to_list(command), [b'end']):
|
||||
self.send_command(cmd)
|
||||
|
||||
def get(self, command, prompt=None, answer=None, sendonly=False):
|
||||
return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly)
|
||||
def get(self, command, prompt=None, answer=None, sendonly=False, check_all=False):
|
||||
return self.send_command(command, prompt=prompt, answer=answer, sendonly=sendonly, check_all=check_all)
|
||||
|
||||
def get_capabilities(self):
|
||||
result = {}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue