From 26c2ba474bd2d87fb7dee58b2e8ddd764981ac78 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 09:30:09 -0500 Subject: [PATCH 1/6] Adds a start of adding some more about the modules. --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f125ffe7..dc023da0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) -# Nautobot modules for Ansible using Ansible Collections +# Nautobot Modules for Ansible using Ansible Collections + +This collection provides Ansible modules to interact with Nautobot, an open-source Network Source of Truth and Network Automation Platform. The modules allow you to automate various tasks in Nautobot, such as managing devices, interfaces, IP addresses, and more. To keep the code simple, we only officially support the two latest releases of Nautobot and don't guarantee backwards compatibility beyond that. @@ -8,13 +10,32 @@ To keep the code simple, we only officially support the two latest releases of N - Nautobot 1.0.0+ or the two latest Nautobot releases - Python 3.6+ -- Python modules: **pynautobot 1.0.0+** +- Python modules: **pynautobot 1.0.0+** for Nautobot 1.x. For Nautobot 2.x please be using **pyantubot 2.x** - Ansible 2.9+ -- Nautobot write-enabled token when using modules or read-only token for `lookup/inventory` +- Nautobot write-enabled token when using modules or read-only token for `lookup/inventory` modules We have a new docs site live that can be found [here](https://nautobot-ansible.readthedocs.io/en/latest/). -> This is a fork of the netbox.netbox Ansible Galaxy collection found at [https://github.com/netbox-community/ansible_modules](https://github.com/netbox-community/ansible_modules) in February, 2021 +## Available Modules + +Here is a list of available modules along with a brief description of each: + +- **nautobot_device**: Manage devices in Nautobot. +- **nautobot_device_role**: Manage device roles in Nautobot. +- **nautobot_device_type**: Manage device types in Nautobot. +- **nautobot_interface**: Manage interfaces on devices in Nautobot. +- **nautobot_ip_address**: Manage IP addresses in Nautobot. +- **nautobot_site**: Manage sites in Nautobot. +- **nautobot_tenant**: Manage tenants in Nautobot. +- **nautobot_vlan**: Manage VLANs in Nautobot. +- **nautobot_virtual_machine**: Manage virtual machines in Nautobot. +- **nautobot_virtualization_cluster**: Manage virtualization clusters in Nautobot. +- **nautobot_cable**: Manage cables in Nautobot. +- **nautobot_circuit**: Manage circuits in Nautobot. +- **nautobot_power_feed**: Manage power feeds in Nautobot. +- **nautobot_rack**: Manage racks in Nautobot. +- **nautobot_rack_group**: Manage rack groups in Nautobot. +- **nautobot_inventory_item**: Manage inventory items in Nautobot. ## Releasing, Versioning, and Deprecation @@ -24,6 +45,8 @@ We plan to regularly release new minor or bugfix versions once new features or b Releasing the current major version happens from the `develop` branch with a release. -If backwards incompatible changes are able, we plan to deprecate the old behavior as early as possible. We also plan to backport at least bugfixes for the old major version for some time after releasing a new major version. We will not block community members from backporting other bugfixes and features from the latest stable version to older release branches, under the condition that these backports are of reasonable quality. Some changes may not be able to be back ported. +If backwards incompatible changes are necessary, we plan to deprecate the old behavior as early as possible. We also plan to backport at least bugfixes for the old major version for some time after releasing a new major version. We will not block community members from backporting other bugfixes and features from the latest stable version to older release branches, under the condition that these backports are of reasonable quality. Some changes may not be able to be backported. + +> Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible. -> Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible. \ No newline at end of file +> This is a fork of the netbox.netbox Ansible Galaxy collection found at [https://github.com/netbox-community/ansible_modules](https://github.com/netbox-community/ansible_modules) in February, 2021 \ No newline at end of file From 4e1f368411aacf664bb7fe7781ff42420371d944 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 09:49:50 -0500 Subject: [PATCH 2/6] Updates commentary. --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dc023da0..61e475a4 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # Nautobot Modules for Ansible using Ansible Collections -This collection provides Ansible modules to interact with Nautobot, an open-source Network Source of Truth and Network Automation Platform. The modules allow you to automate various tasks in Nautobot, such as managing devices, interfaces, IP addresses, and more. +This collection provides Ansible modules to interact with Nautobot, an open-source Network Source of Truth and Network Automation Platform. The modules allow you to automate various tasks in Nautobot, such as managing devices, interfaces, IP addresses, and more. By using these modules, you can keep your Source of Truth (SOT) updated and ensure that your network data is accurate and consistent. To keep the code simple, we only officially support the two latest releases of Nautobot and don't guarantee backwards compatibility beyond that. @@ -10,12 +10,25 @@ To keep the code simple, we only officially support the two latest releases of N - Nautobot 1.0.0+ or the two latest Nautobot releases - Python 3.6+ -- Python modules: **pynautobot 1.0.0+** for Nautobot 1.x. For Nautobot 2.x please be using **pyantubot 2.x** +- Python modules: **pynautobot 1.0.0+**, for Nautobot 2.x use **pynautobot 2.x** - Ansible 2.9+ -- Nautobot write-enabled token when using modules or read-only token for `lookup/inventory` modules +- Nautobot write-enabled token when using modules or read-only token for `lookup/inventory` We have a new docs site live that can be found [here](https://nautobot-ansible.readthedocs.io/en/latest/). +## Keeping Your Source of Truth Updated + +Using the Nautobot Ansible modules, you can ensure that your Nautobot instance remains the authoritative Source of Truth (SOT) for your network. These modules allow for the automation of data input and updates, helping maintain consistency and accuracy across your network configuration and documentation. Whether you are provisioning new devices, updating interface configurations, or managing IP addresses, the Nautobot modules for Ansible provide the tools necessary to automate and streamline these tasks. + +## Interacting with the Nautobot Platform + +The modules in this collection enable seamless interaction with the Nautobot platform. With these modules, you can: + +- Automate the provisioning and deprovisioning of network resources. +- Integrate Nautobot with your CI/CD pipelines to ensure up-to-date network configurations. +- Leverage Nautobot's API to gather real-time data for network monitoring and troubleshooting. +- Implement Infrastructure as Code (IaC) practices by managing Nautobot resources declaratively through Ansible playbooks. + ## Available Modules Here is a list of available modules along with a brief description of each: From 8713296efd8974760cb299a11bdecd63ece116d9 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 13:49:58 -0500 Subject: [PATCH 3/6] Update README.md Co-authored-by: Joe Wesch <10467633+joewesch@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 61e475a4..317d6ccb 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ To keep the code simple, we only officially support the two latest releases of N - Nautobot 1.0.0+ or the two latest Nautobot releases - Python 3.6+ -- Python modules: **pynautobot 1.0.0+**, for Nautobot 2.x use **pynautobot 2.x** +- Python modules: **pynautobot 2.x+** - Ansible 2.9+ - Nautobot write-enabled token when using modules or read-only token for `lookup/inventory` From 4c5ec34aaaa577a50c1efeb9c5811a6cd122a537 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 13:50:07 -0500 Subject: [PATCH 4/6] Update README.md Co-authored-by: Joe Wesch <10467633+joewesch@users.noreply.github.com> --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 317d6ccb..b8a07e4f 100644 --- a/README.md +++ b/README.md @@ -62,4 +62,6 @@ If backwards incompatible changes are necessary, we plan to deprecate the old be > Some changes that would require immediate patching that are breaking changes will fall to SemVer and constitute a breaking change. These will only be done when necessary, such as to support working with the most recent 3 versions of Ansible. Backporting these changes may not be possible. +## History + > This is a fork of the netbox.netbox Ansible Galaxy collection found at [https://github.com/netbox-community/ansible_modules](https://github.com/netbox-community/ansible_modules) in February, 2021 \ No newline at end of file From c0cd2ec77472ecd82deeccdd52df179d3e187a24 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 14:01:14 -0500 Subject: [PATCH 5/6] Minor upates. --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index b8a07e4f..7798d57b 100644 --- a/README.md +++ b/README.md @@ -33,22 +33,22 @@ The modules in this collection enable seamless interaction with the Nautobot pla Here is a list of available modules along with a brief description of each: -- **nautobot_device**: Manage devices in Nautobot. -- **nautobot_device_role**: Manage device roles in Nautobot. -- **nautobot_device_type**: Manage device types in Nautobot. -- **nautobot_interface**: Manage interfaces on devices in Nautobot. -- **nautobot_ip_address**: Manage IP addresses in Nautobot. -- **nautobot_site**: Manage sites in Nautobot. -- **nautobot_tenant**: Manage tenants in Nautobot. -- **nautobot_vlan**: Manage VLANs in Nautobot. -- **nautobot_virtual_machine**: Manage virtual machines in Nautobot. -- **nautobot_virtualization_cluster**: Manage virtualization clusters in Nautobot. -- **nautobot_cable**: Manage cables in Nautobot. -- **nautobot_circuit**: Manage circuits in Nautobot. -- **nautobot_power_feed**: Manage power feeds in Nautobot. -- **nautobot_rack**: Manage racks in Nautobot. -- **nautobot_rack_group**: Manage rack groups in Nautobot. -- **nautobot_inventory_item**: Manage inventory items in Nautobot. +- **nautobot.device**: Manage devices in Nautobot. +- **nautobot.device_role**: Manage device roles in Nautobot. +- **nautobot.device_type**: Manage device types in Nautobot. +- **nautobot.interface**: Manage interfaces on devices in Nautobot. +- **nautobot.ip_address**: Manage IP addresses in Nautobot. +- **nautobot.site**: Manage sites in Nautobot. +- **nautobot.tenant**: Manage tenants in Nautobot. +- **nautobot.vlan**: Manage VLANs in Nautobot. +- **nautobot.virtual_machine**: Manage virtual machines in Nautobot. +- **nautobot.virtualization_cluster**: Manage virtualization clusters in Nautobot. +- **nautobot.cable**: Manage cables in Nautobot. +- **nautobot.circuit**: Manage circuits in Nautobot. +- **nautobot.power_feed**: Manage power feeds in Nautobot. +- **nautobot.rack**: Manage racks in Nautobot. +- **nautobot.rack_group**: Manage rack groups in Nautobot. +- **nautobot.inventory_item**: Manage inventory items in Nautobot. ## Releasing, Versioning, and Deprecation From 245f433a8ee413be188d498019b708b6f9d48174 Mon Sep 17 00:00:00 2001 From: Josh VanDeraa Date: Mon, 15 Jul 2024 14:01:59 -0500 Subject: [PATCH 6/6] Tweaks. --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 7798d57b..08927e6a 100644 --- a/README.md +++ b/README.md @@ -33,22 +33,22 @@ The modules in this collection enable seamless interaction with the Nautobot pla Here is a list of available modules along with a brief description of each: -- **nautobot.device**: Manage devices in Nautobot. -- **nautobot.device_role**: Manage device roles in Nautobot. -- **nautobot.device_type**: Manage device types in Nautobot. -- **nautobot.interface**: Manage interfaces on devices in Nautobot. -- **nautobot.ip_address**: Manage IP addresses in Nautobot. -- **nautobot.site**: Manage sites in Nautobot. -- **nautobot.tenant**: Manage tenants in Nautobot. -- **nautobot.vlan**: Manage VLANs in Nautobot. -- **nautobot.virtual_machine**: Manage virtual machines in Nautobot. -- **nautobot.virtualization_cluster**: Manage virtualization clusters in Nautobot. -- **nautobot.cable**: Manage cables in Nautobot. -- **nautobot.circuit**: Manage circuits in Nautobot. -- **nautobot.power_feed**: Manage power feeds in Nautobot. -- **nautobot.rack**: Manage racks in Nautobot. -- **nautobot.rack_group**: Manage rack groups in Nautobot. -- **nautobot.inventory_item**: Manage inventory items in Nautobot. +- **networktocode.nautobot.device**: Manage devices in Nautobot. +- **networktocode.nautobot.device_role**: Manage device roles in Nautobot. +- **networktocode.nautobot.device_type**: Manage device types in Nautobot. +- **networktocode.nautobot.interface**: Manage interfaces on devices in Nautobot. +- **networktocode.nautobot.ip_address**: Manage IP addresses in Nautobot. +- **networktocode.nautobot.site**: Manage sites in Nautobot. +- **networktocode.nautobot.tenant**: Manage tenants in Nautobot. +- **networktocode.nautobot.vlan**: Manage VLANs in Nautobot. +- **networktocode.nautobot.virtual_machine**: Manage virtual machines in Nautobot. +- **networktocode.nautobot.virtualization_cluster**: Manage virtualization clusters in Nautobot. +- **networktocode.nautobot.cable**: Manage cables in Nautobot. +- **networktocode.nautobot.circuit**: Manage circuits in Nautobot. +- **networktocode.nautobot.power_feed**: Manage power feeds in Nautobot. +- **networktocode.nautobot.rack**: Manage racks in Nautobot. +- **networktocode.nautobot.rack_group**: Manage rack groups in Nautobot. +- **networktocode.nautobot.inventory_item**: Manage inventory items in Nautobot. ## Releasing, Versioning, and Deprecation