diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 8ba64c61b..16459d94a 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,52 @@ NetBox.NetBox Release Notes .. contents:: Topics +v3.22.0 +======= + +Minor Changes +------------- + +- Add integration tests for contact groups +- Add support for custom headers for all modules +- Change `netbox_contact.contact_group` to `contact_groups` +- Fix ansible-bad-import-from pylint errors +- Fix broken code path when using old api path on old netbox systems +- Make the unit-test data structures more flexible. +- Remove abandoned unit-test data. +- add workaround to _build_query_params for services and Netbox 4.3.0 - 4.4.3 (wrong parent_object_type data type) +- add yamllint to project pipeline. +- improve version_check_greater to be more universal +- netbox_circuit_termination - Add parameters termination_id and termination_type for NetBox 4.2+ +- netbox_tag - Add support for object_types on tags +- rename variable full_version to netbox_version. +- rename variable version to api_version. +- sanitize netbox versions received from api +- test suite expanded to run on Python 3.11, 3.12, and 3.13. +- user.groups, user.permissions, user_group.permissions, permission.actions, and permission.object_types are now treated as unordered sets for update comparison purposes. + +Bugfixes +-------- + +- Add netbox version check to support service creation for netbox version prior of 4.3 +- Fix integration test for circuit termination, missing assignment +- Fix integration test for service +- Fix task duplicate task name in documentation that cause ansible-lint error +- Fix typos in tag integration tests. +- Support for related_object_filter when related_object_type is "object" +- Use dedicated function to check netbox version istead of self.full_version for rack. +- add parent_object_type and parent_object_id to services ALLOWED_QUERY_PARAMS +- nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation +- nb_inventory - Fix service collection for version greater than 4.3 +- nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path +- netbox_service - Fix issue 1426 - broken netbox_service module + +New Modules +----------- + +- netbox.netbox.netbox_contact_assignment - Manage contact assignments in NetBox +- netbox.netbox.netbox_data_source - Manage data sources in NetBox + v3.21.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index d2737b844..e2bf09e03 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -852,6 +852,71 @@ releases: name: netbox_mac_address namespace: '' release_date: '2025-03-04' + 3.22.0: + changes: + minor_changes: + - Change `netbox_contact.contact_group` to `contact_groups` + - Add integration tests for contact groups + - Add support for custom headers for all modules + - Fix ansible-bad-import-from pylint errors + - Fix broken code path when using old api path on old netbox systems + - add workaround to _build_query_params for services and Netbox 4.3.0 - 4.4.3 (wrong parent_object_type data type) + - netbox_circuit_termination - Add parameters termination_id and termination_type for NetBox 4.2+ + - netbox_tag - Add support for object_types on tags + - improve version_check_greater to be more universal + - sanitize netbox versions received from api + - test suite expanded to run on Python 3.11, 3.12, and 3.13. + - Make the unit-test data structures more flexible. + - Remove abandoned unit-test data. + - user.groups, user.permissions, user_group.permissions, permission.actions, and permission.object_types are now treated as unordered sets for update comparison purposes. + - rename variable version to api_version. + - rename variable full_version to netbox_version. + - add yamllint to project pipeline. + bugfixes: + - Fix task duplicate task name in documentation that cause ansible-lint error + - nb_inventory - Fix service collection for version greater than 4.3 + - Add netbox version check to support service creation for netbox version prior of 4.3 + - Use dedicated function to check netbox version istead of self.full_version for rack. + - Fix typos in tag integration tests. + - Fix integration test for circuit termination, missing assignment + - Fix integration test for service + - "nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation" + - add parent_object_type and parent_object_id to services ALLOWED_QUERY_PARAMS + - nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path + - Support for related_object_filter when related_object_type is "object" + - netbox_service - Fix issue 1426 - broken netbox_service module + modules: + - description: Manage data sources in NetBox + name: netbox_data_source + namespace: '' + - description: Manage contact assignments in NetBox + name: netbox_contact_assignment + namespace: '' + fragments: + - 1182-fix-contact-groups.yml + - 1433-add-custom-headers.yml + - 1435-fix-duplicate-task-name.yml + - 1438-fix-inventory-service-collection.yml + - 1439-fix-sevral-bug-discovered-by-integration-tests.yml + - 1459-add-netbox-data-sources.yml + - 1462-fix-pylint-errors.yml + - 1464-fix-mac-lookup-by-id.yml + - 1469-fix-old-apis.yml + - 1479-fix-services_parent_object.yml + - contacts.yml + - nb_inventory.yml + - netbox_circuit_termination.yml + - netbox_custom_field.yml + - netbox_service.yml + - netbox_tag.yml + - netbox_version_check_greater.yml + - netbox_version_sanitize.yml + - python_versions.yml + - unit_test_data.yml + - users-ordering.yml + - version_api.yml + - version_netbox.yml + - yamllint.yml 3.3.0: changes: minor_changes: diff --git a/changelogs/fragments/1182-fix-contact-groups.yml b/changelogs/fragments/1182-fix-contact-groups.yml deleted file mode 100644 index f9acabdbd..000000000 --- a/changelogs/fragments/1182-fix-contact-groups.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -minor_changes: - - Change `netbox_contact.contact_group` to `contact_groups` - - Add integration tests for contact groups diff --git a/changelogs/fragments/1433-add-custom-headers.yml b/changelogs/fragments/1433-add-custom-headers.yml deleted file mode 100644 index 5d939cd48..000000000 --- a/changelogs/fragments/1433-add-custom-headers.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Add support for custom headers for all modules diff --git a/changelogs/fragments/1435-fix-duplicate-task-name.yml b/changelogs/fragments/1435-fix-duplicate-task-name.yml deleted file mode 100644 index 6239f595f..000000000 --- a/changelogs/fragments/1435-fix-duplicate-task-name.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - Fix task duplicate task name in documentation that cause ansible-lint error diff --git a/changelogs/fragments/1438-fix-inventory-service-collection.yml b/changelogs/fragments/1438-fix-inventory-service-collection.yml deleted file mode 100644 index 729468783..000000000 --- a/changelogs/fragments/1438-fix-inventory-service-collection.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - nb_inventory - Fix service collection for version greater than 4.3 diff --git a/changelogs/fragments/1439-fix-sevral-bug-discovered-by-integration-tests.yml b/changelogs/fragments/1439-fix-sevral-bug-discovered-by-integration-tests.yml deleted file mode 100644 index d8942f984..000000000 --- a/changelogs/fragments/1439-fix-sevral-bug-discovered-by-integration-tests.yml +++ /dev/null @@ -1,7 +0,0 @@ ---- -bugfixes: - - Add netbox version check to support service creation for netbox version prior of 4.3 - - Use dedicated function to check netbox version istead of self.full_version for rack. - - Fix typos in tag integration tests. - - Fix integration test for circuit termination, missing assignment - - Fix integration test for service diff --git a/changelogs/fragments/1459-add-netbox-data-sources.yml b/changelogs/fragments/1459-add-netbox-data-sources.yml deleted file mode 100644 index 9eb08f364..000000000 --- a/changelogs/fragments/1459-add-netbox-data-sources.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - netbox_data_source - New module `#1459 ` diff --git a/changelogs/fragments/1462-fix-pylint-errors.yml b/changelogs/fragments/1462-fix-pylint-errors.yml deleted file mode 100644 index 0d873939f..000000000 --- a/changelogs/fragments/1462-fix-pylint-errors.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Fix ansible-bad-import-from pylint errors diff --git a/changelogs/fragments/1464-fix-mac-lookup-by-id.yml b/changelogs/fragments/1464-fix-mac-lookup-by-id.yml deleted file mode 100644 index 8380e3a0b..000000000 --- a/changelogs/fragments/1464-fix-mac-lookup-by-id.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - "nb_device_interface: Fix specifying primary_mac_address objects by id for disambiguation" diff --git a/changelogs/fragments/1469-fix-old-apis.yml b/changelogs/fragments/1469-fix-old-apis.yml deleted file mode 100644 index 8ed687cfa..000000000 --- a/changelogs/fragments/1469-fix-old-apis.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Fix broken code path when using old api path on old netbox systems diff --git a/changelogs/fragments/1479-fix-services_parent_object.yml b/changelogs/fragments/1479-fix-services_parent_object.yml deleted file mode 100644 index cb76eacd5..000000000 --- a/changelogs/fragments/1479-fix-services_parent_object.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -bugfixes: - - add parent_object_type and parent_object_id to services ALLOWED_QUERY_PARAMS -minor_changes: - - add workaround to _build_query_params for services and Netbox 4.3.0 - 4.4.3 (wrong parent_object_type data type) diff --git a/changelogs/fragments/contacts.yml b/changelogs/fragments/contacts.yml deleted file mode 100644 index e32d03a5a..000000000 --- a/changelogs/fragments/contacts.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - netbox_contact_assignment - New module `#1480 ` diff --git a/changelogs/fragments/nb_inventory.yml b/changelogs/fragments/nb_inventory.yml deleted file mode 100644 index f66b6078e..000000000 --- a/changelogs/fragments/nb_inventory.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - nb_inventory - Fixed empty inventory results when netbox server URL is a non-root path diff --git a/changelogs/fragments/netbox_circuit_termination.yml b/changelogs/fragments/netbox_circuit_termination.yml deleted file mode 100644 index c95a290de..000000000 --- a/changelogs/fragments/netbox_circuit_termination.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - netbox_circuit_termination - Add parameters termination_id and termination_type for NetBox 4.2+ diff --git a/changelogs/fragments/netbox_custom_field.yml b/changelogs/fragments/netbox_custom_field.yml deleted file mode 100644 index cb90bde0f..000000000 --- a/changelogs/fragments/netbox_custom_field.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - Support for related_object_filter when related_object_type is "object" diff --git a/changelogs/fragments/netbox_service.yml b/changelogs/fragments/netbox_service.yml deleted file mode 100644 index 0b7aa498c..000000000 --- a/changelogs/fragments/netbox_service.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -bugfixes: - - netbox_service - Fix issue 1426 - broken netbox_service module diff --git a/changelogs/fragments/netbox_tag.yml b/changelogs/fragments/netbox_tag.yml deleted file mode 100644 index 33ea2003c..000000000 --- a/changelogs/fragments/netbox_tag.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - netbox_tag - Add support for object_types on tags diff --git a/changelogs/fragments/netbox_version_check_greater.yml b/changelogs/fragments/netbox_version_check_greater.yml deleted file mode 100644 index 51b5369f9..000000000 --- a/changelogs/fragments/netbox_version_check_greater.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - improve version_check_greater to be more universal diff --git a/changelogs/fragments/netbox_version_sanitize.yml b/changelogs/fragments/netbox_version_sanitize.yml deleted file mode 100644 index d9692e651..000000000 --- a/changelogs/fragments/netbox_version_sanitize.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - sanitize netbox versions received from api diff --git a/changelogs/fragments/python_versions.yml b/changelogs/fragments/python_versions.yml deleted file mode 100644 index d11f6b4d6..000000000 --- a/changelogs/fragments/python_versions.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - test suite expanded to run on Python 3.11, 3.12, and 3.13. diff --git a/changelogs/fragments/unit_test_data.yml b/changelogs/fragments/unit_test_data.yml deleted file mode 100644 index 17cf75cdd..000000000 --- a/changelogs/fragments/unit_test_data.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -minor_changes: - - Make the unit-test data structures more flexible. - - Remove abandoned unit-test data. diff --git a/changelogs/fragments/users-ordering.yml b/changelogs/fragments/users-ordering.yml deleted file mode 100644 index 7446dcd3f..000000000 --- a/changelogs/fragments/users-ordering.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - user.groups, user.permissions, user_group.permissions, permission.actions, and permission.object_types are now treated as unordered sets for update comparison purposes. diff --git a/changelogs/fragments/version_api.yml b/changelogs/fragments/version_api.yml deleted file mode 100644 index 40963046e..000000000 --- a/changelogs/fragments/version_api.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - rename variable version to api_version. diff --git a/changelogs/fragments/version_netbox.yml b/changelogs/fragments/version_netbox.yml deleted file mode 100644 index 51161823b..000000000 --- a/changelogs/fragments/version_netbox.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - rename variable full_version to netbox_version. diff --git a/changelogs/fragments/yamllint.yml b/changelogs/fragments/yamllint.yml deleted file mode 100644 index e4ffc93ac..000000000 --- a/changelogs/fragments/yamllint.yml +++ /dev/null @@ -1,3 +0,0 @@ ---- -minor_changes: - - add yamllint to project pipeline. diff --git a/docs/conf.py b/docs/conf.py index 3783ca6d4..2594c8798 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ author = "Mikhail Yohman <@FragmentedPacket>" # The full version, including alpha/beta/rc tags -release = "3.21.0" +release = "3.22.0" # -- General configuration --------------------------------------------------- diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst index e58c8192a..c8f7f7b03 100644 --- a/docs/plugins/environment_variables.rst +++ b/docs/plugins/environment_variables.rst @@ -1,7 +1,7 @@ :orphan: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. _list_of_collection_env_vars: diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index c019dcaae..f712a3a38 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,5 +1,5 @@ .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. _plugins_in_netbox.netbox: @@ -7,7 +7,7 @@ Netbox.Netbox ============= -Collection version 3.21.0 +Collection version 3.22.0 .. contents:: :local: @@ -67,11 +67,13 @@ Modules * :ansplugin:`netbox_console_server_port module ` -- Create, update or delete console server ports within NetBox * :ansplugin:`netbox_console_server_port_template module ` -- Create, update or delete console server port templates within NetBox * :ansplugin:`netbox_contact module ` -- Creates or removes contacts from NetBox +* :ansplugin:`netbox_contact_assignment module ` -- Creates or removes contact assignments from NetBox * :ansplugin:`netbox_contact_group module ` -- Creates or removes contact groups from NetBox * :ansplugin:`netbox_contact_role module ` -- Creates or removes contact roles from NetBox * :ansplugin:`netbox_custom_field module ` -- Creates, updates or deletes custom fields within NetBox * :ansplugin:`netbox_custom_field_choice_set module ` -- Creates, updates or deletes custom field choice sets within Netbox * :ansplugin:`netbox_custom_link module ` -- Creates, updates or deletes custom links within NetBox +* :ansplugin:`netbox_data_source module ` -- Creates or removes data sources from NetBox * :ansplugin:`netbox_device module ` -- Create, update or delete devices within NetBox * :ansplugin:`netbox_device_bay module ` -- Create, update or delete device bays within NetBox * :ansplugin:`netbox_device_bay_template module ` -- Create, update or delete device bay templates within NetBox @@ -160,11 +162,13 @@ Modules netbox_console_server_port_module netbox_console_server_port_template_module netbox_contact_module + netbox_contact_assignment_module netbox_contact_group_module netbox_contact_role_module netbox_custom_field_module netbox_custom_field_choice_set_module netbox_custom_link_module + netbox_data_source_module netbox_device_module netbox_device_bay_module netbox_device_bay_template_module diff --git a/docs/plugins/nb_inventory_inventory.rst b/docs/plugins/nb_inventory_inventory.rst index 3909d074a..0dd1be94a 100644 --- a/docs/plugins/nb_inventory_inventory.rst +++ b/docs/plugins/nb_inventory_inventory.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.nb_inventory inventory -- NetBox inventory source .. Collection note .. note:: - This inventory plugin is part of the `netbox.netbox collection `_ (version 3.21.0). + This inventory plugin is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -252,7 +252,7 @@ Parameters - INI entry: - .. code-block:: + .. code-block:: ini [inventory] cache = false @@ -304,14 +304,14 @@ Parameters - INI entries: - .. code-block:: + .. code-block:: ini [defaults] fact_caching_connection = VALUE - .. code-block:: + .. code-block:: ini [inventory] cache_connection = VALUE @@ -369,14 +369,14 @@ Parameters - INI entries: - .. code-block:: + .. code-block:: ini [defaults] fact_caching = memory - .. code-block:: + .. code-block:: ini [inventory] cache_plugin = memory @@ -434,14 +434,14 @@ Parameters - INI entries: - .. code-block:: + .. code-block:: ini [defaults] fact_caching_prefix = ansible_inventory_ - .. code-block:: + .. code-block:: ini [inventory] cache_prefix = ansible_inventory_ @@ -499,14 +499,14 @@ Parameters - INI entries: - .. code-block:: + .. code-block:: ini [defaults] fact_caching_timeout = 3600 - .. code-block:: + .. code-block:: ini [inventory] cache_timeout = 3600 @@ -2407,7 +2407,7 @@ Parameters - INI entry: - .. code-block:: + .. code-block:: ini [inventory_plugins] use_extra_vars = false @@ -2673,8 +2673,8 @@ Examples - prefix: status key: status.value - # For use in Ansible Tower (AWX), please see this blog from RedHat: https://www.ansible.com/blog/using-an-inventory-plugin-from-a-collection-in-ansible-tower - # The credential for NetBox will need to expose NETBOX_API and NETBOX_TOKEN as environment variables. + # For use in Ansible Tower (AWX) the credential for NetBox will need to expose NETBOX_API + # and NETBOX_TOKEN as environment variables. # Example Ansible Tower credential Input Configuration: fields: diff --git a/docs/plugins/nb_lookup_lookup.rst b/docs/plugins/nb_lookup_lookup.rst index b52d2c5a9..6fc548665 100644 --- a/docs/plugins/nb_lookup_lookup.rst +++ b/docs/plugins/nb_lookup_lookup.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox .. Collection note .. note:: - This lookup plugin is part of the `netbox.netbox collection `_ (version 3.21.0). + This lookup plugin is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -568,7 +568,7 @@ Examples manufactured by {{ item.value.device_type.manufacturer.name }}" loop: "{{ query('netbox.netbox.nb_lookup', 'devices', api_endpoint='http://localhost/', - api_filter='role=management tag=Dell', + api_filter='role=management tag=Dell'), token='') }}" # This example uses an API Filter with a variable and jinja concatenation - name: Set hostname fact diff --git a/docs/plugins/netbox_aggregate_module.rst b/docs/plugins/netbox_aggregate_module.rst index ef8c2684b..df799acd9 100644 --- a/docs/plugins/netbox_aggregate_module.rst +++ b/docs/plugins/netbox_aggregate_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_aggregate module -- Creates or removes aggregates from NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -499,6 +499,40 @@ Parameters + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_aggregate_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_asn_module.rst b/docs/plugins/netbox_asn_module.rst index b0452bf88..b1478b1d3 100644 --- a/docs/plugins/netbox_asn_module.rst +++ b/docs/plugins/netbox_asn_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_asn module -- Create, update or delete ASNs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -409,6 +409,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_asn_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_cable_module.rst b/docs/plugins/netbox_cable_module.rst index 9ff478ec9..0dda0ba2b 100644 --- a/docs/plugins/netbox_cable_module.rst +++ b/docs/plugins/netbox_cable_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_cable module -- Create, update or delete cables within NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -874,6 +874,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_cable_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_circuit_module.rst b/docs/plugins/netbox_circuit_module.rst index 2b18756d9..e05f9b94f 100644 --- a/docs/plugins/netbox_circuit_module.rst +++ b/docs/plugins/netbox_circuit_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_circuit module -- Create, update or delete circuits within .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -619,6 +619,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_circuit_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_circuit_termination_module.rst b/docs/plugins/netbox_circuit_termination_module.rst index 43d8bcaa4..77d78fa72 100644 --- a/docs/plugins/netbox_circuit_termination_module.rst +++ b/docs/plugins/netbox_circuit_termination_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_circuit_termination module -- Create, update or delete circ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -412,7 +412,9 @@ Parameters
- The provider\_network the circuit termination will be assigned to + The provider\_network the circuit termination will be assigned to. + + This parameter is used with NetBox versions before 4.2.0. .. raw:: html @@ -454,7 +456,9 @@ Parameters
- The site the circuit termination will be assigned to + The site the circuit termination will be assigned to. + + This parameter is used with NetBox versions before 4.2.0. .. raw:: html @@ -507,6 +511,111 @@ Parameters - :ansible-option-choices-entry:`"Z"` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/termination_id: + + .. rst-class:: ansible-option-title + + **termination_id** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`integer` + + :ansible-option-versionadded:`added in netbox.netbox 4.2.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The ProviderNetwork, Location, Site, Region, or SiteGroup ID of the circuit termination will be assigned to. + + This parameter is used with NetBox versions \>= 4.2.0. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-data/termination_type: + + .. rst-class:: ansible-option-title + + **termination_type** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + :ansible-option-versionadded:`added in netbox.netbox 4.2.0` + + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The type the circuit termination will be assigned to. + + This parameter is used with NetBox versions \>= 4.2.0. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`"dcim.site"` + - :ansible-option-choices-entry:`"dcim.location"` + - :ansible-option-choices-entry:`"dcim.region"` + - :ansible-option-choices-entry:`"dcim.sitegroup"` + - :ansible-option-choices-entry:`"circuits.providernetwork"` + + .. raw:: html
@@ -596,6 +705,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_circuit_termination_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
@@ -815,7 +958,19 @@ Examples gather_facts: false tasks: - - name: Create circuit termination within NetBox with only required information + - name: Create circuit termination within NetBox version 4.2.0 or later with only required information + netbox.netbox.netbox_circuit_termination: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + circuit: Test Circuit + term_side: A + termination_id: 1 + termination_type: dcim.site + port_speed: 10000 + state: present + + - name: Create circuit termination within NetBox versions earlier than 4.2.0 with only required information netbox.netbox.netbox_circuit_termination: netbox_url: http://netbox.local netbox_token: thisIsMyToken diff --git a/docs/plugins/netbox_circuit_type_module.rst b/docs/plugins/netbox_circuit_type_module.rst index fb5ad2dbb..0f3aab9b6 100644 --- a/docs/plugins/netbox_circuit_type_module.rst +++ b/docs/plugins/netbox_circuit_type_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_circuit_type module -- Create, update or delete circuit typ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -423,6 +423,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_circuit_type_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_cluster_group_module.rst b/docs/plugins/netbox_cluster_group_module.rst index 733f93e9d..39d6529e0 100644 --- a/docs/plugins/netbox_cluster_group_module.rst +++ b/docs/plugins/netbox_cluster_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_cluster_group module -- Create, update or delete cluster gr .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -378,6 +378,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_cluster_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_cluster_module.rst b/docs/plugins/netbox_cluster_module.rst index aa18978c7..cac122ca8 100644 --- a/docs/plugins/netbox_cluster_module.rst +++ b/docs/plugins/netbox_cluster_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_cluster module -- Create, update or delete clusters within .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -686,6 +686,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_cluster_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_cluster_type_module.rst b/docs/plugins/netbox_cluster_type_module.rst index 5d949bc72..0ec940c53 100644 --- a/docs/plugins/netbox_cluster_type_module.rst +++ b/docs/plugins/netbox_cluster_type_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_cluster_type module -- Create, update or delete cluster typ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -375,6 +375,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_cluster_type_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_config_context_module.rst b/docs/plugins/netbox_config_context_module.rst index df9fbef0f..eedab5637 100644 --- a/docs/plugins/netbox_config_context_module.rst +++ b/docs/plugins/netbox_config_context_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_config_context module -- Creates, updates or deletes config .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -879,6 +879,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_config_context_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_config_template_module.rst b/docs/plugins/netbox_config_template_module.rst index dd2b09e6a..1279113d5 100644 --- a/docs/plugins/netbox_config_template_module.rst +++ b/docs/plugins/netbox_config_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_config_template module -- Creates or removes config templat .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -367,6 +367,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_config_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_console_port_module.rst b/docs/plugins/netbox_console_port_module.rst index c7c21f0a6..d21358859 100644 --- a/docs/plugins/netbox_console_port_module.rst +++ b/docs/plugins/netbox_console_port_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_console_port module -- Create, update or delete console por .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -666,6 +666,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_console_port_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_console_port_template_module.rst b/docs/plugins/netbox_console_port_template_module.rst index 8b106309d..00abfcb83 100644 --- a/docs/plugins/netbox_console_port_template_module.rst +++ b/docs/plugins/netbox_console_port_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_console_port_template module -- Create, update or delete co .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -302,6 +302,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_console_port_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_console_server_port_module.rst b/docs/plugins/netbox_console_server_port_module.rst index 88f722ba0..022cbb8c4 100644 --- a/docs/plugins/netbox_console_server_port_module.rst +++ b/docs/plugins/netbox_console_server_port_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_console_server_port module -- Create, update or delete cons .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -621,6 +621,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_console_server_port_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_console_server_port_template_module.rst b/docs/plugins/netbox_console_server_port_template_module.rst index 7f60c0d2c..a03e50bdf 100644 --- a/docs/plugins/netbox_console_server_port_template_module.rst +++ b/docs/plugins/netbox_console_server_port_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_console_server_port_template module -- Create, update or de .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -302,6 +302,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_console_server_port_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_contact_assignment_module.rst b/docs/plugins/netbox_contact_assignment_module.rst new file mode 100644 index 000000000..e733789e4 --- /dev/null +++ b/docs/plugins/netbox_contact_assignment_module.rst @@ -0,0 +1,862 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.16.2 + +.. Anchors + +.. _ansible_collections.netbox.netbox.netbox_contact_assignment_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +netbox.netbox.netbox_contact_assignment module -- Creates or removes contact assignments from NetBox +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `netbox.netbox collection `_ (version 3.22.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. + You need further requirements to be able to use this module, + see :ref:`Requirements ` for details. + + To use it in a playbook, specify: :code:`netbox.netbox.netbox_contact_assignment`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in netbox.netbox 3.1.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Creates or removes contact assignments from NetBox + + +.. Aliases + + +.. Requirements + +.. _ansible_collections.netbox.netbox.netbox_contact_assignment_module_requirements: + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- pynetbox + + + + + + +.. Options + +Parameters +---------- + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-cert: + + .. rst-class:: ansible-option-title + + **cert** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Certificate path + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data: + + .. rst-class:: ansible-option-title + + **data** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Defines the contact configuration + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/contact: + + .. rst-class:: ansible-option-title + + **contact** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The name of the contact to assign to the object + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/object_name: + + .. rst-class:: ansible-option-title + + **object_name** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The name of the object the contact is assigned to + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/object_type: + + .. rst-class:: ansible-option-title + + **object_type** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The type of the object the contact is assigned to + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`"circuit"` + - :ansible-option-choices-entry:`"cluster"` + - :ansible-option-choices-entry:`"cluster\_group"` + - :ansible-option-choices-entry:`"device"` + - :ansible-option-choices-entry:`"location"` + - :ansible-option-choices-entry:`"manufacturer"` + - :ansible-option-choices-entry:`"power\_panel"` + - :ansible-option-choices-entry:`"provider"` + - :ansible-option-choices-entry:`"rack"` + - :ansible-option-choices-entry:`"region"` + - :ansible-option-choices-entry:`"site"` + - :ansible-option-choices-entry:`"site\_group"` + - :ansible-option-choices-entry:`"tenant"` + - :ansible-option-choices-entry:`"virtual\_machine"` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/priority: + + .. rst-class:: ansible-option-title + + **priority** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The priority of this contact + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`"primary"` + - :ansible-option-choices-entry:`"secondary"` + - :ansible-option-choices-entry:`"tertiary"` + - :ansible-option-choices-entry:`"inactive"` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/role: + + .. rst-class:: ansible-option-title + + **role** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The name of the role the contact has for this object + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-data/tags: + + .. rst-class:: ansible-option-title + + **tags** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Any tags that the contact may need to be associated with + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-netbox_token: + + .. rst-class:: ansible-option-title + + **netbox_token** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The NetBox API token. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-netbox_url: + + .. rst-class:: ansible-option-title + + **netbox_url** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL of the NetBox instance. + + Must be accessible by the Ansible control host. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that are defined + + in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The state of the object. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` + - :ansible-option-choices-entry:`"absent"` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If :literal:`no`\ , SSL certificates will not be validated. + + This should only be used on personally controlled sites using a self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`true` + + .. raw:: html + +
+ + +.. Attributes + + +.. Notes + +Notes +----- + +.. note:: + - Tags should be defined as a YAML list + - This should be ran with connection :literal:`local` and hosts :literal:`localhost` + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: "Test NetBox module" + connection: local + hosts: localhost + gather_facts: false + tasks: + - name: Assign a contact to a location with only required information + netbox.netbox.netbox_contact_assignment: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + object_type: location + object_name: My Location + contact: John Doe + role: Supervisor Role + state: present + + - name: Delete contact assignment within netbox + netbox.netbox.netbox_contact_assignment: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + object_type: location + object_name: My Location + contact: John Doe + role: Supervisor Role + state: absent + + - name: Create contact with all parameters + netbox.netbox.netbox_contact: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + object_type: location + object_name: My Location + contact: John Doe + role: Supervisor Role + priority: tertiary + tags: + - tagA + - tagB + - tagC + state: present + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__return-contact_assignment: + + .. rst-class:: ansible-option-title + + **contact_assignment** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within NetBox + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_assignment_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Daniel Chiquito (@dchiquito) + + + +.. Extra links + +Collection links +~~~~~~~~~~~~~~~~ + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true + + +.. Parsing errors diff --git a/docs/plugins/netbox_contact_group_module.rst b/docs/plugins/netbox_contact_group_module.rst index 1185db0f0..7e4955603 100644 --- a/docs/plugins/netbox_contact_group_module.rst +++ b/docs/plugins/netbox_contact_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_contact_group module -- Creates or removes contact groups f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -409,6 +409,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_contact_module.rst b/docs/plugins/netbox_contact_module.rst index d1fe2fcce..3a36a745a 100644 --- a/docs/plugins/netbox_contact_module.rst +++ b/docs/plugins/netbox_contact_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_contact module -- Creates or removes contacts from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -275,7 +275,49 @@ Parameters
- Group assignment for the contact + Group that the contact belongs to. Only available in Netbox version \<4.3 + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-data/contact_groups: + + .. rst-class:: ansible-option-title + + **contact_groups** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Groups that the contact belongs to. Only available in Netbox versions \>=4.3 .. raw:: html @@ -625,6 +667,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
@@ -868,6 +944,9 @@ Examples title: Mr Contact phone: 123456789 email: contac@contact.com + contact_groups: + - Group 1 + - Group 2 tags: - tagA - tagB diff --git a/docs/plugins/netbox_contact_role_module.rst b/docs/plugins/netbox_contact_role_module.rst index ee03b31aa..08dcef0b3 100644 --- a/docs/plugins/netbox_contact_role_module.rst +++ b/docs/plugins/netbox_contact_role_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_contact_role module -- Creates or removes contact roles fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -369,6 +369,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_contact_role_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_custom_field_choice_set_module.rst b/docs/plugins/netbox_custom_field_choice_set_module.rst index f87dd553c..91aa85d4b 100644 --- a/docs/plugins/netbox_custom_field_choice_set_module.rst +++ b/docs/plugins/netbox_custom_field_choice_set_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_custom_field_choice_set module -- Creates, updates or delet .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -388,6 +388,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_custom_field_choice_set_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_custom_field_module.rst b/docs/plugins/netbox_custom_field_module.rst index 717e4ee85..03a12c2cf 100644 --- a/docs/plugins/netbox_custom_field_module.rst +++ b/docs/plugins/netbox_custom_field_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_custom_field module -- Creates, updates or deletes custom f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -581,6 +581,48 @@ Parameters The content type(s) to apply this custom field to (NetBox 4.0+) + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-data/related_object_filter: + + .. rst-class:: ansible-option-title + + **related_object_filter** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Filter definition for related object selection. To reset the value, set it to an empty dict (null value is ignored by the API) + + .. raw:: html
@@ -1010,6 +1052,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_custom_field_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_custom_link_module.rst b/docs/plugins/netbox_custom_link_module.rst index 81d1d060b..e08dc0722 100644 --- a/docs/plugins/netbox_custom_link_module.rst +++ b/docs/plugins/netbox_custom_link_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_custom_link module -- Creates, updates or deletes custom li .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -644,6 +644,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_custom_link_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_data_source_module.rst b/docs/plugins/netbox_data_source_module.rst new file mode 100644 index 000000000..beaacec18 --- /dev/null +++ b/docs/plugins/netbox_data_source_module.rst @@ -0,0 +1,934 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. meta:: + :antsibull-docs: 2.16.2 + +.. Anchors + +.. _ansible_collections.netbox.netbox.netbox_data_source_module: + +.. Anchors: short name for ansible.builtin + +.. Title + +netbox.netbox.netbox_data_source module -- Creates or removes data sources from NetBox +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This module is part of the `netbox.netbox collection `_ (version 3.22.0). + + It is not included in ``ansible-core``. + To check whether it is installed, run :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install netbox.netbox`. + You need further requirements to be able to use this module, + see :ref:`Requirements ` for details. + + To use it in a playbook, specify: :code:`netbox.netbox.netbox_data_source`. + +.. version_added + +.. rst-class:: ansible-version-added + +New in netbox.netbox 3.22.0 + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- Creates or removes data sources from NetBox + + +.. Aliases + + +.. Requirements + +.. _ansible_collections.netbox.netbox.netbox_data_source_module_requirements: + +Requirements +------------ +The below requirements are needed on the host that executes this module. + +- pynetbox + + + + + + +.. Options + +Parameters +---------- + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Parameter + - Comments + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-cert: + + .. rst-class:: ansible-option-title + + **cert** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Certificate path + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data: + + .. rst-class:: ansible-option-title + + **data** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Defines the data source configuration + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/comments: + + .. rst-class:: ansible-option-title + + **comments** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Comments about the data source + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/description: + + .. rst-class:: ansible-option-title + + **description** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Description of the data source + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/enabled: + + .. rst-class:: ansible-option-title + + **enabled** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`boolean` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Whether or not this data source can be synced + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`false` + - :ansible-option-choices-entry:`true` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/ignore_rules: + + .. rst-class:: ansible-option-title + + **ignore_rules** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Patterns (one per line) matching files to ignore when syncing + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/name: + + .. rst-class:: ansible-option-title + + **name** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Name of the data source + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/source_url: + + .. rst-class:: ansible-option-title + + **source_url** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + URL of the data source to be created + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/sync_interval: + + .. rst-class:: ansible-option-title + + **sync_interval** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`integer` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The interval in seconds between syncs + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`1` + - :ansible-option-choices-entry:`60` + - :ansible-option-choices-entry:`720` + - :ansible-option-choices-entry:`1440` + - :ansible-option-choices-entry:`10080` + - :ansible-option-choices-entry:`43200` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-data/type: + + .. rst-class:: ansible-option-title + + **type** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + The origin of the data source + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry:`"local"` + - :ansible-option-choices-entry:`"git"` + - :ansible-option-choices-entry:`"amazon-s3"` + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-netbox_token: + + .. rst-class:: ansible-option-title + + **netbox_token** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The NetBox API token. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-netbox_url: + + .. rst-class:: ansible-option-title + + **netbox_url** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` / :ansible-option-required:`required` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The URL of the NetBox instance. + + Must be accessible by the Ansible control host. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-query_params: + + .. rst-class:: ansible-option-title + + **query_params** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + This can be used to override the specified values in ALLOWED\_QUERY\_PARAMS that are defined + + in plugins/module\_utils/netbox\_utils.py and provides control to users on what may make + + an object unique in their environment. + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-state: + + .. rst-class:: ansible-option-title + + **state** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + The state of the object. + + + .. rst-class:: ansible-option-line + + :ansible-option-choices:`Choices:` + + - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` + - :ansible-option-choices-entry:`"absent"` + + + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__parameter-validate_certs: + + .. rst-class:: ansible-option-title + + **validate_certs** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`any` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + If :literal:`no`\ , SSL certificates will not be validated. + + This should only be used on personally controlled sites using a self-signed certificates. + + + .. rst-class:: ansible-option-line + + :ansible-option-default-bold:`Default:` :ansible-option-default:`true` + + .. raw:: html + +
+ + +.. Attributes + + +.. Notes + + +.. Seealso + + +.. Examples + +Examples +-------- + +.. code-block:: yaml+jinja + + - name: "Test NetBox modules" + connection: local + hosts: localhost + gather_facts: false + + tasks: + - name: "Create a new data source with only required information" + netbox.netbox.netbox_data_source: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: "Data Source 1" + type: "local" + source_url: "/tmp/data-source.txt" + enabled: true + state: present + - name: "Update that data source with other fields" + netbox.netbox.netbox_data_source: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: "Data Source 1" + type: "amazon-s3" + source_url: "path/to/bucket" + enabled: false + description: "My first data source" + ignore_rules: ".*\nfoo.txt\n*.yml" + sync_interval: 1440 + comments: "Some commentary on this data source" + state: present + - name: "Delete the data source" + netbox.netbox.netbox_data_source: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: "Data Source 1" + state: absent + + + +.. Facts + + +.. Return values + +Return Values +------------- +Common return values are documented :ref:`here `, the following are the fields unique to this module: + +.. tabularcolumns:: \X{1}{3}\X{2}{3} + +.. list-table:: + :width: 100% + :widths: auto + :header-rows: 1 + :class: longtable ansible-option-table + + * - Key + - Description + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__return-data_source: + + .. rst-class:: ansible-option-title + + **data_source** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Serialized object as created or already existent within NetBox + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` on creation + + + .. raw:: html + +
+ + + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_data_source_module__return-msg: + + .. rst-class:: ansible-option-title + + **msg** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`string` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Message indicating failure or info about what has been achieved + + + .. rst-class:: ansible-option-line + + :ansible-option-returned-bold:`Returned:` always + + + .. raw:: html + +
+ + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Daniel Chiquito (@dchiquito) + + + +.. Extra links + +Collection links +~~~~~~~~~~~~~~~~ + +.. ansible-links:: + + - title: "Issue Tracker" + url: "https://github.com/netbox-community/ansible_modules/issues" + external: true + - title: "Repository (Sources)" + url: "https://github.com/netbox-community/ansible_modules" + external: true + + +.. Parsing errors diff --git a/docs/plugins/netbox_device_bay_module.rst b/docs/plugins/netbox_device_bay_module.rst index cecae77aa..a8632aa88 100644 --- a/docs/plugins/netbox_device_bay_module.rst +++ b/docs/plugins/netbox_device_bay_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_bay module -- Create, update or delete device bays w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -412,6 +412,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_bay_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_bay_template_module.rst b/docs/plugins/netbox_device_bay_template_module.rst index 9e4a73bfd..6d6b3eef5 100644 --- a/docs/plugins/netbox_device_bay_template_module.rst +++ b/docs/plugins/netbox_device_bay_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_bay_template module -- Create, update or delete devi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -241,6 +241,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_bay_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_interface_module.rst b/docs/plugins/netbox_device_interface_module.rst index b4e2bf0bb..adfd32b4d 100644 --- a/docs/plugins/netbox_device_interface_module.rst +++ b/docs/plugins/netbox_device_interface_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_interface module -- Creates or removes interfaces on .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -983,7 +983,7 @@ Parameters .. ansible-option-type-line:: - :ansible-option-type:`string` + :ansible-option-type:`any` .. raw:: html @@ -1355,6 +1355,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_interface_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_interface_template_module.rst b/docs/plugins/netbox_device_interface_template_module.rst index 9f7d70fce..f5978b587 100644 --- a/docs/plugins/netbox_device_interface_template_module.rst +++ b/docs/plugins/netbox_device_interface_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_interface_template module -- Creates or removes inte .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -568,6 +568,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_interface_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_module.rst b/docs/plugins/netbox_device_module.rst index c478071ad..47b8e9e4c 100644 --- a/docs/plugins/netbox_device_module.rst +++ b/docs/plugins/netbox_device_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device module -- Create, update or delete devices within Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1329,6 +1329,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_role_module.rst b/docs/plugins/netbox_device_role_module.rst index bab31e4b1..7b0188f27 100644 --- a/docs/plugins/netbox_device_role_module.rst +++ b/docs/plugins/netbox_device_role_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_role module -- Create, update or delete devices role .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -467,6 +467,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_role_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_device_type_module.rst b/docs/plugins/netbox_device_type_module.rst index 3426ca0e2..e8991cfc7 100644 --- a/docs/plugins/netbox_device_type_module.rst +++ b/docs/plugins/netbox_device_type_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_device_type module -- Create, update or delete device types .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -847,6 +847,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_device_type_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_export_template_module.rst b/docs/plugins/netbox_export_template_module.rst index 950855825..e8a59cd15 100644 --- a/docs/plugins/netbox_export_template_module.rst +++ b/docs/plugins/netbox_export_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_export_template module -- Creates, updates or deletes expor .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -549,6 +549,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_export_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_fhrp_group_assignment_module.rst b/docs/plugins/netbox_fhrp_group_assignment_module.rst index 040cfb9ed..8807ddcb6 100644 --- a/docs/plugins/netbox_fhrp_group_assignment_module.rst +++ b/docs/plugins/netbox_fhrp_group_assignment_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_fhrp_group_assignment module -- Create, update or delete FH .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -330,6 +330,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_fhrp_group_module.rst b/docs/plugins/netbox_fhrp_group_module.rst index efa8e43c2..a83398b48 100644 --- a/docs/plugins/netbox_fhrp_group_module.rst +++ b/docs/plugins/netbox_fhrp_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_fhrp_group module -- Create, update or delete FHRP groups w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -517,6 +517,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_fhrp_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_front_port_module.rst b/docs/plugins/netbox_front_port_module.rst index f38c2ce4c..5dfaee56a 100644 --- a/docs/plugins/netbox_front_port_module.rst +++ b/docs/plugins/netbox_front_port_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_front_port module -- Create, update or delete front ports w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -516,6 +516,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_front_port_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_front_port_template_module.rst b/docs/plugins/netbox_front_port_template_module.rst index b77e0cb73..b6b41389e 100644 --- a/docs/plugins/netbox_front_port_template_module.rst +++ b/docs/plugins/netbox_front_port_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_front_port_template module -- Create, update or delete fron .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -477,6 +477,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_front_port_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_interface_module.rst b/docs/plugins/netbox_interface_module.rst index 8dc389cd7..69056062c 100644 --- a/docs/plugins/netbox_interface_module.rst +++ b/docs/plugins/netbox_interface_module.rst @@ -3,7 +3,7 @@ :orphan: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -17,7 +17,7 @@ netbox.netbox.netbox_interface .. Collection note .. note:: - This plugin was part of the `netbox.netbox collection `_ (version 3.21.0). + This plugin was part of the `netbox.netbox collection `_ (version 3.22.0). This module has been removed in version 0.1.0 of netbox.netbox. diff --git a/docs/plugins/netbox_inventory_item_module.rst b/docs/plugins/netbox_inventory_item_module.rst index 7fe8675e5..1b942990c 100644 --- a/docs/plugins/netbox_inventory_item_module.rst +++ b/docs/plugins/netbox_inventory_item_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_inventory_item module -- Creates or removes inventory items .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -911,6 +911,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_inventory_item_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_inventory_item_role_module.rst b/docs/plugins/netbox_inventory_item_role_module.rst index f17247cc2..2c3009770 100644 --- a/docs/plugins/netbox_inventory_item_role_module.rst +++ b/docs/plugins/netbox_inventory_item_role_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_inventory_item_role module -- Create, update or delete devi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -411,6 +411,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_inventory_item_role_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_ip_address_module.rst b/docs/plugins/netbox_ip_address_module.rst index aadcf3cc5..d77a58493 100644 --- a/docs/plugins/netbox_ip_address_module.rst +++ b/docs/plugins/netbox_ip_address_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_ip_address module -- Creates or removes IP addresses from N .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -950,6 +950,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_ip_address_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_ipam_role_module.rst b/docs/plugins/netbox_ipam_role_module.rst index b32a27d0e..18dcb7baa 100644 --- a/docs/plugins/netbox_ipam_role_module.rst +++ b/docs/plugins/netbox_ipam_role_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_ipam_role module -- Creates or removes ipam roles from NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -417,6 +417,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_ipam_role_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_journal_entry_module.rst b/docs/plugins/netbox_journal_entry_module.rst index d05d75f8c..4777136dd 100644 --- a/docs/plugins/netbox_journal_entry_module.rst +++ b/docs/plugins/netbox_journal_entry_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_journal_entry module -- Creates a journal entry .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -451,6 +451,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_journal_entry_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_l2vpn_module.rst b/docs/plugins/netbox_l2vpn_module.rst index aeea58e30..c60d78f09 100644 --- a/docs/plugins/netbox_l2vpn_module.rst +++ b/docs/plugins/netbox_l2vpn_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_l2vpn module -- Create, update or delete L2VPNs within NetB .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -580,6 +580,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_l2vpn_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_l2vpn_termination_module.rst b/docs/plugins/netbox_l2vpn_termination_module.rst index 4de8a2f37..c8760577b 100644 --- a/docs/plugins/netbox_l2vpn_termination_module.rst +++ b/docs/plugins/netbox_l2vpn_termination_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_l2vpn_termination module -- Create, update or delete L2VPNs .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -376,6 +376,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_l2vpn_termination_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_location_module.rst b/docs/plugins/netbox_location_module.rst index f418f39a5..f2929c149 100644 --- a/docs/plugins/netbox_location_module.rst +++ b/docs/plugins/netbox_location_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_location module -- Create, update or delete locations withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -594,6 +594,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_location_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_mac_address_module.rst b/docs/plugins/netbox_mac_address_module.rst index 835d2a6b9..42d77bb4c 100644 --- a/docs/plugins/netbox_mac_address_module.rst +++ b/docs/plugins/netbox_mac_address_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_mac_address module -- Create, update or delete MAC addresse .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -409,6 +409,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_mac_address_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_manufacturer_module.rst b/docs/plugins/netbox_manufacturer_module.rst index a1004db9d..b2a13b29a 100644 --- a/docs/plugins/netbox_manufacturer_module.rst +++ b/docs/plugins/netbox_manufacturer_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_manufacturer module -- Create or delete manufacturers withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -375,6 +375,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_manufacturer_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_module_bay_module.rst b/docs/plugins/netbox_module_bay_module.rst index a372a0e9d..f8e314341 100644 --- a/docs/plugins/netbox_module_bay_module.rst +++ b/docs/plugins/netbox_module_bay_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_module_bay module -- Create, update or delete module bay wi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -451,6 +451,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_module_bay_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_module_module.rst b/docs/plugins/netbox_module_module.rst index 8d18846be..647f9fa93 100644 --- a/docs/plugins/netbox_module_module.rst +++ b/docs/plugins/netbox_module_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_module module -- Create, update or delete module within Net .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -590,6 +590,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_module_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_module_type_module.rst b/docs/plugins/netbox_module_type_module.rst index 407a3e7d4..b574f2efa 100644 --- a/docs/plugins/netbox_module_type_module.rst +++ b/docs/plugins/netbox_module_type_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_module_type module -- Create, update or delete module types .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -506,6 +506,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_module_type_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_permission_module.rst b/docs/plugins/netbox_permission_module.rst index d9ceac667..53841a81a 100644 --- a/docs/plugins/netbox_permission_module.rst +++ b/docs/plugins/netbox_permission_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_permission module -- Creates or removes permissions from Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -417,6 +417,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_permission_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_platform_module.rst b/docs/plugins/netbox_platform_module.rst index 0879802a4..b74b007c4 100644 --- a/docs/plugins/netbox_platform_module.rst +++ b/docs/plugins/netbox_platform_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_platform module -- Create or delete platforms within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -546,6 +546,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_platform_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_feed_module.rst b/docs/plugins/netbox_power_feed_module.rst index 8ab877df3..8c0840159 100644 --- a/docs/plugins/netbox_power_feed_module.rst +++ b/docs/plugins/netbox_power_feed_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_feed module -- Create, update or delete power feeds w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -782,6 +782,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_feed_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_outlet_module.rst b/docs/plugins/netbox_power_outlet_module.rst index 805ce3e40..83f13727a 100644 --- a/docs/plugins/netbox_power_outlet_module.rst +++ b/docs/plugins/netbox_power_outlet_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_outlet module -- Create, update or delete power outle .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -566,6 +566,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_outlet_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_outlet_template_module.rst b/docs/plugins/netbox_power_outlet_template_module.rst index 1af7a360f..657d1b998 100644 --- a/docs/plugins/netbox_power_outlet_template_module.rst +++ b/docs/plugins/netbox_power_outlet_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_outlet_template module -- Create, update or delete po .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -437,6 +437,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_outlet_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_panel_module.rst b/docs/plugins/netbox_power_panel_module.rst index af5744340..5712fc505 100644 --- a/docs/plugins/netbox_power_panel_module.rst +++ b/docs/plugins/netbox_power_panel_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_panel module -- Create, update or delete power panels .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -510,6 +510,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_panel_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_port_module.rst b/docs/plugins/netbox_power_port_module.rst index ed03eda68..b1e0824ea 100644 --- a/docs/plugins/netbox_power_port_module.rst +++ b/docs/plugins/netbox_power_port_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_port module -- Create, update or delete power ports w .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -602,6 +602,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_port_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_power_port_template_module.rst b/docs/plugins/netbox_power_port_template_module.rst index d73e76009..6f49779da 100644 --- a/docs/plugins/netbox_power_port_template_module.rst +++ b/docs/plugins/netbox_power_port_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_power_port_template module -- Create, update or delete powe .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -522,6 +522,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_power_port_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_prefix_module.rst b/docs/plugins/netbox_prefix_module.rst index b904a1bff..1a96ad84b 100644 --- a/docs/plugins/netbox_prefix_module.rst +++ b/docs/plugins/netbox_prefix_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_prefix module -- Creates or removes prefixes from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -993,6 +993,40 @@ Parameters - :ansible-option-choices-entry:`true` + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_prefix_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + .. raw:: html
@@ -1216,7 +1250,7 @@ Examples gather_facts: false tasks: - - name: Create prefix within NetBox with only required information before deleting it + - name: Create prefix within NetBox with only required information before deleting it netbox.netbox.netbox_prefix: netbox_url: http://netbox.local netbox_token: thisIsMyToken diff --git a/docs/plugins/netbox_provider_module.rst b/docs/plugins/netbox_provider_module.rst index 8f5a02ee7..57e3ae41f 100644 --- a/docs/plugins/netbox_provider_module.rst +++ b/docs/plugins/netbox_provider_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_provider module -- Create, update or delete providers withi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -580,6 +580,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_provider_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_provider_network_module.rst b/docs/plugins/netbox_provider_network_module.rst index 1f3c2e60c..d36882fb7 100644 --- a/docs/plugins/netbox_provider_network_module.rst +++ b/docs/plugins/netbox_provider_network_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_provider_network module -- Create, update or delete provide .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -454,6 +454,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_provider_network_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rack_group_module.rst b/docs/plugins/netbox_rack_group_module.rst index 2543aa22c..f62dfaabe 100644 --- a/docs/plugins/netbox_rack_group_module.rst +++ b/docs/plugins/netbox_rack_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rack_group module -- Create, update or delete racks groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -285,6 +285,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rack_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rack_module.rst b/docs/plugins/netbox_rack_module.rst index ca93b984f..e62d3b038 100644 --- a/docs/plugins/netbox_rack_module.rst +++ b/docs/plugins/netbox_rack_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rack module -- Create, update or delete racks within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1274,6 +1274,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rack_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rack_role_module.rst b/docs/plugins/netbox_rack_role_module.rst index 10be4d7f2..45d3429f2 100644 --- a/docs/plugins/netbox_rack_role_module.rst +++ b/docs/plugins/netbox_rack_role_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rack_role module -- Create, update or delete racks roles wi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -420,6 +420,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rack_role_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rear_port_module.rst b/docs/plugins/netbox_rear_port_module.rst index cc61be20a..ffa13dbec 100644 --- a/docs/plugins/netbox_rear_port_module.rst +++ b/docs/plugins/netbox_rear_port_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rear_port module -- Create, update or delete rear ports wit .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -474,6 +474,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rear_port_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rear_port_template_module.rst b/docs/plugins/netbox_rear_port_template_module.rst index c0ab2909f..7377c5c78 100644 --- a/docs/plugins/netbox_rear_port_template_module.rst +++ b/docs/plugins/netbox_rear_port_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rear_port_template module -- Create, update or delete rear .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -435,6 +435,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rear_port_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_region_module.rst b/docs/plugins/netbox_region_module.rst index 687c47b9f..d32c616d4 100644 --- a/docs/plugins/netbox_region_module.rst +++ b/docs/plugins/netbox_region_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_region module -- Creates or removes regions from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -420,6 +420,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_region_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_rir_module.rst b/docs/plugins/netbox_rir_module.rst index a346175c1..d3c212885 100644 --- a/docs/plugins/netbox_rir_module.rst +++ b/docs/plugins/netbox_rir_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_rir module -- Create, update or delete RIRs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -425,6 +425,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_rir_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_route_target_module.rst b/docs/plugins/netbox_route_target_module.rst index 96222414d..f3a05067b 100644 --- a/docs/plugins/netbox_route_target_module.rst +++ b/docs/plugins/netbox_route_target_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_route_target module -- Creates or removes route targets fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -412,6 +412,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_route_target_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_service_module.rst b/docs/plugins/netbox_service_module.rst index 006952fca..85b701215 100644 --- a/docs/plugins/netbox_service_module.rst +++ b/docs/plugins/netbox_service_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_service module -- Creates or removes service from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -622,6 +622,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_service_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_service_template_module.rst b/docs/plugins/netbox_service_template_module.rst index 720b5d6d7..75f38c24b 100644 --- a/docs/plugins/netbox_service_template_module.rst +++ b/docs/plugins/netbox_service_template_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_service_template module -- Create, update or delete service .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -460,6 +460,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_service_template_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_site_group_module.rst b/docs/plugins/netbox_site_group_module.rst index 93fcae45c..237f4fa2f 100644 --- a/docs/plugins/netbox_site_group_module.rst +++ b/docs/plugins/netbox_site_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_site_group module -- Create, update, or delete site groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -417,6 +417,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_site_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_site_module.rst b/docs/plugins/netbox_site_module.rst index ede638e82..f74437c07 100644 --- a/docs/plugins/netbox_site_module.rst +++ b/docs/plugins/netbox_site_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_site module -- Creates or removes sites from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1000,6 +1000,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_site_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_tag_module.rst b/docs/plugins/netbox_tag_module.rst index 5784e8f96..b8dc792b5 100644 --- a/docs/plugins/netbox_tag_module.rst +++ b/docs/plugins/netbox_tag_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_tag module -- Creates or removes tags from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -278,6 +278,48 @@ Parameters Tag name + .. raw:: html + +
+ + * - .. raw:: html + +
+
+ + .. raw:: latex + + \hspace{0.02\textwidth}\begin{minipage}[t]{0.3\textwidth} + + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-data/object_types: + + .. rst-class:: ansible-option-title + + **object_types** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`list` / :ansible-option-elements:`elements=any` + + .. raw:: html + +
+ + .. raw:: latex + + \end{minipage} + + - .. raw:: html + +
+ + Objects types using the tag + + .. raw:: html
@@ -327,6 +369,40 @@ Parameters + * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_tag_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
@@ -567,6 +643,15 @@ Examples - mgmt - tun + - name: Restrict object types + netbox.netbox.netbox_tag: + netbox_url: http://netbox.local + netbox_token: thisIsMyToken + data: + name: "MyTag" + object_types: + - dcim.prefix + .. Facts diff --git a/docs/plugins/netbox_tenant_group_module.rst b/docs/plugins/netbox_tenant_group_module.rst index a87e62dfa..c017cbde8 100644 --- a/docs/plugins/netbox_tenant_group_module.rst +++ b/docs/plugins/netbox_tenant_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_tenant_group module -- Creates or removes tenant groups fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -415,6 +415,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_tenant_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_tenant_module.rst b/docs/plugins/netbox_tenant_module.rst index 959150eae..e6ffe339e 100644 --- a/docs/plugins/netbox_tenant_module.rst +++ b/docs/plugins/netbox_tenant_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_tenant module -- Creates or removes tenants from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -451,6 +451,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_tenant_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_token_module.rst b/docs/plugins/netbox_token_module.rst index fad31cb9e..9eb859d9b 100644 --- a/docs/plugins/netbox_token_module.rst +++ b/docs/plugins/netbox_token_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_token module -- Creates or removes tokens from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -375,6 +375,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_token_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_tunnel_group_module.rst b/docs/plugins/netbox_tunnel_group_module.rst index 324b954e3..4882b0494 100644 --- a/docs/plugins/netbox_tunnel_group_module.rst +++ b/docs/plugins/netbox_tunnel_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_tunnel_group module -- Create, update or delete tunnel grou .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -369,6 +369,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_tunnel_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_tunnel_module.rst b/docs/plugins/netbox_tunnel_module.rst index 0ddce6d3f..ce67c2a31 100644 --- a/docs/plugins/netbox_tunnel_module.rst +++ b/docs/plugins/netbox_tunnel_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_tunnel module -- Create, update or delete tunnels within Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -629,6 +629,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_tunnel_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_user_group_module.rst b/docs/plugins/netbox_user_group_module.rst index 54a152138..1c5ffce63 100644 --- a/docs/plugins/netbox_user_group_module.rst +++ b/docs/plugins/netbox_user_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_user_group module -- Creates or removes user groups from Ne .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -283,6 +283,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_user_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_user_module.rst b/docs/plugins/netbox_user_module.rst index 06fb79389..6d3d94fd4 100644 --- a/docs/plugins/netbox_user_module.rst +++ b/docs/plugins/netbox_user_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_user module -- Creates or removes users from NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -551,6 +551,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_user_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_virtual_chassis_module.rst b/docs/plugins/netbox_virtual_chassis_module.rst index 14148e8b9..694bcbb94 100644 --- a/docs/plugins/netbox_virtual_chassis_module.rst +++ b/docs/plugins/netbox_virtual_chassis_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_virtual_chassis module -- Create, update or delete virtual .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -457,6 +457,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_chassis_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_virtual_disk_module.rst b/docs/plugins/netbox_virtual_disk_module.rst index 8807c3394..4f15d10bc 100644 --- a/docs/plugins/netbox_virtual_disk_module.rst +++ b/docs/plugins/netbox_virtual_disk_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_virtual_disk module -- Creates or removes disks from virtua .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -409,6 +409,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_disk_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_virtual_machine_module.rst b/docs/plugins/netbox_virtual_machine_module.rst index d953f259e..461a2253d 100644 --- a/docs/plugins/netbox_virtual_machine_module.rst +++ b/docs/plugins/netbox_virtual_machine_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_virtual_machine module -- Create, update or delete virtual\ .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -1009,6 +1009,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
@@ -1343,17 +1377,17 @@ Common return values are documented :ref:`here `, the foll * - .. raw:: html
-
+
- .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__return-virtual machine: + .. _ansible_collections.netbox.netbox.netbox_virtual_machine_module__return-virtual_machine: .. rst-class:: ansible-option-title - **virtual machine** + **virtual_machine** .. raw:: html - + .. ansible-option-type-line:: diff --git a/docs/plugins/netbox_vlan_group_module.rst b/docs/plugins/netbox_vlan_group_module.rst index ff8a56055..03f3ba245 100644 --- a/docs/plugins/netbox_vlan_group_module.rst +++ b/docs/plugins/netbox_vlan_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_vlan_group module -- Create, update or delete vlans groups .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -660,6 +660,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_vlan_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_vlan_module.rst b/docs/plugins/netbox_vlan_module.rst index d375b1928..0b7dfb8aa 100644 --- a/docs/plugins/netbox_vlan_module.rst +++ b/docs/plugins/netbox_vlan_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_vlan module -- Create, update or delete vlans within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -622,6 +622,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_vlan_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_vm_interface_module.rst b/docs/plugins/netbox_vm_interface_module.rst index fb73c1208..20e678f04 100644 --- a/docs/plugins/netbox_vm_interface_module.rst +++ b/docs/plugins/netbox_vm_interface_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_vm_interface module -- Creates or removes interfaces from v .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -807,6 +807,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_vm_interface_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_vrf_module.rst b/docs/plugins/netbox_vrf_module.rst index ebc9158ca..f75fca61f 100644 --- a/docs/plugins/netbox_vrf_module.rst +++ b/docs/plugins/netbox_vrf_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_vrf module -- Create, update or delete vrfs within NetBox .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -594,6 +594,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_vrf_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_webhook_module.rst b/docs/plugins/netbox_webhook_module.rst index b090575b4..e9337d183 100644 --- a/docs/plugins/netbox_webhook_module.rst +++ b/docs/plugins/netbox_webhook_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_webhook module -- Creates, updates or deletes webhook confi .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -831,6 +831,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_webhook_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_wireless_lan_group_module.rst b/docs/plugins/netbox_wireless_lan_group_module.rst index edbfeb752..3ff6acb41 100644 --- a/docs/plugins/netbox_wireless_lan_group_module.rst +++ b/docs/plugins/netbox_wireless_lan_group_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_wireless_lan_group module -- Creates or removes Wireless LA .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -409,6 +409,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_group_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_wireless_lan_module.rst b/docs/plugins/netbox_wireless_lan_module.rst index deaecc04b..92b68243f 100644 --- a/docs/plugins/netbox_wireless_lan_module.rst +++ b/docs/plugins/netbox_wireless_lan_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_wireless_lan module -- Creates or removes Wireless LANs fro .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -641,6 +641,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_wireless_lan_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/docs/plugins/netbox_wireless_link_module.rst b/docs/plugins/netbox_wireless_link_module.rst index 7e875577c..5ec51d4de 100644 --- a/docs/plugins/netbox_wireless_link_module.rst +++ b/docs/plugins/netbox_wireless_link_module.rst @@ -6,7 +6,7 @@ :trim: .. meta:: - :antsibull-docs: 2.13.1 + :antsibull-docs: 2.16.2 .. Anchors @@ -22,7 +22,7 @@ netbox.netbox.netbox_wireless_link module -- Creates or removes Wireless links f .. Collection note .. note:: - This module is part of the `netbox.netbox collection `_ (version 3.21.0). + This module is part of the `netbox.netbox collection `_ (version 3.22.0). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -650,6 +650,40 @@ Parameters
+ * - .. raw:: html + +
+
+ + .. _ansible_collections.netbox.netbox.netbox_wireless_link_module__parameter-headers: + + .. rst-class:: ansible-option-title + + **headers** + + .. raw:: html + + + + .. ansible-option-type-line:: + + :ansible-option-type:`dictionary` + + .. raw:: html + +
+ + - .. raw:: html + +
+ + Dictionary of headers to be passed to the NetBox API. + + + .. raw:: html + +
+ * - .. raw:: html
diff --git a/galaxy.yml b/galaxy.yml index 3bc6ec1cb..6a1df5eae 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -10,7 +10,7 @@ namespace: netbox name: netbox # The version of the collection. Must be compatible with semantic versioning -version: 3.21.0 +version: 3.22.0 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md diff --git a/pyproject.toml b/pyproject.toml index 53a94876e..439223d19 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "netbox_ansible_modules" -version = "3.21.0" +version = "3.22.0" description = "Ansible collection to interact with NetBox's API" authors = ["Mikhail Yohman "] license = "GPLv3"