orphan: |
---|
Note
This plugin is part of the netbox.netbox collection (version 3.1.2).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_ipam_role
.
.. versionadded:: 0.1.0 of netbox.netbox
- Creates or removes ipam roles from Netbox
The below requirements are needed on the host that executes this module.
- pynetbox
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
- name: "Test Netbox module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create ipam role within Netbox with only required information
netbox_ipam_role:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test IPAM Role
state: present
- name: Delete ipam role within netbox
netbox_ipam_role:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test IPAM Role
state: absent
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg
string
|
always |
Message indicating failure or info about what has been achieved
|
role
dictionary
|
on creation |
Serialized object as created or already existent within Netbox
|
- Mikhail Yohman (@FragmentedPacket)