@itentialopensource/cisco-nxos-upgrade-iag
v0.0.16-2023.1.0
Published
Default artifact description
Downloads
7
Readme
Cisco Nexus Software Upgrade - IAG
Table of Contents
- Deprecation Notice
- Overview
- Installation Prerequisites
- Requirements
- Features
- Future Enhancements
- How to Install
- How to Run
- Command Template Results
Deprecation Notice
This prebuilt has been marked for deprecation on May 17th, 2023 with the scheduled removal date as May 17th, 2024. The replacement for this pre-built is the Cisco NX-OS Upgrade pre-built.
Overview
This pre-built contains the Cisco NXOS Software Upgrade, designed to upgrade firmware on Cisco Nexus 5/7/9k Devices. You will need to provide device hostname from Ansible, firmware filename (should be already located on the device) and mode of operation (Verbose or Zero-Touch). If you are attempting to upgrade a Nexus 5k device, you will also need to provide the kickstart binary file, which should also already be located on the device.
This solution consists of the following:
- Operations Manager (use case entry point) (Cisco NX-OS Upgrade - IAG)
- Main Workflow (Cisco NX-OS Upgrade - IAG)
- Workflow (Device-Connection-Health-Check)
- Workflow (Command Template Runner)
- JSON Form (Cisco NX-OS Upgrade)
- TextFSM Template (Cisco NX-OS Upgrade)
- Command Template (Cisco NX-OS Upgrade - Pre Checks)
- Command Template (Cisco NX-OS Upgrade - Post Checks)
- Transformation (cisco-nxos-upgrade-ID)
- Transformation (cisco-nxos-upgrade-Variables)
- Transformation (incrementNumber)
Estimated Run Time: 20-25 minutes
Installation Prerequisites
Users must satisfy the following pre-requisites:
- Itential Automation Platform (IAP)
^2023.1
- Itential Automation Gateway (IAG)
^3.227.0+2023.1.15
Requirements
This pre-built requires the following:
- Cisco NX Device - with the new firmware binary already downloaded and integrity-verified
Features
The main benefits and features of the pre-built are outlined below.
- NXOS Upgrade Artifact follows Cisco Documentation for ordering and procedure
- 2 modes of operation: Zero-Touch (for happy path), and Verbose
- Allow rollback changes in verbose mode
- Configuration snapshot via IAP configuration manager pre-change and post-change
- Configuration snapshot is directly to the device pre-change and post-change so backups are easily accessible
- Sufficient Error Handling to allow for retrying in almost every failure case, or proper mitigation if necessary
Future Enhancements
- Add better functionality to differentiate between devices that are on IAG versus devices that are on NSO
How to Install
To install the pre-built:
- Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section in order to install the pre-built.
- The pre-built can be installed from within Admin Essentials app. Simply search for the name of your desired pre-built and click the install button (as shown below).
How to Run
- Navigate to Operations Manager and select the "Cisco NX-OS Upgrade - IAG" automation.
- Select the manual trigger and fill in the JSON form with the NX device, desired binary upgrade package, and mode of operation.
- Navigate to active job to monitor progress.
Command Template Results**
If zero-touch is disabled, you will be presented with command template results for pre-checks and post-checks and response from the NXOS upgrade on the device. See the images below for reference.
Pre-Checks and Post-Checks
Pre-check template results for Cisco NX Upgrade.