netbox.netbox.netbox_custom_field_choice_set module – Creates, updates or deletes custom field choice sets within Netbox
Note
This module is part of the netbox.netbox collection (version 3.19.1).
You might already have this collection installed if you are using the ansible
package.
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_choice_set
.
New in netbox.netbox 3.18.0
Synopsis
Creates, updates or removes custom fields choice sets from Netbox
Requirements
The below requirements are needed on the host that executes this module.
pynetbox
Parameters
Parameter |
Comments |
---|---|
Certificate path |
|
Defines the choice set |
|
Selection of base choice to use in the choice set Choices:
|
|
Description of the choice set |
|
List of available choices in the choice set Default: |
|
Name of the choice set |
|
Order the choices alphabetically Choices:
|
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
This should be run with connection
local
and hostslocalhost
Examples
- name: "Test Netbox custom_field_choice_set module"
connection: local
hosts: localhost
tasks:
- name: Create a choice set with choices
netbox.netbox.netbox_custom_field_choice_set:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "ChoiceSetName"
description: "Choice Set Description"
extra_choices:
- ['choice1', 'label1']
- ['choice2', 'label2']
- name: Create a choice set with a base choice
netbox.netbox.netbox_custom_field_choice_set:
netbox_url: http://netbox.local
netbox_token: thisIsMyToken
data:
name: "ChoiceSetName"
description: "Choice Set Description"
order_alphabetically: true
base_choices: "IATA"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Serialized object as created/existent/updated/deleted within NetBox Returned: always |
|
Message indicating failure or info about what has been achieved Returned: always |