netbox.netbox.netbox_device module – Create, update or delete devices within NetBox¶
Note
This module is part of the netbox.netbox collection (version 3.8.1).
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_device
.
New in netbox.netbox 0.1.0
Synopsis¶
Creates, updates or removes devices from NetBox
Requirements¶
The below requirements are needed on the host that executes this module.
pynetbox
Parameters¶
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the device configuration |
|
Airflow of the device Choices: |
|
Asset tag that is associated to the device |
|
Cluster that the device will be assigned to |
|
Comments that may include additional information in regards to the device |
|
must exist in NetBox |
|
Description of the provider |
|
Required if state=present and the device does not exist yet |
|
Required if state=present and the device does not exist yet |
|
Required if rack is defined Choices: |
|
Arbitrary JSON data to define the devices configuration variables. |
|
The location the device will be associated to (NetBox 2.11+) |
|
The name of the device |
|
The platform of the device |
|
The position of the device in the rack defined above |
|
Primary IPv4 address assigned to the device |
|
Primary IPv6 address assigned to the device |
|
The name of the rack to assign the device to |
|
Serial number of the device |
|
Required if state=present and the device does not exist yet |
|
The status of the device |
|
Any tags that the device may need to be associated with |
|
The tenant that the device will be assigned to |
|
Position in the assigned virtual chassis |
|
Priority in the assigned virtual chassis |
|
Virtual chassis the device will be assigned to |
|
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. Choices: |
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: :ansible-option-default:`true` |
Notes¶
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
Examples¶
- name: "Test NetBox modules"
connection: local
hosts: localhost
gather_facts: False
tasks:
- name: Create device within NetBox with only required information
netbox.netbox.netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
device_type: C9410R
device_role: Core Switch
site: Main
state: present
- name: Create device within NetBox with empty string name to generate UUID
netbox.netbox.netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: ""
device_type: C9410R
device_role: Core Switch
site: Main
state: present
- name: Delete device within netbox
netbox.netbox.netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
state: absent
- name: Create device with tags
netbox.netbox.netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Another Test Device
device_type: C9410R
device_role: Core Switch
site: Main
local_context_data:
bgp: "65000"
tags:
- Schnozzberry
state: present
- name: Update the rack and position of an existing device
netbox.netbox.netbox_device:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: Test Device
rack: Test Rack
position: 10
face: Front
state: present
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 NetBox Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved Returned: always |