networktocode.nautobot.inventory_item module – Creates or removes inventory items from Nautobot¶
Note
This module is part of the networktocode.nautobot collection (version 3.4.0).
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 networktocode.nautobot
.
To use it in a playbook, specify: networktocode.nautobot.inventory_item
.
New in version 1.0.0: of networktocode.nautobot
Synopsis¶
Creates or removes inventory items from Nautobot
Requirements¶
The below requirements are needed on the host that executes this module.
pynautobot
Parameters¶
Parameter |
Comments |
---|---|
The asset tag of the inventory item |
|
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 manufacturer of the inventory item |
|
Name of the inventory item to be created |
|
The part ID of the inventory item |
|
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. |
|
The serial number of the inventory item |
|
Use Choices:
|
|
Any tags that the device may need to be associated with |
|
The token created within Nautobot to authorize API access |
|
URL of the Nautobot instance resolvable by Ansible control host |
|
Default: “yes” |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test Nautobot inventory_item module"
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: "10G-SFP+"
state: present
- name: Update inventory item
networktocode.nautobot.inventory_item:
url: http://nautobot.local
token: thisIsMyToken
device: test100
name: "10G-SFP+"
manufacturer: "Cisco"
part_id: "10G-SFP+"
serial: "1234"
asset_tag: "1234"
description: "New SFP"
state: present
- name: Delete inventory item within nautobot
networktocode.nautobot.inventory_item:
url: http://nautobot.local
token: thisIsMyToken
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 Nautobot Returned: on creation |
|
Message indicating failure or info about what has been achieved Returned: always |