diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 5b07e800..6670c27e 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4,6 +4,35 @@ networktocode.nautobot Release Notes .. contents:: Topics +v5.0.0 +====== + +Release Summary +--------------- + +This release updates collection code for compatibility code with Nautobot 2.0, where API has breaking changes. + +Breaking Changes / Porting Guide +-------------------------------- + +- (#234) Updates for Nautobot 2.0 Compatibility + +New Modules +----------- + +- networktocode.nautobot.ip_address_to_interface - Creates or removes associations between IP and interface. +- networktocode.nautobot.role - Creates or removes a role. + +Removed Modules +----------- + +- networktocode.nautobot.site - Removed as locations replace sites and regions. +- networktocode.nautobot.region - Removed as locations replace sites and regions. +- networktocode.nautobot.device_role - Removed as roles changes into generic type with content_types. +- networktocode.nautobot.ipam_role - Removed as roles changes into generic type with content_types. +- networktocode.nautobot.rack_role - Removed as roles changes into generic type with content_types. +- networktocode.nautobot.aggregate - Model removed in 2.0. + v4.4.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index ab25b2eb..ace1a600 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -385,3 +385,16 @@ releases: - (#220) Adds status option to device_interface module - (#217) Fixes and enables testing for Nautobot 1.5 release_summary: "Fixes error handling in inventory to not erase inventories, minor bug fixes, and introduces Plugin module" + 5.0.0: + changes: + breaking_changes: + - (#234) Updates for Nautobot 2.0 Compatibility + release_summary: "This release updates collection code for compatibility code with Nautobot 2.0, where API has breaking changes. +" + modules: + - description: Creates or removes associations between IP and interface. + name: ip_address_to_interface + namespace: "" + - description: Creates or removes a role. Collapsed from several role modules in DCIM and IPAM. + name: role + namespace: "" diff --git a/docs/plugins/cable_module.rst b/docs/plugins/cable_module.rst index 1d57295f..7e46182e 100644 --- a/docs/plugins/cable_module.rst +++ b/docs/plugins/cable_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cable module -- Create, update or delete cables within Na .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/circuit_module.rst b/docs/plugins/circuit_module.rst index a1bde413..ed7c9a69 100644 --- a/docs/plugins/circuit_module.rst +++ b/docs/plugins/circuit_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit module -- Create, update or delete circuits withi .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/circuit_termination_module.rst b/docs/plugins/circuit_termination_module.rst index a75145b2..831bd8c3 100644 --- a/docs/plugins/circuit_termination_module.rst +++ b/docs/plugins/circuit_termination_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit_termination module -- Create, update or delete ci .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/circuit_type_module.rst b/docs/plugins/circuit_type_module.rst index b619c66d..d3f13dfb 100644 --- a/docs/plugins/circuit_type_module.rst +++ b/docs/plugins/circuit_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.circuit_type module -- Create, update or delete circuit t .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/cluster_group_module.rst b/docs/plugins/cluster_group_module.rst index dfe3c44a..86851cce 100644 --- a/docs/plugins/cluster_group_module.rst +++ b/docs/plugins/cluster_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster_group module -- Create, update or delete cluster .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/cluster_module.rst b/docs/plugins/cluster_module.rst index 3c0c8d2a..1326f234 100644 --- a/docs/plugins/cluster_module.rst +++ b/docs/plugins/cluster_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster module -- Create, update or delete clusters withi .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/cluster_type_module.rst b/docs/plugins/cluster_type_module.rst index fa667035..d4ca6674 100644 --- a/docs/plugins/cluster_type_module.rst +++ b/docs/plugins/cluster_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.cluster_type module -- Create, update or delete cluster t .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/console_port_module.rst b/docs/plugins/console_port_module.rst index cfe93fdf..68e3c2f2 100644 --- a/docs/plugins/console_port_module.rst +++ b/docs/plugins/console_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_port module -- Create, update or delete console p .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/console_port_template_module.rst b/docs/plugins/console_port_template_module.rst index b2c8f628..0b857a85 100644 --- a/docs/plugins/console_port_template_module.rst +++ b/docs/plugins/console_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_port_template module -- Create, update or delete .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/console_server_port_module.rst b/docs/plugins/console_server_port_module.rst index bae29bd2..4f7d9514 100644 --- a/docs/plugins/console_server_port_module.rst +++ b/docs/plugins/console_server_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port module -- Create, update or delete co .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/console_server_port_template_module.rst b/docs/plugins/console_server_port_template_module.rst index 919541ca..e45b7d43 100644 --- a/docs/plugins/console_server_port_template_module.rst +++ b/docs/plugins/console_server_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port_template module -- Create, update or .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_bay_module.rst b/docs/plugins/device_bay_module.rst index ea205f2a..c2a5051e 100644 --- a/docs/plugins/device_bay_module.rst +++ b/docs/plugins/device_bay_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_bay module -- Create, update or delete device bays .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_bay_template_module.rst b/docs/plugins/device_bay_template_module.rst index 0ae73b6b..49b25faf 100644 --- a/docs/plugins/device_bay_template_module.rst +++ b/docs/plugins/device_bay_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_bay_template module -- Create, update or delete de .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_interface_module.rst b/docs/plugins/device_interface_module.rst index b506aa10..876ba4ac 100644 --- a/docs/plugins/device_interface_module.rst +++ b/docs/plugins/device_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_interface module -- Creates or removes interfaces .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_interface_template_module.rst b/docs/plugins/device_interface_template_module.rst index d0356382..3bab2bae 100644 --- a/docs/plugins/device_interface_template_module.rst +++ b/docs/plugins/device_interface_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_interface_template module -- Creates or removes in .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst index 5426d847..c89d8e54 100644 --- a/docs/plugins/device_module.rst +++ b/docs/plugins/device_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device module -- Create, update or delete devices within .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst index 8cefa7f7..f8d51006 100644 --- a/docs/plugins/device_type_module.rst +++ b/docs/plugins/device_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.device_type module -- Create, update or delete device typ .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/front_port_module.rst b/docs/plugins/front_port_module.rst index f9e2712d..bd43837b 100644 --- a/docs/plugins/front_port_module.rst +++ b/docs/plugins/front_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.front_port module -- Create, update or delete front ports .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/front_port_template_module.rst b/docs/plugins/front_port_template_module.rst index d99b01d9..37b625b9 100644 --- a/docs/plugins/front_port_template_module.rst +++ b/docs/plugins/front_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.front_port_template module -- Create, update or delete fr .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/gql_inventory_inventory.rst b/docs/plugins/gql_inventory_inventory.rst index 097b5cd0..dd61ff85 100644 --- a/docs/plugins/gql_inventory_inventory.rst +++ b/docs/plugins/gql_inventory_inventory.rst @@ -42,7 +42,7 @@ networktocode.nautobot.gql_inventory inventory -- Nautobot inventory source usin .. Collection note .. note:: - This inventory plugin is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this inventory plugin, diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index c62bac6f..672e3c0a 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -6,7 +6,7 @@ Networktocode.Nautobot ====================== -Collection version 4.5.0 +Collection version 5.0.0 .. contents:: :local: diff --git a/docs/plugins/inventory_inventory.rst b/docs/plugins/inventory_inventory.rst index abc4b239..46b1402e 100644 --- a/docs/plugins/inventory_inventory.rst +++ b/docs/plugins/inventory_inventory.rst @@ -42,7 +42,7 @@ networktocode.nautobot.inventory inventory -- Nautobot inventory source .. Collection note .. note:: - This inventory plugin is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This inventory plugin is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. diff --git a/docs/plugins/inventory_item_module.rst b/docs/plugins/inventory_item_module.rst index 02d0dba7..c2fac475 100644 --- a/docs/plugins/inventory_item_module.rst +++ b/docs/plugins/inventory_item_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.inventory_item module -- Creates or removes inventory ite .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/ip_address_module.rst b/docs/plugins/ip_address_module.rst index cfeecf89..6bc6f6e1 100644 --- a/docs/plugins/ip_address_module.rst +++ b/docs/plugins/ip_address_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.ip_address module -- Creates or removes IP addresses from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/ip_address_to_interface_module.rst b/docs/plugins/ip_address_to_interface_module.rst index c89fd1e5..fa141e00 100644 --- a/docs/plugins/ip_address_to_interface_module.rst +++ b/docs/plugins/ip_address_to_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.ip_address_to_interface module -- Creates or removes IP a .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -54,7 +54,7 @@ networktocode.nautobot.ip_address_to_interface module -- Creates or removes IP a .. rst-class:: ansible-version-added -New in networktocode.nautobot 1.0.0 +New in networktocode.nautobot 5.0.0 .. contents:: :local: diff --git a/docs/plugins/location_module.rst b/docs/plugins/location_module.rst index f48cb300..d1436159 100644 --- a/docs/plugins/location_module.rst +++ b/docs/plugins/location_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.location module -- Creates or removes locations from Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/location_type_module.rst b/docs/plugins/location_type_module.rst index e209a5d4..7bb6ff5c 100644 --- a/docs/plugins/location_type_module.rst +++ b/docs/plugins/location_type_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.location_type module -- Creates or removes location types .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/lookup_graphql_lookup.rst b/docs/plugins/lookup_graphql_lookup.rst index 28db38c1..a2c3c046 100644 --- a/docs/plugins/lookup_graphql_lookup.rst +++ b/docs/plugins/lookup_graphql_lookup.rst @@ -42,7 +42,7 @@ networktocode.nautobot.lookup_graphql lookup -- Queries and returns elements fro .. Collection note .. note:: - This lookup plugin is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this lookup plugin, diff --git a/docs/plugins/lookup_lookup.rst b/docs/plugins/lookup_lookup.rst index 23889c0f..634946ee 100644 --- a/docs/plugins/lookup_lookup.rst +++ b/docs/plugins/lookup_lookup.rst @@ -42,7 +42,7 @@ networktocode.nautobot.lookup lookup -- Queries and returns elements from Nautob .. Collection note .. note:: - This lookup plugin is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This lookup plugin is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this lookup plugin, diff --git a/docs/plugins/manufacturer_module.rst b/docs/plugins/manufacturer_module.rst index 674d4924..7f46cc0d 100644 --- a/docs/plugins/manufacturer_module.rst +++ b/docs/plugins/manufacturer_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.manufacturer module -- Create or delete manufacturers wit .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/nautobot_server_module.rst b/docs/plugins/nautobot_server_module.rst index 9e257f24..0654b821 100644 --- a/docs/plugins/nautobot_server_module.rst +++ b/docs/plugins/nautobot_server_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.nautobot_server module -- Manages Nautobot Server applica .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/platform_module.rst b/docs/plugins/platform_module.rst index 34ec91ed..525da460 100644 --- a/docs/plugins/platform_module.rst +++ b/docs/plugins/platform_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.platform module -- Create or delete platforms within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/plugin_module.rst b/docs/plugins/plugin_module.rst index 1416d4fd..6d85afd4 100644 --- a/docs/plugins/plugin_module.rst +++ b/docs/plugins/plugin_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.plugin module -- CRUD operation on plugin objects .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_feed_module.rst b/docs/plugins/power_feed_module.rst index 25b1a151..899f435e 100644 --- a/docs/plugins/power_feed_module.rst +++ b/docs/plugins/power_feed_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_feed module -- Create, update or delete power feeds .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_outlet_module.rst b/docs/plugins/power_outlet_module.rst index 8dced2d3..15437abe 100644 --- a/docs/plugins/power_outlet_module.rst +++ b/docs/plugins/power_outlet_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_outlet module -- Create, update or delete power out .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_outlet_template_module.rst b/docs/plugins/power_outlet_template_module.rst index 4673f1e3..65a5c1fd 100644 --- a/docs/plugins/power_outlet_template_module.rst +++ b/docs/plugins/power_outlet_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_outlet_template module -- Create, update or delete .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_panel_module.rst b/docs/plugins/power_panel_module.rst index 4467e84b..cb34ea44 100644 --- a/docs/plugins/power_panel_module.rst +++ b/docs/plugins/power_panel_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_panel module -- Create, update or delete power pane .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_port_module.rst b/docs/plugins/power_port_module.rst index 3cf25bed..05799e83 100644 --- a/docs/plugins/power_port_module.rst +++ b/docs/plugins/power_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_port module -- Create, update or delete power ports .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/power_port_template_module.rst b/docs/plugins/power_port_template_module.rst index b45f6743..c62bacb6 100644 --- a/docs/plugins/power_port_template_module.rst +++ b/docs/plugins/power_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.power_port_template module -- Create, update or delete po .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/prefix_module.rst b/docs/plugins/prefix_module.rst index f73156e3..ff3f29a4 100644 --- a/docs/plugins/prefix_module.rst +++ b/docs/plugins/prefix_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.prefix module -- Creates or removes prefixes from Nautobo .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/provider_module.rst b/docs/plugins/provider_module.rst index 26acca19..259b0ca4 100644 --- a/docs/plugins/provider_module.rst +++ b/docs/plugins/provider_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.provider module -- Create, update or delete providers wit .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/query_graphql_module.rst b/docs/plugins/query_graphql_module.rst index f0d4495e..dac023fe 100644 --- a/docs/plugins/query_graphql_module.rst +++ b/docs/plugins/query_graphql_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.query_graphql module -- Queries and returns elements from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rack_group_module.rst b/docs/plugins/rack_group_module.rst index d5753a64..dd1f8967 100644 --- a/docs/plugins/rack_group_module.rst +++ b/docs/plugins/rack_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rack_group module -- Create, update or delete racks group .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rack_module.rst b/docs/plugins/rack_module.rst index dcab06e2..86c0bda9 100644 --- a/docs/plugins/rack_module.rst +++ b/docs/plugins/rack_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rack module -- Create, update or delete racks within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rear_port_module.rst b/docs/plugins/rear_port_module.rst index dce7165b..ad14a2b6 100644 --- a/docs/plugins/rear_port_module.rst +++ b/docs/plugins/rear_port_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rear_port module -- Create, update or delete rear ports w .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rear_port_template_module.rst b/docs/plugins/rear_port_template_module.rst index 4d954778..8791873d 100644 --- a/docs/plugins/rear_port_template_module.rst +++ b/docs/plugins/rear_port_template_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rear_port_template module -- Create, update or delete rea .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/relationship_association_module.rst b/docs/plugins/relationship_association_module.rst index d6e274ae..9c4b01aa 100644 --- a/docs/plugins/relationship_association_module.rst +++ b/docs/plugins/relationship_association_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.relationship_association module -- Creates or removes a r .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/rir_module.rst b/docs/plugins/rir_module.rst index 8d5506bb..f1eeffcf 100644 --- a/docs/plugins/rir_module.rst +++ b/docs/plugins/rir_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.rir module -- Create, update or delete RIRs within Nautob .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/role_module.rst b/docs/plugins/role_module.rst index 3f324cb4..33a82b5e 100644 --- a/docs/plugins/role_module.rst +++ b/docs/plugins/role_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.role module -- Create, update or delete roles within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, @@ -54,7 +54,7 @@ networktocode.nautobot.role module -- Create, update or delete roles within Naut .. rst-class:: ansible-version-added -New in networktocode.nautobot 1.0.0 +New in networktocode.nautobot 5.0.0 .. contents:: :local: @@ -160,7 +160,7 @@ Parameters :ansible-option-type:`string` - :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0` + :ansible-option-versionadded:`added in networktocode.nautobot 5.0.0` .. raw:: html @@ -234,7 +234,7 @@ Parameters :ansible-option-type:`string` - :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0` + :ansible-option-versionadded:`added in networktocode.nautobot 5.0.0` .. raw:: html @@ -245,7 +245,7 @@ Parameters
- The description of the device role + The description of the role .. raw:: html @@ -271,7 +271,7 @@ Parameters :ansible-option-type:`string` / :ansible-option-required:`required` - :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0` + :ansible-option-versionadded:`added in networktocode.nautobot 5.0.0` .. raw:: html @@ -282,7 +282,7 @@ Parameters
- The name of the device role + The name of the role .. raw:: html @@ -545,21 +545,21 @@ Examples gather_facts: False tasks: - - name: Create device role within Nautobot with only required information + - name: Create role within Nautobot with only required information networktocode.nautobot.role: url: http://nautobot.local token: thisIsMyToken - name: Test device role + name: Test role color: FFFFFF content_types: - "dcim.device" state: present - - name: Delete device role within nautobot + - name: Delete role within nautobot networktocode.nautobot.role: url: http://nautobot.local token: thisIsMyToken - name: Test device role + name: Test role state: absent diff --git a/docs/plugins/route_target_module.rst b/docs/plugins/route_target_module.rst index eb2fa1b7..4913c3e1 100644 --- a/docs/plugins/route_target_module.rst +++ b/docs/plugins/route_target_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.route_target module -- Creates or removes route targets f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/service_module.rst b/docs/plugins/service_module.rst index a81dbddf..473c50f6 100644 --- a/docs/plugins/service_module.rst +++ b/docs/plugins/service_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.service module -- Creates or removes service from Nautobo .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/status_module.rst b/docs/plugins/status_module.rst index 8aaca791..28677753 100644 --- a/docs/plugins/status_module.rst +++ b/docs/plugins/status_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.status module -- Creates or removes status from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst index 80cd44c9..4e068e18 100644 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tag module -- Creates or removes tags from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/tenant_group_module.rst b/docs/plugins/tenant_group_module.rst index 10a7d9df..ade4e730 100644 --- a/docs/plugins/tenant_group_module.rst +++ b/docs/plugins/tenant_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tenant_group module -- Creates or removes tenant groups f .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/tenant_module.rst b/docs/plugins/tenant_module.rst index a7c32e0a..4fc0e7f1 100644 --- a/docs/plugins/tenant_module.rst +++ b/docs/plugins/tenant_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.tenant module -- Creates or removes tenants from Nautobot .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/virtual_chassis_module.rst b/docs/plugins/virtual_chassis_module.rst index 8bdd27a4..0a2b69dc 100644 --- a/docs/plugins/virtual_chassis_module.rst +++ b/docs/plugins/virtual_chassis_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.virtual_chassis module -- Create, update or delete virtua .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/virtual_machine_module.rst b/docs/plugins/virtual_machine_module.rst index c2b33641..ba608977 100644 --- a/docs/plugins/virtual_machine_module.rst +++ b/docs/plugins/virtual_machine_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.virtual_machine module -- Create, update or delete virtua .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/vlan_group_module.rst b/docs/plugins/vlan_group_module.rst index 529b46d0..a97f0bce 100644 --- a/docs/plugins/vlan_group_module.rst +++ b/docs/plugins/vlan_group_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vlan_group module -- Create, update or delete vlans group .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst index ade840d0..feeaaab0 100644 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vlan module -- Create, update or delete vlans within Naut .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/vm_interface_module.rst b/docs/plugins/vm_interface_module.rst index 55ad4fba..93cfd9e0 100644 --- a/docs/plugins/vm_interface_module.rst +++ b/docs/plugins/vm_interface_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vm_interface module -- Creates or removes interfaces from .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst index 0cf2f811..4dd8934e 100644 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_module.rst @@ -42,7 +42,7 @@ networktocode.nautobot.vrf module -- Create, update or delete vrfs within Nautob .. Collection note .. note:: - This module is part of the `networktocode.nautobot collection `_ (version 4.5.0). + This module is part of the `networktocode.nautobot collection `_ (version 5.0.0). To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`. You need further requirements to be able to use this module, diff --git a/galaxy.yml b/galaxy.yml index 82a4d5b9..4829244a 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ namespace: networktocode name: nautobot # The version of the collection. Must be compatible with semantic versioning -version: 4.5.0 +version: 5.0.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/plugins/modules/ip_address_to_interface.py b/plugins/modules/ip_address_to_interface.py index 9125c834..b44df9a1 100644 --- a/plugins/modules/ip_address_to_interface.py +++ b/plugins/modules/ip_address_to_interface.py @@ -19,7 +19,7 @@ author: - Mikhail Yohman (@FragmentedPacket) - Anthony Ruhier (@Anthony25) -version_added: "1.0.0" +version_added: "5.0.0" extends_documentation_fragment: - networktocode.nautobot.fragments.base options: diff --git a/plugins/modules/role.py b/plugins/modules/role.py index 99720fbf..30ba2f91 100644 --- a/plugins/modules/role.py +++ b/plugins/modules/role.py @@ -18,28 +18,28 @@ - This should be ran with connection C(local) and hosts C(localhost) author: - Mikhail Yohman (@FragmentedPacket) -version_added: "1.0.0" +version_added: "5.0.0" extends_documentation_fragment: - networktocode.nautobot.fragments.base options: name: description: - - The name of the device role + - The name of the role required: true type: str - version_added: "3.0.0" + version_added: "5.0.0" description: description: - - The description of the device role + - The description of the role required: false type: str - version_added: "3.0.0" + version_added: "5.0.0" color: description: - Hexidecimal code for a color, ex. FFFFFF required: false type: str - version_added: "3.0.0" + version_added: "5.0.0" content_types: description: - Model names which the role can be related to. @@ -60,21 +60,21 @@ gather_facts: False tasks: - - name: Create device role within Nautobot with only required information + - name: Create role within Nautobot with only required information networktocode.nautobot.role: url: http://nautobot.local token: thisIsMyToken - name: Test device role + name: Test role color: FFFFFF content_types: - "dcim.device" state: present - - name: Delete device role within nautobot + - name: Delete role within nautobot networktocode.nautobot.role: url: http://nautobot.local token: thisIsMyToken - name: Test device role + name: Test role state: absent """ diff --git a/pyproject.toml b/pyproject.toml index 0972b396..789700b7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "nautobot_ansible_modules" -version = "4.5.0" +version = "5.0.0" description = "Ansible collection to interact with Nautobot's API" authors = ["Network to Code