mirror of https://github.com/ansible/ansible.git
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
3.3 KiB
ReStructuredText
70 lines
3.3 KiB
ReStructuredText
.. _enos_platform_options:
|
|
|
|
***************************************
|
|
ENOS Platform Options
|
|
***************************************
|
|
|
|
ENOS supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on ENOS 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, ENOS 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/enos.yml``
|
|
--------------------------------------------------------------------------------
|
|
|
|
.. code-block:: yaml
|
|
|
|
ansible_connection: network_cli
|
|
ansible_network_os: enos
|
|
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: Retreive ENOS OS version
|
|
enos_command:
|
|
commands: show version
|
|
when: ansible_network_os == 'enos'
|
|
|
|
.. include:: shared_snippets/SSH_warning.txt
|