netbox.netbox.netbox_inventory_item – Creates or removes inventory items from NetBox¶
Note
This plugin is part of the netbox.netbox collection (version 3.5.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_inventory_item
.
New in version 0.1.0: of netbox.netbox
Synopsis¶
Creates or removes inventory items 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 inventory_item module"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create inventory item within NetBox with only required information
netbox_inventory_item:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: test100
name: "10G-SFP+"
state: present
- name: Update inventory item
netbox_inventory_item:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: test100
name: "10G-SFP+"
manufacturer: "Cisco"
part_id: "10G-SFP+"
serial: "1234"
asset_tag: "1234"
description: "New SFP"
state: present
- name: Create inventory item with parent
netbox_inventory_item:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
parent_inventory_item:
name: "Line Card 1"
device: test100
name: "10G-SFP+"
device: test100
state: present
- name: Delete inventory item within netbox
netbox_inventory_item:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
device: test100
name: "10G-SFP+"
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module: