networktocode.nautobot.custom_field_choice module – Creates or removes custom field choices from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.3.1).

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 networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.custom_field_choice.

New in networktocode.nautobot 5.1.0

Synopsis

• Creates or removes custom field choices from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Comments
api_version :ansible-option-versionadded:`added in networktocode.nautobot 4.1.0`	API Version Nautobot REST API
custom_field :ansible-option-versionadded:`added in networktocode.nautobot 5.1.0`	Custom field this choice belongs to
query_params :ansible-option-versionadded:`added in networktocode.nautobot 3.0.0`	This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment.
state	Use present or absent for adding or removing. :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)`
token	The token created within Nautobot to authorize API access Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.
url	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured. :ansible-option-default-bold:`Default:` :ansible-option-default:`true`
value :ansible-option-versionadded:`added in networktocode.nautobot 5.1.0`	Value of this choice
weight :ansible-option-versionadded:`added in networktocode.nautobot 5.1.0`	Weight of this choice

Notes

Note

• This should be ran with connection local and hosts localhost

Examples

---
- name: Create a custom field choice
  networktocode.nautobot.custom_field_choice:
    url: http://nautobot.local
    token: thisIsMyToken
    value: "Choice 1"
    weight: 100
    custom_field: "Custom Field 1"
    state: present

Return Values

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

Key	Description
custom_field_choice	Serialized object as created or already existent within Nautobot :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Joe Wesch (@joewesch)

Collection links