cisco.catalystcenter.icap_capture_files_info module -- Information module for Icap Capture Files

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Icap Capture Files. - > Lists the ICAP packet capture pcap files matching the specified criteria. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en- programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-icap-1.0.0-resolved.yaml.

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

apMac

string

ApMac query parameter. The base radio macAddress of the access point.

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:

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:

catc_version

string

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

Default: :ansible-option-default:`"2.3.7.6"`

clientMac

string

ClientMac query parameter. The macAddress of client.

endTime

float

EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

headers

dictionary

Additional headers.

limit

float

Limit query parameter. Maximum number of records to return.

offset

float

Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1.

order

string

Order query parameter. The sort order of the field ascending or descending.

sortBy

string

SortBy query parameter. A field within the response to sort by.

startTime

float

StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

type

string

Type query parameter. Capture Type.

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 sensors.Sensors.lists_i_cap_packet_capture_files_matching_specified_criteria,

  • Paths used are get /dna/data/api/v1/icap/captureFiles,

  • Supports 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 Sensors ListsICAPPacketCaptureFilesMatchingSpecifiedCriteria

Complete reference of the ListsICAPPacketCaptureFilesMatchingSpecifiedCriteria API.

Examples

---
- name: Get all Icap Capture Files
  cisco.catalystcenter.icap_capture_files_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    type: string
    clientMac: string
    apMac: string
    startTime: 0
    endTime: 0
    limit: 0
    offset: 0
    sortBy: string
    order: string
  register: result

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:`{"page": {"count": 0, "limit": 0, "offset": 0, "order": "string", "sortBy": "string"}, "response": [{"apMac": "string", "clientMac": "string", "fileCreationTimestamp": 0, "fileName": "string", "fileSize": 0, "id": "string", "lastUpdatedTimestamp": 0, "type": "string"}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)