ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-24 05:40:23 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Exos httpapi (#54405)

Browse source 
* Modify EXOS module utils to utilize 'httpapi' or 'network-cli' connection

* Changes to cliconf plugin to support 'json' or 'text' output for compatibility between network-cli and httpapi

* Add HTTPAPI plugin supportng JSONRPC and RESTCONF for EXOS

* exos_facts modify commands with run script cli2json.py to command dictionary specifying 'json' output
Load appropriate fixtures

* Update exos_config module to utilize the get_diff and get_default_flag functionality.
JSONRPC doesn't work well with pipes, regex MULTILINE

* Support for NOS agnostic 'cli_config' module by implementing 'get_default_flag' and 'get_diff' functionality

* Update Ansible Documentation regarding the connections available for EXOS
This commit is contained in:
Ujwal Komarla 2019-03-27 09:44:04 -04:00 • committed by Ricardo Carrillo Cruz
commit 9384773e1e
14 changed files with 735 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

81
docs/docsite/rst/network/user_guide/platform_exos.rst
View file

@ -4,37 +4,37 @@
EXOS Platform Options
***************************************
Extreme EXOS Ansible modules only support CLI connections today. This page offers details on how to
use ``network_cli`` on EXOS in Ansible.
Extreme EXOS Ansible modules support multiple connections. This page offers details on how each connection works in Ansible and how to use it.
.. 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** | | not supported by EXOS |
| | (Privilege Escalation) | | |
+---------------------------+-----------------------------------------------+
| **Returned Data Format** | ``stdout[0].`` |
+---------------------------+-----------------------------------------------+
+---------------------------+-----------------------------------------------+-----------------------------------------+
|.. | CLI | EXOS-API |
+===========================+===============================================+=========================================+
| **Protocol** | SSH | HTTP(S) |
+---------------------------+-----------------------------------------------+-----------------------------------------+
| | **Credentials** | | uses SSH keys / SSH-agent if present | | uses HTTPS certificates if present |
| | | | accepts ``-u myuser -k`` if using password | | |
+---------------------------+-----------------------------------------------+-----------------------------------------+
| **Indirect Access** | via a bastion (jump host) | via a web proxy |
+---------------------------+-----------------------------------------------+-----------------------------------------+
| | **Connection Settings** | | ``ansible_connection: network_cli`` | | ``ansible_connection: httpapi`` |
| | | | | | |
| | | | | | |
| | | | | | |
| | | | | | |
+---------------------------+-----------------------------------------------+-----------------------------------------+
| | **Enable Mode** | | not supported by EXOS | | not supported by EXOS |
| | (Privilege Escalation) | | | | |
| | | | | | |
+---------------------------+-----------------------------------------------+-----------------------------------------+
| **Returned Data Format** | ``stdout[0].`` | ``stdout[0].messages[0].`` |
+---------------------------+-----------------------------------------------+-----------------------------------------+
EXOS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
EXOS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli`` or ``ansible_connection: httpapi``
Using CLI in Ansible
====================
@ -65,4 +65,37 @@ Example CLI Task
commands: show version
when: ansible_network_os == 'exos'
Using EXOS-API in Ansible
=========================
Example EXOS-API ``group_vars/exos.yml``
----------------------------------------
.. code-block:: yaml
ansible_connection: httpapi
ansible_network_os: exos
ansible_user: myuser
ansible_password: !vault...
proxy_env:
http_proxy: http://proxy.example.com:8080
- If you are accessing your host directly (not through a web proxy) you can remove the ``proxy_env`` configuration.
- If you are accessing your host through a web proxy using ``https``, change ``http_proxy`` to ``https_proxy``.
Example EXOS-API Task
---------------------
.. code-block:: yaml
- name: Retrieve EXOS OS version
exos_command:
commands: show version
when: ansible_network_os == 'exos'
In this example the ``proxy_env`` variable defined in ``group_vars`` gets passed to the ``environment`` option of the module used in the task.
.. include:: shared_snippets/SSH_warning.txt

2
docs/docsite/rst/network/user_guide/platform_index.rst
View file

@ -54,7 +54,7 @@ Settings by Platform
+-------------------+-------------------------+-------------+---------+---------+----------+
| Dell OS10 | ``dellos10`` | ✓ | | | ✓ |
+-------------------+-------------------------+-------------+---------+---------+----------+
| Extreme EXOS | ``exos`` | ✓ | | | |
| Extreme EXOS | ``exos`` | ✓ | | ✓ | |
+-------------------+-------------------------+-------------+---------+---------+----------+
| Extreme IronWare | ``ironware`` | ✓ | | | ✓ |
+-------------------+-------------------------+-------------+---------+---------+----------+