cisco.catalystcenter.network_devices_device_controllability_settings_v1 module -- Resource module for Network Devices Device Controllability Settings V1

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.network_devices_device_controllability_settings_v1.

New in cisco.catalystcenter 6.15.0

Synopsis

• Manage operation update of the resource Network Devices Device Controllability Settings V1.

• Device Controllability is a system-level process on Catalyst Center that enforces state synchronization for some device-layer features. Its purpose is to aid in the deployment of required network settings that Catalyst Center needs to manage devices. Changes are made on network devices during discovery, when adding a device to Inventory, or when assigning a device to a site. If changes are made to any settings that are under the scope of this process, these changes are applied to the network devices during the Provision and Update Telemetry Settings operations, even if Device Controllability is disabled. The following device settings will be enabled as part of Device Controllability when devices are discovered.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
autocorrectTelemetryConfig boolean	If it is true, autocorrect telemetry config is enabled. If it is false, autocorrect telemetry config is disabled. The autocorrect telemetry config feature is supported only when device controllability is enabled. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
deviceControllability boolean	If it is true, device controllability is enabled. If it is false, device controllability is disabled. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are site_design.SiteDesign.update_device_controllability_settings_v1,

• Paths used are put /dna/intent/api/v1/networkDevices/deviceControllability/settings,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Site Design UpdateDeviceControllabilitySettingsV1

Complete reference of the UpdateDeviceControllabilitySettingsV1 API.

Examples

- name: Update all
  cisco.catalystcenter.network_devices_device_controllability_settings_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    autocorrectTelemetryConfig: true
    deviceControllability: true

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)