W3cubDocs

/Ansible

cisco.dnac.endpoint_analytics_cmdb_endpoints_v1 module – Resource module for Endpoint Analytics Cmdb Endpoints V1

Note

This module is part of the cisco.dnac collection (version 6.31.3).

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

New in cisco.dnac 6.16.0

Synopsis

  • Manage operation create of the resource Endpoint Analytics Cmdb Endpoints V1.
  • Processes incoming CMDB endpoints data and imports the same in AI Endpoint Analytics.

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"

payload

list / elements=dictionary

Endpoint Analytics Cmdb Endpoints’s payload.

assetTag

string

Asset tag.

department

string

Department that asset belongs to.

displayName

string

Display name of the asset.

lastUpdateTimestamp

integer

Last update timestamp in epoch milliseconds.

location

string

Location of the asset.

macAddress

string

MAC address of the endpoint.

managedBy

string

Asset managed by.

model

string

Asset model.

modelCategory

string

Category of the model.

serialNumber

string

Serial number of the endpoint.

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 a_i_endpoint_analytics.AIEndpointAnalytics.process_cmdb_endpoints_v1,
  • Paths used are post /dna/intent/api/v1/endpoint-analytics/cmdb/endpoints,
  • 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 AI Endpoint Analytics ProcessCMDBEndpointsV1

Complete reference of the ProcessCMDBEndpointsV1 API.

Examples

- name: Create
  cisco.dnac.endpoint_analytics_cmdb_endpoints_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}}"
    payload:
      - assetTag: string
        department: string
        displayName: string
        lastUpdateTimestamp: 0
        location: string
        macAddress: string
        managedBy: string
        model: string
        modelCategory: string
        serialNumber: 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: {}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/endpoint_analytics_cmdb_endpoints_v1_module.html