netbox_device_type_module.rst

orphan:

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.14.0).

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_device_type_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_device_type.

.. rst-class:: ansible-version-added

New in netbox.netbox 0.1.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes device types from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the device type configuration
.. rst-class:: ansible-option-title airflow .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Airflow of the device .. rst-class:: ansible-option-line 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"`
.. rst-class:: ansible-option-title comments .. rst-class:: ansible-option-type-line string	Comments that may include additional information in regards to the device_type
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	Description of the provider
.. rst-class:: ansible-option-title is_full_depth .. rst-class:: ansible-option-type-line boolean	Whether or not the device consumes both front and rear rack faces .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title manufacturer .. rst-class:: ansible-option-type-line any	The manufacturer of the device type
.. rst-class:: ansible-option-title model .. rst-class:: ansible-option-type-line any / required	The model of the device type
.. rst-class:: ansible-option-title part_number .. rst-class:: ansible-option-type-line string	The part number of the device type
.. rst-class:: ansible-option-title slug .. rst-class:: ansible-option-type-line 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
.. rst-class:: ansible-option-title subdevice_role .. rst-class:: ansible-option-type-line string	Whether the device type is parent, child, or neither .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"Parent"` :ansible-option-choices-entry:`"parent"` :ansible-option-choices-entry:`"Child"` :ansible-option-choices-entry:`"child"`
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the device type may need to be associated with
.. rst-class:: ansible-option-title u_height .. rst-class:: ansible-option-type-line integer	The height of the device type in rack units
.. rst-class:: ansible-option-title weight .. rst-class:: ansible-option-type-line float added in netbox.netbox 3.10.0	The weight of the device type
.. rst-class:: ansible-option-title weight_unit .. rst-class:: ansible-option-type-line string added in netbox.netbox 3.10.0	The weight unit .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"kg"` :ansible-option-choices-entry:`"g"` :ansible-option-choices-entry:`"lb"` :ansible-option-choices-entry:`"oz"`
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line 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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line 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
          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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title device_type .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always

Authors

• Mikhail Yohman (@FragmentedPacket)

Collection links

Issue Tracker Repository (Sources)