dynamic_group¶

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.5.0.

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

Synopsis¶

Creates or removes dynamic groups 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
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
content_type str		Required if I(state=present) and the dynamic group does not exist yet The app_label.model for the objects in the group
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		The description of the dynamic group
filter dict		A dictionary of filter parameters defining membership of this group
group_type str	Choices: dynamic-filter, dynamic-set, static	Required if I(state=present) and the dynamic group does not exist yet
id str		The UUID of the object to operate on Version Added: 5.13.0
name str		The name of the dynamic group Required if I(state=present) and the dynamic group does not exist yet
notes dict		Manage notes on the object Version Added: 6.3.0
notes.objects		List of notes to manage.
notes.state	Default: merge Choices: merge, replace, delete	C(merge) adds notes without removing existing ones. C(replace) enforces exactly the listed notes, removing any extras. C(delete) removes the listed notes.
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.
static_group_associations dict		Static group associations to manage on this dynamic group. Only applicable when I(group_type=static). Version Added: 6.2.0
static_group_associations.objects		List of static group associations to manage.
static_group_associations.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
tenant raw		The tenant that the dynamic group will be assigned to
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.
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

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(localhost)

Examples¶

---
- name: Create a dynamic group
  networktocode.nautobot.dynamic_group:
    url: http://nautobot.local
    token: thisIsMyToken
    name: TestFilterGroup
    group_type: dynamic-filter
    content_type: dcim.device
    filter:
      location:
        - "Child-Child Test Location"
    state: present

- name: Delete a dynamic group
  networktocode.nautobot.dynamic_group:
    url: http://nautobot.local
    token: thisIsMyToken
    name: TestFilterGroup
    state: absent

- name: Create a dynamic group with inline static group association associations
  networktocode.nautobot.dynamic_group:
    url: http://nautobot.local
    token: thisIsMyToken
    name: TestFilterGroup
    group_type: dynamic-filter
    content_type: dcim.device
    static_group_associations:
      state: merge
      objects:
        - associated_object_type: "dcim.device"
          associated_object_id: "{{ my_device['key'] }}"
    state: present

- name: Delete a dynamic group by id
  networktocode.nautobot.dynamic_group:
    url: http://nautobot.local
    token: thisIsMyToken
    id: 00000000-0000-0000-0000-000000000000
    state: absent

Return Values¶

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

Authors¶

Travis Smith (@tsm1th)