static_group_association

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 or removes a static group association from Nautobot

Requirements

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

• pynautobot

Parameters

Parameter	Data Type	Environment Variable	Comments
api_version	str		API Version Nautobot REST API Version Added: 4.1.0
associated_object_id required	str		The UUID of the object in the relationship
associated_object_type required	str		The app_label.model for the object in the relationship
custom_fields	dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
dynamic_group required	raw		The dynamic group to add the association to
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.
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.

Examples

- name: "Test static group association creation/deletion"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create static group association
      networktocode.nautobot.static_group_association:
        url: http://nautobot.local
        token: thisIsMyToken
        dynamic_group: 01234567-abcd-0123-abcd-012345678901
        associated_object_type: dcim.device
        associated_object_id: abcdefgh-0123-abcd-0123-abcdefghijkl

    - name: Delete static group association
      networktocode.nautobot.static_group_association:
        url: http://nautobot.local
        token: thisIsMyToken
        dynamic_group: 01234567-abcd-0123-abcd-012345678901
        associated_object_type: dcim.device
        associated_object_id: abcdefgh-0123-abcd-0123-abcdefghijkl
        state: absent

Return Values

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
static_group_association	dict	Serialized object as created/existent/updated/deleted within Nautobot	always

Authors

• Network To Code (@networktocode)
• Travis Smith (@tsm1th)