controller_managed_device_group¶

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

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

Synopsis¶

Creates, updates or removes managed device groups 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 str		The name of the controller for this group Required if I(state=present) and the controller managed device group does not exist yet
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
id str		The UUID of the object to operate on Version Added: 5.13.0
name str		The name of the controller managed device groups Required if I(state=present) and the controller managed device group 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.
parent_cloud_network raw		The parent cloud network this network should be child to
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
radio_profiles dict		List of radio profiles to associate with this controller managed device group. Version Added: 6.3.0
radio_profiles.objects		List of radio profiles to associate.
radio_profiles.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.
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 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.
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.
weight int		weight of the managed device group
wireless_networks dict		List of wireless networks to associate with this controller managed device group. Version Added: 6.3.0
wireless_networks.objects		List of wireless networks to associate.
wireless_networks.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.

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 managed device group within Nautobot with only required information
      networktocode.nautobot.controller_managed_device_group:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "group_1"
        controller: my_controller
        state: present

    - name: Delete controller managed device group within nautobot
      networktocode.nautobot.controller_managed_device_group:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "group_1"
        controller: test_controller_group_3
        state: absent

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

    - name: Attach radio profiles to a controller managed device group
      networktocode.nautobot.controller_managed_device_group:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "group_1"
        controller: my_controller
        radio_profiles:
          state: merge
          objects:
            - radio_profile: "Indoor 5GHz"
            - radio_profile: "Outdoor 2.4GHz"
        state: present

    - name: Replace wireless networks on a controller managed device group
      networktocode.nautobot.controller_managed_device_group:
        url: http://nautobot.local
        token: thisIsMyToken
        name: "group_1"
        controller: my_controller
        wireless_networks:
          state: replace
          objects:
            - wireless_network: "Corp"
              vlan:
                name: "My VLAN"
                vid: 100
            - wireless_network: "Guest"
        state: present

Return Values¶

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

Sven Winkelmann (@pugnacity)