summaryrefslogtreecommitdiffstats
path: root/ansible_collections/netbox/netbox/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/netbox/netbox/README.md')
-rw-r--r--ansible_collections/netbox/netbox/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/ansible_collections/netbox/netbox/README.md b/ansible_collections/netbox/netbox/README.md
new file mode 100644
index 000000000..c5869cf23
--- /dev/null
+++ b/ansible_collections/netbox/netbox/README.md
@@ -0,0 +1,29 @@
+![Devel CI Status](https://github.com/netbox-community/ansible_modules/workflows/All%20CI%20related%20tasks/badge.svg?branch=devel)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+![Release](https://img.shields.io/github/v/release/netbox-community/ansible_modules)
+[![Talk to us: Slack](https://img.shields.io/badge/Slack-blue.svg)](https://netdev-community.slack.com/join/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ#/shared-invite/email)
+
+# NetBox modules for Ansible using Ansible Collections
+
+We have moved this collection to a different namespace and collection name on Ansible Galaxy. The new versions will be at `netbox.netbox`.
+
+To keep the code simple, we only officially support the two latest releases of NetBox and don't guarantee backwards compatibility beyond that. We do try and keep these breaking changes to a minimum, but sometimes changes to NetBox's API cause us to have to make breaking changes.
+
+## Requirements
+
+- The two latest NetBox releases
+- Python 3.8+
+- Python modules:
+ - `pytz`
+ - `pynetbox`
+ - `packaging` if using Ansible < 2.10, as it's included in Ansible 2.10+
+- Ansible 2.12+
+- NetBox write-enabled token when using modules or read-only token for `nb_lookup/nb_inventory`
+
+## Docs
+
+Module documentation exists on [netbox-ansible-collection.readthedocs.io](https://netbox-ansible-collection.readthedocs.io/en/latest/).
+
+## Join the discussion
+
+We have a dedicated Slack channel `#ansible` on [netdev-community.slack.com](https://netdev-community.slack.com/join/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ#/shared-invite/email)