netbox.netbox.netbox_device_type module – Create, update or delete device types 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_type.

New in netbox.netbox 0.1.0

Synopsis

• Creates, updates or removes device types 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 type 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"`
comments	Comments that may include additional information in regards to the device_type
custom_fields	must exist in NetBox
default_platform :ansible-option-versionadded:`added in netbox.netbox 3.15.0`	Set the default platform used by the device
description :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Description of the provider
is_full_depth	Whether or not the device consumes both front and rear rack faces :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
manufacturer	The manufacturer of the device type
model	The model of the device type
part_number	The part number of the device type
slug	The slug of the device type. Must follow slug formatting (URL friendly) If not specified, it will slugify the model ex. test-device-type
subdevice_role	Whether the device type is parent, child, or neither :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"Parent"` :ansible-option-choices-entry:`"parent"` :ansible-option-choices-entry:`"Child"` :ansible-option-choices-entry:`"child"`
tags	Any tags that the device type may need to be associated with
u_height	The height of the device type in rack units
weight :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The weight of the device type
weight_unit :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The weight unit :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"kg"` :ansible-option-choices-entry:`"g"` :ansible-option-choices-entry:`"lb"` :ansible-option-choices-entry:`"oz"`
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 type within NetBox with only required information
      netbox.netbox.netbox_device_type:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          slug: test-device-type
          model: ws-test-3750
          manufacturer: Test Manufacturer
        state: present

    - name: Create device type within NetBox with only required information
      netbox.netbox.netbox_device_type:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          slug: test-device-type
          model: ws-test-3750
          manufacturer: Test Manufacturer
          part_number: ws-3750g-v2
          u_height: 1.5
          is_full_depth: false
          subdevice_role: parent
        state: present

    - name: Delete device type within netbox
      netbox.netbox.netbox_device_type:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          slug: test-device-type
        state: absent

Return Values

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

Key	Description
device_type	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)

Collection links