cisco.catalystcenter.endpoint_analytics_endpoints module -- Resource module for Endpoint Analytics Endpoints

Note

This module is part of the cisco.catalystcenter collection (version 2.3.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_endpoints.

New in cisco.catalystcenter 6.16.0

Synopsis

• Manage operations create, update and delete of the resource Endpoint Analytics Endpoints.

• Register a new endpoint in the system.

• Deletes the endpoint for the given unique identifier 'epId'.

• Update attributes of a registered endpoint.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.6.0.0

• python >= 3.12

Parameters

Parameter	Comments
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"`
deviceType string	Type of the device represented by this endpoint.
epId string	EpId path parameter. Unique identifier for the endpoint.
hardwareManufacturer string	Hardware manufacturer for the endpoint.
hardwareModel string	Hardware model of the endpoint.
macAddress string	MAC address 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.delete_an_endpoint, ai_endpoint_analytics.AiEndpointAnalytics.register_an_endpoint, ai_endpoint_analytics.AiEndpointAnalytics.update_a_registered_endpoint,

• Paths used are post /dna/intent/api/v1/endpoint-analytics/endpoints, delete /dna/intent/api/v1/endpoint-analytics/endpoints/{epId}, put /dna/intent/api/v1/endpoint-analytics/endpoints/{epId},

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

Complete reference of the RegisterAnEndpoint API.

Cisco DNA Center documentation for AI Endpoint Analytics DeleteAnEndpoint

Complete reference of the DeleteAnEndpoint API.

Cisco DNA Center documentation for AI Endpoint Analytics UpdateARegisteredEndpoint

Complete reference of the UpdateARegisteredEndpoint API.

Examples

---
- name: Create
  cisco.catalystcenter.endpoint_analytics_endpoints:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    deviceType: string
    hardwareManufacturer: string
    hardwareModel: string
    macAddress: string
- name: Delete by id
  cisco.catalystcenter.endpoint_analytics_endpoints:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    epId: string
- name: Update by id
  cisco.catalystcenter.endpoint_analytics_endpoints:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    deviceType: string
    epId: string
    hardwareManufacturer: string
    hardwareModel: 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: :ansible-rv-sample-value:`{}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)