cisco.catalystcenter.endpoint_analytics_cmdb_endpoints_v1 module -- Resource module for Endpoint Analytics Cmdb Endpoints 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.endpoint_analytics_cmdb_endpoints_v1.

New in cisco.catalystcenter 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.

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

_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:

_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:

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 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 AI Endpoint Analytics ProcessCMDBEndpointsV1

Complete reference of the ProcessCMDBEndpointsV1 API.

Examples

- name: Create
  cisco.catalystcenter.endpoint_analytics_cmdb_endpoints_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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

catalystcenter_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)