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

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	Certificate path
data	Defines the token configuration
description	The description of the token to be created
expires	When the token to be created should expire
key	Key of the token to be created. Must be exactly 40 characters
user	User the token to be created belongs to
write_enabled	Whether or not the token to be created should allow write operations :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`Default:` :ansible-option-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	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always
token	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation

Authors

• Daniel Chiquito (@dchiquito)

Collection links