netbox.netbox.netbox_device module – Create, update or delete devices within NetBox

Note

This module is part of the netbox.netbox collection (version 3.20.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 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
cert	Certificate path
data	Defines the device configuration
airflow :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Airflow of the device :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"front-to-rear"` :ansible-option-choices-entry:`"rear-to-front"` :ansible-option-choices-entry:`"left-to-right"` :ansible-option-choices-entry:`"right-to-left"` :ansible-option-choices-entry:`"side-to-rear"` :ansible-option-choices-entry:`"passive"` :ansible-option-choices-entry:`"mixed"`
asset_tag	Asset tag that is associated to the device
cluster	Cluster that the device will be assigned to
comments	Comments that may include additional information in regards to the device
config_template :ansible-option-versionadded:`added in netbox.netbox 3.17.0`	Configuration template
custom_fields	must exist in NetBox
description :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Description of the provider
device_role	Required if state=present and the device does not exist yet
device_type	Required if state=present and the device does not exist yet
face	Required if rack is defined :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"Front"` :ansible-option-choices-entry:`"front"` :ansible-option-choices-entry:`"Rear"` :ansible-option-choices-entry:`"rear"`
local_context_data	Arbitrary JSON data to define the devices configuration variables.
location :ansible-option-versionadded:`added in netbox.netbox 3.3.0`	The location the device will be associated to (NetBox 2.11+)
name	The name of the device
oob_ip :ansible-option-versionadded:`added in netbox.netbox 3.15.0`	Out-of-band (OOB) IP address assigned to the device
platform	The platform of the device
position	The position of the device in the rack defined above
primary_ip4	Primary IPv4 address assigned to the device
primary_ip6	Primary IPv6 address assigned to the device
rack	The name of the rack to assign the device to
serial	Serial number of the device
site	Required if state=present and the device does not exist yet
status	The status of the device
tags	Any tags that the device may need to be associated with
tenant	The tenant that the device will be assigned to
vc_position	Position in the assigned virtual chassis
vc_priority	Priority in the assigned virtual chassis
virtual_chassis	Virtual chassis the device will be assigned to
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

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.5
          face: Front
        state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
device	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Mikhail Yohman (@FragmentedPacket)

• David Gomez (@amb1s1)

Collection links