cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update network platform guides with FQCN (#70699)

Browse source 
* fqcn all the docs things!
This commit is contained in:
Sandra McCann 2020-07-31 16:57:57 -04:00 committed by GitHub
parent 61b36c6f30
commit 54bee7152b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 267 additions and 245 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

188
docs/docsite/rst/network/user_guide/platform_ce.rst
View file

@ -4,11 +4,12 @@
CloudEngine OS Platform Options
***************************************
CloudEngine CE OS supports multiple connections. This page offers details on how each connection works in Ansible and how to use it.
CloudEngine CE OS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and supports multiple connections. This page offers details on how each connection works in Ansible and how to use it.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -27,7 +28,8 @@ Connections Available
Indirect Access via a bastion (jump host) via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli`` ``ansible_connection: netconf``
Connection Settings ``ansible_connection:`` ``ansible_connection:``
``ansible.netcommon.network_cli`` ``ansible.netcommon.netconf``
|enable_mode| not supported by ce OS not supported by ce OS
@ -36,7 +38,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, Ansible still supports ``ansible_connection=local`` on all CloudEngine modules. We recommend modernizing to use ``ansible_connection=netconf`` or ``ansible_connection=network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.netconf`` or ``ansible_connection=ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
====================
@ -47,8 +49,8 @@ Example CLI inventory ``[ce:vars]``
.. code-block:: yaml
[ce:vars]
ansible_connection=network_cli
ansible_network_os=ce
ansible_connection=ansible.netcommon.network_cli
ansible_network_os=community.network.ce
ansible_user=myuser
ansible_password=!vault...
ansible_ssh_common_args='-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -58,15 +60,15 @@ Example CLI inventory ``[ce:vars]``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Retrieve CE OS version
ce_command:
community.network.ce_command:
commands: display version
when: ansible_network_os == 'ce'
when: ansible_network_os == 'community.network.ce'
Using NETCONF in Ansible
@ -80,16 +82,16 @@ Before you can use NETCONF to connect to a switch, you must:
- install the ``ncclient`` python package on your control node(s) with ``pip install ncclient``
- enable NETCONF on the CloudEngine OS device(s)
To enable NETCONF on a new switch via Ansible, use the ``ce_config`` module via the CLI connection. Set up your platform-level variables just like in the CLI example above, then run a playbook task like this:
To enable NETCONF on a new switch using Ansible, use the ``community.network.ce_config`` module with the CLI connection. Set up your platform-level variables just like in the CLI example above, then run a playbook task like this:
.. code-block:: yaml
- name: Enable NETCONF
connection: network_cli
ce_config:
connection: ansible.netcommon.network_cli
community.network.ce_config:
lines:
- snetconf server enable
when: ansible_network_os == 'ce'
when: ansible_network_os == 'community.network.ce'
Once NETCONF is enabled, change your variables to use the NETCONF connection.
@ -99,110 +101,110 @@ Example NETCONF inventory ``[ce:vars]``
.. code-block:: yaml
[ce:vars]
ansible_connection=netconf
ansible_network_os=ce
ansible_connection=ansible.netcommon.netconf
ansible_network_os=community.network.ce
ansible_user=myuser
ansible_password=!vault |
ansible_ssh_common_args='-o ProxyCommand="ssh -W %h:%p -q bastion01"'
Example NETCONF Task
Example NETCONF task
--------------------
.. code-block:: yaml
- name: Create a vlan, id is 50(ce)
ce_vlan:
community.network.ce_vlan:
vlan_id: 50
name: WEB
when: ansible_network_os == 'ce'
when: ansible_network_os == 'community.network.ce'
Notes
========================
Modules work with connection C(network_cli)
--------------------------------------------
Modules that work with ``ansible.netcommon.network_cli``
---------------------------------------------------------
.. code-block:: yaml
ce_acl_interface
ce_command
ce_config
ce_evpn_bgp
ce_evpn_bgp_rr
ce_evpn_global
ce_facts
ce_mlag_interface
ce_mtu
ce_netstream_aging
ce_netstream_export
ce_netstream_global
ce_netstream_template
ce_ntp_auth
ce_rollback
ce_snmp_contact
ce_snmp_location
ce_snmp_traps
ce_startup
ce_stp
ce_vxlan_arp
ce_vxlan_gateway
ce_vxlan_global
community.network.ce_acl_interface
community.network.ce_command
community.network.ce_config
community.network.ce_evpn_bgp
community.network.ce_evpn_bgp_rr
community.network.ce_evpn_global
community.network.ce_facts
community.network.ce_mlag_interface
community.network.ce_mtu
community.network.ce_netstream_aging
community.network.ce_netstream_export
community.network.ce_netstream_global
community.network.ce_netstream_template
community.network.ce_ntp_auth
community.network.ce_rollback
community.network.ce_snmp_contact
community.network.ce_snmp_location
community.network.ce_snmp_traps
community.network.ce_startup
community.network.ce_stp
community.network.ce_vxlan_arp
community.network.ce_vxlan_gateway
community.network.ce_vxlan_global
Modules work with connection C(netconf)
--------------------------------------------
Modules that work with ``ansible.netcommon.netconf``
-----------------------------------------------------
.. code-block:: yaml
ce_aaa_server
ce_aaa_server_host
ce_acl
ce_acl_advance
ce_bfd_global
ce_bfd_session
ce_bfd_view
ce_bgp
ce_bgp_af
ce_bgp_neighbor
ce_bgp_neighbor_af
ce_dldp
ce_dldp_interface
ce_eth_trunk
ce_evpn_bd_vni
ce_file_copy
ce_info_center_debug
ce_info_center_global
ce_info_center_log
ce_info_center_trap
ce_interface
ce_interface_ospf
ce_ip_interface
ce_lacp
ce_link_status
ce_lldp
ce_lldp_interface
ce_mlag_config
ce_netconf
ce_ntp
ce_ospf
ce_ospf_vrf
ce_reboot
ce_sflow
ce_snmp_community
ce_snmp_target_host
ce_snmp_user
ce_static_route
ce_static_route_bfd
ce_switchport
ce_vlan
ce_vrf
ce_vrf_af
ce_vrf_interface
ce_vrrp
ce_vxlan_tunnel
ce_vxlan_vap
community.network.ce_aaa_server
community.network.ce_aaa_server_host
community.network.ce_acl
community.network.ce_acl_advance
community.network.ce_bfd_global
community.network.ce_bfd_session
community.network.ce_bfd_view
community.network.ce_bgp
community.network.ce_bgp_af
community.network.ce_bgp_neighbor
community.network.ce_bgp_neighbor_af
community.network.ce_dldp
community.network.ce_dldp_interface
community.network.ce_eth_trunk
community.network.ce_evpn_bd_vni
community.network.ce_file_copy
community.network.ce_info_center_debug
community.network.ce_info_center_global
community.network.ce_info_center_log
community.network.ce_info_center_trap
community.network.ce_interface
community.network.ce_interface_ospf
community.network.ce_ip_interface
community.network.ce_lacp
community.network.ce_link_status
community.network.ce_lldp
community.network.ce_lldp_interface
community.network.ce_mlag_config
community.network.ce_netconf
community.network.ce_ntp
community.network.ce_ospf
community.network.ce_ospf_vrf
community.network.ce_reboot
community.network.ce_sflow
community.network.ce_snmp_community
community.network.ce_snmp_target_host
community.network.ce_snmp_user
community.network.ce_static_route
community.network.ce_static_route_bfd
community.network.ce_switchport
community.network.ce_vlan
community.network.ce_vrf
community.network.ce_vrf_af
community.network.ce_vrf_interface
community.network.ce_vrrp
community.network.ce_vxlan_tunnel
community.network.ce_vxlan_vap
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_cnos.rst
View file

@ -4,11 +4,12 @@
CNOS Platform Options
***************************************
CNOS supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on CNOS in Ansible.
CNOS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on CNOS in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -36,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, CNOS still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
================================================================================
@ -46,8 +47,8 @@ Example CLI ``group_vars/cnos.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: cnos
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.cnos
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -60,15 +61,15 @@ Example CLI ``group_vars/cnos.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Retrieve CNOS OS version
cnos_command:
community.network.cnos_command:
commands: show version
when: ansible_network_os == 'cnos'
when: ansible_network_os == 'community.network.cnos'
.. include:: shared_snippets/SSH_warning.txt

22
docs/docsite/rst/network/user_guide/platform_dellos10.rst
View file

@ -4,11 +4,12 @@
Dell OS10 Platform Options
***************************************
OS10 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS10 in Ansible.
The `dellemc.os10 <https://galaxy.ansible.com/dellemc_networking/os10>`_ collection supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS10 in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -36,7 +37,8 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, OS10 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
================================================================================
@ -46,8 +48,8 @@ Example CLI ``group_vars/dellos10.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: dellos10
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: dellemc.os10.os10
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -60,16 +62,16 @@ Example CLI ``group_vars/dellos10.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (dellos10)
dellos10_config:
dellemc.os10.os10_config:
backup: yes
register: backup_dellos10_location
when: ansible_network_os == 'dellos10'
when: ansible_network_os == 'dellemc.os10.os10'
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_dellos6.rst
View file

@ -4,11 +4,12 @@
Dell OS6 Platform Options
***************************************
OS6 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS6 in Ansible.
The `dellemc.os6 <https://github.com/ansible-collections/dellemc.os6>`_ collection supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS6 in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -36,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, OS6 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
================================================================================
@ -46,8 +47,8 @@ Example CLI ``group_vars/dellos6.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: dellos6
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: dellemc.os6.os6
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -60,16 +61,16 @@ Example CLI ``group_vars/dellos6.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (dellos6)
dellos6_config:
dellemc.os6.os6_config:
backup: yes
register: backup_dellso6_location
when: ansible_network_os == 'dellos6'
when: ansible_network_os == 'dellemc.os6.os6'
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_dellos9.rst
View file

@ -4,11 +4,12 @@
Dell OS9 Platform Options
***************************************
OS9 supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS9 in Ansible.
The `dellemc.os9 <https://github.com/ansible-collections/dellemc.os9>`_ collection supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on OS9 in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -36,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, OS9 still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
================================================================================
@ -46,8 +47,8 @@ Example CLI ``group_vars/dellos9.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: dellos9
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: dellemc.os9.os9
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -60,16 +61,16 @@ Example CLI ``group_vars/dellos9.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (dellos9)
dellos9_config:
dellemc.os9.os9_config:
backup: yes
register: backup_dellos9_location
when: ansible_network_os == 'dellos9'
when: ansible_network_os == 'dellemc.os9.os9'
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_enos.rst
View file

@ -4,11 +4,12 @@
ENOS Platform Options
***************************************
ENOS supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on ENOS in Ansible.
ENOS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on ENOS in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -38,7 +39,7 @@ Connections Available
+---------------------------+-----------------------------------------------+
For legacy playbooks, ENOS still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
================================================================================
@ -48,8 +49,8 @@ Example CLI ``group_vars/enos.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: enos
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.enos
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -62,15 +63,15 @@ Example CLI ``group_vars/enos.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Retrieve ENOS OS version
enos_command:
community.network.enos_command:
commands: show version
when: ansible_network_os == 'enos'
when: ansible_network_os == 'community.network.enos'
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_eric_eccli.rst
View file

@ -4,11 +4,12 @@
ERIC_ECCLI Platform Options
***************************************
Extreme ERIC_ECCLI Ansible modules only supports CLI connections today. This page offers details on how to use ``network_cli`` on ERIC_ECCLI in Ansible.
Extreme ERIC_ECCLI is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. This page offers details on how to use ``ansible.netcommon.network_cli`` on ERIC_ECCLI in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| not supported by ERIC_ECCLI
@ -34,7 +35,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
ERIC_ECCLI does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
ERIC_ECCLI does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -44,8 +45,8 @@ Example CLI ``group_vars/eric_eccli.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: eric_eccli
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.eric_eccli
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -55,15 +56,15 @@ Example CLI ``group_vars/eric_eccli.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: run show version on remote devices (eric_eccli)
eric_eccli_command:
community.network.eric_eccli_command:
commands: show version
when: ansible_network_os == 'eric_eccli'
when: ansible_network_os == 'community.network.eric_eccli'
.. include:: shared_snippets/SSH_warning.txt

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

@ -4,11 +4,12 @@
EXOS Platform Options
***************************************
Extreme EXOS Ansible modules support multiple connections. This page offers details on how each connection works in Ansible and how to use it.
Extreme EXOS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and supports multiple connections. This page offers details on how each connection works in Ansible and how to use it.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
@ -26,7 +27,8 @@ Connections Available
Indirect Access via a bastion (jump host) via a web proxy
Connection Settings ``ansible_connection: network_cli`` ``ansible_connection: httpapi``
Connection Settings ``ansible_connection:`` ``ansible_connection:``
``ansible.netcommon.network_cli`` ``ansible.netcommon.httpapi``
|enable_mode| not supported by EXOS not supported by EXOS
@ -35,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
EXOS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli`` or ``ansible_connection: httpapi``
EXOS does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli`` or ``ansible_connection: ansible.netcommon.httpapi``.
Using CLI in Ansible
====================
@ -45,8 +47,8 @@ Example CLI ``group_vars/exos.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: exos
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.exos
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -56,15 +58,15 @@ Example CLI ``group_vars/exos.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Retrieve EXOS OS version
exos_command:
community.network.exos_command:
commands: show version
when: ansible_network_os == 'exos'
when: ansible_network_os == 'community.network.exos'
@ -76,8 +78,8 @@ Example EXOS-API ``group_vars/exos.yml``
.. code-block:: yaml
ansible_connection: httpapi
ansible_network_os: exos
ansible_connection: ansible.netcommon.httpapi
ansible_network_os: community.network.exos
ansible_user: myuser
ansible_password: !vault...
proxy_env:
@ -87,15 +89,15 @@ Example EXOS-API ``group_vars/exos.yml``
- If you are accessing your host through a web proxy using ``https``, change ``http_proxy`` to ``https_proxy``.
Example EXOS-API Task
Example EXOS-API task
---------------------
.. code-block:: yaml
- name: Retrieve EXOS OS version
exos_command:
community.network.exos_command:
commands: show version
when: ansible_network_os == 'exos'
when: ansible_network_os == 'community.network.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.

19
docs/docsite/rst/network/user_guide/platform_icx.rst
View file

@ -4,11 +4,12 @@
ICX Platform Options
***************************************
ICX supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on ICX in Ansible.
ICX is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on ICX in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes`` with
``ansible_become_method: enable`` and ``ansible_become_password:``
@ -44,8 +45,8 @@ Example CLI ``group_vars/icx.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: icx
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.icx
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -58,16 +59,16 @@ Example CLI ``group_vars/icx.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (icx)
icx_config:
community.network.icx_config:
backup: yes
register: backup_icx_location
when: ansible_network_os == 'icx'
when: ansible_network_os == 'community.network.icx'
.. include:: shared_snippets/SSH_warning.txt

21
docs/docsite/rst/network/user_guide/platform_ironware.rst
View file

@ -4,11 +4,12 @@
IronWare Platform Options
***************************************
IronWare supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on IronWare in Ansible.
IronWare is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and supports Enable Mode (Privilege Escalation). This page offers details on how to use Enable Mode on IronWare in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -25,7 +26,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -37,7 +38,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
For legacy playbooks, IronWare still supports ``ansible_connection: local``. We recommend modernizing to use ``ansible_connection: network_cli`` as soon as possible.
The ``ansible_connection: local`` has been deprecated. Please use ``ansible_connection: ansible.netcommon.network_cli`` instead.
Using CLI in Ansible
====================
@ -47,8 +48,8 @@ Example CLI ``group_vars/mlx.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: ironware
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.ironware
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -61,16 +62,16 @@ Example CLI ``group_vars/mlx.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (ironware)
ironware_config:
community.network.ironware_config:
backup: yes
register: backup_ironware_location
when: ansible_network_os == 'ironware'
when: ansible_network_os == 'community.network.ironware'
.. include:: shared_snippets/SSH_warning.txt

11
docs/docsite/rst/network/user_guide/platform_meraki.rst
View file

@ -4,11 +4,12 @@
Meraki Platform Options
***************************************
Meraki only support supports the ``local`` connection type at this time.
The `cisco.meraki <https://galaxy.ansible.com/cisco/meraki>`_ collection only supports the ``local`` connection type at this time.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -27,12 +28,12 @@ Connections Available
==================== ==========================================
Example Meraki Task
Example Meraki task
-------------------
.. code-block:: yaml
meraki_organization:
cisco.meraki.meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: present

23
docs/docsite/rst/network/user_guide/platform_netvisor.rst
View file

@ -4,12 +4,13 @@
Pluribus NETVISOR Platform Options
**********************************
Pluribus NETVISOR Ansible modules only support CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``network_cli`` on NETVISOR in Ansible.
Pluribus NETVISOR Ansible is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``ansible.netcommon.network_cli`` on NETVISOR in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -26,7 +27,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| not supported by NETVISOR
@ -35,7 +36,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
Pluribus NETVISOR does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
Pluribus NETVISOR does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -45,8 +46,8 @@ Example CLI ``group_vars/netvisor.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: netvisor
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.netcommon.netvisor
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -56,18 +57,18 @@ Example CLI ``group_vars/netvisor.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Create access list
pn_access_list:
community.network.pn_access_list:
pn_name: "foo"
pn_scope: "local"
state: "present"
register: acc_list
when: ansible_network_os == 'netvisor'
when: ansible_network_os == 'community.network.netvisor'
.. include:: shared_snippets/SSH_warning.txt

23
docs/docsite/rst/network/user_guide/platform_nos.rst
View file

@ -4,12 +4,13 @@
NOS Platform Options
***************************************
Extreme NOS Ansible modules only support CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``network_cli`` on NOS in Ansible.
Extreme NOS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``ansible.netcommon.network_cli`` on NOS in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -26,7 +27,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: community.netcommon.network_cli``
|enable_mode| not supported by NOS
@ -35,7 +36,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
NOS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
NOS does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -45,8 +46,8 @@ Example CLI ``group_vars/nos.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: nos
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.nos
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -56,16 +57,16 @@ Example CLI ``group_vars/nos.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Get version information (nos)
nos_command:
community.network.nos_command:
commands: "show version"
register: show_ver
when: ansible_network_os == 'nos'
when: ansible_network_os == 'community.network.nos'
.. include:: shared_snippets/SSH_warning.txt

22
docs/docsite/rst/network/user_guide/platform_routeros.rst
View file

@ -4,9 +4,13 @@
RouterOS Platform Options
***************************************
.. contents:: Topics
RouterOS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``ansible.netcommon.network_cli`` on RouterOS in Ansible.
Connections Available
.. contents::
:local:
Connections available
================================================================================
.. table::
@ -23,7 +27,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.network.network_cli``
|enable_mode| not supported by RouterOS
@ -33,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
RouterOS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
RouterOS does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -43,8 +47,8 @@ Example CLI ``group_vars/routeros.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: routeros
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.routeros
ansible_user: myuser
ansible_password: !vault...
ansible_become: yes
@ -58,16 +62,16 @@ Example CLI ``group_vars/routeros.yml``
- 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.
- If you are getting timeout errors you may want to add ``+cet1024w`` suffix to your username which will disable console colors, enable "dumb" mode, tell RouterOS not to try detecting terminal capabilities and set terminal width to 1024 columns. See article `Console login process <https://wiki.mikrotik.com/wiki/Manual:Console_login_process>`_ in MikroTik wiki for more information.
Example CLI Task
Example CLI task
----------------
.. code-block:: yaml
- name: Display resource statistics (routeros)
routeros_command:
community.network.routeros_command:
commands: /system resource print
register: routeros_resources
when: ansible_network_os == 'routeros'
when: ansible_network_os == 'community.network.routeros'
.. include:: shared_snippets/SSH_warning.txt

23
docs/docsite/rst/network/user_guide/platform_slxos.rst
View file

@ -4,12 +4,13 @@
SLX-OS Platform Options
***************************************
Extreme SLX-OS Ansible modules only support CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``network_cli`` on SLX-OS in Ansible.
Extreme SLX-OS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. ``httpapi`` modules may be added in future.
This page offers details on how to use ``ansible.netcommon.network_cli`` on SLX-OS in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -26,7 +27,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| not supported by SLX-OS
@ -36,7 +37,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
SLX-OS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
SLX-OS does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -46,8 +47,8 @@ Example CLI ``group_vars/slxos.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: slxos
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.slxos
ansible_user: myuser
ansible_password: !vault...
ansible_ssh_common_args: '-o ProxyCommand="ssh -W %h:%p -q bastion01"'
@ -57,16 +58,16 @@ Example CLI ``group_vars/slxos.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Backup current switch config (slxos)
slxos_config:
community.network.slxos_config:
backup: yes
register: backup_slxos_location
when: ansible_network_os == 'slxos'
when: ansible_network_os == 'community.network.slxos'
.. include:: shared_snippets/SSH_warning.txt

23
docs/docsite/rst/network/user_guide/platform_voss.rst
View file

@ -4,12 +4,13 @@
VOSS Platform Options
***************************************
Extreme VOSS Ansible modules only support CLI connections today. This page offers details on how to
use ``network_cli`` on VOSS in Ansible.
Extreme VOSS is part of the `community.network <https://galaxy.ansible.com/community/network>`_ collection and only supports CLI connections today. This page offers details on how to
use ``ansible.netcommon.network_cli`` on VOSS in Ansible.
.. contents:: Topics
.. contents::
:local:
Connections Available
Connections available
================================================================================
.. table::
@ -26,7 +27,7 @@ Connections Available
Indirect Access via a bastion (jump host)
Connection Settings ``ansible_connection: network_cli``
Connection Settings ``ansible_connection: ansible.netcommon.network_cli``
|enable_mode| supported: use ``ansible_become: yes``
with ``ansible_become_method: enable``
@ -37,7 +38,7 @@ Connections Available
.. |enable_mode| replace:: Enable Mode |br| (Privilege Escalation)
VOSS does not support ``ansible_connection: local``. You must use ``ansible_connection: network_cli``.
VOSS does not support ``ansible_connection: local``. You must use ``ansible_connection: ansible.netcommon.network_cli``.
Using CLI in Ansible
====================
@ -47,8 +48,8 @@ Example CLI ``group_vars/voss.yml``
.. code-block:: yaml
ansible_connection: network_cli
ansible_network_os: voss
ansible_connection: ansible.netcommon.network_cli
ansible_network_os: community.network.voss
ansible_user: myuser
ansible_become: yes
ansible_become_method: enable
@ -60,15 +61,15 @@ Example CLI ``group_vars/voss.yml``
- 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
Example CLI task
----------------
.. code-block:: yaml
- name: Retrieve VOSS info
voss_command:
community.network.voss_command:
commands: show sys-info
when: ansible_network_os == 'voss'
when: ansible_network_os == 'community.network.voss'
.. include:: shared_snippets/SSH_warning.txt