Note
This plugin is part of the netbox.netbox collection (version 3.3.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 netbox.netbox
.
To use it in a playbook, specify: netbox.netbox.netbox_inventory_item
.
New in version 0.1.0: of netbox.netbox
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
cert raw | Certificate path | ||
data dictionary / required | Defines the inventory item configuration | ||
asset_tag string | The asset tag of the inventory item | ||
description string | The description of the inventory item | ||
device raw | Name of the device the inventory item belongs to | ||
discovered boolean |
| Set the discovery flag for the inventory item | |
manufacturer raw | The manufacturer of the inventory item | ||
name string / required | Name of the inventory item to be created | ||
part_id string | The part ID of the inventory item | ||
serial string | The serial number of the inventory item | ||
tags list / elements=raw | Any tags that the device may need to be associated with | ||
netbox_token string / required | The token created within Netbox to authorize API access | ||
netbox_url string / required | URL of the Netbox instance resolvable by Ansible control host | ||
query_params list / elements=string | This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. | ||
state string |
| Use present or absent for adding or removing. | |
validate_certs raw | Default: "yes" | If no , SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
Note
local
and hosts localhost
- 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: Delete inventory item within netbox netbox_inventory_item: netbox_url: http://netbox.local netbox_token: thisIsMyToken data: device: test100 name: "10G-SFP+" state: absent
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
inventory_item dictionary | on creation | Serialized object as created or already existent within Netbox |
msg string | always | Message indicating failure or info about what has been achieved |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_inventory_item_module.html