netbox.netbox.netbox_user_group module – Creates or removes user groups 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_user_group.

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	Certificate path
data	Defines the user group configuration
description	Description of the user group to be created
name	Name of the user group to be created
permissions	Permissions the user group to be created should have
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 group within NetBox with only required information
      netbox.netbox.netbox_user_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Group
        state: present

    - name: Create user belonging to the group
      netbox.netbox.netbox_user:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          username: MyUser
          password: MyPassword
          groups:
            - My Group
        state: present

    - name: Delete user group within netbox
      netbox.netbox.netbox_user_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Group
        state: absent

    - name: Create user group with all parameters
      netbox.netbox.netbox_user_group:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: My Group
          description: The group I made
        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
user_group	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation

Authors

• Daniel Chiquito (@dchiquito)

Collection links