networktocode.nautobot.contact module – Creates or removes contacts from Nautobot

Note

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

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

New in networktocode.nautobot 5.3.0

Synopsis

  • Creates or removes contacts from Nautobot

Requirements

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

  • pynautobot

Parameters

Parameter

Comments

address

The address of the contact

API Version Nautobot REST API

comments

Comments about the contact

Must exist in Nautobot and in key/value format

email

The email of the contact

name

The name of the contact

phone

The phone number of the contact

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.

state

Any tags that this item may need to be associated with

teams

The teams the contact is associated with

token

The token created within Nautobot to authorize API access

Can be omitted if the :ansenvvarref:`NAUTOBOT\_TOKEN` environment variable is configured.

url

The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000)

Can be omitted if the :ansenvvarref:`NAUTOBOT\_URL` environment variable is configured.

validate_certs

If 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 :ansenvvar:`NAUTOBOT\_VALIDATE\_CERTS` environment variable is configured.

:ansible-option-default-bold:`Default:` :ansible-option-default:`true`

Notes

Note

  • Tags should be defined as a YAML list

  • This should be ran with connection local and hosts localhost

Examples

---
- name: Create a contact
  networktocode.nautobot.contact:
    url: http://nautobot.local
    token: thisIsMyToken
    name: My Contact
    phone: 123-456-7890
    email: user@example.com
    address: 1234 Main St
    teams:
      - name: team1
      - name: team2
    comments: My Comments
    tags:
      - tag1
      - tag2
    custom_fields:
      my_custom_field: my_value
    state: present

- name: Delete a contact
  networktocode.nautobot.contact:
    url: http://nautobot.local
    token: thisIsMyToken
    name: My Contact
    state: absent

Return Values

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

Key

Description

contact

Serialized object as created or already existent within Nautobot

:ansible-option-returned-bold:`Returned:` success (when state=present)

msg

Message indicating failure or info about what has been achieved

:ansible-option-returned-bold:`Returned:` always

Authors

  • Joe Wesch (@joewesch)