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.20.0).

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. 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 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
cert	Certificate path
data	Defines the inventory item configuration
asset_tag	The asset tag of the inventory item
component :ansible-option-versionadded:`added in netbox.netbox 3.15.0`	The associated component
device	The device the component is attached to.
name	The name of the component
component_type :ansible-option-versionadded:`added in netbox.netbox 3.15.0`	The type of the component. Required if component is defined. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"dcim.consoleport"` :ansible-option-choices-entry:`"dcim.consoleserverport"` :ansible-option-choices-entry:`"dcim.frontport"` :ansible-option-choices-entry:`"dcim.interface"` :ansible-option-choices-entry:`"dcim.poweroutlet"` :ansible-option-choices-entry:`"dcim.powerport"` :ansible-option-choices-entry:`"dcim.rearport"`
custom_fields :ansible-option-versionadded:`added in netbox.netbox 3.4.0`	must exist in Netbox
description	The description of the inventory item
device	Name of the device the inventory item belongs to
discovered	Set the discovery flag for the inventory item :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`true`
inventory_item_role :ansible-option-versionadded:`added in netbox.netbox 3.14.0`	Set the inventory item role
label :ansible-option-versionadded:`added in netbox.netbox 3.4.0`	The physical label of the inventory item
manufacturer	The manufacturer of the inventory item
name	Name of the inventory item to be created
parent_inventory_item :ansible-option-versionadded:`added in netbox.netbox 3.5.0`	The parent inventory item the inventory item will be associated with
part_id	The part ID of the inventory item
serial	The serial number of the inventory item
tags	Any tags that the device may need to be associated with
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

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.netbox.netbox_inventory_item:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: test100
          name: "10G-SFP+"
        state: present

    - name: Update inventory item
      netbox.netbox.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"
          inventory_item_role: NIC
        state: present

    - name: Create inventory item with parent
      netbox.netbox.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: Create inventory item with component
      netbox.netbox.netbox_inventory_item:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "10G-SFP+"
          device: test100
          component_type: "dcim.interface"
          component:
            name: GigabitEthernet2
            device: "test100"
        state: present

    - name: Delete inventory item within netbox
      netbox.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
inventory_item	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links