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

Note

This module is part of the netbox.netbox collection (version 3.23.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_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	Certificate path
data	Defines the device type configuration
asset_tag	The asset tag of the modyle
comments	Comments that may include additional information in regards to the module
custom_fields	must exist in NetBox
description	The description of the module
device	The device of the module
module_bay	The module bay of the module
module_type	The module type of the module
serial	The weight of the device type
status	The status of the module :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"offline"` :ansible-option-choices-entry:`"active"` :ansible-option-choices-entry:`"planned"` :ansible-option-choices-entry:`"staged"` :ansible-option-choices-entry:`"side-to-rear"` :ansible-option-choices-entry:`"failed"` :ansible-option-choices-entry:`"decommissioning"`
tags	Any tags that the module may need to be associated with
headers	Dictionary of headers to be passed to the NetBox API.
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 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	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

• Erwan TONNERRE (@etonnerre)

Collection links