networktocode.nautobot.relationship_association module – Creates or removes a relationship association from Nautobot

Note

This module is part of the networktocode.nautobot collection (version 4.1.1).

To install it, use: ansible-galaxy collection install networktocode.nautobot. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: networktocode.nautobot.relationship_association.

New in version 4.0.0: of networktocode.nautobot

Synopsis

  • Creates or removes a relationship association from Nautobot

Requirements

The below requirements are needed on the host that executes this module.

  • pynautobot

Parameters

Parameter

Comments

api_version

string

added in 4.1.0 of networktocode.nautobot

API Version Nautobot REST API

destination_id

string / required

The UUID of the destination of the relationship

destination_type

string / required

The app_label.model for the destination of the relationship

query_params

list / elements=string

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.

relationship

string / required

The Relationship UUID to add the association to

source_id

string / required

The UUID of the source of the relationship

source_type

string / required

The app_label.model for the source of the relationship

state

string

Use present or absent for adding or removing.

Choices:

  • absent

  • present ← (default)

token

string / required

The token created within Nautobot to authorize API access

url

string / required

URL of the Nautobot instance resolvable by Ansible control host

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using self-signed certificates.

Default: “true”

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

msg

string

Message indicating failure or info about what has been achieved

Returned: always

relationship_associations

dictionary

Serialized object as created/existent/updated/deleted within Nautobot

Returned: always

Authors

  • Network to Code (@networktocode)

  • Joe Wesch (@joewesch)