From 7070662ef921f2d5a0a63ba269a366c2f9624c55 Mon Sep 17 00:00:00 2001 From: Garrett Date: Fri, 26 Apr 2024 16:27:13 +0000 Subject: [PATCH 1/3] updates for issue 138 -rev1 --- plugins/action/query_graphql.py | 8 ++- plugins/doc_fragments/fragments.py | 3 ++ plugins/lookup/lookup.py | 10 +++- plugins/lookup/lookup_graphql.py | 10 +++- plugins/module_utils/utils.py | 32 ++++++++++- tests/unit/conftest.py | 2 +- .../module_utils/test_nautobot_base_class.py | 38 ++++++++++++- tests/unit/module_utils/test_utils.py | 53 +++++++++++++++++++ 8 files changed, 149 insertions(+), 7 deletions(-) create mode 100644 tests/unit/module_utils/test_utils.py diff --git a/plugins/action/query_graphql.py b/plugins/action/query_graphql.py index 1908135f..2e5dc944 100644 --- a/plugins/action/query_graphql.py +++ b/plugins/action/query_graphql.py @@ -28,6 +28,7 @@ from ansible_collections.networktocode.nautobot.plugins.module_utils.utils import ( NautobotApiBase, NautobotGraphQL, + is_truthy, ) from ansible.utils.display import Display @@ -46,7 +47,12 @@ def nautobot_action_graphql(args): token = args.get("token") or os.getenv("NAUTOBOT_TOKEN") api_version = args.get("api_version") - ssl_verify = args.get("validate_certs", True) + if args.get("validate_certs") is not None: + ssl_verify = args.get("validate_certs") + elif os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None: + ssl_verify = is_truthy(os.getenv("NAUTOBOT_VALIDATE_CERTS")) + else: + ssl_verify = True Display().vv("Verify Certificates: %s" % ssl_verify) # Verify SSL Verify is of boolean diff --git a/plugins/doc_fragments/fragments.py b/plugins/doc_fragments/fragments.py index db80ed28..9421865c 100644 --- a/plugins/doc_fragments/fragments.py +++ b/plugins/doc_fragments/fragments.py @@ -15,11 +15,13 @@ class ModuleDocFragment(object): url: description: - "The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)" + - "Can be omitted if the E(NAUTOBOT_URL) environment variable is configured." required: true type: str token: description: - "The token created within Nautobot to authorize API access" + - "Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured." required: true type: str state: @@ -40,6 +42,7 @@ class ModuleDocFragment(object): validate_certs: description: - "If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates." + - "Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured." required: false default: true type: raw diff --git a/plugins/lookup/lookup.py b/plugins/lookup/lookup.py index f21fd95d..75d03b5c 100644 --- a/plugins/lookup/lookup.py +++ b/plugins/lookup/lookup.py @@ -136,6 +136,9 @@ from ansible.parsing.splitter import parse_kv, split_args from ansible.utils.display import Display from ansible.module_utils.six import raise_from +from ansible_collections.networktocode.nautobot.plugins.module_utils.utils import ( + is_truthy, +) try: import pynautobot @@ -312,7 +315,12 @@ def run(self, terms, variables=None, **kwargs): api_token = kwargs.get("token") or os.getenv("NAUTOBOT_TOKEN") api_endpoint = kwargs.get("api_endpoint") or os.getenv("NAUTOBOT_URL") - ssl_verify = kwargs.get("validate_certs", True) + if kwargs.get("validate_certs") is not None: + ssl_verify = kwargs.get("validate_certs") + elif os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None: + ssl_verify = is_truthy(os.getenv("NAUTOBOT_VALIDATE_CERTS")) + else: + ssl_verify = True api_filter = kwargs.get("api_filter") raw_return = kwargs.get("raw_data") plugin = kwargs.get("plugin") diff --git a/plugins/lookup/lookup_graphql.py b/plugins/lookup/lookup_graphql.py index 6e785562..8d4deaf2 100644 --- a/plugins/lookup/lookup_graphql.py +++ b/plugins/lookup/lookup_graphql.py @@ -121,6 +121,7 @@ from ansible_collections.networktocode.nautobot.plugins.module_utils.utils import ( NautobotApiBase, NautobotGraphQL, + is_truthy, ) except ModuleNotFoundError: # For testing @@ -151,7 +152,14 @@ def nautobot_lookup_graphql(**kwargs): raise AnsibleLookupError("Missing URL of Nautobot") token = kwargs.get("token") or os.getenv("NAUTOBOT_TOKEN") - ssl_verify = kwargs.get("validate_certs", True) + + if kwargs.get("validate_certs") is not None: + ssl_verify = kwargs.get("validate_certs") + elif os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None: + ssl_verify = is_truthy(os.getenv("NAUTOBOT_VALIDATE_CERTS")) + else: + ssl_verify = True + api_version = kwargs.get("api_version") Display().vv("Validate certs: %s" % ssl_verify) diff --git a/plugins/module_utils/utils.py b/plugins/module_utils/utils.py index 0f7a0969..a2eb761d 100644 --- a/plugins/module_utils/utils.py +++ b/plugins/module_utils/utils.py @@ -420,6 +420,31 @@ ) +def is_truthy(arg): + """ + Convert "truthy" strings into Booleans. + + Examples: + >>> is_truthy('yes') + True + + Args: + arg (str): Truthy string (True values are y, yes, t, true, on and 1; false values are n, no, + f, false, off and 0. Raises ValueError if val is anything else. + """ + + if isinstance(arg, bool): + return arg + + val = str(arg).lower() + if val in ("y", "yes", "t", "true", "on", "1"): + return True + elif val in ("n", "no", "f", "false", "off", "0"): + return False + else: + raise ValueError(f"Invalid truthy value: `{arg}`") + + class NautobotModule: """ Initialize connection to Nautobot, sets AnsibleModule passed in to @@ -990,7 +1015,12 @@ class NautobotApiBase: def __init__(self, **kwargs): self.url = kwargs.get("url") or os.getenv("NAUTOBOT_URL") self.token = kwargs.get("token") or os.getenv("NAUTOBOT_TOKEN") - self.ssl_verify = kwargs.get("ssl_verify", True) + if kwargs.get("ssl_verify") is not None: + self.ssl_verify = kwargs.get("ssl_verify") + elif os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None: + self.ssl_verify = is_truthy(os.getenv("NAUTOBOT_VALIDATE_CERTS")) + else: + self.ssl_verify = True self.api_version = kwargs.get("api_version") # Setup the API client calls diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py index 2f8ce4f6..5ed949a3 100644 --- a/tests/unit/conftest.py +++ b/tests/unit/conftest.py @@ -19,7 +19,7 @@ def patch_pynautobot_version_check(monkeypatch): @pytest.fixture def nautobot_api_base(): - return NautobotApiBase(url="https://nautobot.mock.com", token="abc123", valdiate_certs=False) + return NautobotApiBase(url="https://nautobot.mock.com", token="abc123", validate_certs=False) @pytest.fixture diff --git a/tests/unit/module_utils/test_nautobot_base_class.py b/tests/unit/module_utils/test_nautobot_base_class.py index 47bca429..e71b110c 100644 --- a/tests/unit/module_utils/test_nautobot_base_class.py +++ b/tests/unit/module_utils/test_nautobot_base_class.py @@ -13,10 +13,11 @@ from functools import partial from unittest.mock import patch, MagicMock, Mock from ansible.module_utils.basic import AnsibleModule +from ansible.errors import AnsibleError import pynautobot try: - from ansible_collections.networktocode.nautobot.plugins.module_utils.utils import NautobotModule + from ansible_collections.networktocode.nautobot.plugins.module_utils.utils import NautobotModule, NautobotApiBase from ansible_collections.networktocode.nautobot.plugins.module_utils.dcim import NB_DEVICES from ansible_collections.networktocode.nautobot.tests.test_data import load_test_data @@ -29,7 +30,7 @@ sys.path.append("plugins/module_utils") sys.path.append("tests") - from utils import NautobotModule + from utils import NautobotModule, NautobotApiBase from dcim import NB_DEVICES from test_data import load_test_data @@ -332,3 +333,36 @@ def test_invalid_api_version_error_handling(mock_ansible_module, monkeypatch, ap monkeypatch.setattr(pynautobot.api, "version", api_version) module = NautobotModule(mock_ansible_module, "devices") assert isinstance(module.nb, obj_type) + + +@patch.dict(os.environ, {}) +def test_validate_certs_defaults_true(): + """Test that the default SSL verify is set as true and no environment variable is set.""" + test_class = NautobotApiBase(url="https://nautobot.example.com", token="abc123") + assert os.getenv("NAUTOBOT_VALIDATE_CERTS") is None + assert test_class.ssl_verify is True + + +@patch.dict(os.environ, {"NAUTOBOT_VALIDATE_CERTS": "FALSE"}) +def test_validate_certs_environment_var_false(): + """Test that the default SSL verify is set as false via environment variable.""" + test_class = NautobotApiBase(url="https://nautobot.example.com", token="abc123") + assert os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None + assert test_class.ssl_verify is False + + +@patch.dict(os.environ, {"NAUTOBOT_VALIDATE_CERTS": "FALSE"}) +def test_validate_certs_override(): + """Test that the default SSL verify is set as true via API class, and overrides environment variable.""" + test_class = NautobotApiBase(url="https://nautobot.example.com", token="abc123", ssl_verify=True) + assert os.getenv("NAUTOBOT_VALIDATE_CERTS") is not None + assert os.getenv("NAUTOBOT_VALIDATE_CERTS") == "FALSE" + assert test_class.ssl_verify is True + + +@patch.dict(os.environ, {"NAUTOBOT_VALIDATE_CERTS": "cheese"}) +def test_validate_certs_invalid(): + """Test that the default SSL verify is set as false via environment variable.""" + with pytest.raises(ValueError) as exc: + _ = NautobotApiBase(url="https://nautobot.example.com", token="abc123") + assert "Invalid truthy value" in str(exc.value) diff --git a/tests/unit/module_utils/test_utils.py b/tests/unit/module_utils/test_utils.py new file mode 100644 index 00000000..4e502c16 --- /dev/null +++ b/tests/unit/module_utils/test_utils.py @@ -0,0 +1,53 @@ +"""Tests for module_utils functions.""" +from typing import Any + +import pytest + +try: + from plugins.module_utils.utils import is_truthy +except ImportError: + import sys + + sys.path.append("plugins/module_utils") + sys.path.append("tests") + from utils import is_truthy + + +@pytest.mark.parametrize( + "value, expected", + [ + (True, True), + (False, False), + ("true", True), + ("false", False), + ("True", True), + ("False", False), + ("TRUE", True), + ("FALSE", False), + ("t", True), + ("f", False), + ("T", True), + ("F", False), + ("yes", True), + ("no", False), + ("Yes", True), + ("No", False), + ("YES", True), + ("NO", False), + ("y", True), + ("n", False), + ("Y", True), + ("N", False), + ("1", True), + ("0", False), + ], +) +def test_is_truthy(value: Any, expected: bool) -> None: + assert is_truthy(value) == expected + + +def test_is_truthy_raises_exception_on_invalid_type() -> None: + with pytest.raises(ValueError) as excinfo: + is_truthy("test") + + assert "Invalid truthy value" in str(excinfo.value) From d87c13efc9c18e927770c42c268dd387f9554a3a Mon Sep 17 00:00:00 2001 From: Garrett Date: Fri, 26 Apr 2024 16:35:34 +0000 Subject: [PATCH 2/3] fixing for black --- tests/unit/module_utils/test_utils.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/unit/module_utils/test_utils.py b/tests/unit/module_utils/test_utils.py index 4e502c16..c83d1bcc 100644 --- a/tests/unit/module_utils/test_utils.py +++ b/tests/unit/module_utils/test_utils.py @@ -1,4 +1,5 @@ """Tests for module_utils functions.""" + from typing import Any import pytest From 80b3d56b690d93d9577f0888029db46745f4548e Mon Sep 17 00:00:00 2001 From: Joe Wesch Date: Mon, 29 Apr 2024 19:31:07 -0500 Subject: [PATCH 3/3] Release v5.2.1 --- CHANGELOG.rst | 8 + changelogs/changelog.yaml | 5 + docs/plugins/cable_module.rst | 8 +- docs/plugins/circuit_module.rst | 8 +- docs/plugins/circuit_termination_module.rst | 8 +- docs/plugins/circuit_type_module.rst | 8 +- docs/plugins/cluster_group_module.rst | 8 +- docs/plugins/cluster_module.rst | 8 +- docs/plugins/cluster_type_module.rst | 8 +- docs/plugins/console_port_module.rst | 8 +- docs/plugins/console_port_template_module.rst | 8 +- docs/plugins/console_server_port_module.rst | 8 +- .../console_server_port_template_module.rst | 8 +- docs/plugins/custom_field_choice_module.rst | 8 +- docs/plugins/custom_field_module.rst | 8 +- docs/plugins/device_bay_module.rst | 8 +- docs/plugins/device_bay_template_module.rst | 8 +- docs/plugins/device_interface_module.rst | 8 +- .../device_interface_template_module.rst | 8 +- docs/plugins/device_module.rst | 8 +- .../device_redundancy_group_module.rst | 8 +- docs/plugins/device_type_module.rst | 8 +- docs/plugins/front_port_module.rst | 8 +- docs/plugins/front_port_template_module.rst | 8 +- docs/plugins/gql_inventory_inventory.rst | 2 +- docs/plugins/index.rst | 2 +- docs/plugins/inventory_inventory.rst | 2 +- docs/plugins/inventory_item_module.rst | 8 +- docs/plugins/ip_address_module.rst | 8 +- .../ip_address_to_interface_module.rst | 8 +- docs/plugins/location_module.rst | 8 +- docs/plugins/location_type_module.rst | 8 +- docs/plugins/lookup_graphql_lookup.rst | 2 +- docs/plugins/lookup_lookup.rst | 2 +- docs/plugins/manufacturer_module.rst | 8 +- docs/plugins/namespace_module.rst | 8 +- docs/plugins/nautobot_server_module.rst | 2 +- docs/plugins/platform_module.rst | 8 +- docs/plugins/plugin_module.rst | 8 +- docs/plugins/power_feed_module.rst | 8 +- docs/plugins/power_outlet_module.rst | 8 +- docs/plugins/power_outlet_template_module.rst | 8 +- docs/plugins/power_panel_module.rst | 8 +- docs/plugins/power_port_module.rst | 8 +- docs/plugins/power_port_template_module.rst | 8 +- docs/plugins/prefix_module.rst | 8 +- docs/plugins/provider_module.rst | 8 +- docs/plugins/query_graphql_module.rst | 2 +- docs/plugins/rack_group_module.rst | 8 +- docs/plugins/rack_module.rst | 8 +- docs/plugins/rear_port_module.rst | 8 +- docs/plugins/rear_port_template_module.rst | 8 +- .../relationship_association_module.rst | 8 +- docs/plugins/rir_module.rst | 8 +- docs/plugins/role_module.rst | 8 +- docs/plugins/route_target_module.rst | 8 +- docs/plugins/service_module.rst | 8 +- docs/plugins/status_module.rst | 8 +- docs/plugins/tag_module.rst | 8 +- docs/plugins/tenant_group_module.rst | 8 +- docs/plugins/tenant_module.rst | 8 +- docs/plugins/virtual_chassis_module.rst | 8 +- docs/plugins/virtual_machine_module.rst | 8 +- docs/plugins/vlan_group_module.rst | 8 +- docs/plugins/vlan_module.rst | 8 +- docs/plugins/vm_interface_module.rst | 8 +- docs/plugins/vrf_module.rst | 8 +- galaxy.yml | 2 +- plugins/inventory/gql_inventory.py | 2 +- poetry.lock | 243 +++++++----------- pyproject.toml | 2 +- tests/unit/inventory/test_graphql.py | 6 + 72 files changed, 531 insertions(+), 215 deletions(-) diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7b5d20e6..8a2beed0 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,14 @@ networktocode.nautobot Release Notes .. contents:: Topics +v5.2.1 +====== + +Minor Changes +------------- +- (#345) Added `NAUTOBOT_VALIDATE_CERTS` environment variable to disable SSL verification +- (#348) Fixed GraphQL Inventory plugin bug when device platform is None + v5.2.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 31dbd225..fef7abf4 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -444,3 +444,8 @@ releases: - (#336) Added `custom_fields` to the `inventory_item` module - (#338) Added `num_retries` to the `lookup` plugin - (#340) Added `label` and `description` to the `device_interface_template` module + 5.2.1: + changes: + minor_changes: + - (#345) Added `NAUTOBOT_VALIDATE_CERTS` environment variable to disable SSL verification + - (#348) Fixed GraphQL Inventory plugin bug when device platform is None diff --git a/docs/plugins/cable_module.rst b/docs/plugins/cable_module.rst index 09da8bd1..390fc108 100755 --- a/docs/plugins/cable_module.rst +++ b/docs/plugins/cable_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cable module -- Create, update or delete cables within Na .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -618,6 +618,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -689,6 +691,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -723,6 +727,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/circuit_module.rst b/docs/plugins/circuit_module.rst index 90f581ac..dbf3e08b 100755 --- a/docs/plugins/circuit_module.rst +++ b/docs/plugins/circuit_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit module -- Create, update or delete circuits withi .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -662,6 +662,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -696,6 +698,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -730,6 +734,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/circuit_termination_module.rst b/docs/plugins/circuit_termination_module.rst index 40da9b4c..7c7ada07 100755 --- a/docs/plugins/circuit_termination_module.rst +++ b/docs/plugins/circuit_termination_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit_termination module -- Create, update or delete ci .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -520,6 +520,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -591,6 +593,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -625,6 +629,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/circuit_type_module.rst b/docs/plugins/circuit_type_module.rst index 3e5c54e2..558e5e28 100755 --- a/docs/plugins/circuit_type_module.rst +++ b/docs/plugins/circuit_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit_type module -- Create, update or delete circuit t .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/cluster_group_module.rst b/docs/plugins/cluster_group_module.rst index 3906c15a..f758759b 100755 --- a/docs/plugins/cluster_group_module.rst +++ b/docs/plugins/cluster_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster_group module -- Create, update or delete cluster .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/cluster_module.rst b/docs/plugins/cluster_module.rst index bcb846bb..c8e36ceb 100755 --- a/docs/plugins/cluster_module.rst +++ b/docs/plugins/cluster_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster module -- Create, update or delete clusters withi .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -549,6 +549,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -583,6 +585,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -617,6 +621,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/cluster_type_module.rst b/docs/plugins/cluster_type_module.rst index d3550e28..17b728c1 100755 --- a/docs/plugins/cluster_type_module.rst +++ b/docs/plugins/cluster_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster_type module -- Create, update or delete cluster t .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/console_port_module.rst b/docs/plugins/console_port_module.rst index da86ddd0..ba134563 100755 --- a/docs/plugins/console_port_module.rst +++ b/docs/plugins/console_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_port module -- Create, update or delete console p .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/console_port_template_module.rst b/docs/plugins/console_port_template_module.rst index cad5dc86..d8a9ca35 100755 --- a/docs/plugins/console_port_template_module.rst +++ b/docs/plugins/console_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_port_template module -- Create, update or delete .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -398,6 +400,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -432,6 +436,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/console_server_port_module.rst b/docs/plugins/console_server_port_module.rst index 126fc215..69acf0a8 100755 --- a/docs/plugins/console_server_port_module.rst +++ b/docs/plugins/console_server_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port module -- Create, update or delete co .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/console_server_port_template_module.rst b/docs/plugins/console_server_port_template_module.rst index 0c3f6987..24fea239 100755 --- a/docs/plugins/console_server_port_template_module.rst +++ b/docs/plugins/console_server_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port_template module -- Create, update or .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -398,6 +400,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -432,6 +436,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/custom_field_choice_module.rst b/docs/plugins/custom_field_choice_module.rst index d6243570..0e82dbf6 100755 --- a/docs/plugins/custom_field_choice_module.rst +++ b/docs/plugins/custom_field_choice_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.custom_field_choice module -- Creates or removes custom f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -290,6 +290,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -324,6 +326,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -358,6 +362,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/custom_field_module.rst b/docs/plugins/custom_field_module.rst index d80ac689..1c662132 100755 --- a/docs/plugins/custom_field_module.rst +++ b/docs/plugins/custom_field_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.custom_field module -- Creates or removes custom fields f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -623,6 +623,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -713,6 +715,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -747,6 +751,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_bay_module.rst b/docs/plugins/device_bay_module.rst index 81e7650f..95b09aae 100755 --- a/docs/plugins/device_bay_module.rst +++ b/docs/plugins/device_bay_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_bay module -- Create, update or delete device bays .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -438,6 +438,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_bay_template_module.rst b/docs/plugins/device_bay_template_module.rst index e27c8bf3..12e8552b 100755 --- a/docs/plugins/device_bay_template_module.rst +++ b/docs/plugins/device_bay_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_bay_template module -- Create, update or delete de .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_interface_module.rst b/docs/plugins/device_interface_module.rst index d3da7e64..4422ba77 100755 --- a/docs/plugins/device_interface_module.rst +++ b/docs/plugins/device_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_interface module -- Creates or removes interfaces .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -863,6 +863,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -1021,6 +1023,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -1055,6 +1059,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_interface_template_module.rst b/docs/plugins/device_interface_template_module.rst index 8057b617..55b3aa67 100755 --- a/docs/plugins/device_interface_template_module.rst +++ b/docs/plugins/device_interface_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_interface_template module -- Creates or removes in .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -446,6 +446,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -520,6 +522,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -554,6 +558,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst index 10f99d4e..e918b7ff 100755 --- a/docs/plugins/device_module.rst +++ b/docs/plugins/device_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device module -- Create, update or delete devices within .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -1042,6 +1042,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -1076,6 +1078,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -1110,6 +1114,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_redundancy_group_module.rst b/docs/plugins/device_redundancy_group_module.rst index 5e06e1f6..3e05dfcd 100755 --- a/docs/plugins/device_redundancy_group_module.rst +++ b/docs/plugins/device_redundancy_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_redundancy_group module -- Creates or removes devi .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -522,6 +522,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -556,6 +558,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -590,6 +594,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst index 2dac413a..ebe0c74f 100755 --- a/docs/plugins/device_type_module.rst +++ b/docs/plugins/device_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_type module -- Create, update or delete device typ .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -567,6 +567,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -638,6 +640,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -672,6 +676,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/front_port_module.rst b/docs/plugins/front_port_module.rst index 7750277f..88e2e12c 100755 --- a/docs/plugins/front_port_module.rst +++ b/docs/plugins/front_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.front_port module -- Create, update or delete front ports .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -475,6 +475,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -546,6 +548,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -580,6 +584,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/front_port_template_module.rst b/docs/plugins/front_port_template_module.rst index 7bcaf0ed..ad1f4633 100755 --- a/docs/plugins/front_port_template_module.rst +++ b/docs/plugins/front_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.front_port_template module -- Create, update or delete fr .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/gql_inventory_inventory.rst b/docs/plugins/gql_inventory_inventory.rst index c0382946..799d3365 100755 --- a/docs/plugins/gql_inventory_inventory.rst +++ b/docs/plugins/gql_inventory_inventory.rst @@ -42,7 +42,7 @@ networktocode.nautobot.gql_inventory inventory -- Nautobot inventory source usin .. Collection note .. note:: - This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this inventory plugin, diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index b1c905fa..b6d5ff9a 100755 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -6,7 +6,7 @@ Networktocode.Nautobot ====================== -Collection version 5.2.0 +Collection version 5.2.1 .. contents:: :local: diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index b7650602..44c7a85b 100755 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -42,7 +42,7 @@ networktocode.nautobot.inventory inventory -- Nautobot inventory source .. Collection note .. note:: - This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. diff --git a/docs/plugins/inventory_item_module.rst b/docs/plugins/inventory_item_module.rst index 48bb7f1e..c2da3376 100755 --- a/docs/plugins/inventory_item_module.rst +++ b/docs/plugins/inventory_item_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.inventory_item module -- Creates or removes inventory ite .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -631,6 +631,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -665,6 +667,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -699,6 +703,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/ip_address_module.rst b/docs/plugins/ip_address_module.rst index 86984638..7a4ceb08 100755 --- a/docs/plugins/ip_address_module.rst +++ b/docs/plugins/ip_address_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.ip_address module -- Creates or removes IP addresses from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -676,6 +676,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -756,6 +758,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -790,6 +794,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/ip_address_to_interface_module.rst b/docs/plugins/ip_address_to_interface_module.rst index b6895226..fee3e35d 100755 --- a/docs/plugins/ip_address_to_interface_module.rst +++ b/docs/plugins/ip_address_to_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.ip_address_to_interface module -- Creates or removes IP a .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/location_module.rst b/docs/plugins/location_module.rst index 01c01a1e..8044fdb9 100755 --- a/docs/plugins/location_module.rst +++ b/docs/plugins/location_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.location module -- Creates or removes locations from Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -989,6 +989,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -1023,6 +1025,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -1057,6 +1061,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/location_type_module.rst b/docs/plugins/location_type_module.rst index 76d95b9f..932c3ab1 100755 --- a/docs/plugins/location_type_module.rst +++ b/docs/plugins/location_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.location_type module -- Creates or removes location types .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -478,6 +478,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -512,6 +514,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -546,6 +550,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/lookup_graphql_lookup.rst b/docs/plugins/lookup_graphql_lookup.rst index 498d9fd8..2d3b96a6 100755 --- a/docs/plugins/lookup_graphql_lookup.rst +++ b/docs/plugins/lookup_graphql_lookup.rst @@ -42,7 +42,7 @@ networktocode.nautobot.lookup_graphql lookup -- Queries and returns elements fro .. Collection note .. note:: - This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this lookup plugin, diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 5f00bdc7..85c1050a 100755 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -42,7 +42,7 @@ networktocode.nautobot.lookup lookup -- Queries and returns elements from Nautob .. Collection note .. note:: - This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this lookup plugin, diff --git a/docs/plugins/manufacturer_module.rst b/docs/plugins/manufacturer_module.rst index 65e99a9d..48f352ca 100755 --- a/docs/plugins/manufacturer_module.rst +++ b/docs/plugins/manufacturer_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.manufacturer module -- Create or delete manufacturers wit .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -327,6 +327,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -361,6 +363,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -395,6 +399,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/namespace_module.rst b/docs/plugins/namespace_module.rst index d0ffb7f2..518c25fa 100755 --- a/docs/plugins/namespace_module.rst +++ b/docs/plugins/namespace_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.namespace module -- Creates or removes namespaces from Na .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -438,6 +438,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/nautobot_server_module.rst b/docs/plugins/nautobot_server_module.rst index f5dd742c..382bc4a0 100755 --- a/docs/plugins/nautobot_server_module.rst +++ b/docs/plugins/nautobot_server_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.nautobot_server module -- Manages Nautobot Server applica .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/platform_module.rst b/docs/plugins/platform_module.rst index de0c696f..6d626ddf 100755 --- a/docs/plugins/platform_module.rst +++ b/docs/plugins/platform_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.platform module -- Create or delete platforms within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -438,6 +438,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/plugin_module.rst b/docs/plugins/plugin_module.rst index efb80381..f7b565a8 100755 --- a/docs/plugins/plugin_module.rst +++ b/docs/plugins/plugin_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.plugin module -- CRUD operation on plugin objects .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -407,6 +407,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -441,6 +443,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -475,6 +479,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_feed_module.rst b/docs/plugins/power_feed_module.rst index 2aca4542..89b35fa4 100755 --- a/docs/plugins/power_feed_module.rst +++ b/docs/plugins/power_feed_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_feed module -- Create, update or delete power feeds .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -678,6 +678,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -757,6 +759,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -791,6 +795,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_outlet_module.rst b/docs/plugins/power_outlet_module.rst index 8568d1dd..c9e569f9 100755 --- a/docs/plugins/power_outlet_module.rst +++ b/docs/plugins/power_outlet_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_outlet module -- Create, update or delete power out .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -484,6 +484,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -555,6 +557,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -589,6 +593,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_outlet_template_module.rst b/docs/plugins/power_outlet_template_module.rst index cc2229a9..59cbaaf6 100755 --- a/docs/plugins/power_outlet_template_module.rst +++ b/docs/plugins/power_outlet_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_outlet_template module -- Create, update or delete .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -410,6 +410,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -481,6 +483,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -515,6 +519,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_panel_module.rst b/docs/plugins/power_panel_module.rst index 9f5199b1..3f0a5ba9 100755 --- a/docs/plugins/power_panel_module.rst +++ b/docs/plugins/power_panel_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_panel module -- Create, update or delete power pane .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -364,6 +364,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -398,6 +400,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -432,6 +436,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_port_module.rst b/docs/plugins/power_port_module.rst index 6d981108..7a4fe526 100755 --- a/docs/plugins/power_port_module.rst +++ b/docs/plugins/power_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_port module -- Create, update or delete power ports .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -475,6 +475,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -546,6 +548,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -580,6 +584,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/power_port_template_module.rst b/docs/plugins/power_port_template_module.rst index 0b283979..6e8fa504 100755 --- a/docs/plugins/power_port_template_module.rst +++ b/docs/plugins/power_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_port_template module -- Create, update or delete po .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/prefix_module.rst b/docs/plugins/prefix_module.rst index 61aa9fbb..4faab93f 100755 --- a/docs/plugins/prefix_module.rst +++ b/docs/plugins/prefix_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.prefix module -- Creates or removes prefixes from Nautobo .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -751,6 +751,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -831,6 +833,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -865,6 +869,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/provider_module.rst b/docs/plugins/provider_module.rst index 3474cda4..c3c64747 100755 --- a/docs/plugins/provider_module.rst +++ b/docs/plugins/provider_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.provider module -- Create, update or delete providers wit .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -586,6 +586,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -620,6 +622,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -654,6 +658,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index a3f14f3c..ea443373 100755 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.query_graphql module -- Queries and returns elements from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rack_group_module.rst b/docs/plugins/rack_group_module.rst index a2a1dd66..b12e29ad 100755 --- a/docs/plugins/rack_group_module.rst +++ b/docs/plugins/rack_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rack_group module -- Create, update or delete racks group .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -407,6 +407,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -441,6 +443,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -475,6 +479,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/rack_module.rst b/docs/plugins/rack_module.rst index 2fc8fa0a..2848421a 100755 --- a/docs/plugins/rack_module.rst +++ b/docs/plugins/rack_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rack module -- Create, update or delete racks within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -863,6 +863,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -971,6 +973,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -1005,6 +1009,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/rear_port_module.rst b/docs/plugins/rear_port_module.rst index f979d3a4..dc1244a9 100755 --- a/docs/plugins/rear_port_module.rst +++ b/docs/plugins/rear_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rear_port module -- Create, update or delete rear ports w .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -438,6 +438,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -509,6 +511,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -543,6 +547,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/rear_port_template_module.rst b/docs/plugins/rear_port_template_module.rst index a05066e4..baf0373b 100755 --- a/docs/plugins/rear_port_template_module.rst +++ b/docs/plugins/rear_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rear_port_template module -- Create, update or delete rea .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -364,6 +364,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -435,6 +437,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -469,6 +473,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/relationship_association_module.rst b/docs/plugins/relationship_association_module.rst index fef922c5..c494270a 100755 --- a/docs/plugins/relationship_association_module.rst +++ b/docs/plugins/relationship_association_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.relationship_association module -- Creates or removes a r .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -423,6 +423,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -457,6 +459,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -491,6 +495,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/rir_module.rst b/docs/plugins/rir_module.rst index 9cb79a87..c07d9797 100755 --- a/docs/plugins/rir_module.rst +++ b/docs/plugins/rir_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rir module -- Create, update or delete RIRs within Nautob .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -335,6 +335,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -369,6 +371,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -403,6 +407,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/role_module.rst b/docs/plugins/role_module.rst index 003c4d38..9760637b 100755 --- a/docs/plugins/role_module.rst +++ b/docs/plugins/role_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.role module -- Create, update or delete roles within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -438,6 +438,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -472,6 +474,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -506,6 +510,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/route_target_module.rst b/docs/plugins/route_target_module.rst index b3275513..2267fb30 100755 --- a/docs/plugins/route_target_module.rst +++ b/docs/plugins/route_target_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.route_target module -- Creates or removes route targets f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -435,6 +435,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -469,6 +471,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -503,6 +507,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/service_module.rst b/docs/plugins/service_module.rst index 44dfa1a4..1a1644f8 100755 --- a/docs/plugins/service_module.rst +++ b/docs/plugins/service_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.service module -- Creates or removes service from Nautobo .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -549,6 +549,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -583,6 +585,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -617,6 +621,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/status_module.rst b/docs/plugins/status_module.rst index 8833e935..1022fa0f 100755 --- a/docs/plugins/status_module.rst +++ b/docs/plugins/status_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.status module -- Creates or removes status from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -403,6 +403,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -437,6 +439,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -471,6 +475,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst index 99a5bd38..4cb9d6cc 100755 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tag module -- Creates or removes tags from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -439,6 +439,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -473,6 +475,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -507,6 +511,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/tenant_group_module.rst b/docs/plugins/tenant_group_module.rst index 15f4c318..c2f0d1e8 100755 --- a/docs/plugins/tenant_group_module.rst +++ b/docs/plugins/tenant_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tenant_group module -- Creates or removes tenant groups f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -370,6 +370,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -404,6 +406,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -438,6 +442,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/tenant_module.rst b/docs/plugins/tenant_module.rst index ca600abb..9d7eaef5 100755 --- a/docs/plugins/tenant_module.rst +++ b/docs/plugins/tenant_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tenant module -- Creates or removes tenants from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -475,6 +475,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -509,6 +511,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -543,6 +547,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/virtual_chassis_module.rst b/docs/plugins/virtual_chassis_module.rst index 99c76e2b..63a4040c 100755 --- a/docs/plugins/virtual_chassis_module.rst +++ b/docs/plugins/virtual_chassis_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.virtual_chassis module -- Create, update or delete virtua .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -435,6 +437,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -469,6 +473,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/virtual_machine_module.rst b/docs/plugins/virtual_machine_module.rst index e5185d2d..c5e31db4 100755 --- a/docs/plugins/virtual_machine_module.rst +++ b/docs/plugins/virtual_machine_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.virtual_machine module -- Create, update or delete virtua .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -773,6 +773,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -807,6 +809,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -841,6 +845,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/vlan_group_module.rst b/docs/plugins/vlan_group_module.rst index d0af266e..b26bf152 100755 --- a/docs/plugins/vlan_group_module.rst +++ b/docs/plugins/vlan_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vlan_group module -- Create, update or delete vlans group .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -401,6 +401,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -435,6 +437,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -469,6 +473,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst index c8667d1a..dac00923 100755 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vlan module -- Create, update or delete vlans within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -551,6 +551,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -585,6 +587,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -619,6 +623,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/vm_interface_module.rst b/docs/plugins/vm_interface_module.rst index d5e68ead..85b9d12b 100755 --- a/docs/plugins/vm_interface_module.rst +++ b/docs/plugins/vm_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vm_interface module -- Creates or removes interfaces from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -633,6 +633,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -704,6 +706,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -738,6 +742,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst index d339c975..b198fda1 100755 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vrf module -- Create, update or delete vrfs within Nautob .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 5.2.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.2.1). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -590,6 +590,8 @@ Parameters The token created within Nautobot to authorize API access + Can be omitted if the \ :envvar:`NAUTOBOT\_TOKEN`\ environment variable is configured. + .. raw:: html @@ -624,6 +626,8 @@ Parameters The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) + Can be omitted if the \ :envvar:`NAUTOBOT\_URL`\ environment variable is configured. + .. raw:: html @@ -658,6 +662,8 @@ Parameters If \ :literal:`no`\ , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. + Can be omitted if the \ :envvar:`NAUTOBOT\_VALIDATE\_CERTS`\ environment variable is configured. + .. rst-class:: ansible-option-line diff --git a/galaxy.yml b/galaxy.yml index 61b24711..84780faa 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: 5.2.0 +version: 5.2.1 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/plugins/inventory/gql_inventory.py b/plugins/inventory/gql_inventory.py index 32a34014..bbfc5dd2 100644 --- a/plugins/inventory/gql_inventory.py +++ b/plugins/inventory/gql_inventory.py @@ -262,7 +262,7 @@ def add_ipv4_address(self, device): def add_ansible_platform(self, device): """Add network platform to host""" - if device.get("platform", {}).get("napalm_driver"): + if device.get("platform") and "napalm_driver" in device["platform"]: self.add_variable( device["name"], ANSIBLE_LIB_MAPPER_REVERSE.get(NAPALM_LIB_MAPPER.get(device["platform"]["napalm_driver"])), # Convert napalm_driver to ansible_network_os value diff --git a/poetry.lock b/poetry.lock index 7c67e6e3..291b056e 100644 --- a/poetry.lock +++ b/poetry.lock @@ -132,17 +132,6 @@ files = [ {file = "alabaster-0.7.16.tar.gz", hash = "sha256:75a8b99c28a5dad50dd7f8ccdd447a121ddb3892da9e53d1ca5cca3106d58d65"}, ] -[[package]] -name = "annotated-types" -version = "0.6.0" -description = "Reusable constraint types to use with typing.Annotated" -optional = false -python-versions = ">=3.8" -files = [ - {file = "annotated_types-0.6.0-py3-none-any.whl", hash = "sha256:0641064de18ba7a25dee8f96403ebc39113d0cb953a01429249d5c7564666a43"}, - {file = "annotated_types-0.6.0.tar.gz", hash = "sha256:563339e807e53ffd9c267e99fc6d9ea23eb8443c08f112651963e24e22f84a5d"}, -] - [[package]] name = "ansible-core" version = "2.15.11" @@ -245,24 +234,30 @@ twiggy = ">=0.5.0" [[package]] name = "antsibull-docs" -version = "1.9.0" +version = "1.11.1" description = "Tools for building Ansible documentation" optional = false python-versions = ">=3.6.1,<4.0.0" files = [ - {file = "antsibull_docs-1.9.0-py3-none-any.whl", hash = "sha256:b9fc1243f47a6e32392cbd860ed73f9c34833ee7e9caafbefb3f7e6e01976429"}, - {file = "antsibull_docs-1.9.0.tar.gz", hash = "sha256:aee9383dd24548507ea53dd76adb39367600d2df80d6dcfa81c93c578d589601"}, + {file = "antsibull_docs-1.11.1-py3-none-any.whl", hash = "sha256:e198ee3aaeb9a95b110f424a91ee36cc30cdc41bd4df2eee9185cd0bf6e00d9c"}, + {file = "antsibull_docs-1.11.1.tar.gz", hash = "sha256:b18649b2a56cd6c84a9dd68563bad57bca0f08510efc4ad2c552daf3763fd9b2"}, ] [package.dependencies] +aiohttp = ">=3.0.0" ansible-pygments = "*" antsibull-core = ">=1.2.0,<3.0.0" asyncio-pool = "*" docutils = "*" -jinja2 = "*" +jinja2 = ">=3.0" packaging = "*" +pydantic = ">=1.0.0,<2.0.0" +PyYAML = "*" rstcheck = ">=3.0.0,<7.0.0" +semantic_version = "*" +sh = ">=1.0.0,<2.0.0" sphinx = "*" +twiggy = "*" [[package]] name = "astroid" @@ -1440,113 +1435,55 @@ files = [ [[package]] name = "pydantic" -version = "2.7.1" -description = "Data validation using Python type hints" +version = "1.10.15" +description = "Data validation and settings management using python type hints" optional = false -python-versions = ">=3.8" +python-versions = ">=3.7" files = [ - {file = "pydantic-2.7.1-py3-none-any.whl", hash = "sha256:e029badca45266732a9a79898a15ae2e8b14840b1eabbb25844be28f0b33f3d5"}, - {file = "pydantic-2.7.1.tar.gz", hash = "sha256:e9dbb5eada8abe4d9ae5f46b9939aead650cd2b68f249bb3a8139dbe125803cc"}, + {file = "pydantic-1.10.15-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:22ed12ee588b1df028a2aa5d66f07bf8f8b4c8579c2e96d5a9c1f96b77f3bb55"}, + {file = "pydantic-1.10.15-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:75279d3cac98186b6ebc2597b06bcbc7244744f6b0b44a23e4ef01e5683cc0d2"}, + {file = "pydantic-1.10.15-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:50f1666a9940d3d68683c9d96e39640f709d7a72ff8702987dab1761036206bb"}, + {file = "pydantic-1.10.15-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82790d4753ee5d00739d6cb5cf56bceb186d9d6ce134aca3ba7befb1eedbc2c8"}, + {file = "pydantic-1.10.15-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:d207d5b87f6cbefbdb1198154292faee8017d7495a54ae58db06762004500d00"}, + {file = "pydantic-1.10.15-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:e49db944fad339b2ccb80128ffd3f8af076f9f287197a480bf1e4ca053a866f0"}, + {file = "pydantic-1.10.15-cp310-cp310-win_amd64.whl", hash = "sha256:d3b5c4cbd0c9cb61bbbb19ce335e1f8ab87a811f6d589ed52b0254cf585d709c"}, + {file = "pydantic-1.10.15-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c3d5731a120752248844676bf92f25a12f6e45425e63ce22e0849297a093b5b0"}, + {file = "pydantic-1.10.15-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:c365ad9c394f9eeffcb30a82f4246c0006417f03a7c0f8315d6211f25f7cb654"}, + {file = "pydantic-1.10.15-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3287e1614393119c67bd4404f46e33ae3be3ed4cd10360b48d0a4459f420c6a3"}, + {file = "pydantic-1.10.15-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:be51dd2c8596b25fe43c0a4a59c2bee4f18d88efb8031188f9e7ddc6b469cf44"}, + {file = "pydantic-1.10.15-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:6a51a1dd4aa7b3f1317f65493a182d3cff708385327c1c82c81e4a9d6d65b2e4"}, + {file = "pydantic-1.10.15-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:4e316e54b5775d1eb59187f9290aeb38acf620e10f7fd2f776d97bb788199e53"}, + {file = "pydantic-1.10.15-cp311-cp311-win_amd64.whl", hash = "sha256:0d142fa1b8f2f0ae11ddd5e3e317dcac060b951d605fda26ca9b234b92214986"}, + {file = "pydantic-1.10.15-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:7ea210336b891f5ea334f8fc9f8f862b87acd5d4a0cbc9e3e208e7aa1775dabf"}, + {file = "pydantic-1.10.15-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3453685ccd7140715e05f2193d64030101eaad26076fad4e246c1cc97e1bb30d"}, + {file = "pydantic-1.10.15-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9bea1f03b8d4e8e86702c918ccfd5d947ac268f0f0cc6ed71782e4b09353b26f"}, + {file = "pydantic-1.10.15-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:005655cabc29081de8243126e036f2065bd7ea5b9dff95fde6d2c642d39755de"}, + {file = "pydantic-1.10.15-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:af9850d98fc21e5bc24ea9e35dd80a29faf6462c608728a110c0a30b595e58b7"}, + {file = "pydantic-1.10.15-cp37-cp37m-win_amd64.whl", hash = "sha256:d31ee5b14a82c9afe2bd26aaa405293d4237d0591527d9129ce36e58f19f95c1"}, + {file = "pydantic-1.10.15-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5e09c19df304b8123938dc3c53d3d3be6ec74b9d7d0d80f4f4b5432ae16c2022"}, + {file = "pydantic-1.10.15-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:7ac9237cd62947db00a0d16acf2f3e00d1ae9d3bd602b9c415f93e7a9fc10528"}, + {file = "pydantic-1.10.15-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:584f2d4c98ffec420e02305cf675857bae03c9d617fcfdc34946b1160213a948"}, + {file = "pydantic-1.10.15-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bbc6989fad0c030bd70a0b6f626f98a862224bc2b1e36bfc531ea2facc0a340c"}, + {file = "pydantic-1.10.15-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:d573082c6ef99336f2cb5b667b781d2f776d4af311574fb53d908517ba523c22"}, + {file = "pydantic-1.10.15-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:6bd7030c9abc80134087d8b6e7aa957e43d35714daa116aced57269a445b8f7b"}, + {file = "pydantic-1.10.15-cp38-cp38-win_amd64.whl", hash = "sha256:3350f527bb04138f8aff932dc828f154847fbdc7a1a44c240fbfff1b57f49a12"}, + {file = "pydantic-1.10.15-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:51d405b42f1b86703555797270e4970a9f9bd7953f3990142e69d1037f9d9e51"}, + {file = "pydantic-1.10.15-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:a980a77c52723b0dc56640ced396b73a024d4b74f02bcb2d21dbbac1debbe9d0"}, + {file = "pydantic-1.10.15-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:67f1a1fb467d3f49e1708a3f632b11c69fccb4e748a325d5a491ddc7b5d22383"}, + {file = "pydantic-1.10.15-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:676ed48f2c5bbad835f1a8ed8a6d44c1cd5a21121116d2ac40bd1cd3619746ed"}, + {file = "pydantic-1.10.15-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:92229f73400b80c13afcd050687f4d7e88de9234d74b27e6728aa689abcf58cc"}, + {file = "pydantic-1.10.15-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:2746189100c646682eff0bce95efa7d2e203420d8e1c613dc0c6b4c1d9c1fde4"}, + {file = "pydantic-1.10.15-cp39-cp39-win_amd64.whl", hash = "sha256:394f08750bd8eaad714718812e7fab615f873b3cdd0b9d84e76e51ef3b50b6b7"}, + {file = "pydantic-1.10.15-py3-none-any.whl", hash = "sha256:28e552a060ba2740d0d2aabe35162652c1459a0b9069fe0db7f4ee0e18e74d58"}, + {file = "pydantic-1.10.15.tar.gz", hash = "sha256:ca832e124eda231a60a041da4f013e3ff24949d94a01154b137fc2f2a43c3ffb"}, ] [package.dependencies] -annotated-types = ">=0.4.0" -pydantic-core = "2.18.2" -typing-extensions = ">=4.6.1" +typing-extensions = ">=4.2.0" [package.extras] -email = ["email-validator (>=2.0.0)"] - -[[package]] -name = "pydantic-core" -version = "2.18.2" -description = "Core functionality for Pydantic validation and serialization" -optional = false -python-versions = ">=3.8" -files = [ - {file = "pydantic_core-2.18.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:9e08e867b306f525802df7cd16c44ff5ebbe747ff0ca6cf3fde7f36c05a59a81"}, - {file = "pydantic_core-2.18.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:f0a21cbaa69900cbe1a2e7cad2aa74ac3cf21b10c3efb0fa0b80305274c0e8a2"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0680b1f1f11fda801397de52c36ce38ef1c1dc841a0927a94f226dea29c3ae3d"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:95b9d5e72481d3780ba3442eac863eae92ae43a5f3adb5b4d0a1de89d42bb250"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c4fcf5cd9c4b655ad666ca332b9a081112cd7a58a8b5a6ca7a3104bc950f2038"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9b5155ff768083cb1d62f3e143b49a8a3432e6789a3abee8acd005c3c7af1c74"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:553ef617b6836fc7e4df130bb851e32fe357ce36336d897fd6646d6058d980af"}, - {file = "pydantic_core-2.18.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:b89ed9eb7d616ef5714e5590e6cf7f23b02d0d539767d33561e3675d6f9e3857"}, - {file = "pydantic_core-2.18.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:75f7e9488238e920ab6204399ded280dc4c307d034f3924cd7f90a38b1829563"}, - {file = "pydantic_core-2.18.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:ef26c9e94a8c04a1b2924149a9cb081836913818e55681722d7f29af88fe7b38"}, - {file = "pydantic_core-2.18.2-cp310-none-win32.whl", hash = "sha256:182245ff6b0039e82b6bb585ed55a64d7c81c560715d1bad0cbad6dfa07b4027"}, - {file = "pydantic_core-2.18.2-cp310-none-win_amd64.whl", hash = "sha256:e23ec367a948b6d812301afc1b13f8094ab7b2c280af66ef450efc357d2ae543"}, - {file = "pydantic_core-2.18.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:219da3f096d50a157f33645a1cf31c0ad1fe829a92181dd1311022f986e5fbe3"}, - {file = "pydantic_core-2.18.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:cc1cfd88a64e012b74e94cd00bbe0f9c6df57049c97f02bb07d39e9c852e19a4"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:05b7133a6e6aeb8df37d6f413f7705a37ab4031597f64ab56384c94d98fa0e90"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:224c421235f6102e8737032483f43c1a8cfb1d2f45740c44166219599358c2cd"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b14d82cdb934e99dda6d9d60dc84a24379820176cc4a0d123f88df319ae9c150"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2728b01246a3bba6de144f9e3115b532ee44bd6cf39795194fb75491824a1413"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:470b94480bb5ee929f5acba6995251ada5e059a5ef3e0dfc63cca287283ebfa6"}, - {file = "pydantic_core-2.18.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:997abc4df705d1295a42f95b4eec4950a37ad8ae46d913caeee117b6b198811c"}, - {file = "pydantic_core-2.18.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:75250dbc5290e3f1a0f4618db35e51a165186f9034eff158f3d490b3fed9f8a0"}, - {file = "pydantic_core-2.18.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:4456f2dca97c425231d7315737d45239b2b51a50dc2b6f0c2bb181fce6207664"}, - {file = "pydantic_core-2.18.2-cp311-none-win32.whl", hash = "sha256:269322dcc3d8bdb69f054681edff86276b2ff972447863cf34c8b860f5188e2e"}, - {file = "pydantic_core-2.18.2-cp311-none-win_amd64.whl", hash = "sha256:800d60565aec896f25bc3cfa56d2277d52d5182af08162f7954f938c06dc4ee3"}, - {file = "pydantic_core-2.18.2-cp311-none-win_arm64.whl", hash = "sha256:1404c69d6a676245199767ba4f633cce5f4ad4181f9d0ccb0577e1f66cf4c46d"}, - {file = "pydantic_core-2.18.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:fb2bd7be70c0fe4dfd32c951bc813d9fe6ebcbfdd15a07527796c8204bd36242"}, - {file = "pydantic_core-2.18.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:6132dd3bd52838acddca05a72aafb6eab6536aa145e923bb50f45e78b7251043"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d7d904828195733c183d20a54230c0df0eb46ec746ea1a666730787353e87182"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:c9bd70772c720142be1020eac55f8143a34ec9f82d75a8e7a07852023e46617f"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2b8ed04b3582771764538f7ee7001b02e1170223cf9b75dff0bc698fadb00cf3"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e6dac87ddb34aaec85f873d737e9d06a3555a1cc1a8e0c44b7f8d5daeb89d86f"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7ca4ae5a27ad7a4ee5170aebce1574b375de390bc01284f87b18d43a3984df72"}, - {file = "pydantic_core-2.18.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:886eec03591b7cf058467a70a87733b35f44707bd86cf64a615584fd72488b7c"}, - {file = "pydantic_core-2.18.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ca7b0c1f1c983e064caa85f3792dd2fe3526b3505378874afa84baf662e12241"}, - {file = "pydantic_core-2.18.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:4b4356d3538c3649337df4074e81b85f0616b79731fe22dd11b99499b2ebbdf3"}, - {file = "pydantic_core-2.18.2-cp312-none-win32.whl", hash = "sha256:8b172601454f2d7701121bbec3425dd71efcb787a027edf49724c9cefc14c038"}, - {file = "pydantic_core-2.18.2-cp312-none-win_amd64.whl", hash = "sha256:b1bd7e47b1558ea872bd16c8502c414f9e90dcf12f1395129d7bb42a09a95438"}, - {file = "pydantic_core-2.18.2-cp312-none-win_arm64.whl", hash = "sha256:98758d627ff397e752bc339272c14c98199c613f922d4a384ddc07526c86a2ec"}, - {file = "pydantic_core-2.18.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:9fdad8e35f278b2c3eb77cbdc5c0a49dada440657bf738d6905ce106dc1de439"}, - {file = "pydantic_core-2.18.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:1d90c3265ae107f91a4f279f4d6f6f1d4907ac76c6868b27dc7fb33688cfb347"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:390193c770399861d8df9670fb0d1874f330c79caaca4642332df7c682bf6b91"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:82d5d4d78e4448683cb467897fe24e2b74bb7b973a541ea1dcfec1d3cbce39fb"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4774f3184d2ef3e14e8693194f661dea5a4d6ca4e3dc8e39786d33a94865cefd"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d4d938ec0adf5167cb335acb25a4ee69a8107e4984f8fbd2e897021d9e4ca21b"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e0e8b1be28239fc64a88a8189d1df7fad8be8c1ae47fcc33e43d4be15f99cc70"}, - {file = "pydantic_core-2.18.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:868649da93e5a3d5eacc2b5b3b9235c98ccdbfd443832f31e075f54419e1b96b"}, - {file = "pydantic_core-2.18.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:78363590ef93d5d226ba21a90a03ea89a20738ee5b7da83d771d283fd8a56761"}, - {file = "pydantic_core-2.18.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:852e966fbd035a6468fc0a3496589b45e2208ec7ca95c26470a54daed82a0788"}, - {file = "pydantic_core-2.18.2-cp38-none-win32.whl", hash = "sha256:6a46e22a707e7ad4484ac9ee9f290f9d501df45954184e23fc29408dfad61350"}, - {file = "pydantic_core-2.18.2-cp38-none-win_amd64.whl", hash = "sha256:d91cb5ea8b11607cc757675051f61b3d93f15eca3cefb3e6c704a5d6e8440f4e"}, - {file = "pydantic_core-2.18.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:ae0a8a797a5e56c053610fa7be147993fe50960fa43609ff2a9552b0e07013e8"}, - {file = "pydantic_core-2.18.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:042473b6280246b1dbf530559246f6842b56119c2926d1e52b631bdc46075f2a"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1a388a77e629b9ec814c1b1e6b3b595fe521d2cdc625fcca26fbc2d44c816804"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:e25add29b8f3b233ae90ccef2d902d0ae0432eb0d45370fe315d1a5cf231004b"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f459a5ce8434614dfd39bbebf1041952ae01da6bed9855008cb33b875cb024c0"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eff2de745698eb46eeb51193a9f41d67d834d50e424aef27df2fcdee1b153845"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a8309f67285bdfe65c372ea3722b7a5642680f3dba538566340a9d36e920b5f0"}, - {file = "pydantic_core-2.18.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:f93a8a2e3938ff656a7c1bc57193b1319960ac015b6e87d76c76bf14fe0244b4"}, - {file = "pydantic_core-2.18.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:22057013c8c1e272eb8d0eebc796701167d8377441ec894a8fed1af64a0bf399"}, - {file = "pydantic_core-2.18.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:cfeecd1ac6cc1fb2692c3d5110781c965aabd4ec5d32799773ca7b1456ac636b"}, - {file = "pydantic_core-2.18.2-cp39-none-win32.whl", hash = "sha256:0d69b4c2f6bb3e130dba60d34c0845ba31b69babdd3f78f7c0c8fae5021a253e"}, - {file = "pydantic_core-2.18.2-cp39-none-win_amd64.whl", hash = "sha256:d9319e499827271b09b4e411905b24a426b8fb69464dfa1696258f53a3334641"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:a1874c6dd4113308bd0eb568418e6114b252afe44319ead2b4081e9b9521fe75"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:ccdd111c03bfd3666bd2472b674c6899550e09e9f298954cfc896ab92b5b0e6d"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e18609ceaa6eed63753037fc06ebb16041d17d28199ae5aba0052c51449650a9"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6e5c584d357c4e2baf0ff7baf44f4994be121e16a2c88918a5817331fc7599d7"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:43f0f463cf89ace478de71a318b1b4f05ebc456a9b9300d027b4b57c1a2064fb"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:e1b395e58b10b73b07b7cf740d728dd4ff9365ac46c18751bf8b3d8cca8f625a"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:0098300eebb1c837271d3d1a2cd2911e7c11b396eac9661655ee524a7f10587b"}, - {file = "pydantic_core-2.18.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:36789b70d613fbac0a25bb07ab3d9dba4d2e38af609c020cf4d888d165ee0bf3"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:3f9a801e7c8f1ef8718da265bba008fa121243dfe37c1cea17840b0944dfd72c"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:3a6515ebc6e69d85502b4951d89131ca4e036078ea35533bb76327f8424531ce"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:20aca1e2298c56ececfd8ed159ae4dde2df0781988c97ef77d5c16ff4bd5b400"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:223ee893d77a310a0391dca6df00f70bbc2f36a71a895cecd9a0e762dc37b349"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2334ce8c673ee93a1d6a65bd90327588387ba073c17e61bf19b4fd97d688d63c"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:cbca948f2d14b09d20268cda7b0367723d79063f26c4ffc523af9042cad95592"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:b3ef08e20ec49e02d5c6717a91bb5af9b20f1805583cb0adfe9ba2c6b505b5ae"}, - {file = "pydantic_core-2.18.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:c6fdc8627910eed0c01aed6a390a252fe3ea6d472ee70fdde56273f198938374"}, - {file = "pydantic_core-2.18.2.tar.gz", hash = "sha256:2e29d20810dfc3043ee13ac7d9e25105799817683348823f305ab3f349b9386e"}, -] - -[package.dependencies] -typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0" +dotenv = ["python-dotenv (>=0.10.4)"] +email = ["email-validator (>=1.0.3)"] [[package]] name = "pygments" @@ -1812,50 +1749,46 @@ jupyter = ["ipywidgets (>=7.5.1,<9)"] [[package]] name = "rstcheck" -version = "6.2.1" +version = "6.1.2" description = "Checks syntax of reStructuredText and code blocks nested within it" optional = false -python-versions = ">=3.8" +python-versions = ">=3.7,<4.0" files = [ - {file = "rstcheck-6.2.1-py3-none-any.whl", hash = "sha256:b450943707d8ca053f5c6b9f103ee595f4926a064203e5e579172aefb3fe2c12"}, - {file = "rstcheck-6.2.1.tar.gz", hash = "sha256:e4d173950b023eb12c2b9d2348a8c62bef46612bbc7b29e1e57d37320ed0a891"}, + {file = "rstcheck-6.1.2-py3-none-any.whl", hash = "sha256:4aaa46e0debc179f849807c453fa384fd2b75167faf5b1274115730805fab529"}, + {file = "rstcheck-6.1.2.tar.gz", hash = "sha256:f9cb07a72ef9a81d1e32187eae29b00a89421ccba1bde0b1652a08ed0923f61b"}, ] [package.dependencies] -rstcheck-core = ">=1.1" -typer = {version = ">=0.4.1", extras = ["all"]} +rstcheck-core = ">=1.0.2,<2.0.0" +typer = {version = ">=0.4.1,<0.8", extras = ["all"]} [package.extras] -dev = ["rstcheck[docs,sphinx,testing,toml,type-check]", "tox (>=3.15)"] -docs = ["m2r2 (>=0.3.2)", "sphinx (>=5.0)", "sphinx-autobuild (>=2021.3.14)", "sphinx-click (>=4.0.3)", "sphinx-rtd-theme (>=1.2)", "sphinxcontrib-spelling (>=7.3)"] -sphinx = ["sphinx (>=5.0)"] +docs = ["m2r2 (>=0.3.2)", "sphinx", "sphinx-autobuild (==2021.3.14)", "sphinx-click (>=4.0.3,<5.0.0)", "sphinx-rtd-dark-mode (>=1.2.4,<2.0.0)", "sphinx-rtd-theme (<1)", "sphinxcontrib-spelling (>=7.3)"] +sphinx = ["sphinx"] testing = ["coverage-conditional-plugin (>=0.5)", "coverage[toml] (>=6.0)", "pytest (>=7.2)", "pytest-cov (>=3.0)", "pytest-randomly (>=3.0)", "pytest-sugar (>=0.9.5)"] -toml = ["tomli (>=2.0)"] -type-check = ["mypy (>=1.0)"] +toml = ["tomli"] [[package]] name = "rstcheck-core" -version = "1.2.1" +version = "1.0.3" description = "Checks syntax of reStructuredText and code blocks nested within it" optional = false -python-versions = ">=3.8" +python-versions = ">=3.7,<4.0" files = [ - {file = "rstcheck-core-1.2.1.tar.gz", hash = "sha256:9b330020d912e2864f23f332c1a0569463ca3b06b8fee7b7bdd201b055f7f831"}, - {file = "rstcheck_core-1.2.1-py3-none-any.whl", hash = "sha256:1c100de418b6c9e14d9cf6558644d0ab103fdc447f891313882d02df3a3c52ba"}, + {file = "rstcheck_core-1.0.3-py3-none-any.whl", hash = "sha256:d75d7df8f15b58e8aafe322d6fb6ef1ac8d12bb563089b0696948a00ee7f601a"}, + {file = "rstcheck_core-1.0.3.tar.gz", hash = "sha256:add19c9a1b97d9087f4b463b49c12cd8a9c03689a255e99089c70a2692f16369"}, ] [package.dependencies] -docutils = ">=0.7" -pydantic = ">=2" +docutils = ">=0.7,<0.20" +pydantic = ">=1.2,<2.0" +types-docutils = ">=0.18,<0.20" [package.extras] -dev = ["rstcheck-core[docs,sphinx,testing,toml,type-check,yaml]", "tox (>=3.15)"] -docs = ["m2r2 (>=0.3.2)", "sphinx (>=5.0,!=7.2.5)", "sphinx-autobuild (>=2021.3.14)", "sphinx-autodoc-typehints (>=1.15)", "sphinx-rtd-theme (>=1.2)", "sphinxcontrib-apidoc (>=0.3)", "sphinxcontrib-spelling (>=7.3)"] -sphinx = ["sphinx (>=5.0)"] -testing = ["coverage-conditional-plugin (>=0.5)", "coverage[toml] (>=6.0)", "pytest (>=7.2)", "pytest-cov (>=3.0)", "pytest-mock (>=3.7)", "pytest-randomly (>=3.0)", "pytest-sugar (>=0.9.5)"] -toml = ["tomli (>=2.0)"] -type-check = ["mypy (>=1.0)", "types-PyYAML (>=6.0.0)", "types-docutils (>=0.18)"] -yaml = ["pyyaml (>=6.0.0)"] +docs = ["m2r2 (>=0.3.2)", "sphinx (>=4.0,<6.0)", "sphinx-autobuild (==2021.3.14)", "sphinx-autodoc-typehints (>=1.15)", "sphinx-rtd-dark-mode (>=1.2.4,<2.0.0)", "sphinx-rtd-theme (<1)", "sphinxcontrib-apidoc (>=0.3)", "sphinxcontrib-spelling (>=7.3)"] +sphinx = ["sphinx (>=4.0,<6.0)"] +testing = ["coverage-conditional-plugin (>=0.5)", "coverage[toml] (>=6.0)", "pytest (>=6.0)", "pytest-cov (>=3.0)", "pytest-mock (>=3.7)", "pytest-randomly (>=3.0)", "pytest-sugar (>=0.9.5)"] +toml = ["tomli (>=2.0,<3.0)"] [[package]] name = "semantic-version" @@ -2156,20 +2089,36 @@ six = "*" [[package]] name = "typer" -version = "0.12.3" +version = "0.4.2" description = "Typer, build great CLIs. Easy to code. Based on Python type hints." optional = false -python-versions = ">=3.7" +python-versions = ">=3.6" files = [ - {file = "typer-0.12.3-py3-none-any.whl", hash = "sha256:070d7ca53f785acbccba8e7d28b08dcd88f79f1fbda035ade0aecec71ca5c914"}, - {file = "typer-0.12.3.tar.gz", hash = "sha256:49e73131481d804288ef62598d97a1ceef3058905aa536a1134f90891ba35482"}, + {file = "typer-0.4.2-py3-none-any.whl", hash = "sha256:023bae00d1baf358a6cc7cea45851639360bb716de687b42b0a4641cd99173f1"}, + {file = "typer-0.4.2.tar.gz", hash = "sha256:b8261c6c0152dd73478b5ba96ba677e5d6948c715c310f7c91079f311f62ec03"}, ] [package.dependencies] -click = ">=8.0.0" -rich = ">=10.11.0" -shellingham = ">=1.3.0" -typing-extensions = ">=3.7.4.3" +click = ">=7.1.1,<9.0.0" +colorama = {version = ">=0.4.3,<0.5.0", optional = true, markers = "extra == \"all\""} +shellingham = {version = ">=1.3.0,<2.0.0", optional = true, markers = "extra == \"all\""} + +[package.extras] +all = ["colorama (>=0.4.3,<0.5.0)", "shellingham (>=1.3.0,<2.0.0)"] +dev = ["autoflake (>=1.3.1,<2.0.0)", "flake8 (>=3.8.3,<4.0.0)", "pre-commit (>=2.17.0,<3.0.0)"] +doc = ["mdx-include (>=1.4.1,<2.0.0)", "mkdocs (>=1.1.2,<2.0.0)", "mkdocs-material (>=8.1.4,<9.0.0)"] +test = ["black (>=22.3.0,<23.0.0)", "coverage (>=5.2,<6.0)", "isort (>=5.0.6,<6.0.0)", "mypy (==0.910)", "pytest (>=4.4.0,<5.4.0)", "pytest-cov (>=2.10.0,<3.0.0)", "pytest-sugar (>=0.9.4,<0.10.0)", "pytest-xdist (>=1.32.0,<2.0.0)", "shellingham (>=1.3.0,<2.0.0)"] + +[[package]] +name = "types-docutils" +version = "0.19.1.9" +description = "Typing stubs for docutils" +optional = false +python-versions = "*" +files = [ + {file = "types-docutils-0.19.1.9.tar.gz", hash = "sha256:1d029567e67c52992fd42aa968778bc10a5e445c8450fc751d672d6f50330a4a"}, + {file = "types_docutils-0.19.1.9-py3-none-any.whl", hash = "sha256:556fb7ee19248aa482caa142a830c940b776b0f8c7577a98abe0977574546a1d"}, +] [[package]] name = "typing-extensions" diff --git a/pyproject.toml b/pyproject.toml index 84b537d5..0654c793 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nautobot_ansible_modules" -version = "5.2.0" +version = "5.2.1" description = "Ansible collection to interact with Nautobot's API" authors = ["Network to Code "] license = "Apache 2.0" diff --git a/tests/unit/inventory/test_graphql.py b/tests/unit/inventory/test_graphql.py index 28ca9b0b..b6fda081 100644 --- a/tests/unit/inventory/test_graphql.py +++ b/tests/unit/inventory/test_graphql.py @@ -195,3 +195,9 @@ def test_ansible_group_by_tags_invalid_nested_path(mock_display, inventory_fixtu inventory_fixture.group_by = ["tags.var.name"] inventory_fixture.create_groups(device_data) mock_display.assert_any_call("Tags must be grouped by name or display. tags.var.name is not a valid path.") + + +def test_platform_none(inventory_fixture, device_data): + """Regression testing for issue #347.""" + device_data["platform"] = None + inventory_fixture.add_ansible_platform(device_data)