netbox.netbox.netbox_contact_assignment module – Creates or removes contact assignments from NetBox

Note

This module is part of the netbox.netbox collection (version 3.22.0).

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. You need further requirements to be able to use this module, see Requirements for details.

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

New in netbox.netbox 3.1.0

Synopsis

• Creates or removes contact assignments from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the contact configuration
contact	The name of the contact to assign to the object
object_name	The name of the object the contact is assigned to
object_type	The type of the object the contact is assigned to :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"circuit"` :ansible-option-choices-entry:`"cluster"` :ansible-option-choices-entry:`"cluster\_group"` :ansible-option-choices-entry:`"device"` :ansible-option-choices-entry:`"location"` :ansible-option-choices-entry:`"manufacturer"` :ansible-option-choices-entry:`"power\_panel"` :ansible-option-choices-entry:`"provider"` :ansible-option-choices-entry:`"rack"` :ansible-option-choices-entry:`"region"` :ansible-option-choices-entry:`"site"` :ansible-option-choices-entry:`"site\_group"` :ansible-option-choices-entry:`"tenant"` :ansible-option-choices-entry:`"virtual\_machine"`
priority	The priority of this contact :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"primary"` :ansible-option-choices-entry:`"secondary"` :ansible-option-choices-entry:`"tertiary"` :ansible-option-choices-entry:`"inactive"`
role	The name of the role the contact has for this object
tags	Any tags that the contact may need to be associated with
headers	Dictionary of headers to be passed to the NetBox API.
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :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: "Test NetBox module"
  connection: local
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Assign a contact to a location with only required information
      netbox.netbox.netbox_contact_assignment:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          object_type: location
          object_name: My Location
          contact: John Doe
          role: Supervisor Role
        state: present

    - name: Delete contact assignment within netbox
      netbox.netbox.netbox_contact_assignment:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          object_type: location
          object_name: My Location
          contact: John Doe
          role: Supervisor Role
        state: absent

    - name: Create contact with all parameters
      netbox.netbox.netbox_contact:
        netbox_url: http://netbox.local
        netbox_token: thisIsMyToken
        data:
          object_type: location
          object_name: My Location
          contact: John Doe
          role: Supervisor Role
          priority: tertiary
          tags:
            - tagA
            - tagB
            - tagC
        state: present

Return Values

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

Key	Description
contact_assignment	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` on creation
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Daniel Chiquito (@dchiquito)

Collection links