networktocode.nautobot.device_interface_template module – Creates or removes interfaces on devices from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 3.4.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 networktocode.nautobot.

To use it in a playbook, specify: networktocode.nautobot.device_interface_template.

New in version 1.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes interfaces from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

device_type

raw / required

added in 3.0.0 of networktocode.nautobot

Name of the device the interface template will be associated with (case-sensitive)

mgmt_only

boolean

added in 3.0.0 of networktocode.nautobot

This interface template is used only for out-of-band management

Choices:

  • no

  • yes

name

string / required

added in 3.0.0 of networktocode.nautobot

Name of the interface template to be created

query_params

list / elements=string

added in 3.0.0 of networktocode.nautobot

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

token

string / required

The token created within Nautobot to authorize API access

type

string / required

added in 3.0.0 of networktocode.nautobot

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

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

raw

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Default: “yes”

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot interface template module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create interface template within Nautobot with only required information
      networktocode.nautobot.device_interface_template:
        url: http://nautobot.local
        token: thisIsMyToken
        device_type: Arista Test
        name: 10GBASE-T (10GE)
        type: 10gbase-t
        state: present
    - name: Delete interface template within nautobot
      networktocode.nautobot.device_interface_template:
        url: http://nautobot.local
        token: thisIsMyToken
        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

dictionary

Serialized object as created or already existent within Nautobot

Returned: on creation

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Tobias Groß (@toerb)