networktocode.nautobot.admin_user module – Create, update or delete users within Nautobot

Note

This module is part of the networktocode.nautobot collection (version 5.3.1).

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 networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.admin_user.

New in networktocode.nautobot 5.3.0

Synopsis

  • Creates, updates or removes users from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

  • pynautobot

Parameters

Parameter

Comments

API Version Nautobot REST API

email

The email of the user

first_name

The first name of the user

groups

The groups the user is assigned to

is_active

is_staff

is_superuser

last_name

The last name of the user

This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined

in plugins/module_utils/utils.py and provides control to users on what may make

an object unique in their environment.

state

token

The token created within Nautobot to authorize API access

Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.

url

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.

username

The name of the user

validate_certs

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Can be omitted if the :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured.

:ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

  • This should be ran with connection local and hosts localhost

Examples

- name: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: False

  tasks:
    - name: Create user within Nautobot with only required information
      networktocode.nautobot.admin_user:
        url: http://nautobot.local
        token: thisIsMyToken
        username: nb_user
        email: nb_user@example.com
        first_name: nb
        last_name: user
        state: present

    - name: Delete user within nautobot
      networktocode.nautobot.admin_user:
        url: http://nautobot.local
        token: thisIsMyToken
        username: nb_user
        email: nb_user@example.com
        first_name: nb
        last_name: user
        state: absent

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

user

Serialized object as created or already existent within Nautobot

:ansible-option-returned-bold:`Returned:` success (when state=present)

Authors

  • Jeff Kala (@jeffkala)