Add reboot flag to install_os (#376)

* add reboot argument to install_os, vendor pynxos and update to support a reboot argument on set_boot_options

* add comment

* fix gitignore to allow pynxos/lib

* changelog

* PR feedback

Author: gsnider2195

.gitignore

@@ -309,3 +309,6 @@ public
 /compose.yaml
 /dump.sql
 /pyntc/static/pyntc/docs
+
+# Exception for pynxos/lib
+!/pyntc/devices/pynxos/lib/

changes/376.added

@@ -0,0 +1,2 @@
+Added reboot flag to Device.install_os for supported platforms.
+Vendored pynxos library and added reboot flag to Device.set_boot_options.

docs/generate_code_reference_pages.py

@@ -4,7 +4,13 @@
 
 import mkdocs_gen_files
 
+EXCLUDE_PATHS = {
+    "pyntc/devices/pynxos",  # Exclude vendored package pynxos
+}
+
 for file_path in Path("pyntc").rglob("*.py"):
+    if any(str(file_path).startswith(excluded) for excluded in EXCLUDE_PATHS):
+        continue
     module_path = file_path.with_suffix("")
     doc_path = file_path.with_suffix(".md")
     full_doc_path = Path("code-reference", doc_path)

poetry.lock

@@ -971,12 +971,15 @@ def hostname(self):
         hostname_string = hostname.group(1)
         return hostname_string
 
-    def install_os(self, image_name, controller="both", save_config=True, disable_wlans=None, **vendor_specifics):
+    def install_os(
+        self, image_name, reboot=True, controller="both", save_config=True, disable_wlans=None, **vendor_specifics
+    ):
         """
         Install an operating system on the controller.
 
         Args:
             image_name (str): The version to install on the device.
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to true.
             controller (str): The controller(s) to reboot for install (only applies to HA device).
             save_config (bool): Whether the config should be saved to the device before reboot.
             disable_wlans (str|list): Which WLANs to disable/enable before/after upgrade. Default is None.
@@ -1014,6 +1017,9 @@ def install_os(self, image_name, controller="both", save_config=True, disable_wl
         if not self._image_booted(image_name):
             peer_redundancy = self.peer_redundancy_state
             self.set_boot_options(image_name, **vendor_specifics)
+            if not reboot:
+                log.info("Host %s: OS image %s boot options set. Reboot the device to apply", self.host, image_name)
+                return True
             if disable_wlans is not None:
                 self.disable_wlans(disable_wlans)
             self.reboot(controller=controller, save_config=save_config)

pyntc/devices/aireos_device.py

@@ -685,12 +685,13 @@ def get_remote_checksum(self, filename, hashing_algorithm="md5", **kwargs: Any):
         log.error("Host %s: Unable to parse checksum for %s from output: %s", self.host, filename, result)
         raise CommandError(cmd, f"Unable to parse checksum for {filename}")
 
-    def install_os(self, image_name, **vendor_specifics):
+    def install_os(self, image_name, reboot=True, **vendor_specifics):
         """
         Install OS on device.
 
         Args:
             image_name (str): Name of the image to be installed.
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to true.
             vendor_specifics (dict): Vendor specific arguments to pass to the install process.
 
         Raises:
@@ -702,6 +703,9 @@ def install_os(self, image_name, **vendor_specifics):
         timeout = vendor_specifics.get("timeout", 3600)
         if not self._image_booted(image_name):
             self.set_boot_options(image_name, **vendor_specifics)
+            if not reboot:
+                log.info("Host %s: OS image %s boot options set. Reboot the device to apply", self.host, image_name)
+                return True
             self.reboot()
             self._wait_for_device_reboot(timeout=timeout)
             if not self._image_booted(image_name):

pyntc/devices/asa_device.py

@@ -450,11 +450,12 @@ def verify_file(self, checksum, filename, hashing_algorithm="md5", **kwargs):
         """
         raise NotImplementedError
 
-    def install_os(self, image_name, **vendor_specifics):
+    def install_os(self, image_name, reboot=True, **vendor_specifics):
         """Install the OS from specified image_name.
 
         Args:
             image_name (str): The name of the image on the device to install.
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to true.
 
         Keyword Args:
             kickstart (str): Option for ``NXOSDevice`` for devices that require a kickstart image.

pyntc/devices/base_device.py

@@ -715,11 +715,12 @@ def verify_file(self, checksum, filename, hashing_algorithm="md5", **kwargs):
         )
         return False
 
-    def install_os(self, image_name, **vendor_specifics):
+    def install_os(self, image_name, reboot=True, **vendor_specifics):
         """Install new OS on device.
 
         Args:
             image_name (str): Name of the image name to be installed.
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to true.
             vendor_specifics (dict): Vendor specific options for installing OS, such as timeout.
 
         Raises:
@@ -731,6 +732,9 @@ def install_os(self, image_name, **vendor_specifics):
         timeout = vendor_specifics.get("timeout", 3600)
         if not self._image_booted(image_name):
             self.set_boot_options(image_name, **vendor_specifics)
+            if not reboot:
+                log.info("Host %s: OS image %s boot options set. Reboot the device to apply", self.host, image_name)
+                return True
             self.reboot()
             self._wait_for_device_reboot(timeout=timeout)
             if not self._image_booted(image_name):

pyntc/devices/eos_device.py

@@ -654,11 +654,12 @@ def image_installed(self, image_name, volume):
         log.debug("Host %s: Image %s not installed on volume %s.", self.host, image_name, volume)
         return False
 
-    def install_os(self, image_name, **vendor_specifics):
+    def install_os(self, image_name, reboot=False, **vendor_specifics):
         """Install OS on device.
 
         Args:
             image_name (str): Image name.
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to false.
             vendor_specifics (dict): Vendor specific arguments.
 
         Raises:
@@ -667,6 +668,10 @@ def install_os(self, image_name, **vendor_specifics):
         Returns:
             (bool): True if image is installed successfully. Otherwise, false.
         """
+        if reboot:
+            # TODO: Implement reboot after OS installation
+            raise NotImplementedError("F5 reboot after OS installation is not supported.")
+
         volume = vendor_specifics.get("volume")
         if not self.image_installed(image_name, volume):
             self._check_free_space(min_space=6)

pyntc/devices/f5_device.py

@@ -877,11 +877,12 @@ def file_copy_remote_exists(self, src, dest=None, file_system=None):
         log.debug("Host %s: File %s does not already exist on remote.", self.host, src)
         return False
 
-    def install_os(self, image_name, install_mode=False, read_timeout=2000, **vendor_specifics):
+    def install_os(self, image_name, reboot=True, install_mode=False, read_timeout=2000, **vendor_specifics):
         """Installs the prescribed Network OS, which must be present before issuing this command.
 
         Args:
             image_name (str): Name of the IOS image to boot into
+            reboot (bool): Whether to reboot the device after setting the boot options. Defaults to true.
             install_mode (bool, optional): Uses newer install method on devices. Defaults to False.
             read_timeout (int, optional): Netmiko timeout when waiting for device prompt. Default 2000.
             vendor_specifics (dict, optional): Vendor specific arguments to pass to the install command.
@@ -894,6 +895,11 @@ def install_os(self, image_name, install_mode=False, read_timeout=2000, **vendor
         """
         timeout = vendor_specifics.get("timeout", 3600)
         if not self._image_booted(image_name):
+            if install_mode and not reboot:
+                raise ValueError(
+                    "IOS devices automatically reboot after installation when using install mode but the reboot argument was set to false."
+                )
+
             if install_mode:
                 # Change boot statement to be boot system <flash>:packages.conf
                 self.set_boot_options(INSTALL_MODE_FILE_NAME, **vendor_specifics)
@@ -926,6 +932,9 @@ def install_os(self, image_name, install_mode=False, read_timeout=2000, **vendor
                         self.reboot()
             else:
                 self.set_boot_options(image_name, **vendor_specifics)
+                if not reboot:
+                    log.info("Host %s: OS image %s boot options set. Reboot the device to apply", self.host, image_name)
+                    return True
                 self.reboot()
 
             # Wait for the reboot to finish