- orphan
netbox.netbox.netbox_inventory_item_role module -- Create, update or delete devices roles within NetBox
Note
This module is part of the netbox.netbox collection (version 3.10.0).
To install it, use: ansible-galaxy collection install netbox.netbox
. You need further requirements to be able to use this module, see Requirements <ansible_collections.netbox.netbox.netbox_inventory_item_role_module_requirements>
for details.
To use it in a playbook, specify: netbox.netbox.netbox_inventory_item_role
.
ansible-version-added
New in netbox.netbox 3.10.0
- Creates, updates or removes devices roles from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
ansible-option-table
Parameter | Comments |
---|---|
Certificate path |
|
Defines the inventory item role configuration |
|
Hexidecimal code for a color, ex. FFFFFF |
|
Must exist in NetBox |
|
The description of the inventory item role |
|
The name of the inventory item role |
|
The slugified version of the name or custom slug. This is auto-generated following NetBox rules if not provided |
|
The tags to add/update |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. ansible-option-line Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line Default: |
Note
- Tags should be defined as a YAML list - This should be ran with connection local
and hosts localhost
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create inventory item role within NetBox with only required information
netbox.netbox.netbox_inventory_item_role:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Inventory Item role
color: FFFFFF
state: present
- name: Delete inventory item role within netbox
netbox.netbox.netbox_inventory_item_role:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Inventory Item role
state: absent
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
ansible-option-table
Key | Description |
---|---|
Serialized object as created or already existent within NetBox ansible-option-line Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved ansible-option-line Returned: always |
- Martin Rødvand (@rodvand)