cisco.catalystcenter.endpoint_analytics_cmdb_endpoints module -- Resource module for Endpoint Analytics Cmdb Endpoints

Note

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

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

New in cisco.catalystcenter 6.16.0

Synopsis

• Manage operation create of the resource Endpoint Analytics Cmdb Endpoints.

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-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 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 ai_endpoint_analytics.AiEndpointAnalytics.process_cmdb_endpoints,

• 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 uses the embedded connection manager from Cisco CATALYST SDK

See Also

See also

Cisco DNA Center documentation for AI Endpoint Analytics ProcessCMDBEndpoints

Complete reference of the ProcessCMDBEndpoints API.

Examples

---
- name: Create
  cisco.catalystcenter.endpoint_analytics_cmdb_endpoints:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)