netbox.netbox.netbox_custom_field module – Creates, updates or deletes custom fields 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_field.

New in netbox.netbox 3.6.0

Synopsis

• Creates, updates or removes custom fields 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
choice_set	The name of the choice set to use (for selection fields)
content_types	The content type(s) to apply this custom field to
default	Default value of the custom field
description	Description of the custom field
filter_logic	Filter logic of the custom field
group_name :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The group to associate the custom field with
label	Label of the custom field
name	Name of the custom field
object_type :ansible-option-versionadded:`added in netbox.netbox 3.7.0`	The object type of the custom field (if any)
object_types :ansible-option-versionadded:`added in netbox.netbox 3.19.0`	The content type(s) to apply this custom field to (NetBox 4.0+)
related_object_type :ansible-option-versionadded:`added in netbox.netbox 3.20.0`	The object type of the custom field (if any) (NetBox 4.0+)
required	Whether the custom field is required :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
search_weight :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	Weighting for search. Lower values are considered more important. Fields with a search weight of zero will be ignored.
type	The type of custom field :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"text"` :ansible-option-choices-entry:`"longtext"` :ansible-option-choices-entry:`"integer"` :ansible-option-choices-entry:`"decimal"` :ansible-option-choices-entry:`"boolean"` :ansible-option-choices-entry:`"date"` :ansible-option-choices-entry:`"datetime"` :ansible-option-choices-entry:`"url"` :ansible-option-choices-entry:`"json"` :ansible-option-choices-entry:`"select"` :ansible-option-choices-entry:`"multiselect"` :ansible-option-choices-entry:`"object"` :ansible-option-choices-entry:`"multiobject"`
ui_visibility :ansible-option-versionadded:`added in netbox.netbox 3.10.0`	The UI visibility of the custom field :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"read-write"` :ansible-option-choices-entry:`"read-only"` :ansible-option-choices-entry:`"hidden"` :ansible-option-choices-entry:`"hidden-ifunset"`
validation_maximum	The maximum allowed value (for numeric fields)
validation_minimum	The minimum allowed value (for numeric fields)
validation_regex	The regular expression to enforce on text fields
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

Examples

- name: "Test NetBox custom_fields module"
  connection: local
  hosts: localhost
  tasks:
    - name: Create a custom field on device and virtual machine
      netbox.netbox.netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          content_types:
            - dcim.device
            - virtualization.virtualmachine
          name: A Custom Field
          type: text

    - name: Create a custom field of type selection
      netbox.netbox.netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: "Custom_Field"
          content_types:
            - dcim.device
            - virtualization.virtualmachine
          type: select
          choice_set: A Choice Set name

    - name: Update the custom field to make it required
      netbox.netbox.netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: A Custom Field
          required: true

    - name: Update the custom field to make it read only
      netbox.netbox.netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: A Custom Field
          ui_visibility: read-only

    - name: Delete the custom field
      netbox.netbox.netbox_custom_field:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: A Custom Field
        state: absent

Return Values

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

Key	Description
custom_field	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