admin_user

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 5.3.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis

• Creates, updates or removes users from Nautobot

Requirements

The following Python packages are needed on the host that executes this module:

• pynautobot

Parameters

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
email str		The email of the user
first_name str		The first name of the user
groups list / elements=raw		The groups the user is assigned to
id str		The UUID of the object to operate on Version Added: 5.13.0
is_active bool		If the user should be active
is_staff bool		If the user should be set for staff status
is_superuser bool		If the user should be set for superuser status
last_name str		The last name of the user
query_params list / elements=str		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. Version Added: 3.0.0
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
username str		The name of the user Required if I(state=present) and the user does not exist yet
validate_certs raw	Default: True	If C(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 E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes

Note

• This should be ran with connection C(local) and hosts C(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: [email protected]
        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: [email protected]
        first_name: nb
        last_name: user
        state: absent

    - name: Delete user by id
      networktocode.nautobot.admin_user:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
user	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors

• Jeff Kala (@jeffkala)