netbox.netbox.netbox_contact – Creates or removes contacts from NetBox

Note

This plugin is part of the netbox.netbox collection (version 3.5.0).

You might already have this collection installed if you are using the ansible package. 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 netbox.netbox.

To use it in a playbook, specify: netbox.netbox.netbox_contact.

New in version 3.5.0: of netbox.netbox

Synopsis

• Creates or removes contacts from NetBox

Requirements

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

• pynetbox

Parameters

Parameter		Choices/Defaults	Comments
cert raw			Certificate path
data dictionary / required			Defines the contact configuration
	address string		The address of the contact
	comments string		Comments on the contact
	contact_group raw		Group assignment for the contact
	custom_fields dictionary		must exist in NetBox
	email string		The email of the contact
	name string / required		Name of the contact to be created
	phone string		The phone number of the contact
	tags list / elements=raw		Any tags that the contact may need to be associated with
	title string		The title of the contact
netbox_token string / required			The NetBox API token.
netbox_url string / required			The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params list / elements=string			This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment.
state string		Choices: present ← absent	The state of the object.
validate_certs raw		Default: "yes"	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates.

Notes

Note

• Tags should be defined as a YAML list

• This should be ran with connection local and hosts localhost

Examples

- name: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: False
  tasks:
    - name: Create contact within NetBox with only required information
      netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Contact One
        state: present

    - name: Delete contact within netbox
      netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: Contact One
        state: absent

    - name: Create contact with all parameters
      netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          name: contact ABC
          title: Mr Contact
          phone: 123456789
          email: contac@contact.com
          tags:
            - tagA
            - tagB
            - tagC
        state: present

Return Values

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

Key	Returned	Description
contact dictionary	on creation	Serialized object as created or already existent within NetBox
msg string	always	Message indicating failure or info about what has been achieved

Authors

• Martin Rødvand (@rodvand)