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

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

cert

any

Certificate path

data

dictionary / required

Defines the choice set

base_choices

string

Selection of base choice to use in the choice set

Choices:

  • "IATA"

  • "ISO_3166"

  • "UN_LOCODE"

description

string

Description of the choice set

extra_choices

list / elements=list

List of available choices in the choice set

Default: []

name

string / required

Name of the choice set

order_alphabetically

boolean

Order the choices alphabetically

Choices:

  • false

  • true

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

list / elements=string

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

string

The state of the object.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

Default: true

Notes

Note

  • This should be run with connection local and hosts localhost

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

custom_field_choice_set

dictionary

Serialized object as created/existent/updated/deleted within NetBox

Returned: always

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Philipp Rintz (@p-rintz)