From 4331d916ac6e6423e145d6c4496947404b7dc8ab Mon Sep 17 00:00:00 2001 From: jmcgill298 Date: Fri, 17 Dec 2021 22:51:03 -0500 Subject: [PATCH] Release 3.3.0 --- CHANGELOG.rst | 14 + changelogs/changelog.yaml | 11 +- docs/plugins/aggregate_module.rst | 25 +- docs/plugins/cable_module.rst | 25 +- docs/plugins/circuit_module.rst | 25 +- docs/plugins/circuit_termination_module.rst | 25 +- docs/plugins/circuit_type_module.rst | 25 +- docs/plugins/cluster_group_module.rst | 25 +- docs/plugins/cluster_module.rst | 25 +- docs/plugins/cluster_type_module.rst | 25 +- docs/plugins/console_port_module.rst | 25 +- docs/plugins/console_port_template_module.rst | 25 +- docs/plugins/console_server_port_module.rst | 25 +- .../console_server_port_template_module.rst | 25 +- docs/plugins/device_bay_module.rst | 25 +- docs/plugins/device_bay_template_module.rst | 25 +- docs/plugins/device_interface_module.rst | 25 +- .../device_interface_template_module.rst | 25 +- docs/plugins/device_module.rst | 25 +- docs/plugins/device_role_module.rst | 25 +- docs/plugins/device_type_module.rst | 25 +- docs/plugins/front_port_module.rst | 25 +- docs/plugins/front_port_template_module.rst | 25 +- docs/plugins/gql_inventory_inventory.rst | 106 ++++---- docs/plugins/index.rst | 72 +++++- docs/plugins/inventory_inventory.rst | 241 +++++++++++------- docs/plugins/inventory_item_module.rst | 25 +- docs/plugins/ip_address_module.rst | 25 +- docs/plugins/ipam_role_module.rst | 25 +- docs/plugins/lookup_graphql_lookup.rst | 88 ++++--- docs/plugins/lookup_lookup.rst | 64 +++-- docs/plugins/manufacturer_module.rst | 25 +- docs/plugins/nautobot_server_module.rst | 29 ++- docs/plugins/platform_module.rst | 25 +- docs/plugins/power_feed_module.rst | 25 +- docs/plugins/power_outlet_module.rst | 25 +- docs/plugins/power_outlet_template_module.rst | 25 +- docs/plugins/power_panel_module.rst | 25 +- docs/plugins/power_port_module.rst | 25 +- docs/plugins/power_port_template_module.rst | 25 +- docs/plugins/prefix_module.rst | 25 +- docs/plugins/provider_module.rst | 25 +- docs/plugins/query_graphql_module.rst | 29 ++- docs/plugins/rack_group_module.rst | 25 +- docs/plugins/rack_module.rst | 25 +- docs/plugins/rack_role_module.rst | 25 +- docs/plugins/rear_port_module.rst | 25 +- docs/plugins/rear_port_template_module.rst | 25 +- docs/plugins/region_module.rst | 25 +- docs/plugins/rir_module.rst | 25 +- docs/plugins/route_target_module.rst | 25 +- docs/plugins/service_module.rst | 21 +- docs/plugins/site_module.rst | 25 +- docs/plugins/status_module.rst | 25 +- docs/plugins/tag_module.rst | 25 +- docs/plugins/tenant_group_module.rst | 25 +- docs/plugins/tenant_module.rst | 25 +- docs/plugins/virtual_chassis_module.rst | 25 +- docs/plugins/virtual_machine_module.rst | 25 +- docs/plugins/vlan_group_module.rst | 25 +- docs/plugins/vlan_module.rst | 25 +- docs/plugins/vm_interface_module.rst | 25 +- docs/plugins/vrf_module.rst | 25 +- galaxy.yml | 2 +- pyproject.toml | 2 +- 65 files changed, 1589 insertions(+), 415 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index db9046f3..b13d70df 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,20 @@ networktocode.nautobot Release Notes .. contents:: Topics +v3.3.0 +====== + +Release Summary +--------------- + +GraphQL Inventory Group Customization + +Minor Changes +------------- + +- (#115) Documentation fixes +- (#110) Allow users to define any path for defining GroupBy Group names + v3.2.1 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index c6b0f88a..ea0735a7 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -274,7 +274,14 @@ releases: 3.2.1: changes: bugfixes: - - Remove bad code in plugins/inventory/inventory.yml when locally built to publish that prevented it from grabbing all hosts + - Remove bad code in plugins/inventory/inventory.yml when locally built to publish + that prevented it from grabbing all hosts release_summary: Unbreak plugins/inventory/inventory.yml release_date: '2021-11-18' - + 3.3.0: + changes: + minor_changes: + - (#115) Documentation fixes + - (#110) Allow users to define any path for defining GroupBy Group names + release_summary: GraphQL Inventory Group Customization + release_date: '2021-12-17' diff --git a/docs/plugins/aggregate_module.rst b/docs/plugins/aggregate_module.rst index db90eff5..65089736 100755 --- a/docs/plugins/aggregate_module.rst +++ b/docs/plugins/aggregate_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.aggregate_module: @@ -20,9 +30,13 @@ networktocode.nautobot.aggregate -- Creates or removes aggregates from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.aggregate`. @@ -266,6 +280,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -352,7 +369,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -367,7 +384,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/cable_module.rst b/docs/plugins/cable_module.rst index c88e1dc9..783ed5d2 100755 --- a/docs/plugins/cable_module.rst +++ b/docs/plugins/cable_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.cable_module: @@ -20,9 +30,13 @@ networktocode.nautobot.cable -- Create, update or delete cables within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.cable`. @@ -389,6 +403,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -497,7 +514,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -512,7 +529,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/circuit_module.rst b/docs/plugins/circuit_module.rst index a84eac92..77aa1a2a 100755 --- a/docs/plugins/circuit_module.rst +++ b/docs/plugins/circuit_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.circuit_module: @@ -20,9 +30,13 @@ networktocode.nautobot.circuit -- Create, update or delete circuits within Nauto .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.circuit`. @@ -357,6 +371,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -449,7 +466,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -464,7 +481,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/circuit_termination_module.rst b/docs/plugins/circuit_termination_module.rst index 412e2093..d8222a26 100755 --- a/docs/plugins/circuit_termination_module.rst +++ b/docs/plugins/circuit_termination_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.circuit_termination_module: @@ -20,9 +30,13 @@ networktocode.nautobot.circuit_termination -- Create, update or delete circuit t .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.circuit_termination`. @@ -306,6 +320,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -395,7 +412,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -410,7 +427,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/circuit_type_module.rst b/docs/plugins/circuit_type_module.rst index 7beb7cd4..d25c9fbf 100755 --- a/docs/plugins/circuit_type_module.rst +++ b/docs/plugins/circuit_type_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.circuit_type_module: @@ -20,9 +30,13 @@ networktocode.nautobot.circuit_type -- Create, update or delete circuit types wi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.circuit_type`. @@ -195,6 +209,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -268,7 +285,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -283,7 +300,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/cluster_group_module.rst b/docs/plugins/cluster_group_module.rst index f717a306..a7491f05 100755 --- a/docs/plugins/cluster_group_module.rst +++ b/docs/plugins/cluster_group_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.cluster_group_module: @@ -20,9 +30,13 @@ networktocode.nautobot.cluster_group -- Create, update or delete cluster groups .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.cluster_group`. @@ -195,6 +209,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -268,7 +285,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -283,7 +300,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/cluster_module.rst b/docs/plugins/cluster_module.rst index 3d291478..9b469add 100755 --- a/docs/plugins/cluster_module.rst +++ b/docs/plugins/cluster_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.cluster_module: @@ -20,9 +30,13 @@ networktocode.nautobot.cluster -- Create, update or delete clusters within Nauto .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.cluster`. @@ -302,6 +316,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -396,7 +413,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -411,7 +428,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/cluster_type_module.rst b/docs/plugins/cluster_type_module.rst index ac17f7d0..b5d477f7 100755 --- a/docs/plugins/cluster_type_module.rst +++ b/docs/plugins/cluster_type_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.cluster_type_module: @@ -20,9 +30,13 @@ networktocode.nautobot.cluster_type -- Create, update or delete cluster types wi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.cluster_type`. @@ -195,6 +209,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -268,7 +285,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -283,7 +300,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/console_port_module.rst b/docs/plugins/console_port_module.rst index e6b84655..15cc7151 100755 --- a/docs/plugins/console_port_module.rst +++ b/docs/plugins/console_port_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.console_port_module: @@ -20,9 +30,13 @@ networktocode.nautobot.console_port -- Create, update or delete console ports wi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.console_port`. @@ -263,6 +277,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -348,7 +365,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -363,7 +380,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/console_port_template_module.rst b/docs/plugins/console_port_template_module.rst index b2b2fd02..075f8761 100755 --- a/docs/plugins/console_port_template_module.rst +++ b/docs/plugins/console_port_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.console_port_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.console_port_template -- Create, update or delete console .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.console_port_template`. @@ -227,6 +241,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -311,7 +328,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -326,7 +343,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/console_server_port_module.rst b/docs/plugins/console_server_port_module.rst index ca02951f..a14cc248 100755 --- a/docs/plugins/console_server_port_module.rst +++ b/docs/plugins/console_server_port_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.console_server_port_module: @@ -20,9 +30,13 @@ networktocode.nautobot.console_server_port -- Create, update or delete console s .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.console_server_port`. @@ -263,6 +277,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -348,7 +365,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -363,7 +380,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/console_server_port_template_module.rst b/docs/plugins/console_server_port_template_module.rst index c082a85e..882a37db 100755 --- a/docs/plugins/console_server_port_template_module.rst +++ b/docs/plugins/console_server_port_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.console_server_port_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.console_server_port_template -- Create, update or delete .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.console_server_port_template`. @@ -227,6 +241,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -311,7 +328,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -326,7 +343,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_bay_module.rst b/docs/plugins/device_bay_module.rst index d86a7327..5372d5e3 100755 --- a/docs/plugins/device_bay_module.rst +++ b/docs/plugins/device_bay_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_bay_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_bay -- Create, update or delete device bays within .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_bay`. @@ -248,6 +262,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -332,7 +349,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -347,7 +364,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_bay_template_module.rst b/docs/plugins/device_bay_template_module.rst index c7332a8e..368044f6 100755 --- a/docs/plugins/device_bay_template_module.rst +++ b/docs/plugins/device_bay_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_bay_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_bay_template -- Create, update or delete device ba .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_bay_template`. @@ -194,6 +208,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -269,7 +286,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -284,7 +301,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_interface_module.rst b/docs/plugins/device_interface_module.rst index a7ee18ad..597dad4e 100755 --- a/docs/plugins/device_interface_module.rst +++ b/docs/plugins/device_interface_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_interface_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_interface -- Creates or removes interfaces on devi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_interface`. @@ -462,6 +476,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -599,7 +616,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -614,7 +631,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_interface_template_module.rst b/docs/plugins/device_interface_template_module.rst index 56698e7b..124c14b9 100755 --- a/docs/plugins/device_interface_template_module.rst +++ b/docs/plugins/device_interface_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_interface_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_interface_template -- Creates or removes interface .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_interface_template`. @@ -237,6 +251,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -312,7 +329,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -327,7 +344,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst index e5854c48..ca5937b2 100755 --- a/docs/plugins/device_module.rst +++ b/docs/plugins/device_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device -- Create, update or delete devices within Nautobo .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device`. @@ -561,6 +575,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -674,7 +691,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -689,7 +706,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_role_module.rst b/docs/plugins/device_role_module.rst index 4311be8d..e729db23 100755 --- a/docs/plugins/device_role_module.rst +++ b/docs/plugins/device_role_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_role_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_role -- Create, update or delete devices roles wit .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_role`. @@ -253,6 +267,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -327,7 +344,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -342,7 +359,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst index 8b7c482d..a63f51a5 100755 --- a/docs/plugins/device_type_module.rst +++ b/docs/plugins/device_type_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.device_type_module: @@ -20,9 +30,13 @@ networktocode.nautobot.device_type -- Create, update or delete device types with .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.device_type`. @@ -350,6 +364,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -438,7 +455,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -453,7 +470,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/front_port_module.rst b/docs/plugins/front_port_module.rst index 68605fcd..698e3d13 100755 --- a/docs/plugins/front_port_module.rst +++ b/docs/plugins/front_port_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.front_port_module: @@ -20,9 +30,13 @@ networktocode.nautobot.front_port -- Create, update or delete front ports within .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.front_port`. @@ -300,6 +314,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -391,7 +408,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -406,7 +423,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/front_port_template_module.rst b/docs/plugins/front_port_template_module.rst index 7418c1a8..d68038e9 100755 --- a/docs/plugins/front_port_template_module.rst +++ b/docs/plugins/front_port_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.front_port_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.front_port_template -- Create, update or delete front por .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.front_port_template`. @@ -274,6 +288,9 @@ Parameters
+.. Attributes + + .. Notes Notes @@ -365,7 +382,7 @@ Common return values are documented :ref:`here `, the foll
Serialized object as created or already existent within Nautobot

- + @@ -380,7 +397,7 @@ Common return values are documented :ref:`here `, the foll
Message indicating failure or info about what has been achieved

- +

diff --git a/docs/plugins/gql_inventory_inventory.rst b/docs/plugins/gql_inventory_inventory.rst index dd9bc92b..ed6c2b6d 100755 --- a/docs/plugins/gql_inventory_inventory.rst +++ b/docs/plugins/gql_inventory_inventory.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.gql_inventory_inventory: @@ -20,9 +30,13 @@ networktocode.nautobot.gql_inventory -- Nautobot inventory source using GraphQL .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.gql_inventory`. @@ -78,12 +92,13 @@ Parameters
list / elements=string
- + + Default:
[]
- +
Variable types and values to use while making the call
@@ -96,14 +111,16 @@ Parameters
string / required
- + +
env:NAUTOBOT_URL -
- + + +
Endpoint of the Nautobot API
@@ -116,12 +133,13 @@ Parameters
dictionary
- + + Default:
{}
- +
Granular device search query
@@ -134,7 +152,8 @@ Parameters
string
- + +
    Choices:
  • urllib2 ←
    • @@ -145,7 +164,7 @@ Parameters
- +
Determine how redirects are followed.
By default, follow_redirects is set to uses urllib2 default behavior.
@@ -159,20 +178,18 @@ Parameters
list / elements=string
- + + -
    Choices: -
  • platform
    • -
  • status
    • -
  • device_role
    • -
  • site
    • -
- Default:
[]
+ Default:
[]
- + -
List of data paths to group the hosts.
+
List of dot-sparated paths to index graphql query results (e.g. `platform.slug`)
+
The final value returned by each path is used to derive group names and then group the devices into these groups.
+
Valid group names must be string, so indexing the dotted path should return a string (i.e. `platform.slug` instead of `platform`)
+
If value returned by the defined path is a dictionary, an attempt will first be made to access the `name` field, and then the `slug` field. (i.e. `platform` would attempt to lookup `platform.name`, and if that data was not returned, it would then try `platform.slug`)
@@ -183,14 +200,15 @@ Parameters
string / required
- + +
    Choices:
  • networktocode.nautobot.gql_inventory
- +
Setting that ensures this is a source file for the 'networktocode.nautobot' plugin.
@@ -203,12 +221,13 @@ Parameters
dictionary
- + + Default:
{}
- +
GraphQL query to send to Nautobot to obtain desired data
@@ -221,12 +240,13 @@ Parameters
integer
- + + Default:
60
- +
Timeout for Nautobot requests in seconds
@@ -239,14 +259,16 @@ Parameters
string / required
- + +
env:NAUTOBOT_TOKEN -
- + + +
Nautobot API token to be able to read against Nautobot.
This may not be required depending on the Nautobot setup.
@@ -260,7 +282,8 @@ Parameters
boolean
- + +
    Choices:
  • no
    • @@ -268,7 +291,7 @@ Parameters
- +
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
@@ -276,6 +299,9 @@ Parameters
+.. Attributes + + .. Notes @@ -289,7 +315,7 @@ Examples .. code-block:: yaml+jinja - + # inventory.yml file in YAML format # Example command line: ansible-inventory -v --list -i inventory.yml @@ -300,24 +326,14 @@ Examples query: tags: name - # To group by use group_by key - # Please see choices for supported group_by options. - plugin: networktocode.nautobot.gql_inventory - api_endpoint: http://localhost:8000 - validate_certs: True - group_by: - - platform - # To group by use group_by key # Specify the full path to the data you would like to use to group by. - # Note. If you pass in a single string rather than a path, the plugin will automatically try to find a name or slug value. plugin: networktocode.nautobot.gql_inventory api_endpoint: http://localhost:8000 validate_certs: True group_by: - - tenant.name - - status.slug - + - tenant.name + - status.slug # Add additional variables plugin: networktocode.nautobot.gql_inventory diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index 9a3555a5..8bdac237 100755 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,15 +1,15 @@ -:orphan: .. _plugins_in_networktocode.nautobot: Networktocode.Nautobot ====================== -Collection version 3.2.1 +Collection version 3.3.0 .. toctree:: :maxdepth: 1 + Plugin Index ------------ @@ -89,6 +89,72 @@ Modules * :ref:`vrf ` -- Create, update or delete vrfs within Nautobot + .. seealso:: - List of :ref:`collections ` with docs hosted here. \ No newline at end of file + List of :ref:`collections ` with docs hosted here. + +.. toctree:: + :maxdepth: 1 + :hidden: + + gql_inventory_inventory + inventory_inventory + lookup_lookup + lookup_graphql_lookup + aggregate_module + cable_module + circuit_module + circuit_termination_module + circuit_type_module + cluster_module + cluster_group_module + cluster_type_module + console_port_module + console_port_template_module + console_server_port_module + console_server_port_template_module + device_module + device_bay_module + device_bay_template_module + device_interface_module + device_interface_template_module + device_role_module + device_type_module + front_port_module + front_port_template_module + inventory_item_module + ip_address_module + ipam_role_module + manufacturer_module + nautobot_server_module + platform_module + power_feed_module + power_outlet_module + power_outlet_template_module + power_panel_module + power_port_module + power_port_template_module + prefix_module + provider_module + query_graphql_module + rack_module + rack_group_module + rack_role_module + rear_port_module + rear_port_template_module + region_module + rir_module + route_target_module + service_module + site_module + status_module + tag_module + tenant_module + tenant_group_module + virtual_chassis_module + virtual_machine_module + vlan_module + vlan_group_module + vm_interface_module + vrf_module diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index 60e6668d..4cf26abf 100755 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.inventory_inventory: @@ -20,9 +30,13 @@ networktocode.nautobot.inventory -- Nautobot inventory source .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.inventory`. @@ -72,7 +86,8 @@ Parameters
boolean
- + +
    Choices:
  • no ←
    • @@ -80,7 +95,7 @@ Parameters
- +
If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address.
@@ -93,14 +108,16 @@ Parameters
string / required
- + +
env:NAUTOBOT_URL -
- + + +
Endpoint of the Nautobot API
@@ -113,7 +130,8 @@ Parameters
boolean
- + +
    Choices:
  • no ←
    • @@ -124,12 +142,14 @@ Parameters
    ini entries:

    [inventory]
    cache = no -

    + +

    env:ANSIBLE_INVENTORY_CACHE -
    - + + +
    Toggle to enable/disable the caching of the inventory's source data, requires a cache plugin setup to work.
    @@ -142,25 +162,30 @@ Parameters
    string
    - + +
    ini entries:

    [defaults]
    fact_caching_connection = None -

    + +

    [inventory]
    cache_connection = None -

    + +

    env:ANSIBLE_CACHE_PLUGIN_CONNECTION -
    + +
    env:ANSIBLE_INVENTORY_CACHE_CONNECTION -
    - + + +
    Cache connection data or path, read cache plugin documentation for specifics.
    @@ -173,7 +198,8 @@ Parameters
    string
    - + + Default:
    "memory"
    @@ -181,18 +207,22 @@ Parameters
    ini entries:

    [defaults]
    fact_caching = memory -

    + +

    [inventory]
    cache_plugin = memory -

    + +

    env:ANSIBLE_CACHE_PLUGIN -
    + +
    env:ANSIBLE_INVENTORY_CACHE_PLUGIN -
    - + + +
    Cache plugin to use for the inventory's source data.
    @@ -205,7 +235,8 @@ Parameters
    string
    - + + Default:
    "ansible_inventory_"
    @@ -213,18 +244,22 @@ Parameters
    ini entries:

    [default]
    fact_caching_prefix = ansible_inventory_ -

    + +

    [inventory]
    cache_prefix = ansible_inventory_ -

    + +

    env:ANSIBLE_CACHE_PLUGIN_PREFIX -
    + +
    env:ANSIBLE_INVENTORY_CACHE_PLUGIN_PREFIX -
    - + + +
    Prefix to use for cache plugin files/tables
    @@ -237,7 +272,8 @@ Parameters
    integer
    - + + Default:
    3600
    @@ -245,18 +281,22 @@ Parameters
    ini entries:

    [defaults]
    fact_caching_timeout = 3600 -

    + +

    [inventory]
    cache_timeout = 3600 -

    + +

    env:ANSIBLE_CACHE_PLUGIN_TIMEOUT -
    + +
    env:ANSIBLE_INVENTORY_CACHE_TIMEOUT -
    - + + +
    Cache duration in seconds
    @@ -269,12 +309,13 @@ Parameters
    dictionary
    - + + Default:
    {}
    - +
    List of custom ansible host vars to create from the device object fetched from Nautobot
    @@ -287,7 +328,8 @@ Parameters
    boolean
    - + +
      Choices:
    • no ←
      • @@ -295,7 +337,7 @@ Parameters
    - +
    If True, it adds config_context in host vars.
    Config-context enables the association of arbitrary data to devices and virtual machines grouped by region, site, role, platform, and/or tenant. Please check official nautobot docs for more info.
    @@ -309,12 +351,13 @@ Parameters
    list / elements=string
    - + + Default:
    []
    - +
    List of parameters passed to the query string for devices (Multiple values may be separated by commas)
    @@ -327,7 +370,8 @@ Parameters
    boolean
    - + +
      Choices:
    • no ←
      • @@ -335,7 +379,7 @@ Parameters
    - +
    Force IP Addresses to be fetched so that the dns_name for the primary_ip of each device or VM is set as a host_var.
    Setting interfaces will also fetch IP addresses and the dns_name host_var will be set.
    @@ -352,7 +396,8 @@ Parameters
    added in 1.0.0 of networktocode.nautobot
    - + +
      Choices:
    • no
      • @@ -360,7 +405,7 @@ Parameters
    - +
    By default, fetching interfaces and services will get all of the contents of Nautobot regardless of query_filters applied to devices and VMs.
    When set to False, separate requests will be made fetching interfaces, services, and IP addresses for each device_id and virtual_machine_id.
    @@ -381,7 +426,8 @@ Parameters
    added in 1.0.0 of networktocode.nautobot
    - + +
      Choices:
    • no ←
      • @@ -389,7 +435,7 @@ Parameters
    - +
    If config_context is enabled, by default it's added as a host var named config_context.
    If flatten_config_context is set to True, the config context variables will be added directly to the host instead.
    @@ -406,7 +452,8 @@ Parameters
    added in 1.0.0 of networktocode.nautobot
    - + +
      Choices:
    • no ←
      • @@ -414,7 +461,7 @@ Parameters
    - +
    By default, host custom fields are added as a dictionary host var named custom_fields.
    If flatten_custom_fields is set to True, the fields will be added directly to the host instead.
    @@ -431,7 +478,8 @@ Parameters
    added in 1.0.0 of networktocode.nautobot
    - + +
      Choices:
    • no ←
      • @@ -439,7 +487,7 @@ Parameters
    - +
    If local_context_data is enabled, by default it's added as a host var named local_context_data.
    If flatten_local_context_data is set to True, the config context variables will be added directly to the host instead.
    @@ -453,7 +501,8 @@ Parameters
    string
    - + +
      Choices:
    • urllib2 ←
      • @@ -464,7 +513,7 @@ Parameters
    - +
    Determine how redirects are followed.
    By default, follow_redirects is set to uses urllib2 default behavior.
    @@ -478,7 +527,8 @@ Parameters
    list / elements=string
    - + +
      Choices:
    • sites
      • @@ -511,7 +561,7 @@ Parameters Default:
      []
      - +
      Keys used to create groups. The plurals option controls which of these are valid.
      @@ -527,7 +577,8 @@ Parameters
      added in 1.0.0 of networktocode.nautobot
      - + +
        Choices:
      • no ←
        • @@ -535,7 +586,7 @@ Parameters
      - +
      Will not add the group_by choice name to the group names
      @@ -548,12 +599,13 @@ Parameters
      dictionary
      - + + Default:
      {}
      - +
      Add hosts to group based on Jinja2 conditionals.
      @@ -569,7 +621,8 @@ Parameters
      added in 1.0.0 of networktocode.nautobot
      - + +
        Choices:
      • no ←
        • @@ -577,7 +630,7 @@ Parameters
      - +
      If True, it adds the device or virtual machine interface information in host vars.
      @@ -590,12 +643,13 @@ Parameters
      list / elements=string
      - + + Default:
      []
      - +
      Add hosts to group based on the values of a variable.
      @@ -611,12 +665,13 @@ Parameters
      added in 1.0.0 of networktocode.nautobot
      - + + Default:
      4000
      - +
      When fetch_all is False, GET requests to Nautobot may become quite long and return a HTTP 414 (URI Too Long).
      You can adjust this option to be smaller to avoid 414 errors, or larger for a reduced number of requests.
      @@ -630,14 +685,15 @@ Parameters
      string / required
      - + +
        Choices:
      • networktocode.nautobot.inventory
      - +
      token that ensures this is a source file for the 'nautobot' plugin.
      @@ -653,7 +709,8 @@ Parameters
      added in 1.0.0 of networktocode.nautobot
      - + +
        Choices:
      • no
        • @@ -661,7 +718,7 @@ Parameters
      - +
      If True, all host vars are contained inside single-element arrays for legacy compatibility with old versions of this plugin.
      Group names will be plural (ie. "sites_mysite" instead of "site_mysite")
      @@ -676,12 +733,13 @@ Parameters
      list / elements=string
      - + + Default:
      []
      - +
      List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas)
      @@ -697,7 +755,8 @@ Parameters
      added in 1.0.0 of networktocode.nautobot
      - + +
        Choices:
      • no
        • @@ -705,7 +764,7 @@ Parameters
      - +
      If True, it adds the device or virtual machine services information in host vars.
      @@ -718,7 +777,8 @@ Parameters
      boolean
      - + +
        Choices:
      • no ←
        • @@ -726,7 +786,7 @@ Parameters
      - +
      If yes make invalid entries a fatal error, otherwise skip and continue.
      Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
      @@ -740,12 +800,13 @@ Parameters
      integer
      - + + Default:
      60
      - +
      Timeout for Nautobot requests in seconds
      @@ -758,14 +819,16 @@ Parameters
      string
      - + +
      env:NAUTOBOT_TOKEN -
      - + + +
      Nautobot API token to be able to read against Nautobot.
      This may not be required depending on the Nautobot setup.
      @@ -779,7 +842,8 @@ Parameters
      boolean
      - + +
        Choices:
      • no
        • @@ -787,7 +851,7 @@ Parameters
      - +
      Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
      @@ -800,7 +864,8 @@ Parameters
      boolean
      - + +
        Choices:
      • no ←
        • @@ -808,7 +873,7 @@ Parameters
      - +
      When a device is part of a virtual chassis, use the virtual chassis name as the Ansible inventory hostname.
      The host var values will be from the virtual chassis master.
      @@ -822,12 +887,13 @@ Parameters
      list / elements=string
      - + + Default:
      []
      - +
      List of parameters passed to the query string for VMs (Multiple values may be separated by commas)
      @@ -835,6 +901,9 @@ Parameters
      +.. Attributes + + .. Notes diff --git a/docs/plugins/inventory_item_module.rst b/docs/plugins/inventory_item_module.rst index 727c60c4..e951c90c 100755 --- a/docs/plugins/inventory_item_module.rst +++ b/docs/plugins/inventory_item_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.inventory_item_module: @@ -20,9 +30,13 @@ networktocode.nautobot.inventory_item -- Creates or removes inventory items from .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.inventory_item`. @@ -325,6 +339,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -412,7 +429,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - + @@ -427,7 +444,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - +

      diff --git a/docs/plugins/ip_address_module.rst b/docs/plugins/ip_address_module.rst index 62cf21c6..479470da 100755 --- a/docs/plugins/ip_address_module.rst +++ b/docs/plugins/ip_address_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.ip_address_module: @@ -20,9 +30,13 @@ networktocode.nautobot.ip_address -- Creates or removes IP addresses from Nautob .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.ip_address`. @@ -446,6 +460,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -578,7 +595,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - + @@ -593,7 +610,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - +

      diff --git a/docs/plugins/ipam_role_module.rst b/docs/plugins/ipam_role_module.rst index 800e170b..04a0203b 100755 --- a/docs/plugins/ipam_role_module.rst +++ b/docs/plugins/ipam_role_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.ipam_role_module: @@ -20,9 +30,13 @@ networktocode.nautobot.ipam_role -- Creates or removes ipam roles from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.ipam_role`. @@ -214,6 +228,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -286,7 +303,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -301,7 +318,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/lookup_graphql_lookup.rst b/docs/plugins/lookup_graphql_lookup.rst index 902bd1a2..1e585a28 100755 --- a/docs/plugins/lookup_graphql_lookup.rst +++ b/docs/plugins/lookup_graphql_lookup.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.lookup_graphql_lookup: @@ -20,9 +30,13 @@ networktocode.nautobot.lookup_graphql -- Queries and returns elements from Nauto .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.lookup_graphql`. @@ -73,17 +87,37 @@ Parameters +
      + graph_variables + +
      + string +
      + + + + + + + +
      Dictionary of keys/values to pass into the GraphQL query
      +
      See [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more details
      + + + +
      query
      string / required
      - + + - +
      The GraphQL formatted query string, see [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html).
      @@ -96,14 +130,16 @@ Parameters
      string
      - + +
      env:NAUTOBOT_TOKEN -
      - + + +
      The API token created through Nautobot
      @@ -116,14 +152,16 @@ Parameters
      string / required
      - + +
      env:NAUTOBOT_URL -
      - + + +
      The URL to the Nautobot instance to query (http://nautobot.example.com:8000)
      @@ -136,37 +174,23 @@ Parameters
      string
      - + + Default:
      "yes"
      - +
      Whether or not to validate SSL of the Nautobot instance
      - - - -
      - variables - -
      - string -
      - - - - - - -
      Dictionary of keys/values to pass into the GraphQL query
      -
      See [pynautobot GraphQL documentation](https://pynautobot.readthedocs.io/en/latest/advanced/graphql.html) for more details
      -
      +.. Attributes + + .. Notes @@ -198,7 +222,7 @@ Examples # Make query to GraphQL Endpoint - name: Obtain list of sites from Nautobot set_fact: - query_response: "{{ query('networktocode.nautobot.lookup_graphql', query=query, url='https://nautobot.example.com', token='') }}" + query_response: "{{ query('networktocode.nautobot.lookup_graphql', query=query_string, url='https://nautobot.example.com', token='') }}" # Example with variables - name: SET FACTS TO SEND TO GRAPHQL ENDPOINT @@ -255,7 +279,7 @@ Common return values are documented :ref:`here `, the foll
      Data result from the GraphQL endpoint

      - +

      diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 5bb6d952..bf3b5450 100755 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.lookup_lookup: @@ -20,9 +30,13 @@ networktocode.nautobot.lookup -- Queries and returns elements from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.lookup`. @@ -79,11 +93,12 @@ Parameters
      string / required
      - + + - +
      The Nautobot object type to query
      @@ -96,14 +111,16 @@ Parameters
      string / required
      - + +
      env:NAUTOBOT_URL -
      - + + +
      The URL to the Nautobot instance to query
      @@ -116,11 +133,12 @@ Parameters
      string
      - + + - +
      The api_filter to use.
      @@ -133,11 +151,12 @@ Parameters
      string
      - + + - +
      The Nautobot plugin to query
      @@ -150,11 +169,12 @@ Parameters
      string
      - + + - +
      Whether to return raw API data with the lookup/query or whether to return a key/value dict
      @@ -167,14 +187,16 @@ Parameters
      string
      - + +
      env:NAUTOBOT_TOKEN -
      - + + +
      The API token created through Nautobot
      This may not be required depending on the Nautobot setup.
      @@ -188,12 +210,13 @@ Parameters
      string
      - + + Default:
      "yes"
      - +
      Whether or not to validate SSL of the Nautobot instance
      @@ -201,6 +224,9 @@ Parameters
      +.. Attributes + + .. Notes @@ -282,7 +308,7 @@ Common return values are documented :ref:`here `, the foll
      list of composed dictionaries with key and value

      - +

      diff --git a/docs/plugins/manufacturer_module.rst b/docs/plugins/manufacturer_module.rst index 6ac28113..d570aba0 100755 --- a/docs/plugins/manufacturer_module.rst +++ b/docs/plugins/manufacturer_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.manufacturer_module: @@ -20,9 +30,13 @@ networktocode.nautobot.manufacturer -- Create or delete manufacturers within Nau .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.manufacturer`. @@ -195,6 +209,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -268,7 +285,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - + @@ -283,7 +300,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - +

      diff --git a/docs/plugins/nautobot_server_module.rst b/docs/plugins/nautobot_server_module.rst index 2c16e0fa..9332a74a 100755 --- a/docs/plugins/nautobot_server_module.rst +++ b/docs/plugins/nautobot_server_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.nautobot_server_module: @@ -20,9 +30,13 @@ networktocode.nautobot.nautobot_server -- Manages Nautobot Server application. .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.nautobot_server`. @@ -233,6 +247,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -316,7 +333,7 @@ Common return values are documented :ref:`here `, the foll
      Boolean that is true if the command changed the state.

      -
      Sample:
      +
      Sample:
      True
      @@ -333,7 +350,7 @@ Common return values are documented :ref:`here `, the foll
      Full command executed in the Server.

      -
      Sample:
      +
      Sample:
      nautobot-server createsuperuser --noinput --email=admin33@example.com --username=superadmin
      @@ -350,7 +367,7 @@ Common return values are documented :ref:`here `, the foll
      Raw output from the command execution.

      -
      Sample:
      +
      Sample:
      superadmin user already exists.
      @@ -367,7 +384,7 @@ Common return values are documented :ref:`here `, the foll
      The path to the root of the Nautobot application where nautobot-server lives.

      -
      Sample:
      +
      Sample:
      /opt/nautobot
      diff --git a/docs/plugins/platform_module.rst b/docs/plugins/platform_module.rst index 6c6d2b2f..fd15f24e 100755 --- a/docs/plugins/platform_module.rst +++ b/docs/plugins/platform_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.platform_module: @@ -20,9 +30,13 @@ networktocode.nautobot.platform -- Create or delete platforms within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.platform`. @@ -267,6 +281,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -351,7 +368,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -366,7 +383,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_feed_module.rst b/docs/plugins/power_feed_module.rst index 7f75df9a..7e8c853d 100755 --- a/docs/plugins/power_feed_module.rst +++ b/docs/plugins/power_feed_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_feed_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_feed -- Create, update or delete power feeds within .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_feed`. @@ -405,6 +419,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -497,7 +514,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -512,7 +529,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_outlet_module.rst b/docs/plugins/power_outlet_module.rst index 7f02e4c7..57980af2 100755 --- a/docs/plugins/power_outlet_module.rst +++ b/docs/plugins/power_outlet_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_outlet_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_outlet -- Create, update or delete power outlets wi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_outlet`. @@ -345,6 +359,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -432,7 +449,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -447,7 +464,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_outlet_template_module.rst b/docs/plugins/power_outlet_template_module.rst index f7f3804a..0070ee94 100755 --- a/docs/plugins/power_outlet_template_module.rst +++ b/docs/plugins/power_outlet_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_outlet_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_outlet_template -- Create, update or delete power o .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_outlet_template`. @@ -309,6 +323,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -395,7 +412,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -410,7 +427,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_panel_module.rst b/docs/plugins/power_panel_module.rst index e91d8a37..bd54b046 100755 --- a/docs/plugins/power_panel_module.rst +++ b/docs/plugins/power_panel_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_panel_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_panel -- Create, update or delete power panels with .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_panel`. @@ -212,6 +226,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -296,7 +313,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -311,7 +328,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_port_module.rst b/docs/plugins/power_port_module.rst index 0aa7b276..d6341350 100755 --- a/docs/plugins/power_port_module.rst +++ b/docs/plugins/power_port_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_port_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_port -- Create, update or delete power ports within .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_port`. @@ -340,6 +354,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -427,7 +444,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -442,7 +459,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/power_port_template_module.rst b/docs/plugins/power_port_template_module.rst index 7327f3b7..5863ca6f 100755 --- a/docs/plugins/power_port_template_module.rst +++ b/docs/plugins/power_port_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.power_port_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.power_port_template -- Create, update or delete power por .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.power_port_template`. @@ -304,6 +318,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -390,7 +407,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -405,7 +422,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/prefix_module.rst b/docs/plugins/prefix_module.rst index 5f04f360..f2fa5cc3 100755 --- a/docs/plugins/prefix_module.rst +++ b/docs/plugins/prefix_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.prefix_module: @@ -20,9 +30,13 @@ networktocode.nautobot.prefix -- Creates or removes prefixes from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.prefix`. @@ -438,6 +452,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -570,7 +587,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -585,7 +602,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/provider_module.rst b/docs/plugins/provider_module.rst index cf6e80f8..6a356098 100755 --- a/docs/plugins/provider_module.rst +++ b/docs/plugins/provider_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.provider_module: @@ -20,9 +30,13 @@ networktocode.nautobot.provider -- Create, update or delete providers within Nau .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.provider`. @@ -320,6 +334,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -406,7 +423,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -421,7 +438,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index 9418a5d6..dd746d19 100755 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.query_graphql_module: @@ -20,9 +30,13 @@ networktocode.nautobot.query_graphql -- Queries and returns elements from Nautob .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.query_graphql`. @@ -173,6 +187,9 @@ Parameters
      +.. Attributes + + .. Notes @@ -267,7 +284,7 @@ Common return values are documented :ref:`here `, the foll
      Data result from the GraphQL endpoint

      - + @@ -282,7 +299,7 @@ Common return values are documented :ref:`here `, the foll
      Variables passed in

      - + @@ -297,7 +314,7 @@ Common return values are documented :ref:`here `, the foll
      Query string that was sent to Nautobot

      - + @@ -312,7 +329,7 @@ Common return values are documented :ref:`here `, the foll
      Nautobot URL that was supplied for troubleshooting

      - +

      diff --git a/docs/plugins/rack_group_module.rst b/docs/plugins/rack_group_module.rst index c7895f1a..fa3a30a3 100755 --- a/docs/plugins/rack_group_module.rst +++ b/docs/plugins/rack_group_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rack_group_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rack_group -- Create, update or delete racks groups withi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rack_group`. @@ -267,6 +281,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -342,7 +359,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -357,7 +374,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/rack_module.rst b/docs/plugins/rack_module.rst index d1609aa8..448afbc1 100755 --- a/docs/plugins/rack_module.rst +++ b/docs/plugins/rack_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rack_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rack -- Create, update or delete racks within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rack`. @@ -522,6 +536,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -597,7 +614,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -612,7 +629,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/rack_role_module.rst b/docs/plugins/rack_role_module.rst index 47c2888d..530ad1d4 100755 --- a/docs/plugins/rack_role_module.rst +++ b/docs/plugins/rack_role_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rack_role_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rack_role -- Create, update or delete racks roles within .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rack_role`. @@ -213,6 +227,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -287,7 +304,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -302,7 +319,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/rear_port_module.rst b/docs/plugins/rear_port_module.rst index 6ce082a5..cc933e65 100755 --- a/docs/plugins/rear_port_module.rst +++ b/docs/plugins/rear_port_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rear_port_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rear_port -- Create, update or delete rear ports within N .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rear_port`. @@ -285,6 +299,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -373,7 +390,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -388,7 +405,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/rear_port_template_module.rst b/docs/plugins/rear_port_template_module.rst index 6bf7bc27..2748e5f0 100755 --- a/docs/plugins/rear_port_template_module.rst +++ b/docs/plugins/rear_port_template_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rear_port_template_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rear_port_template -- Create, update or delete rear port .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rear_port_template`. @@ -256,6 +270,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -343,7 +360,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -358,7 +375,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/region_module.rst b/docs/plugins/region_module.rst index 8e16cd14..ce7b04db 100755 --- a/docs/plugins/region_module.rst +++ b/docs/plugins/region_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.region_module: @@ -20,9 +30,13 @@ networktocode.nautobot.region -- Creates or removes regions from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.region`. @@ -214,6 +228,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -286,7 +303,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -301,7 +318,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/rir_module.rst b/docs/plugins/rir_module.rst index 45622f24..cca8e87e 100755 --- a/docs/plugins/rir_module.rst +++ b/docs/plugins/rir_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.rir_module: @@ -20,9 +30,13 @@ networktocode.nautobot.rir -- Create, update or delete RIRs within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.rir`. @@ -217,6 +231,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -298,7 +315,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -313,7 +330,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/route_target_module.rst b/docs/plugins/route_target_module.rst index 1f595ef7..527b44c7 100755 --- a/docs/plugins/route_target_module.rst +++ b/docs/plugins/route_target_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.route_target_module: @@ -20,9 +30,13 @@ networktocode.nautobot.route_target -- Creates or removes route targets from Nau .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.route_target`. @@ -246,6 +260,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -339,7 +356,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -354,7 +371,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created/existent/updated/deleted within Nautobot

      - +

      diff --git a/docs/plugins/service_module.rst b/docs/plugins/service_module.rst index 28c0c483..449d7c57 100755 --- a/docs/plugins/service_module.rst +++ b/docs/plugins/service_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.service_module: @@ -20,9 +30,13 @@ networktocode.nautobot.service -- Creates or removes service from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.service`. @@ -320,6 +334,9 @@ Parameters
      +.. Attributes + + .. Notes Notes diff --git a/docs/plugins/site_module.rst b/docs/plugins/site_module.rst index ed14b03b..e706be8f 100755 --- a/docs/plugins/site_module.rst +++ b/docs/plugins/site_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.site_module: @@ -20,9 +30,13 @@ networktocode.nautobot.site -- Creates or removes sites from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.site`. @@ -499,6 +513,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -595,7 +612,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -610,7 +627,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/status_module.rst b/docs/plugins/status_module.rst index 2a0004d2..37c29aa5 100755 --- a/docs/plugins/status_module.rst +++ b/docs/plugins/status_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.status_module: @@ -20,9 +30,13 @@ networktocode.nautobot.status -- Creates or removes status from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.status`. @@ -251,6 +265,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -334,7 +351,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -349,7 +366,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created/existent/updated/deleted within Nautobot

      - +

      diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst index 709417f2..6c482299 100755 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.tag_module: @@ -20,9 +30,13 @@ networktocode.nautobot.tag -- Creates or removes tags from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.tag`. @@ -232,6 +246,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -310,7 +327,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -325,7 +342,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created/existent/updated/deleted within Nautobot

      - +

      diff --git a/docs/plugins/tenant_group_module.rst b/docs/plugins/tenant_group_module.rst index 3c06a414..1c3a2cc7 100755 --- a/docs/plugins/tenant_group_module.rst +++ b/docs/plugins/tenant_group_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.tenant_group_module: @@ -20,9 +30,13 @@ networktocode.nautobot.tenant_group -- Creates or removes tenant groups from Nau .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.tenant_group`. @@ -231,6 +245,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -314,7 +331,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -329,7 +346,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/tenant_module.rst b/docs/plugins/tenant_module.rst index be690ecc..0d399f4b 100755 --- a/docs/plugins/tenant_module.rst +++ b/docs/plugins/tenant_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.tenant_module: @@ -20,9 +30,13 @@ networktocode.nautobot.tenant -- Creates or removes tenants from Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.tenant`. @@ -285,6 +299,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -372,7 +389,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -387,7 +404,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/virtual_chassis_module.rst b/docs/plugins/virtual_chassis_module.rst index 625e0192..a3585136 100755 --- a/docs/plugins/virtual_chassis_module.rst +++ b/docs/plugins/virtual_chassis_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.virtual_chassis_module: @@ -20,9 +30,13 @@ networktocode.nautobot.virtual_chassis -- Create, update or delete virtual chass .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.virtual_chassis`. @@ -230,6 +244,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -312,7 +329,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -327,7 +344,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/virtual_machine_module.rst b/docs/plugins/virtual_machine_module.rst index defbade0..f814162d 100755 --- a/docs/plugins/virtual_machine_module.rst +++ b/docs/plugins/virtual_machine_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.virtual_machine_module: @@ -20,9 +30,13 @@ networktocode.nautobot.virtual_machine -- Create, update or delete virtual_machi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.virtual_machine`. @@ -444,6 +458,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -541,7 +558,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -556,7 +573,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/vlan_group_module.rst b/docs/plugins/vlan_group_module.rst index fea1b1c7..c26b83a2 100755 --- a/docs/plugins/vlan_group_module.rst +++ b/docs/plugins/vlan_group_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.vlan_group_module: @@ -20,9 +30,13 @@ networktocode.nautobot.vlan_group -- Create, update or delete vlans groups withi .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.vlan_group`. @@ -231,6 +245,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -305,7 +322,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -320,7 +337,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst index 696e54dc..5612e31e 100755 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.vlan_module: @@ -20,9 +30,13 @@ networktocode.nautobot.vlan -- Create, update or delete vlans within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.vlan`. @@ -339,6 +353,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -432,7 +449,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -447,7 +464,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/docs/plugins/vm_interface_module.rst b/docs/plugins/vm_interface_module.rst index 6046d9a8..1c920a6a 100755 --- a/docs/plugins/vm_interface_module.rst +++ b/docs/plugins/vm_interface_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.vm_interface_module: @@ -20,9 +30,13 @@ networktocode.nautobot.vm_interface -- Creates or removes interfaces from virtua .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.vm_interface`. @@ -343,6 +357,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -436,7 +453,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - + @@ -451,7 +468,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - +

      diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst index 0df61cd5..4d5d9631 100755 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_module.rst @@ -2,6 +2,16 @@ :orphan: +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + .. Anchors .. _ansible_collections.networktocode.nautobot.vrf_module: @@ -20,9 +30,13 @@ networktocode.nautobot.vrf -- Create, update or delete vrfs within Nautobot .. Collection note .. note:: - This plugin is part of the `networktocode.nautobot collection `_ (version 3.2.1). + This plugin is part of the `networktocode.nautobot collection `_ (version 3.3.0). + + You might already have this collection installed if you are using the ``ansible`` package. + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. - To install it use: :code:`ansible-galaxy collection install networktocode.nautobot`. + To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. To use it in a playbook, specify: :code:`networktocode.nautobot.vrf`. @@ -324,6 +338,9 @@ Parameters
      +.. Attributes + + .. Notes Notes @@ -414,7 +431,7 @@ Common return values are documented :ref:`here `, the foll
      Message indicating failure or info about what has been achieved

      - + @@ -429,7 +446,7 @@ Common return values are documented :ref:`here `, the foll
      Serialized object as created or already existent within Nautobot

      - +

      diff --git a/galaxy.yml b/galaxy.yml index bc7ec40f..91d93d8f 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ namespace: networktocode name: nautobot # The version of the collection. Must be compatible with semantic versioning -version: 3.2.1 +version: 3.3.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index 89dedac4..c8df3b02 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nautobot_ansible_modules" -version = "3.2.1" +version = "3.3.0" description = "Ansible collection to interact with Nautobot's API" authors = ["Network to Code