Adds implemented feature to support fastcli=False (#202)

Author: jvanderaa

pyntc/devices/ios_device.py

@@ -46,7 +46,7 @@ class IOSDevice(BaseDevice):
     vendor = "cisco"
     active_redundancy_states = {None, "active"}
 
-    def __init__(self, host, username, password, secret="", port=22, confirm_active=True, **kwargs):
+    def __init__(self, host, username, password, secret="", port=22, confirm_active=True, fast_cli=True, **kwargs):
         """
         PyNTC Device implementation for Cisco IOS.
 
@@ -57,6 +57,7 @@ def __init__(self, host, username, password, secret="", port=22, confirm_active=
             secret (str): The password to escalate privilege on the device.
             port (int): The port to use to establish the connection.
             confirm_active (bool): Determines if device's high availability state should be validated before leaving connection open.
+            fast_cli (bool): Fast CLI mode for Netmiko, it is recommended to use False when opening the client on code upgrades
         """
         super().__init__(host, username, password, device_type="cisco_ios_ssh")
 
@@ -65,6 +66,7 @@ def __init__(self, host, username, password, secret="", port=22, confirm_active=
         self.port = int(port)
         self.global_delay_factor = kwargs.get("global_delay_factor", 1)
         self.delay_factor = kwargs.get("delay_factor", 1)
+        self._fast_cli = fast_cli
         self._connected = False
         self.open(confirm_active=confirm_active)
 
@@ -133,11 +135,21 @@ def _get_file_system(self):
         raise FileSystemNotFoundError(hostname=self.hostname, command="dir")
 
     # Get the version of the image that is booted into on the device
-    def _image_booted(self, image_name, **vendor_specifics):
+    def _image_booted(self, image_name, image_pattern=r".*\.(\d+\.\d+\.\w+)\.SPA.+", **vendor_specifics):
         version_data = self.show("show version")
         if re.search(image_name, version_data):
             return True
 
+        # Test for version number in the text, used on install mode devices that use packages.conf
+        try:
+            version_number = re.search(image_pattern, image_name).group(1)
+            if version_number and version_number in version_data:
+                return True
+        # Continue on if regex is unable to find the result, which raises an attribute error
+        except AttributeError:
+            pass
+
+        # Unable to find the version number in output, the image is not booted.
         return False
 
     def _interfaces_detailed_list(self):
@@ -277,8 +289,8 @@ def config(self, command, **netmiko_args):
             **netmiko_args: Any argument supported by ``netmiko.ConnectHandler.send_config_set``.
 
         Returns:
-            str: When ``command`` is a str, the config session input and ouput from sending ``command``.
-            list: When ``command`` is a list, the config session input and ouput from sending ``command``.
+            str: When ``command`` is a str, the config session input and output from sending ``command``.
+            list: When ``command`` is a list, the config session input and output from sending ``command``.
 
         Raises:
             TypeError: When sending an argument in ``**netmiko_args`` that is not supported.
@@ -350,7 +362,7 @@ def config_list(self, commands, **netmiko_args):
             **netmiko_args: Any argument supported by ``netmiko.ConnectHandler.send_config_set``.
 
         Returns:
-            list: Each command's input and ouput from sending the command in ``commands``.
+            list: Each command's input and output from sending the command in ``commands``.
 
         Raises:
             TypeError: When sending an argument in ``**netmiko_args`` that is not supported.
@@ -509,6 +521,15 @@ def config_register(self):
 
         return self._config_register
 
+    @property
+    def fast_cli(self):
+        return self._fast_cli
+
+    @fast_cli.setter
+    def fast_cli(self, value):
+        self._fast_cli = value
+        self.native.fast_cli = value
+
     def file_copy(self, src, dest=None, file_system=None):
         self.enable()
         if file_system is None:
@@ -551,7 +572,7 @@ def file_copy_remote_exists(self, src, dest=None, file_system=None):
             return True
         return False
 
-    def install_os(self, image_name, install_mode=False, install_mode_delay_factor=10, **vendor_specifics):
+    def install_os(self, image_name, install_mode=False, install_mode_delay_factor=20, **vendor_specifics):
         """Installs the prescribed Network OS, which must be present before issuing this command.
 
         Args:
@@ -570,6 +591,12 @@ def install_os(self, image_name, install_mode=False, install_mode_delay_factor=1
                 # Change boot statement to be boot system <flash>:packages.conf
                 self.set_boot_options(INSTALL_MODE_FILE_NAME, **vendor_specifics)
 
+                # Get the current fast_cli to set it back later to whatever it is
+                current_fast_cli = self.fast_cli
+
+                # Set fast_cli to False to handle install mode, 10+ minute installation
+                self.fast_cli = False
+
                 # Check for OS Version specific upgrade path
                 # https://www.cisco.com/c/en/us/td/docs/switches/lan/catalyst9300/software/release/17-2/release_notes/ol-17-2-9300.html
                 os_version = self.os_version
@@ -589,13 +616,18 @@ def install_os(self, image_name, install_mode=False, install_mode_delay_factor=1
                         self.show(command, delay_factor=install_mode_delay_factor)
                     except IOError:
                         pass
+
             else:
                 self.set_boot_options(image_name, **vendor_specifics)
                 self.reboot()
 
             # Wait for the reboot to finish
             self._wait_for_device_reboot(timeout=timeout)
 
+            # Set FastCLI back to originally set when using install mode
+            if install_mode:
+                self.fast_cli = current_fast_cli
+
             # Verify the OS level
             if not self._image_booted(image_name):
                 raise OSInstallError(hostname=self.hostname, desired_boot=image_name)
@@ -624,13 +656,13 @@ def open(self, confirm_active=True):
         Open a connection to the network device.
 
         This method will close the connection if ``confirm_active`` is True and the device is not active.
-        Devices that do not have high availibility are considred active.
+        Devices that do not have high availability are considered active.
 
         Args:
             confirm_active (bool): Determines if device's high availability state should be validated before leaving connection open.
 
         Raises:
-            DeviceNotActiveError: When ``confirm_active`` is True, and the device high availabilit state is not active.
+            DeviceNotActiveError: When ``confirm_active`` is True, and the device high availability state is not active.
 
         Example:
             >>> device = IOSDevice(**connection_args)
@@ -662,6 +694,7 @@ def open(self, confirm_active=True):
                 global_delay_factor=self.global_delay_factor,
                 secret=self.secret,
                 verbose=False,
+                fast_cli=self.fast_cli,
             )
             self._connected = True
 

test/unit/test_devices/device_mocks/ios/show_version.txt

@@ -0,0 +1,62 @@
+Cisco IOS Software, C3750 Software (C3750-IPSERVICESK9-M), Version 15.0(2)SE11, RELEASE SOFTWARE (fc3)
+Technical Support: http://www.cisco.com/techsupport
+Copyright (c) 1986-2017 by Cisco Systems, Inc.
+Compiled Sat 19-Aug-17 09:28 by prod_rel_team
+
+ROM: Bootstrap program is C3750 boot loader
+BOOTLDR: C3750 Boot Loader (C3750-HBOOT-M) Version 12.2(25r)SE1, RELEASE SOFTWARE (fc)
+
+joshv-sw01 uptime is 30 weeks, 2 days, 6 hours, 5 minutes
+System returned to ROM by power-on
+System restarted at 16:23:49 CDT Sun Jul 19 2020
+System image file is "flash:/c3750-ipservicesk9-mz.150-2.SE11.bin"
+
+
+This product contains cryptographic features and is subject to United
+States and local country laws governing import, export, transfer and
+use. Delivery of Cisco cryptographic products does not imply
+third-party authority to import, export, distribute or use encryption.
+Importers, exporters, distributors and users are responsible for
+compliance with U.S. and local country laws. By using this product you
+agree to comply with applicable laws and regulations. If you are unable
+to comply with U.S. and local laws, return this product immediately.
+
+A summary of U.S. laws governing Cisco cryptographic products may be found at:
+http://www.cisco.com/wwl/export/crypto/tool/stqrg.html
+
+If you require further assistance please contact us by sending email to
+[email protected].
+
+cisco WS-C3750G-48PS (PowerPC405) processor (revision C0) with 131072K bytes of memory.
+Processor board ID FOC0948Y2RB
+Last reset from power-on
+4 Virtual Ethernet interfaces
+52 Gigabit Ethernet interfaces
+The password-recovery mechanism is enabled.
+
+512K bytes of flash-simulated non-volatile configuration memory.
+Base ethernet MAC Address       : 00:16:47:10:AF:00
+Motherboard assembly number     : 73-9365-08
+Power supply part number        : 341-0108-02
+Motherboard serial number       : FOC09480D0A
+Power supply serial number      : DCA09431730
+Model revision number           : C0
+Motherboard revision number     : A0
+Model number                    : WS-C3750G-48PS-E
+System serial number            : FOC0948Y2RB
+SFP Module assembly part number : 73-7757-03
+SFP Module revision Number      : A0
+SFP Module serial number        : CAT094403WR
+Top Assembly Part Number        : 800-26344-02
+Top Assembly Revision Number    : B0
+Version ID                      : V02
+CLEI Code Number                : CNMWM00ARB
+Hardware Board Revision Number  : 0x05
+
+
+Switch Ports Model              SW Version            SW Image
+------ ----- -----              ----------            ----------
+*    1 52    WS-C3750G-48PS     15.0(2)SE11           C3750-IPSERVICESK9-M
+
+
+Configuration register is 0xF

test/unit/test_devices/device_mocks/ios/show_version_install_mode.txt

@@ -0,0 +1,99 @@
+Cisco IOS XE Software, Version 16.09.03
+Cisco IOS Software [Fuji], Catalyst L3 Switch Software (CAT9K_IOSXE), Version 16.9.3, RELEASE SOFTWARE (fc2)
+Technical Support: http://www.cisco.com/techsupport
+Copyright (c) 1986-2019 by Cisco Systems, Inc.
+Compiled Wed 20-Mar-19 08:02 by mcpre
+
+
+Cisco IOS-XE software, Copyright (c) 2005-2019 by cisco Systems, Inc.
+All rights reserved.  Certain components of Cisco IOS-XE software are
+licensed under the GNU General Public License ("GPL") Version 2.0.  The
+software code licensed under GPL Version 2.0 is free software that comes
+with ABSOLUTELY NO WARRANTY.  You can redistribute and/or modify such
+GPL code under the terms of GPL Version 2.0.  For more details, see the
+documentation or "License Notice" file accompanying the IOS-XE software,
+or the applicable URL provided on the flyer accompanying the IOS-XE
+software.
+
+
+ROM: IOS-XE ROMMON
+BOOTLDR: System Bootstrap, Version 16.9.1r [FC2], RELEASE SOFTWARE (P)
+
+AKBTESTW01 uptime is 1 year, 22 weeks, 6 days, 9 hours, 38 minutes
+Uptime for this control processor is 1 year, 22 weeks, 6 days, 9 hours, 44 minutes
+System returned to ROM by Reload Command at 22:09:11 NZST Wed May 1 2019
+System restarted at 22:16:13 NZST Wed May 1 2019
+System image file is "flash:packages.conf"
+Last reload reason: Reload Command
+
+
+
+This product contains cryptographic features and is subject to United
+States and local country laws governing import, export, transfer and
+use. Delivery of Cisco cryptographic products does not imply
+third-party authority to import, export, distribute or use encryption.
+Importers, exporters, distributors and users are responsible for
+compliance with U.S. and local country laws. By using this product you
+agree to comply with applicable laws and regulations. If you are unable
+to comply with U.S. and local laws, return this product immediately.
+
+A summary of U.S. laws governing Cisco cryptographic products may be found at:
+http://www.cisco.com/wwl/export/crypto/tool/stqrg.html
+
+If you require further assistance please contact us by sending email to
+[email protected].
+
+
+Technology Package License Information: 
+
+------------------------------------------------------------------------------
+Technology-package                                     Technology-package
+Current                        Type                       Next reboot  
+------------------------------------------------------------------------------
+network-advantage       Smart License                    network-advantage   
+dna-advantage           Subscription Smart License       dna-advantage                 
+
+
+Smart Licensing Status: UNREGISTERED/EVAL EXPIRED
+
+cisco C9500-40X (X86) processor with 1419496K/6147K bytes of memory.
+Processor board ID FCW2233FFG3
+16 Virtual Ethernet interfaces
+96 Ten Gigabit Ethernet interfaces
+4 Forty Gigabit Ethernet interfaces
+2048K bytes of non-volatile configuration memory.
+16777216K bytes of physical memory.
+1638400K bytes of Crash Files at crashinfo:.
+1638400K bytes of Crash Files at crashinfo-2:.
+11264000K bytes of Flash at flash:.
+11264000K bytes of Flash at flash-2:.
+0K bytes of WebUI ODM Files at webui:.
+
+Base Ethernet MAC Address          : 0c:d0:f8:cd:b5:80
+Motherboard Assembly Number        : 73-18140-03
+Motherboard Serial Number          : FOC223855F9
+Model Revision Number              : D0
+Motherboard Revision Number        : B0
+Model Number                       : C9500-40X
+System Serial Number               : FCW2233FFG3
+
+
+Switch Ports Model              SW Version        SW Image              Mode   
+------ ----- -----              ----------        ----------            ----   
+*    1 50    C9500-40X          16.9.3            CAT9K_IOSXE           INSTALL
+     2 50    C9500-40X          16.9.3            CAT9K_IOSXE           INSTALL
+
+
+Switch 02
+---------
+Switch uptime                      : 1 year, 22 weeks, 6 days, 9 hours, 47 minutes
+
+Base Ethernet MAC Address          : 70:35:09:dd:20:00
+Motherboard Assembly Number        : 73-11122-03
+Motherboard Serial Number          : FOC234567Y9
+Model Revision Number              : D0
+Motherboard Revision Number        : B0
+Model Number                       : C9500-40X
+System Serial Number               : FCW1234F88V
+
+Configuration register is 0x102