cisco.meraki.organizations_devices_packet_capture_captures module -- Resource module for organizations _devices _packet _capture _captures
Note
This module is part of the cisco.meraki collection (version 2.22.0).
To install it, use: ansible-galaxy collection install cisco.meraki.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.organizations_devices_packet_capture_captures.
New in cisco.meraki 1.0.0
Synopsis
Manage operations create and delete of the resource organizations _devices _packet _capture _captures.
Perform a packet capture on a device and store in Meraki Cloud. Only a single switch may be chosen per request, while multiple access points are allowed at once.
Delete a single packet capture from cloud using captureId.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Advanced filters for IOSXE devices (supported for Campus Gateway devices only). |
|
Number of buffer files for circular buffer capture (1-5 for Campus Gateway devices). |
|
Type of capture. Possible values linear (default), circular. |
|
Direction for control plane capture. |
|
Inner MAC address filter for tunneled traffic (up to 5 MAC addresses for Campus Gateway devices). |
|
Maximum file size in megabytes (MB). Range 1-100 MB when bufferFiles=1, 1-500 MB when bufferFiles=2-5. |
|
Packets per second limit for Campus Gateway devices (1-1000000). |
|
Direction for physical interface capture. |
|
CaptureId path parameter. Capture ID. |
|
Destination of packet capture file. Possible values upload_to_cloud. |
|
Duration in seconds of packet capture. |
|
Filter expression for packet capture. |
|
Interface of the device. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: :ansible-option-default:`60` |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: :ansible-option-default:`"https://api.meraki.com/api/v1"` |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: :ansible-option-default:`""` |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: :ansible-option-default:`""` |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices: |
|
meraki_log_file_prefix (string), log file name appended with date and timestamp |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: :ansible-option-default:`""` |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: :ansible-option-default:`2` |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: :ansible-option-default:`60` |
|
meraki_output_log (boolean), create an output log file? Choices: |
|
meraki_print_console (boolean), print logging output to console? Choices: |
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: :ansible-option-default:`""` |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices: |
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: :ansible-option-default:`60` |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices: |
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: :ansible-option-default:`60` |
|
meraki_suppress_logging (boolean), disable all logging? you're on your own then! Choices: |
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices: |
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices: |
|
Name of packet capture file. |
|
Reason for taking the packet capture. |
|
OrganizationId path parameter. Organization ID. |
|
Output type of packet capture file. Possible values text, pcap, cloudshark, or upload_to_cloud. |
|
Ports of packet capture file, comma-separated. |
|
The serial(s) of the device(s). |
Notes
Note
SDK Method used are organizations.Organizations.create_organization_devices_packet_capture_capture, organizations.Organizations.delete_organization_devices_packet_capture_capture,
Paths used are post /organizations/{organizationId}/devices/packetCapture/captures, delete /organizations/{organizationId}/devices/packetCapture/captures/{captureId},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager
from Cisco Dashboard API Python(SDK)
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for organizations createOrganizationDevicesPacketCaptureCapture
Complete reference of the createOrganizationDevicesPacketCaptureCapture API.
- Cisco Meraki documentation for organizations deleteOrganizationDevicesPacketCaptureCapture
Complete reference of the deleteOrganizationDevicesPacketCaptureCapture API.
Examples
- name: Create
cisco.meraki.organizations_devices_packet_capture_captures:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: present
advanced:
bufferFiles: 5
captureType: circular
controlPlaneDirection: both
innerFilterMacs:
- aa:bb:cc:dd:ee:ff
- 11:22:33:44:55:66
maxFilesize: 10
packetsPerSecond: 10000
physicalInterfaceDirection: both
destination: upload_to_cloud
duration: 3
filterExpression: host 10.1.27.253
interface: wireless
name: Capture no. 3
notes: Debugging connectivity issue...
organizationId: string
outputType: upload_to_cloud
ports: 1, 3
serials:
- Q234-ABCD-5678
- name: Delete by id
cisco.meraki.organizations_devices_packet_capture_captures:
meraki_api_key: "{{ meraki_api_key }}"
meraki_base_url: "{{ meraki_base_url }}"
meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
meraki_certificate_path: "{{ meraki_certificate_path }}"
meraki_requests_proxy: "{{ meraki_requests_proxy }}"
meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
meraki_maximum_retries: "{{ meraki_maximum_retries }}"
meraki_output_log: "{{ meraki_output_log }}"
meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
meraki_log_path: "{{ meraki_log_path }}"
meraki_print_console: "{{ meraki_print_console }}"
meraki_suppress_logging: "{{ meraki_suppress_logging }}"
meraki_simulate: "{{ meraki_simulate }}"
meraki_be_geo_id: "{{ meraki_be_geo_id }}"
meraki_caller: "{{ meraki_caller }}"
meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
state: absent
captureId: string
organizationId: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always |