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

New in netbox.netbox 3.6.0

Synopsis

• Creates, updates or removes custom links 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 custom field
button_class	Button class for the custom link
content_type	The content type to apply this custom link to
content_types :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The content type to apply this custom link to (NetBox 3.4+)
enabled :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	Enable/disable custom link :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
group_name	The group to associate the custom link with
link_text	Link text of the custom link
link_url	Link URL of the custom link
name	The name of the custom link
new_window	Open link in new window :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
object_types :ansible-option-versionadded:`added in netbox.netbox 3.19.0`	The object type(s) to apply this custom link to (NetBox 4.0+)
weight	Fields with higher weights appear lower in a form
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

• 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 here, the following are the fields unique to this module:

Key	Description
custom_link	Serialized object as created/existent/updated/deleted within NetBox :ansible-option-returned-bold:`Returned:` always
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Martin Rødvand (@rodvand)

Collection links