netbox.netbox.netbox_export_template module – Creates, updates or deletes export templates within NetBox

Note

This module is part of the netbox.netbox collection (version 3.8.1).

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_export_template.

New in netbox.netbox 3.6.0

Synopsis

  • Creates, updates or removes export templates 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 custom field

as_attachment

boolean

Download file as attachment

Choices:

  • false

  • true

content_type

any

The content type to apply this export template to

description

string

Description of the export template

file_extension

string

The file extension of the export template

mime_type

string

MIME type of the export template

name

string / required

The name of the export template

template_code

any / required

Template code of the export template

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

  • This should be ran with connection local and hosts localhost

  • Use the !unsafe data type if you want jinja2 code in template_code

Examples

- name: "Test NetBox custom_link module"
  connection: local
  hosts: localhost
  tasks:
    - name: Create a custom link on device
      netbox_custom_link:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          content_type: "dcim.device"
          name: Custom Link
          link_text: "Open Web Management"
          link_url: !unsafe https://{{ obj.name }}.domain.local

    - name: Delete the custom link
      netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          content_type: "dcim.device"
          name: Custom Link
          link_text: "Open Web Management"
          link_url: !unsafe https://{{ obj.name }}.domain.local
        state: absent

Return Values

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

Key

Description

dictionary

Serialized object as created/existent/updated/deleted within NetBox

Returned: always

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Martin Rødvand (@rodvand)