Ironware: Deprecate provider, support network_cli (#43285)

2 files changed, 100 insertions, 27 deletions

diff --git a/docs/docsite/rst/network/user_guide/platform_index.rst b/docs/docsite/rst/network/user_guide/platform_index.rst
index 83b4510140..c43abeb53e 100644
--- a/docs/docsite/rst/network/user_guide/platform_index.rst
+++ b/docs/docsite/rst/network/user_guide/platform_index.rst
@@ -12,6 +12,7 @@ Some Ansible Network platforms support multiple connection types, privilege esca
 
    platform_eos
    platform_ios
+   platform_ironware
    platform_junos
    platform_nxos
 
@@ -20,30 +21,32 @@ Some Ansible Network platforms support multiple connection types, privilege esca
 Settings by Platform
 ================================
 
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-|..              |                         | ``ansible_connection:`` settings available                                        |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Network OS     | ``ansible_network_os:`` | network_cli          | netconf              | httpapi          | local            |
-+================+=========================+======================+======================+==================+==================+
-| Arista EOS*    | ``eos``                 | in v. >=2.5          | N/A                  | in v. >=2.6      |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco ASA      | ``asa``                 | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco IOS*     | ``ios``                 | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco IOS XR*  | ``iosxr``               | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Cisco NX-OS*   | ``nxos``                | in v. >=2.5          | N/A                  | in v. >=2.6      |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| F5 BIG-IP      | N/A                     | N/A                  | N/A                  | N/A              |  in v. >=2.0     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| F5 BIG-IQ      | N/A                     | N/A                  | N/A                  | N/A              |  in v. >=2.0     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Junos OS*      | ``junos``               | in v. >=2.5          | in v. >=2.5          | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| Nokia SR OS    | ``sros``                | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-| VyOS*          | ``vyos``                | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
-+----------------+-------------------------+----------------------+----------------------+------------------+------------------+
-
-`*` Maintained by Ansible Network Team
\ No newline at end of file
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+|..                |                         | ``ansible_connection:`` settings available                                        |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Network OS       | ``ansible_network_os:`` | network_cli          | netconf              | httpapi          | local            |
++==================+=========================+======================+======================+==================+==================+
+| Arista EOS*      | ``eos``                 | in v. >=2.5          | N/A                  | in v. >=2.6      |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco ASA        | ``asa``                 | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco IOS*       | ``ios``                 | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco IOS XR*    | ``iosxr``               | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Cisco NX-OS*     | ``nxos``                | in v. >=2.5          | N/A                  | in v. >=2.6      |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Extreme IronWare | ``ironware``            | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.5     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| F5 BIG-IP        | N/A                     | N/A                  | N/A                  | N/A              |  in v. >=2.0     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| F5 BIG-IQ        | N/A                     | N/A                  | N/A                  | N/A              |  in v. >=2.0     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Junos OS*        | ``junos``               | in v. >=2.5          | in v. >=2.5          | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| Nokia SR OS      | ``sros``                | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+| VyOS*            | ``vyos``                | in v. >=2.5          | N/A                  | N/A              |  in v. >=2.4     |
++------------------+-------------------------+----------------------+----------------------+------------------+------------------+
+
+`*` Maintained by Ansible Network Team
diff --git a/docs/docsite/rst/network/user_guide/platform_ironware.rst b/docs/docsite/rst/network/user_guide/platform_ironware.rst
new file mode 100644
index 0000000000..e04c6a12d2
--- /dev/null
+++ b/docs/docsite/rst/network/user_guide/platform_ironware.rst
@@ -0,0 +1,70 @@
+.. _ironware_platform_options:
+
+***************************************
+IronWare Platform Options
+***************************************
+
+IronWare supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on IronWare in Ansible 2.7. 
+
+.. contents:: Topics
+
+Connections Available
+================================================================================
+
++---------------------------+-----------------------------------------------+
+|..                         | CLI                                           |
++===========================+===============================================+
+| **Protocol**              |  SSH                                          |
++---------------------------+-----------------------------------------------+
+| | **Credentials**         | | uses SSH keys / SSH-agent if present        |
+| |                         | | accepts ``-u myuser -k`` if using password  |
++---------------------------+-----------------------------------------------+
+| **Indirect Access**       | via a bastion (jump host)                     |
++---------------------------+-----------------------------------------------+
+| | **Connection Settings** | | ``ansible_connection: network_cli``         |
+| |                         | |                                             |
+| |                         | |                                             |
++---------------------------+-----------------------------------------------+
+| | **Enable Mode**         | | supported - use ``ansible_become: yes``     |
+| | (Privilege Escalation)  | | with ``ansible_become_method: enable``      |
+| |                         | | and ``ansible_become_pass:``                |
++---------------------------+-----------------------------------------------+
+| **Returned Data Format**  | ``stdout[0].``                                |
++---------------------------+-----------------------------------------------+
+
+For legacy playbooks, IronWare still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
+
+Using CLI in Ansible 2.6
+================================================================================
+
+Example CLI ``group_vars/mlx.yml``
+----------------------------------
+
+.. code-block:: yaml
+
+   ansible_connection: network_cli
+   ansible_network_os: ironware
+   ansible_user: myuser
+   ansible_ssh_pass: !vault...
+   ansible_become: yes
+   ansible_become_method: enable
+   ansible_become_pass: !vault...
+   ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
+
+
+- If you are using SSH keys (including an ssh-agent) you can remove the ``ansible_ssh_pass`` configuration.
+- If you are accessing your host directly (not through a bastion/jump host) you can remove the ``ansible_ssh_common_args`` configuration.
+- If you are accessing your host through a bastion/jump host, you cannot include your SSH password in the ``ProxyCommand`` directive. To prevent secrets from leaking out (for example in ``ps`` output), SSH does not support providing passwords via environment variables.
+
+Example CLI Task
+----------------
+
+.. code-block:: yaml
+
+   - name: Backup current switch config (ironware)
+     ironware_config:
+       backup: yes
+     register: backup_ironware_location
+     when: ansible_network_os == 'ironware'
+
+.. include:: shared_snippets/SSH_warning.txt