netbox.netbox.netbox_token module – Creates or removes tokens from 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_token.

New in netbox.netbox 3.20.0

Synopsis

  • Creates or removes tokens 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 token configuration

description

string

The description of the token to be created

expires

string

When the token to be created should expire

key

string / required

Key of the token to be created. Must be exactly 40 characters

user

string

User the token to be created belongs to

write_enabled

boolean

Whether or not the token to be created should allow write operations

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

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create user to own the token
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: MyPassword
        state: present

    - name: Create token within NetBox with only required information
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          user: TestUser
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        state: present

    - name: Delete token within netbox
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        state: absent

    - name: Create token with all parameters
      netbox.netbox.netbox_token:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          user: TestUser
          key: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
          description: The test token
          write_enabled: false
          expires: 2024-08-26T14:49:01.345000+00:00
        state: present

Return Values

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

Key

Description

msg

string

Message indicating failure or info about what has been achieved

Returned: always

token

dictionary

Serialized object as created or already existent within NetBox

Returned: on creation

Authors

  • Daniel Chiquito (@dchiquito)