| orphan: |
|---|
Note
This module is part of the netbox.netbox collection (version 3.18.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 :ref:`Requirements <ansible_collections.netbox.netbox.netbox_module_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_module.
.. rst-class:: ansible-version-added
New in netbox.netbox 3.18.0
- Creates, updates or removes module from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Parameter | Comments |
|---|---|
Certificate path |
|
Defines the device type configuration |
|
The asset tag of the modyle |
|
Comments that may include additional information in regards to the module |
|
must exist in NetBox |
|
The description of the module |
|
The device of the module |
|
The module bay of the module |
|
The module type of the module |
|
The weight of the device type |
|
The status of the module .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:`
|
|
Any tags that the module may need to be associated with |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. .. rst-class:: ansible-option-line |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
localand hostslocalhost
- 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
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. tabularcolumns:: \X{1}{3}\X{2}{3}
| Key | Description |
|---|---|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success (when state=present) |
|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line |
- Erwan TONNERRE (@etonnerre)
.. ansible-links::
- title: "Issue Tracker"
url: "https://github.com/netbox-community/ansible_modules/issues"
external: true
- title: "Repository (Sources)"
url: "https://github.com/netbox-community/ansible_modules"
external: true