netbox.netbox.netbox_device_interface_template module – Creates or removes interfaces on devices from NetBox

Note

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

New in netbox.netbox 0.3.0

Synopsis

• Creates or removes interfaces 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 interface template configuration
device_type	Name of the device the interface template will be associated with (case-sensitive)
mgmt_only	This interface template is used only for out-of-band management :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
name	Name of the interface template to be created
poe_mode :ansible-option-versionadded:`added in netbox.netbox 3.8.0`	This interface has PoE ability (NetBox release 3.3 and later)
poe_type :ansible-option-versionadded:`added in netbox.netbox 3.8.0`	This interface’s power type (NetBox release 3.3 and later)
type	Form factor of the interface: ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE) This has to be specified exactly as what is found within UI
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 interface template module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create interface template within NetBox with only required information
      netbox.netbox.netbox_device_interface_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device_type: Arista Test
          name: 10GBASE-T (10GE)
          type: 10gbase-t
        state: present
    - name: Delete interface template within netbox
      netbox.netbox.netbox_device_interface_template:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          device_type: Arista Test
          name: 10GBASE-T (10GE)
          type: 10gbase-t
        state: absent

Return Values

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

Key	Description
interface_template	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Tobias Groß (@toerb)

Collection links