Bug Fix NXOS by mattmiller87 · Pull Request #387 · networktocode/pyntc

mattmiller87 · 2026-05-14T14:56:26Z

New Pull Request

I am solving three bugs when running nxos_device.py:

A return changed to be a string, not a tuple.
using native instead of native_ssh
fixed a vrf prompt option

Change Notes

Fixed _build_url_copy_command_simple to return a string.
Fixed _get_file_system and _get_free_space to use native_ssh; initial intent when created.
Fixed the remote_file_copy prompts to detect needing to enter a vrf if one isn't provided.

Justification

The copy command return from _build_url_copy_command_simple should not be a tuple.
remote_file_copy method is using native_ssh and _get_file_systemand_get_free_spaceshould be using it too.remote_file_copy` may return a prompt we were not catching previously.

Note: unittest changes were written with AI

jtdub

LGTM

gsnider2195 · 2026-05-18T16:10:56Z

            FileSystemNotFoundError: When the module is unable to determine the default file system.
        """
-        raw_data = self.show("dir", raw_text=True)
+        self.open()


Why are we calling self.open() in seemingly random places? Is this working around timeouts not being handled correctly?

Netmiko seems to be handling this fine so I'm going to remove these redundant self.open() calls:

>>> nxos.check_file_exists("system.bin") 2026-05-18 15:34:01,174 [ERROR] paramiko.transport: Socket exception: Connection reset by peer (104) 2026-05-18 15:34:03,854 [INFO] paramiko.transport: Connected (version 2.0, client OpenSSH_6.2) 2026-05-18 15:34:04,476 [INFO] paramiko.transport: Auth banner: b'C\ntest banner\n' 2026-05-18 15:34:04,476 [INFO] paramiko.transport: Authentication (password) successful!

gsnider2195 · 2026-05-18T16:13:52Z

 import unittest

 import mock
+from hypothesis import given


In a prior PR I asked that we stick with testing patterns that the team is familiar with. Please remove hypothesis.

gsnider2195

We need to address some feedback before merging this

gsnider2195 · 2026-05-18T22:38:40Z

Tested the updated commands against a device in the lab:

>>> nxos = pyntc.devices.nxos_device.NXOSDevice(host=nexus_device_ip, username=colo_username, password=colo_pw)
2026-05-18 15:39:03,557 [INFO] pyntc: Logging initialized for host <sanitized>.
>>> nxos._get_file_system()
'bootflash:'
>>> nxos._get_free_space()
48654139392

gsnider2195 · 2026-05-18T23:29:39Z

+    def test_get_free_space_raises_on_parse_error(self):
        """Test _get_free_space raises CommandError when output can't be parsed."""
-        mock_show.return_value = "Directory of bootflash:/\nNo free space info here\n"
+        self.device.native_ssh.send_command.return_value = "Directory of bootflash:/\nNo free space info here\n"


"Directory of ..." is an IOS command output but is fine for this test.

gsnider2195 · 2026-05-19T23:08:51Z

These are the functions that need to be updated to use Netmiko to support OS Upgrades:

These are all staged locally but need unit tests written.

- _image_booted - _wait_for_device_reboot - uptime - hostname - redundancy_state - reboot - set_boot_options Removed caching for the uptime and uptime_string properties Added an NXOSDevice.show_netmiko method and added a deprecation warning to the existing NXOSDevice.show method

gsnider2195 · 2026-05-21T00:59:57Z

@jtdub this one should be ready for another review

jtdub · 2026-05-21T21:23:55Z

I updated the NXOSDevice.os_version task to use netmiko.

>>> from pyntc.devices.nxos_device import NXOSDevice
>>> device = NXOSDevice(host="10.1.100.27", username=username, password=password)
2026-05-21 16:18:52,282 [INFO] pyntc: Logging initialized for host 10.1.100.27.
>>> print(device.os_version)
6.1(2)I3(3a)
>>> print(device.show_netmiko("show version"))
[{'uptime': '2 day(s), 22 hour(s), 13 minute(s), 56 second(s)', 'last_reboot_reason': 'Reset Requested by CLI command reload', 'bios': '07.59', 'os': '6.1(2)I3(3a)', 'boot_image': 'bootflash:///n9000-dk9.6.1.2.I3.3a.bin', 'platform': 'C9372TX', 'hostname': 'nyc-leaf-02', 'serial': 'SAL19058U1M'}]
>>> print(device.hostname)
nyc-leaf-02
>>> print(device.uptime)
252851
>>> device.close()

…yntc into u/mattmiller/nxos_bugfix

mattmiller87

Updated changes are approved.

* Bug Fix NXOS (#387) * Fix operations to use native_ssh instead of nx-api * Update NXOS so that both nx-api and ssh can co-exist * Updates to remove api_port * remove redundant line, update tests * changelog * minor tweak to f5 workaround * Updated the following NXOSDevice methods to use netmiko: - _image_booted - _wait_for_device_reboot - uptime - hostname - redundancy_state - reboot - set_boot_options Removed caching for the uptime and uptime_string properties Added an NXOSDevice.show_netmiko method and added a deprecation warning to the existing NXOSDevice.show method * added test mocks for most of the netmiko commands and updated tests * revert breaking property changes and fix pylint * revert breaking changes * Updated the NXOSDevice driver to use netmiko for the os_version * updated the nxos file transfer methods to resolve file verification * ruff ruff * add changelog fragments * update the NXOSDevice.save to use netmiko instead of NXAPI * Migrate NXOSDevice.show to netmiko from NXAPI * update _wait_for_device_reboot to reconnect via ssh * updates per CI failures * updates per CI failures --------- Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Co-authored-by: James Williams <amascuba@gmail.com> * v3.0.0 post sync to develop (#385) * Release 3.0.0 * bump version --------- Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com> Co-authored-by: James Williams <amascuba@gmail.com> * bump version * create release notes * fix v3 release notes * fix v3 release notes --------- Co-authored-by: Matt Miller <mattmiller87@gmail.com> Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com>

* Release 3.0.0 * Release v3.0.1 (#391) * Bug Fix NXOS (#387) * Fix operations to use native_ssh instead of nx-api * Update NXOS so that both nx-api and ssh can co-exist * Updates to remove api_port * remove redundant line, update tests * changelog * minor tweak to f5 workaround * Updated the following NXOSDevice methods to use netmiko: - _image_booted - _wait_for_device_reboot - uptime - hostname - redundancy_state - reboot - set_boot_options Removed caching for the uptime and uptime_string properties Added an NXOSDevice.show_netmiko method and added a deprecation warning to the existing NXOSDevice.show method * added test mocks for most of the netmiko commands and updated tests * revert breaking property changes and fix pylint * revert breaking changes * Updated the NXOSDevice driver to use netmiko for the os_version * updated the nxos file transfer methods to resolve file verification * ruff ruff * add changelog fragments * update the NXOSDevice.save to use netmiko instead of NXAPI * Migrate NXOSDevice.show to netmiko from NXAPI * update _wait_for_device_reboot to reconnect via ssh * updates per CI failures * updates per CI failures --------- Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Co-authored-by: James Williams <amascuba@gmail.com> * v3.0.0 post sync to develop (#385) * Release 3.0.0 * bump version --------- Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com> Co-authored-by: James Williams <amascuba@gmail.com> * bump version * create release notes * fix v3 release notes * fix v3 release notes --------- Co-authored-by: Matt Miller <mattmiller87@gmail.com> Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com> * bump version --------- Co-authored-by: Gary Snider <75227981+gsnider2195@users.noreply.github.com> Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com> Co-authored-by: Matt Miller <mattmiller87@gmail.com>

mattmiller87 requested review from jeffkala, pke11y and pszulczewski as code owners May 14, 2026 14:56

mattmiller87 force-pushed the u/mattmiller/nxos_bugfix branch 2 times, most recently from 4864906 to 428cfa6 Compare May 14, 2026 14:57

Fix operations to use native_ssh instead of nx-api

b4a3f78

mattmiller87 force-pushed the u/mattmiller/nxos_bugfix branch from 428cfa6 to b4a3f78 Compare May 14, 2026 15:34

mattmiller87 marked this pull request as draft May 14, 2026 16:24

Update NXOS so that both nx-api and ssh can co-exist

9b5c676

mattmiller87 force-pushed the u/mattmiller/nxos_bugfix branch from cacc60c to 9b5c676 Compare May 14, 2026 19:42

mattmiller87 marked this pull request as ready for review May 14, 2026 19:42

jtdub self-requested a review May 15, 2026 13:51

mattmiller87 marked this pull request as draft May 15, 2026 14:20

mattmiller87 marked this pull request as ready for review May 15, 2026 15:08

mattmiller87 changed the title ~~Fix operations to use native_ssh instead of nx-api~~ Bug Fix NXOS May 15, 2026

mattmiller87 force-pushed the u/mattmiller/nxos_bugfix branch from 498d9d1 to aa6a1cc Compare May 15, 2026 15:19

Updates to remove api_port

87fbf1e

mattmiller87 force-pushed the u/mattmiller/nxos_bugfix branch from aa6a1cc to 87fbf1e Compare May 15, 2026 15:41

jtdub approved these changes May 15, 2026

View reviewed changes

gsnider2195 reviewed May 18, 2026

View reviewed changes

gsnider2195 requested changes May 18, 2026

View reviewed changes

gsnider2195 added 3 commits May 18, 2026 16:19

remove redundant line, update tests

193177b

changelog

03798a3

minor tweak to f5 workaround

d3fc6d1

gsnider2195 reviewed May 18, 2026

View reviewed changes

gsnider2195 approved these changes May 18, 2026

View reviewed changes

added test mocks for most of the netmiko commands and updated tests

5730f79

gsnider2195 reviewed May 21, 2026

View reviewed changes

Comment thread pyntc/devices/nxos_device.py

gsnider2195 reviewed May 21, 2026

View reviewed changes

Comment thread pyntc/devices/nxos_device.py Outdated

gsnider2195 and others added 3 commits May 21, 2026 08:02

revert breaking property changes and fix pylint

7be75fd

revert breaking changes

8f190b4

Updated the NXOSDevice driver to use netmiko for the os_version

fedaa92

jtdub and others added 6 commits May 21, 2026 17:34

updated the nxos file transfer methods to resolve file verification

9538a54

ruff ruff

76b5a0e

add changelog fragments

7dac715

Merge branch 'u/mattmiller/nxos_bugfix' of github.com:networktocode/p…

a8ae1ca

…yntc into u/mattmiller/nxos_bugfix

update the NXOSDevice.save to use netmiko instead of NXAPI

441091b

Migrate NXOSDevice.show to netmiko from NXAPI

98acc63

jtdub force-pushed the u/mattmiller/nxos_bugfix branch from 987724b to 98acc63 Compare May 22, 2026 01:33

jtdub added 3 commits May 22, 2026 08:53

update _wait_for_device_reboot to reconnect via ssh

19a8b62

updates per CI failures

175546e

updates per CI failures

2aa258b

mattmiller87 commented May 22, 2026

View reviewed changes

jtdub merged commit c115720 into develop May 22, 2026
10 checks passed

jtdub deleted the u/mattmiller/nxos_bugfix branch May 22, 2026 14:44

jtdub mentioned this pull request May 26, 2026

Release v3.0.1 #391

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bug Fix NXOS#387

Bug Fix NXOS#387
jtdub merged 20 commits into
developfrom
u/mattmiller/nxos_bugfix

mattmiller87 commented May 14, 2026 •

edited

Loading

Uh oh!

jtdub left a comment

Uh oh!

gsnider2195 May 18, 2026

Uh oh!

gsnider2195 May 18, 2026

Uh oh!

gsnider2195 May 18, 2026

Uh oh!

gsnider2195 left a comment

Uh oh!

gsnider2195 commented May 18, 2026 •

edited

Loading

Uh oh!

gsnider2195 May 18, 2026

Uh oh!

gsnider2195 commented May 19, 2026 •

edited

Loading

Uh oh!

gsnider2195 commented May 21, 2026

Uh oh!

Uh oh!

Uh oh!

jtdub commented May 21, 2026

Uh oh!

mattmiller87 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

mattmiller87 commented May 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

New Pull Request

Change Notes

Justification

Uh oh!

jtdub left a comment

Choose a reason for hiding this comment

Uh oh!

gsnider2195 May 18, 2026

Choose a reason for hiding this comment

Uh oh!

gsnider2195 May 18, 2026

Choose a reason for hiding this comment

Uh oh!

gsnider2195 May 18, 2026

Choose a reason for hiding this comment

Uh oh!

gsnider2195 left a comment

Choose a reason for hiding this comment

Uh oh!

gsnider2195 commented May 18, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gsnider2195 May 18, 2026

Choose a reason for hiding this comment

Uh oh!

gsnider2195 commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gsnider2195 commented May 21, 2026

Uh oh!

Uh oh!

Uh oh!

jtdub commented May 21, 2026

Uh oh!

mattmiller87 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mattmiller87 commented May 14, 2026 •

edited

Loading

gsnider2195 commented May 18, 2026 •

edited

Loading

gsnider2195 commented May 19, 2026 •

edited

Loading