contact¶

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

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

Synopsis¶

Creates or removes contacts from Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
address str		The address of the contact
api_version str		API Version Nautobot REST API Version Added: 4.1.0
comments str		Comments about the contact
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
email str		The email of the contact
id str		The UUID of the object to operate on Version Added: 5.13.0
name str		The name of the contact Required if I(state=present) and the contact 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.
phone str		The phone number of the contact
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.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams list / elements=raw		The teams the contact is associated with
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 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

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

Return Values¶

Key	Data Type	Description	Returned
contact	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¶

Joe Wesch (@joewesch)