inventory_item¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Creates or removes inventory items from Nautobot

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Data Type	Comments
api_version	str	API Version Nautobot REST API Version Added: 4.1.0
asset_tag	str	The asset tag of the inventory item Version Added: 3.0.0
custom_fields	dict	Must exist in Nautobot and in key/value format Version Added: 3.0.0
description	str	The description of the inventory item Version Added: 3.0.0
device required	raw	Name of the device the inventory item belongs to Version Added: 3.0.0
discovered	bool	Set the discovery flag for the inventory item Version Added: 3.0.0
manufacturer	raw	The manufacturer of the inventory item Version Added: 3.0.0
name required	str	Name of the inventory item to be created Version Added: 3.0.0
part_id	str	The part ID of the inventory item Version Added: 3.0.0
query_params	list	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. Version Added: 3.0.0
serial	str	The serial number of the inventory item Version Added: 3.0.0
state	str	Use C(present) or C(absent) for adding or removing.
tags	list	Any tags that this item may need to be associated with Version Added: 3.0.0
token required	str	The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url required	str	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs	raw	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(localhost)

Examples¶

- name: &#34;Test Nautobot inventory_item module&#34;
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create inventory item within Nautobot with only required information
      networktocode.nautobot.inventory_item:
        url: http://nautobot.local
        token: thisIsMyToken
        device: test100
        name: &#34;10G-SFP+&#34;
        state: present

    - name: Update inventory item
      networktocode.nautobot.inventory_item:
        url: http://nautobot.local
        token: thisIsMyToken
        device: test100
        name: &#34;10G-SFP+&#34;
        manufacturer: &#34;Cisco&#34;
        part_id: &#34;10G-SFP+&#34;
        serial: &#34;1234&#34;
        asset_tag: &#34;1234&#34;
        description: &#34;New SFP&#34;
        state: present

    - name: Delete inventory item within nautobot
      networktocode.nautobot.inventory_item:
        url: http://nautobot.local
        token: thisIsMyToken
        device: test100
        name: &#34;10G-SFP+&#34;
        state: absent

Return Values¶

Key	Data Type	Description	Returned
inventory_item	dict	Serialized object as created or already existent within Nautobot	on creation
msg	str	Message indicating failure or info about what has been achieved	always

Authors¶

Mikhail Yohman (@fragmentedpacket)