dellos module doc updates for network_cli (#51207)
* dellos module doc updates for network_cli * remove ansible 2.6 reference from dellos10 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * remove ansible 2.6 reference from dellos6 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * remove ansible 2.6 reference from dellos10 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * remove ansible 2.6 reference from dellos6 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * fix dellos6 register copy mistake Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * remove ansible 2.6 reference from dellos9 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * fix dellos6 register copy mistake Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * removed indicator of dellos modules being maintained by ansible network team dellos modules are maintained by Dell Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * removed indicator of dellos modules being maintained by ansible network team dellos modules are maintained by Dell Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * Removed indicator of dellos modules being maintained by ansible network team DellOS modules are maintained by Dell Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com> * remove ansible 2.6 reference from dellos9 Co-Authored-By: ryanmerolle <ryanmerolle@users.noreply.github.com>
This commit is contained in:
Ryan Merolle
Sandra McCann
parent
2b1b4db04d
commit
8c703da46a
4 changed files with 219 additions and 0 deletions
70
docs/docsite/rst/network/user_guide/platform_dellos10.rst
Normal file
70
docs/docsite/rst/network/user_guide/platform_dellos10.rst
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
.. _dellos10_platform_options:
|
||||||
|
|
||||||
|
***************************************
|
||||||
|
Dell OS10 Platform Options
|
||||||
|
***************************************
|
||||||
|
|
||||||
|
OS10 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS10 in Ansible.
|
||||||
|
|
||||||
|
.. 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, OS10 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
|
||||||
|
|
||||||
|
Using CLI in Ansible
|
||||||
|
================================================================================
|
||||||
|
|
||||||
|
Example CLI ``group_vars/dellos10.yml``
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
ansible_connection: network_cli
|
||||||
|
ansible_network_os: dellos10
|
||||||
|
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 (dellos10)
|
||||||
|
dellos10_config:
|
||||||
|
backup: yes
|
||||||
|
register: backup_dellos10_location
|
||||||
|
when: ansible_network_os == 'dellos10'
|
||||||
|
|
||||||
|
.. include:: shared_snippets/SSH_warning.txt
|
||||||
70
docs/docsite/rst/network/user_guide/platform_dellos6.rst
Normal file
70
docs/docsite/rst/network/user_guide/platform_dellos6.rst
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
.. _dellos6_platform_options:
|
||||||
|
|
||||||
|
***************************************
|
||||||
|
Dell OS6 Platform Options
|
||||||
|
***************************************
|
||||||
|
|
||||||
|
OS6 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS6 in Ansible.
|
||||||
|
|
||||||
|
.. 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, OS6 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
|
||||||
|
|
||||||
|
Using CLI in Ansible
|
||||||
|
================================================================================
|
||||||
|
|
||||||
|
Example CLI ``group_vars/dellos6.yml``
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
ansible_connection: network_cli
|
||||||
|
ansible_network_os: dellos6
|
||||||
|
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 (dellos6)
|
||||||
|
dellos6_config:
|
||||||
|
backup: yes
|
||||||
|
register: backup_dellso6_location
|
||||||
|
when: ansible_network_os == 'dellos6'
|
||||||
|
|
||||||
|
.. include:: shared_snippets/SSH_warning.txt
|
||||||
70
docs/docsite/rst/network/user_guide/platform_dellos9.rst
Normal file
70
docs/docsite/rst/network/user_guide/platform_dellos9.rst
Normal file
|
|
@ -0,0 +1,70 @@
|
||||||
|
.. _dellos9_platform_options:
|
||||||
|
|
||||||
|
***************************************
|
||||||
|
Dell OS9 Platform Options
|
||||||
|
***************************************
|
||||||
|
|
||||||
|
OS9 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS9 in Ansible.
|
||||||
|
|
||||||
|
.. 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, OS9 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
|
||||||
|
|
||||||
|
Using CLI in Ansible
|
||||||
|
================================================================================
|
||||||
|
|
||||||
|
Example CLI ``group_vars/dellos9.yml``
|
||||||
|
--------------------------------------
|
||||||
|
|
||||||
|
.. code-block:: yaml
|
||||||
|
|
||||||
|
ansible_connection: network_cli
|
||||||
|
ansible_network_os: dellos9
|
||||||
|
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 (dellos9)
|
||||||
|
dellos9_config:
|
||||||
|
backup: yes
|
||||||
|
register: backup_dellos9_location
|
||||||
|
when: ansible_network_os == 'dellos9'
|
||||||
|
|
||||||
|
.. include:: shared_snippets/SSH_warning.txt
|
||||||
|
|
@ -11,6 +11,9 @@ Some Ansible Network platforms support multiple connection types, privilege esca
|
||||||
:caption: Platform Options
|
:caption: Platform Options
|
||||||
|
|
||||||
platform_cnos
|
platform_cnos
|
||||||
|
platform_dellos6
|
||||||
|
platform_dellos9
|
||||||
|
platform_dellos10
|
||||||
platform_enos
|
platform_enos
|
||||||
platform_eos
|
platform_eos
|
||||||
platform_exos
|
platform_exos
|
||||||
|
|
@ -44,6 +47,12 @@ Settings by Platform
|
||||||
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
| Cisco NX-OS* | ``nxos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
|
| Cisco NX-OS* | ``nxos`` | in v. >=2.5 | N/A | in v. >=2.6 | in v. >=2.4 |
|
||||||
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
|
| Dell OS6 | ``dellos6`` | in v. >=2.5 | N/A | N/A . | in v. >=2.3 |
|
||||||
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
|
| Dell OS9 | ``dellos9`` | in v. >=2.5 | N/A | N/A . | in v. >=2.3 |
|
||||||
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
|
| Dell OS10 | ``dellos10`` | in v. >=2.5 | N/A | N/A . | in v. >=2.3 |
|
||||||
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
| Extreme EXOS | ``exos`` | in v. >=2.6 | N/A | N/A | N/A |
|
| Extreme EXOS | ``exos`` | in v. >=2.6 | N/A | N/A | N/A |
|
||||||
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
+-------------------+-------------------------+----------------------+----------------------+------------------+------------------+
|
||||||
| Extreme IronWare | ``ironware`` | in v. >=2.5 | N/A | N/A | in v. >=2.5 |
|
| Extreme IronWare | ``ironware`` | in v. >=2.5 | N/A | N/A | in v. >=2.5 |
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue