netbox.netbox.netbox_user module – Creates or removes users 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_user.

New in netbox.netbox 3.20.0

Synopsis

  • Creates or removes users 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 user configuration

email

string

Email of the user to be created

first_name

string

First name of the user to be created

groups

list / elements=string

Groups the user to be created should belong to

is_active

boolean

Active status of the user to be created

Choices:

  • false

  • true

is_staff

boolean

Staff status of the user to be created

Choices:

  • false

  • true

last_name

string

Last name of the user to be created

password

string

Password of the user to be created. If this is specified, the password field will always be updated.

permissions

list / elements=string

Permissions the user to be created should have

username

string / required

Username of the user to be created

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 within NetBox with only required information
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: MyPassword
        state: present

    - name: Update a user's email
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: [email protected]
        state: present

    - name: Delete user within netbox
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
        state: absent

    - name: Create user with all parameters
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser2
          password: MyPassword
          email: [email protected]
          first_name: My
          last_name: User
        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

user

dictionary

Serialized object as created or already existent within NetBox

Returned: on creation

Authors

  • Daniel Chiquito (@dchiquito)