custom_field_choice_module.rst

orphan

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

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements <ansible_collections.networktocode.nautobot.custom_field_choice_module_requirements> for details.

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

ansible-version-added

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

ansible-option-table

Parameter	Comments
ansible-option-title api_version ansible-option-type-line string added in networktocode.nautobot 4.1.0	API Version Nautobot REST API
ansible-option-title custom_field ansible-option-type-line any / required added in networktocode.nautobot 5.1.0	Custom field this choice belongs to
ansible-option-title query_params ansible-option-type-line list / elements=string 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.
ansible-option-title state ansible-option-type-line string	Use present or absent for adding or removing. ansible-option-line Choices: "absent" "present" ← (default)
ansible-option-title token ansible-option-type-line string / required	The token created within Nautobot to authorize API access Can be omitted if the NAUTOBOT\_TOKEN environment variable is configured.
ansible-option-title url ansible-option-type-line string / required	The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the NAUTOBOT\_URL environment variable is configured.
ansible-option-title validate_certs ansible-option-type-line any	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 NAUTOBOT\_VALIDATE\_CERTS environment variable is configured. ansible-option-line Default: true
ansible-option-title value ansible-option-type-line string / required added in networktocode.nautobot 5.1.0	Value of this choice
ansible-option-title weight ansible-option-type-line integer 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 <common_return_values>, the following are the fields unique to this module:

ansible-option-table

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

Authors

• Joe Wesch (@joewesch)

Collection links

Issue Tracker Repository (Sources)