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).
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_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 |
---|---|
Certificate path |
|
Defines the user group configuration |
|
Description of the user group to be created |
|
Name of the user group to be created |
|
Permissions the user group to be created should have |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
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. |
|
The state of the object. Choices:
|
|
If This should only be used on personally controlled sites using a self-signed certificates. Default: |
Notes
Note
Tags should be defined as a YAML list
This should be ran with connection
local
and hostslocalhost
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 |
---|---|
Message indicating failure or info about what has been achieved Returned: always |
|
Serialized object as created or already existent within NetBox Returned: on creation |