Skip to content

Commit

Permalink
Switch to collection with --squash-hierarchy
Browse files Browse the repository at this point in the history
  • Loading branch information
Qalthos committed Apr 12, 2024
1 parent 83fc928 commit b83139d
Show file tree
Hide file tree
Showing 54 changed files with 354 additions and 0 deletions.
14 changes: 14 additions & 0 deletions docs/cidr_merge_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.cidr_merge filter
+++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.cidr_merge`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.cidr_merge filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.cidr\_merge' module instead.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/hwaddr_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.hwaddr filter
+++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.hwaddr`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.hwaddr filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.hwaddr' module instead.
116 changes: 116 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@

.. Created with antsibull-docs 2.9.0
Ansible.Netcommon
=================

Collection version 6.1.0

.. contents::
:local:
:depth: 1

Description
-----------

Ansible Collection with common content to help automate the management of network, security, and cloud devices.

**Author:**

* Ansible Network Community (ansible-network)

**Supported ansible-core versions:**

* 2.14.0 or newer

Collection links
~~~~~~~~~~~~~~~~

* `Issue Tracker <https://github.com/ansible-collections/ansible.netcommon/issues>`__
* `Repository (Sources) <https://github.com/ansible-collections/ansible.netcommon>`__



Plugin Index
------------

These are the plugins in the ansible.netcommon collection:


Modules
~~~~~~~

* `cli_backup module <cli_backup_module.rst>`_ -- Back up device configuration from network devices over network\_cli
* `cli_command module <cli_command_module.rst>`_ -- Run a cli command on cli-based network devices
* `cli_config module <cli_config_module.rst>`_ -- Push text based configuration to network devices over network\_cli
* `cli_restore module <cli_restore_module.rst>`_ -- Restore device configuration to network devices over network\_cli
* `grpc_config module <grpc_config_module.rst>`_ -- Fetch configuration/state data from gRPC enabled target hosts.
* `grpc_get module <grpc_get_module.rst>`_ -- Fetch configuration/state data from gRPC enabled target hosts.
* `net_get module <net_get_module.rst>`_ -- Copy a file from a network device to Ansible Controller
* `net_ping module <net_ping_module.rst>`_ -- Tests reachability using ping from a network device
* `net_put module <net_put_module.rst>`_ -- Copy a file from Ansible Controller to a network device
* `netconf_config module <netconf_config_module.rst>`_ -- netconf device configuration
* `netconf_get module <netconf_get_module.rst>`_ -- Fetch configuration/state data from NETCONF enabled network devices.
* `netconf_rpc module <netconf_rpc_module.rst>`_ -- Execute operations on NETCONF enabled network devices.
* `network_resource module <network_resource_module.rst>`_ -- Manage resource modules
* `restconf_config module <restconf_config_module.rst>`_ -- Handles create, update, read and delete of configuration data on RESTCONF enabled devices.
* `restconf_get module <restconf_get_module.rst>`_ -- Fetch configuration/state data from RESTCONF enabled devices.
* `telnet module <telnet_module.rst>`_ -- Executes a low-down and dirty telnet command


Become Plugins
~~~~~~~~~~~~~~

* `enable become <enable_become.rst>`_ -- Switch to elevated permissions on a network device


Cache Plugins
~~~~~~~~~~~~~

* `memory cache <memory_cache.rst>`_ -- RAM backed, non persistent cache.


Cliconf Plugins
~~~~~~~~~~~~~~~

* `default cliconf <default_cliconf.rst>`_ -- General purpose cliconf plugin for new platforms


Connection Plugins
~~~~~~~~~~~~~~~~~~

* `grpc connection <grpc_connection.rst>`_ -- Provides a persistent connection using the gRPC protocol
* `httpapi connection <httpapi_connection.rst>`_ -- Use httpapi to run command on network appliances
* `libssh connection <libssh_connection.rst>`_ -- Run tasks using libssh for ssh connection
* `netconf connection <netconf_connection.rst>`_ -- Provides a persistent connection using the netconf protocol
* `network_cli connection <network_cli_connection.rst>`_ -- Use network\_cli to run command on network appliances
* `persistent connection <persistent_connection.rst>`_ -- Use a persistent unix socket for connection


Filter Plugins
~~~~~~~~~~~~~~

* `comp_type5 filter <comp_type5_filter.rst>`_ -- The comp\_type5 filter plugin.
* `hash_salt filter <hash_salt_filter.rst>`_ -- The hash\_salt filter plugin.
* `parse_cli filter <parse_cli_filter.rst>`_ -- parse\_cli filter plugin.
* `parse_cli_textfsm filter <parse_cli_textfsm_filter.rst>`_ -- parse\_cli\_textfsm filter plugin.
* `parse_xml filter <parse_xml_filter.rst>`_ -- The parse\_xml filter plugin.
* `pop_ace filter <pop_ace_filter.rst>`_ -- Remove ace entries from a acl source of truth.
* `type5_pw filter <type5_pw_filter.rst>`_ -- The type5\_pw filter plugin.
* `vlan_expander filter <vlan_expander_filter.rst>`_ -- The vlan\_expander filter plugin.
* `vlan_parser filter <vlan_parser_filter.rst>`_ -- The vlan\_parser filter plugin.


Httpapi Plugins
~~~~~~~~~~~~~~~

* `restconf httpapi <restconf_httpapi.rst>`_ -- HttpApi Plugin for devices supporting Restconf API


Netconf Plugins
~~~~~~~~~~~~~~~

* `default netconf <default_netconf.rst>`_ -- Use default netconf plugin to run standard netconf commands as per RFC


14 changes: 14 additions & 0 deletions docs/ip4_hex_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ip4_hex filter
++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipv4_hex`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipv4_hex filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ip4\_hex' module instead.
14 changes: 14 additions & 0 deletions docs/ipaddr_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipaddr filter
+++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipaddr`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipaddr filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipaddr' module instead.
14 changes: 14 additions & 0 deletions docs/ipmath_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipmath filter
+++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipmath`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipmath filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipmath' module instead.
14 changes: 14 additions & 0 deletions docs/ipsubnet_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipsubnet filter
+++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipsubnet`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipsubnet filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipsubnet' module instead.
14 changes: 14 additions & 0 deletions docs/ipv4_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipv4 filter
+++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipv4`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipv4 filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipv4' module instead.
14 changes: 14 additions & 0 deletions docs/ipv6_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipv6 filter
+++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipv6`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipv6 filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipv6' module instead.
14 changes: 14 additions & 0 deletions docs/ipwrap_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.ipwrap filter
+++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.ipwrap`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.ipwrap filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.ipwrap' module instead.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/macaddr_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.macaddr filter
++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.macaddr`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.macaddr filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.macaddr' module instead.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/network_in_network_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.network_in_network filter
+++++++++++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.network_in_network`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.network_in_network filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.network\_in\_network' module instead.
14 changes: 14 additions & 0 deletions docs/network_in_usable_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.network_in_usable filter
++++++++++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.network_in_usable`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.network_in_usable filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.network\_in\_usable' module instead.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/next_nth_usable_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.next_nth_usable filter
++++++++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.next_nth_usable`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.next_nth_usable filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.next\_nth\_usable' module instead.
14 changes: 14 additions & 0 deletions docs/nthhost_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.nthhost filter
++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.nthhost`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.nthhost filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.nthhost' module instead.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/previous_nth_usable_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.previous_nth_usable filter
++++++++++++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.previous_nth_usable`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.previous_nth_usable filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.previous\_nth\_usable' module instead.
14 changes: 14 additions & 0 deletions docs/reduce_on_network_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.reduce_on_network filter
++++++++++++++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.reduce_on_network`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.reduce_on_network filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.reduce\_on\_network' module instead.
File renamed without changes.
File renamed without changes.
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/slaac_filter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

.. Created with antsibull-docs 2.9.0
ansible.netcommon.slaac filter
++++++++++++++++++++++++++++++

- This redirect is part of the `ansible.netcommon collection <https://galaxy.ansible.com/ui/repo/published/ansible/netcommon/>`_ (version 6.1.0).


- This redirect has been **deprecated**. Please update your tasks to use the new name ``ansible.utils.slaac`` instead.
It will be removed in a major release after 2024-01-01 of ansible.netcommon.
- This is a redirect to the ansible.utils.slaac filter plugin.
- This redirect does **not** work with Ansible 2.9.
- The collection contains the following information on this deprecation: Use 'ansible.utils.slaac' module instead.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit b83139d

Please sign in to comment.