Skip to content

Latest commit

 

History

History
879 lines (454 loc) · 18.4 KB

netbox_export_template_module.rst

File metadata and controls

879 lines (454 loc) · 18.4 KB
Raw
orphan:

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.17.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_export_template_module_requirements>` for details.

To use it in a playbook, specify: netbox.netbox.netbox_export_template.

.. rst-class:: ansible-version-added

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

.. tabularcolumns:: \X{1}{3}\X{2}{3}
Parameter Comments 
.. rst-class:: ansible-option-title

cert

.. ansible-option-type-line::

  :ansible-option-type:`any`

Certificate path

 
.. rst-class:: ansible-option-title

data

.. ansible-option-type-line::

  :ansible-option-type:`dictionary` / :ansible-option-required:`required`

Defines the custom field

 
.. rst-class:: ansible-option-title

as_attachment

.. ansible-option-type-line::

  :ansible-option-type:`boolean`


.. rst-class:: ansible-option-title

content_type

.. ansible-option-type-line::

  :ansible-option-type:`any`

The content type to apply this export template to

 
.. rst-class:: ansible-option-title

content_types

.. ansible-option-type-line::

  :ansible-option-type:`list` / :ansible-option-elements:`elements=any`

:ansible-option-versionadded:`added in netbox.netbox 3.10.0`

The content type to apply this export template to (NetBox 3.4+)

 
.. rst-class:: ansible-option-title

description

.. ansible-option-type-line::

  :ansible-option-type:`string`

Description of the export template

 
.. rst-class:: ansible-option-title

file_extension

.. ansible-option-type-line::

  :ansible-option-type:`string`

The file extension of the export template

 
.. rst-class:: ansible-option-title

mime_type

.. ansible-option-type-line::

  :ansible-option-type:`string`

MIME type of the export template

 
.. rst-class:: ansible-option-title

name

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

The name of the export template

 
.. rst-class:: ansible-option-title

template_code

.. ansible-option-type-line::

  :ansible-option-type:`any` / :ansible-option-required:`required`

Template code of the export template

 
.. rst-class:: ansible-option-title

netbox_token

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

The NetBox API token.

 
.. rst-class:: ansible-option-title

netbox_url

.. ansible-option-type-line::

  :ansible-option-type:`string` / :ansible-option-required:`required`

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

 
.. rst-class:: ansible-option-title

query_params

.. ansible-option-type-line::

  :ansible-option-type:`list` / :ansible-option-elements:`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.

 
.. rst-class:: ansible-option-title

state

.. ansible-option-type-line::

  :ansible-option-type:`string`


.. rst-class:: ansible-option-title

validate_certs

.. ansible-option-type-line::

  :ansible-option-type:`any`

If no, SSL certificates will not be validated.

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`

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.netbox.netbox_export_template:
        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.netbox.netbox_export_template:
        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 :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}
Key Description 
.. rst-class:: ansible-option-title

custom_link

.. ansible-option-type-line::

  :ansible-option-type:`dictionary`

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

.. rst-class:: ansible-option-line

:ansible-option-returned-bold:`Returned:` always

 
.. rst-class:: ansible-option-title

msg

.. ansible-option-type-line::

  :ansible-option-type:`string`

Message indicating failure or info about what has been achieved

.. rst-class:: ansible-option-line

:ansible-option-returned-bold:`Returned:` always

Authors

  • Martin Rødvand (@rodvand)

Collection links

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