controller¶

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, updates or removes controllers from Nautobot.

Requirements¶

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

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
controller_device str		Device that runs the controller software
controller_device_redundancy_group str		Related device redundancy group the controller will be assigned to
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
description str		Description of the controller
external_integration str		External connection for the controller, such as Meraki Cloud URL
id str		The UUID of the object to operate on Version Added: 5.13.0
location raw		Required if I(state=present) and the controller does not exist yet
name str		The name of the controller Required if I(state=present) and the controller 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.
platform raw		The platform of the controller
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
role raw		Required if I(state=present) and the controller does not exist yet
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
status raw		The status of the controller Required if I(state=present) and the controller does not exist yet
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
tenant raw		The tenant that the controller will be assigned to
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: "Test Nautobot modules"
  connection: local
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Create controller within Nautobot with only required information
      networktocode.nautobot.controller:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "test_controller_2"
        location: My Location
        status: "Active"
        state: present

    - name: "CREATE THE SECOND CONTROLLER"
      networktocode.nautobot.controller:
        name: "test_controller_3"
        url: http://nautobot.local
        token: thisIsMyToken
        status: "Active"
        description: "Description of the controller"
        location: "Cisco"
        external_integration: "Cisco Catalyst SD-WAN"
        role: "Administrative"
        platform: "Cisco IOS"
        tenant: "Nautobot Baseball Stadiums"
        controller_device_redundancy_group: "controller_test"
        notes:
          objects:
            - note: Example note text
        contacts:
          objects:
            - contact: Jane Doe
              role: User
              status: Active
            - contact:
                name: John Smith
              role: User
              status: Active
            - contact:
                name: John Smith, Jr.
              role: User
              status: Active
          teams:
            objects:
              - team: Network Team
                role: Admin
                status: Active

    - name: Delete controller within nautobot
      networktocode.nautobot.controller:
        url: http://nautobot.local
        token: thisIsMyToken
        name: test_controller_3
        state: absent

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

Return Values¶

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

Josh Vanderaa (@jvanderaa)