- orphan
Note
This module is part of the netbox.netbox collection (version 3.17.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 <ansible_collections.netbox.netbox.netbox_inventory_item_module_requirements>
for details.
To use it in a playbook, specify: netbox.netbox.netbox_inventory_item
.
ansible-version-added
New in netbox.netbox 0.1.0
- Creates or removes inventory items from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
X{1}{3}X{2}{3}
Parameter | Comments |
---|---|
Certificate path |
|
Defines the inventory item configuration |
|
The asset tag of the inventory item |
|
The associated component |
|
The device the component is attached to. |
|
The name of the component |
|
The type of the component. Required if component is defined. ansible-option-line
|
|
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 ansible-option-line
|
|
Set the inventory item role |
|
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. ansible-option-line
|
|
If This should only be used on personally controlled sites using a self-signed certificates. ansible-option-line
|
Note
- Tags should be defined as a YAML list - This should be ran with connection 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.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
Common return values are documented here <common_return_values>
, the following are the fields unique to this module:
X{1}{3}X{2}{3}
Key | Description |
---|---|
Serialized object as created or already existent within NetBox ansible-option-line
|
|
Message indicating failure or info about what has been achieved ansible-option-line
|
- Mikhail Yohman (@FragmentedPacket)
- title: "Issue Tracker" url: "https://github.com/netbox-community/ansible_modules/issues" external: true
- title: "Repository (Sources)" url: "https://github.com/netbox-community/ansible_modules" external: true