netbox.netbox.netbox_ipam_role – Creates or removes ipam roles from Netbox¶
Note
This plugin is part of the netbox.netbox collection (version 3.1.1).
To install it use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_ipam_role
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates or removes ipam roles from Netbox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- 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
Return Values¶
Common return values are documented here, 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
|