netbox_custom_link_module.rst

orphan:

netbox.netbox.netbox_custom_link module -- Creates, updates or deletes custom links within NetBox

Note

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

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

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

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

New in netbox.netbox 3.6.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Creates, updates or removes custom links from NetBox

Requirements

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

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the custom field
.. rst-class:: ansible-option-title button_class .. rst-class:: ansible-option-type-line any	Button class for the custom link
.. rst-class:: ansible-option-title content_type .. rst-class:: ansible-option-type-line any	The content type to apply this custom link to
.. rst-class:: ansible-option-title content_types .. rst-class:: ansible-option-type-line list / elements=any added in netbox.netbox 3.10.0	The content type to apply this custom link to (NetBox 3.4+)
.. rst-class:: ansible-option-title enabled .. rst-class:: ansible-option-type-line boolean added in netbox.netbox 3.7.0	Enable/disable custom link .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title group_name .. rst-class:: ansible-option-type-line string	The group to associate the custom link with
.. rst-class:: ansible-option-title link_text .. rst-class:: ansible-option-type-line any / required	Link text of the custom link
.. rst-class:: ansible-option-title link_url .. rst-class:: ansible-option-type-line any / required	Link URL of the custom link
.. rst-class:: ansible-option-title name .. rst-class:: ansible-option-type-line string / required	The name of the custom link
.. rst-class:: ansible-option-title new_window .. rst-class:: ansible-option-type-line boolean	Open link in new window .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
.. rst-class:: ansible-option-title weight .. rst-class:: ansible-option-type-line integer	Fields with higher weights appear lower in a form
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line 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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line 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 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 link_text or link_url

Examples

- name: "Test NetBox custom_link module"
  connection: local
  hosts: localhost
  tasks:
    - name: Create a custom link on device
      netbox.netbox.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.netbox.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
        state: absent

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. rst-class:: ansible-option-table

Key	Description
.. rst-class:: ansible-option-title custom_link .. rst-class:: ansible-option-type-line dictionary	Serialized object as created/existent/updated/deleted within NetBox .. rst-class:: ansible-option-line Returned: always
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always

Authors

• Martin Rødvand (@rodvand)

Collection links

Issue Tracker Repository (Sources)