Skip to content

relationship_association

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

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

Synopsis

  • Creates or removes a relationship association from Nautobot

Requirements

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

Parameters

Parameter Defaults / Choices Comments
api_version
str		 API Version Nautobot REST API
Version Added: 4.1.0
destination_id
str		 The UUID of the destination of the relationship
Required if I(state=present) and the relationship association does not exist yet
destination_type
str		 The app_label.model for the destination of the relationship
Required if I(state=present) and the relationship association does not exist yet
id
str		 The UUID of the object to operate on
Version Added: 5.13.0
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
relationship
raw		 The Relationship UUID to add the association to
Required if I(state=present) and the relationship association does not exist yet
source_id
str		 The UUID of the source of the relationship
Required if I(state=present) and the relationship association does not exist yet
source_type
str		 The app_label.model for the source of the relationship
Required if I(state=present) and the relationship association does not exist yet
state
str		 Default: present
Choices: absent, present		 Use C(present) or C(absent) for adding or removing.
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.

Examples

- name: "Test relationship association creation/deletion"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Create relationship association
      networktocode.nautobot.relationship_association:
        url: http://nautobot.local
        token: thisIsMyToken
        relationship: 01234567-abcd-0123-abcd-012345678901
        source_type: dcim.device
        source_id: abcdefgh-0123-abcd-0123-abcdefghijkl
        destination_type: ipam.vrf
        destination_id: 01234567-abcd-0123-abcd-123456789012

    - name: Delete relationship association
      networktocode.nautobot.relationship_association:
        url: http://nautobot.local
        token: thisIsMyToken
        relationship: 01234567-abcd-0123-abcd-012345678901
        source_type: dcim.device
        source_id: abcdefgh-0123-abcd-0123-abcdefghijkl
        destination_type: ipam.vrf
        destination_id: 01234567-abcd-0123-abcd-123456789012
        state: absent

    - name: Delete relationship association by id
      networktocode.nautobot.relationship_association:
        url: http://nautobot.local
        token: thisIsMyToken
        id: 00000000-0000-0000-0000-000000000000
        state: absent

Return Values

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

Authors

  • Network To Code (@networktocode)
  • Joe Wesch (@joewesch)