cisco.dnac.application_visibility_network_devices_enable_cbar_v1 module – Resource module for Application Visibility Network Devices Enable Cbar V1

Note

This module is part of the cisco.dnac collection (version 6.27.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 cisco.dnac. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.dnac.application_visibility_network_devices_enable_cbar_v1.

New in cisco.dnac 6.17.0

Synopsis

  • Manage operation create of the resource Application Visibility Network Devices Enable Cbar V1.

  • This API can be used to enable CBAR feature on multiple network devices. Request payload should include the list of network devices where CBAR has to be enabled. It can optionally include list of interfaces wired or WLAN modes wireless to be excluded from CBAR enablement.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

networkDevices

list / elements=dictionary

Application Visibility Network Devices Enable Cbar’s networkDevices.

excludeInterfaceIds

list / elements=string

List of interface identifiers which needs to be excluded from CBAR enablement. Applicable only for wired devices. Please note that this list considered as absolute exclusion and earlier exclusions are not considered. For example, if IF1 and IF2 have already been excluded from CBAR as part of earlier enablement, and this API is now called with IF3 and IF4 as inputs, then IF1 and IF2 are removed from exclusion list and only IF3 and IF4 are excluded.

excludeWlanModes

list / elements=string

WLAN modes which needs to be excluded from CBAR enablement. Applicable only for wireless devices. Applicable values are LOCAL, FLEX, or FABRIC.

id

string

Network device identifier.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are application_policy.ApplicationPolicy.enable_c_b_a_r_feature_on_multiple_network_devices_v1,

  • Paths used are post /dna/intent/api/v1/applicationVisibility/networkDevices/enableCbar,

  • 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 DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Application Policy EnableCBARFeatureOnMultipleNetworkDevicesV1

Complete reference of the EnableCBARFeatureOnMultipleNetworkDevicesV1 API.

Examples

- name: Create
  cisco.dnac.application_visibility_network_devices_enable_cbar_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    networkDevices:
    - excludeInterfaceIds:
      - string
      excludeWlanModes:
      - string
      id: string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)