Skip to content

Commit 9584659

Browse files
authored
Add example of using as inventory in README (#291)
1 parent 9403a08 commit 9584659

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,23 @@ To keep the code simple, we only officially support the two latest releases of N
8686
- `ansible-galaxy collection install netbox-netbox-X.X.X.tar.gz`
8787
- Can add `-p` to provide a different path other than the default path, but it must be within your `ansible.cfg` or provided via an environment variable.
8888

89+
### Example inventory
90+
91+
```yaml
92+
plugin: netbox.netbox.nb_inventory
93+
api_endpoint: http://netbox-demo.org:32768
94+
token: 0123456789abcdef0123456789abcdef01234567
95+
config_context: True
96+
interfaces: True
97+
group_by:
98+
- device_roles
99+
100+
compose:
101+
ansible_network_os: platform.slug
102+
```
103+
104+
More configuration options and examples can be found [here](plugins/inventory/nb_inventory.py)
105+
89106
### Example playbooks
90107
91108
Using the **collections** at the play level

0 commit comments

Comments
 (0)