netbox.netbox.netbox_inventory_item module – Creates or removes inventory items from NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.9.0).
To install it, use: ansible-galaxy collection install netbox.netbox
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: netbox.netbox.netbox_inventory_item
.
New in version netbox.netbox: 0.1.0
Synopsis¶
Creates or removes inventory items from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the inventory item configuration |
|
The asset tag of the inventory item |
|
must exist in Netbox |
|
The description of the inventory item |
|
Name of the device the inventory item belongs to |
|
Set the discovery flag for the inventory item Choices:
|
|
The physical label of the inventory item |
|
The manufacturer of the inventory item |
|
Name of the inventory item to be created |
|
The parent inventory item the inventory item will be associated with |
|
The part ID of the inventory item |
|
The serial number of the inventory item |
|
Any tags that the device may need to be associated with |
|
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. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: “true” |
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:
Key |
Description |
---|---|
Serialized object as created or already existent within NetBox Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |