Merge branch 'develop' into cisco_ap

Author: ktbyers

EXAMPLES.md

@@ -11,7 +11,6 @@ A set of common Netmiko use cases.
 
 #### Available Device Types
 - [Available device types](#available-device-types-1)
-
 #### Simple Examples
 - [Simple example](#simple-example)
 - [Connect using a dictionary](#connect-using-a-dictionary)
@@ -662,6 +661,9 @@ device = {
 commands = ["logging buffered 100000"]
 with ConnectHandler(**device) as net_connect:
     output = net_connect.send_config_set(commands)
+    # use the appropriate function for your Netmiko platform:
+    # commit for Cisco-XR, Juniper-Junos, Palo Alto; save_config for others
+    # output += net_connect.commit()
     output += net_connect.save_config()
 
 print()
@@ -713,6 +715,9 @@ device1 = {
 cfg_file = "config_changes.txt"
 with ConnectHandler(**device1) as net_connect:
     output = net_connect.send_config_from_file(cfg_file)
+    # use the appropriate function for your Netmiko platform:
+    # commit for Cisco-XR, Juniper-Junos, Palo Alto; save_config for others
+    # output += net_connect.commit()
     output += net_connect.save_config()
 
 print()

PLATFORMS.md

@@ -51,6 +51,7 @@
 - Maipu
 - MikroTik RouterOS
 - MikroTik SwitchOS
+- NEC Univerge IX Routers
 - NetApp cDOT
 - Netgear ProSafe
 - Nokia/Alcatel SR OS

README.md

@@ -41,7 +41,7 @@ Netmiko aims to accomplish both of these operations and to do it across a very b
 
 ## Supported Platforms
 
-[PLATFORMS](PLATFORMS.md)
+[PLATFORMS](https://github.com/ktbyers/netmiko/blob/develop/PLATFORMS.md)
 
 <br />
 
@@ -64,7 +64,7 @@ $ pip install netmiko
 
 ## Common Issues/FAQ
 
-Answers to some [common questions](COMMON_ISSUES.md)
+Answers to some [common_questions](https://github.com/ktbyers/netmiko/blob/develop/COMMON_ISSUES.md)
 
 <br />
 
@@ -158,7 +158,7 @@ Contributors are welcome.
 
 You can contribute to Netmiko in a variety of ways: answering questions on Slack (see below in Questions/Discussions), responding to issues, adding to the common issues, reporting/fixing bugs, or even adding your own device type.
 
-Before contributing a new vendor/platform device type, remember that any code added needs to be supported in some fashion. To add a vendor/platform you can follow the outline [here](VENDOR.md). Once you've worked on your first pass of your driver and have it functional, you'll need to include test data in order for it to be merged into develop, you can see the general flow of how to do that [here](TESTING.md).
+Before contributing a new vendor/platform device type, remember that any code added needs to be supported in some fashion. To add a vendor/platform you can follow the outline [here](https://github.com/ktbyers/netmiko/blob/develop/VENDOR.md). Once you've worked on your first pass of your driver and have it functional, you'll need to include test data in order for it to be merged into develop, you can see the general flow of how to do that [here](https://github.com/ktbyers/netmiko/blob/develop/TESTING.md).
 
 For all code contributions, please ensure that you have ran `black` against the code or your code will fail the Travis CI build.
 
@@ -170,8 +170,20 @@ If you find an issue with Netmiko, then you can open an issue on this projects i
 
 If you have questions or would like to discuss Netmiko, a #netmiko channel exists in [this Slack](https://pynet.slack.com) workspace. To join, use [this invitation](https://join.slack.com/t/pynet/shared_invite/zt-km2k3upf-AkWHY4YEx3sI1R5irMmc7Q). Once you have entered the workspace, then you can join the #netmiko channel.
 
+<br />
+
+## Sponsors 2025
+
+Special thanks to organizations and people that have helped support Netmiko development. In particular, these organizations have made meaningful contributions that help Netmiko keep moving forward:
+
+<a href="https://slurpit.io/"><img src="https://github.com/ktbyers/netmiko/blob/develop/images/slurpit.png" width="200" alt="Slurp'it Logo"></a>
+<a href="https://netpicker.io/"><img src="https://github.com/ktbyers/netmiko/blob/develop/images/netpicker.png" width="200" alt="Netpicker Logo"></a>
 
----
-Kirk Byers  
-Python for Network Engineers  
-https://pynet.twb-tech.com  
+<br />
+<br />
+
+##  
+Kirk Byers <br />
+Python for Network Engineers <br />
+https://pynet.twb-tech.com  <br />
+<br />

docs/netmiko/a10/a10_ssh.html

@@ -178,6 +178,27 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         # self.set_terminal_width()
         self.disable_paging(command=&#34;terminal length 0&#34;)
 
+    def check_config_mode(
+        self, check_string: str = &#34;)#&#34;, pattern: str = &#34;)#&#34;, force_regex: bool = False
+    ) -&gt; bool:
+        self.write_channel(self.RETURN)
+
+        # You can encounter an issue here (on router name changes) prefer delay-based solution
+        if not pattern:
+            output = self.read_channel_timing(read_timeout=10.0)
+        else:
+            output = self.read_until_pattern(pattern=pattern)
+
+        # A10 can do this &#39;LBR1_PROD-EXT_(NOLICENSE)#&#39; when not licensed (e.g. gns3)
+        # Example, config: LBR1_PROD-EXT_(config)(NOLICENSE)#
+        # Example, outside of config LBR1_PROD-EXT_(NOLICENSE)#
+        output = output.replace(&#34;(NOLICENSE)&#34;, &#34;&#34;)
+
+        if force_regex:
+            return bool(re.search(check_string, output))
+        else:
+            return check_string in output
+
     def save_config(
         self, cmd: str = &#34;&#34;, confirm: bool = False, confirm_response: str = &#34;&#34;
     ) -&gt; str:

docs/netmiko/a10/index.html

@@ -184,6 +184,27 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         # self.set_terminal_width()
         self.disable_paging(command=&#34;terminal length 0&#34;)
 
+    def check_config_mode(
+        self, check_string: str = &#34;)#&#34;, pattern: str = &#34;)#&#34;, force_regex: bool = False
+    ) -&gt; bool:
+        self.write_channel(self.RETURN)
+
+        # You can encounter an issue here (on router name changes) prefer delay-based solution
+        if not pattern:
+            output = self.read_channel_timing(read_timeout=10.0)
+        else:
+            output = self.read_until_pattern(pattern=pattern)
+
+        # A10 can do this &#39;LBR1_PROD-EXT_(NOLICENSE)#&#39; when not licensed (e.g. gns3)
+        # Example, config: LBR1_PROD-EXT_(config)(NOLICENSE)#
+        # Example, outside of config LBR1_PROD-EXT_(NOLICENSE)#
+        output = output.replace(&#34;(NOLICENSE)&#34;, &#34;&#34;)
+
+        if force_regex:
+            return bool(re.search(check_string, output))
+        else:
+            return check_string in output
+
     def save_config(
         self, cmd: str = &#34;&#34;, confirm: bool = False, confirm_response: str = &#34;&#34;
     ) -&gt; str:

docs/netmiko/arista/arista.html

@@ -171,8 +171,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         &#34;&#34;&#34;Prepare the session after the connection has been established.&#34;&#34;&#34;
         self.ansi_escape_codes = True
         self._test_channel_read(pattern=self.prompt_pattern)
-        cmd = &#34;terminal width 511&#34;
-        self.set_terminal_width(command=cmd, pattern=r&#34;Width set to&#34;)
+        try:
+            cmd = &#34;terminal width 511&#34;
+            self.set_terminal_width(command=cmd, pattern=r&#34;Width set to&#34;)
+        except NetmikoTimeoutException:
+            # Continue on if setting &#39;terminal width&#39; fails
+            pass
         self.disable_paging(cmd_verify=False, pattern=r&#34;Pagination disabled&#34;)
         self.set_base_prompt()
 
@@ -369,6 +373,8 @@ <h3>Inherited members</h3>
 <pre><code class="python">class AristaFileTransfer(CiscoFileTransfer):
     &#34;&#34;&#34;Arista SCP File Transfer driver.&#34;&#34;&#34;
 
+    prompt_pattern = r&#34;[$&gt;#]&#34;
+
     def __init__(
         self,
         ssh_conn: &#34;BaseConnection&#34;,
@@ -389,6 +395,7 @@ <h3>Inherited members</h3>
 
     def remote_space_available(self, search_pattern: str = &#34;&#34;) -&gt; int:
         &#34;&#34;&#34;Return space available on remote device.&#34;&#34;&#34;
+        search_pattern = self.prompt_pattern
         return self._remote_space_available_unix(search_pattern=search_pattern)
 
     def check_file_exists(self, remote_cmd: str = &#34;&#34;) -&gt; bool:
@@ -427,6 +434,13 @@ <h3>Ancestors</h3>
 <li><a title="netmiko.cisco_base_connection.CiscoFileTransfer" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoFileTransfer">CiscoFileTransfer</a></li>
 <li><a title="netmiko.scp_handler.BaseFileTransfer" href="../scp_handler.html#netmiko.scp_handler.BaseFileTransfer">BaseFileTransfer</a></li>
 </ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="netmiko.arista.arista.AristaFileTransfer.prompt_pattern"><code class="name">var <span class="ident">prompt_pattern</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
 <h3>Inherited members</h3>
 <ul class="hlist">
 <li><code><b><a title="netmiko.cisco_base_connection.CiscoFileTransfer" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoFileTransfer">CiscoFileTransfer</a></b></code>:
@@ -858,6 +872,9 @@ <h4><code><a title="netmiko.arista.arista.AristaBase" href="#netmiko.arista.aris
 </li>
 <li>
 <h4><code><a title="netmiko.arista.arista.AristaFileTransfer" href="#netmiko.arista.arista.AristaFileTransfer">AristaFileTransfer</a></code></h4>
+<ul class="">
+<li><code><a title="netmiko.arista.arista.AristaFileTransfer.prompt_pattern" href="#netmiko.arista.arista.AristaFileTransfer.prompt_pattern">prompt_pattern</a></code></li>
+</ul>
 </li>
 <li>
 <h4><code><a title="netmiko.arista.arista.AristaSSH" href="#netmiko.arista.arista.AristaSSH">AristaSSH</a></code></h4>

docs/netmiko/arista/index.html

@@ -55,6 +55,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <pre><code class="python">class AristaFileTransfer(CiscoFileTransfer):
     &#34;&#34;&#34;Arista SCP File Transfer driver.&#34;&#34;&#34;
 
+    prompt_pattern = r&#34;[$&gt;#]&#34;
+
     def __init__(
         self,
         ssh_conn: &#34;BaseConnection&#34;,
@@ -75,6 +77,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     def remote_space_available(self, search_pattern: str = &#34;&#34;) -&gt; int:
         &#34;&#34;&#34;Return space available on remote device.&#34;&#34;&#34;
+        search_pattern = self.prompt_pattern
         return self._remote_space_available_unix(search_pattern=search_pattern)
 
     def check_file_exists(self, remote_cmd: str = &#34;&#34;) -&gt; bool:
@@ -113,6 +116,13 @@ <h3>Ancestors</h3>
 <li><a title="netmiko.cisco_base_connection.CiscoFileTransfer" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoFileTransfer">CiscoFileTransfer</a></li>
 <li><a title="netmiko.scp_handler.BaseFileTransfer" href="../scp_handler.html#netmiko.scp_handler.BaseFileTransfer">BaseFileTransfer</a></li>
 </ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="netmiko.arista.AristaFileTransfer.prompt_pattern"><code class="name">var <span class="ident">prompt_pattern</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
 <h3>Inherited members</h3>
 <ul class="hlist">
 <li><code><b><a title="netmiko.cisco_base_connection.CiscoFileTransfer" href="../cisco_base_connection.html#netmiko.cisco_base_connection.CiscoFileTransfer">CiscoFileTransfer</a></b></code>:
@@ -539,6 +549,9 @@ <h3>Inherited members</h3>
 <ul>
 <li>
 <h4><code><a title="netmiko.arista.AristaFileTransfer" href="#netmiko.arista.AristaFileTransfer">AristaFileTransfer</a></code></h4>
+<ul class="">
+<li><code><a title="netmiko.arista.AristaFileTransfer.prompt_pattern" href="#netmiko.arista.AristaFileTransfer.prompt_pattern">prompt_pattern</a></code></li>
+</ul>
 </li>
 <li>
 <h4><code><a title="netmiko.arista.AristaSSH" href="#netmiko.arista.AristaSSH">AristaSSH</a></code></h4>