admin_user¶

Collection Note

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

ansible-galaxy collection install networktocode.nautobot

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	Data Type	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	The groups the user is assigned to
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	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	Use C(present) or C(absent) for adding or removing.
token required	str	The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url required	str	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 required	str	The name of the user
validate_certs	raw	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: &#34;Test Nautobot modules&#34;
  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¶

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)