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.10.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. 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

any

Certificate path

data

dictionary / required

Defines the device type configuration

airflow

string

added in netbox.netbox 3.10.0

Airflow of the device

Choices:

  • "front-to-rear"

  • "rear-to-front"

  • "left-to-right"

  • "right-to-left"

  • "side-to-rear"

  • "passive"

  • "mixed"

comments

string

Comments that may include additional information in regards to the device_type

custom_fields

dictionary

must exist in NetBox

description

string

added in netbox.netbox 3.10.0

Description of the provider

is_full_depth

boolean

Whether or not the device consumes both front and rear rack faces

Choices:

  • false

  • true

manufacturer

any

The manufacturer of the device type

model

any / required

The model of the device type

part_number

string

The part number of the device type

slug

string

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

string

Whether the device type is parent, child, or neither

Choices:

  • "Parent"

  • "parent"

  • "Child"

  • "child"

tags

list / elements=any

Any tags that the device type may need to be associated with

u_height

integer

The height of the device type in rack units

weight

float

added in netbox.netbox 3.10.0

The weight of the device type

weight_unit

string

added in netbox.netbox 3.10.0

The weight unit

Choices:

  • "kg"

  • "g"

  • "lb"

  • "oz"

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

list / elements=string

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

string

The state of the object.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

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
          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

dictionary

Serialized object as created or already existent within NetBox

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Mikhail Yohman (@FragmentedPacket)