W3cubDocs

/Ansible

netbox.netbox.netbox_module module – Create, update or delete module within NetBox

Note

This module is part of the netbox.netbox collection (version 3.21.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_module.

New in netbox.netbox 3.18.0

Synopsis

  • Creates, updates or removes module 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

asset_tag

string

The asset tag of the modyle

comments

string

Comments that may include additional information in regards to the module

custom_fields

dictionary

must exist in NetBox

description

string

The description of the module

device

any / required

The device of the module

module_bay

any / required

The module bay of the module

module_type

any / required

The module type of the module

serial

string

The weight of the device type

status

string

The status of the module

Choices:

  • "offline"
  • "active"
  • "planned"
  • "staged"
  • "side-to-rear"
  • "failed"
  • "decommissioning"

tags

list / elements=any

Any tags that the module may need to be associated with

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 module type within NetBox with only required information
      netbox.netbox.netbox_module:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: C9300-DEMO
          module_bay: Network Module
          module_type: C9300-NM-8X
        state: present

    - name: Create module type within NetBox
      netbox.netbox.netbox_module:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device:
            name: C9300-DEMO
            site: EUPARIS
          module_bay:
            name: Network Module
            position: 1
          module_type:
            manufacturer: Cisco
            model: C9300-NM-8X
        state: present

    - name: Delete module type within netbox
      netbox.netbox.netbox_module:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device: C9300-DEMO
          module_bay: Network Module
          module_type: C9300-NM-8X
          asset_tag: "00001"
          serial: XXXNNNNXXXX
        state: absent

Return Values

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

Key

Description

module

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

  • Erwan TONNERRE (@etonnerre)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/netbox/netbox/netbox_module_module.html