cisco.meraki.organizations_devices_packet_capture_captures_info module – Information module for organizations _devices _packet _capture _captures

Note

This module is part of the cisco.meraki collection (version 2.23.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.meraki 1.0.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples
Return Values

Synopsis

Information module for Organizations Devices Packet Capture Captures Info.
Get all organizations _devices _packet _capture _captures.
List Packet Captures. The current license level allows storage of up to 10 capture files in the cloud. When this limit is reached and a new capture is taken, the oldest capture will be automatically deleted to ensure sufficient space. Additional storage for switches will be available with an advantage license at a future date. These future capabilities will be consistent with what is available today via advantage licensing for access points.

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
adminName string	Information module for Organizations Devices Packet Capture Captures Info. AdminName query parameter. Return the packet captures matching the admin name.
captureIds list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. CaptureIds query parameter. Return the packet captures of the specified capture ids.
captureStatus list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. CaptureStatus query parameter. Return the packet captures of the specified capture status.
clientMac list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. ClientMac query parameter. Return the packet captures matching the specified client macs.
deviceName string	Information module for Organizations Devices Packet Capture Captures Info. DeviceName query parameter. Return the packet captures matching the specified device name.
direction string	direction (string), direction to paginate, either “next” (default) or “prev” page Default: `"https://api.meraki.com/api/v1"`
endingBefore string	Information module for Organizations Devices Packet Capture Captures Info. EndingBefore query parameter. A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
headers dictionary	Additional headers.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: `60`
meraki_api_key string / required	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	meraki_base_url (string), preceding all endpoint resources Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), log file name appended with date and timestamp Default: `"meraki_api_"`
meraki_log_path string	log_path (string), path to output log; by default, working directory of script if not specified Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), create an output log file? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), print logging output to console? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	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: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices: `false` `true` ← (default)
name list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. Name query parameter. Return the packet captures matching the specified name.
networkIds list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. NetworkIds query parameter. Return the packet captures of the specified network(s).
notes string	Information module for Organizations Devices Packet Capture Captures Info. Notes query parameter. Return the packet captures matching the specified notes.
organizationId string	Information module for Organizations Devices Packet Capture Captures Info. OrganizationId path parameter. Organization ID.
perPage integer	Information module for Organizations Devices Packet Capture Captures Info. PerPage query parameter. The number of entries per page returned. Acceptable range is 3 - 100. Default is 10.
process list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. Process query parameter. Return the packet captures of the specified process.
serials list / elements=string	Information module for Organizations Devices Packet Capture Captures Info. Serials query parameter. Return the packet captures of the specified device(s).
sortOrder string	Information module for Organizations Devices Packet Capture Captures Info. SortOrder query parameter. Sorted order of entries. Order options are ‘ascending’ and ‘descending’. Default is ‘descending’.
startingAfter string	Information module for Organizations Devices Packet Capture Captures Info. StartingAfter query parameter. A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.
t0 string	Information module for Organizations Devices Packet Capture Captures Info. T0 query parameter. The beginning of the timespan for the data. The maximum lookback period is 365 days from today.
t1 string	Information module for Organizations Devices Packet Capture Captures Info. T1 query parameter. The end of the timespan for the data. T1 can be a maximum of 365 days after t0.
timespan float	Information module for Organizations Devices Packet Capture Captures Info. Timespan query parameter. The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days.
total_pages string / required	total_pages(int), use with perPage to get total results up to total_pages*perPage; -1 for all pages

Notes

Note

SDK Method used are organizations.Organizations.get_organization_devices_packet_capture_captures,
Paths used are get /organizations/{organizationId}/devices/packetCapture/captures,
Supports 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 meraki SDK
The parameters starting with meraki_ are used by the Cisco meraki Python SDK to establish the connection

Examples

- name: Get all organizations _devices _packet _capture _captures
  cisco.meraki.organizations_devices_packet_capture_captures_info:
    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 }}"
    captureIds: []
    networkIds: []
    serials: []
    process: []
    captureStatus: []
    name: []
    clientMac: []
    notes: string
    deviceName: string
    adminName: string
    t0: string
    t1: string
    timespan: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    sortOrder: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meraki_response dictionary	A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: {"items": [{"admin": {"id": "string", "name": "string"}, "captureId": "string", "client": {"id": "string", "mac": "string"}, "counts": {"packets": {"total": 0}}, "destination": "string", "details": [{"name": "string", "productType": "string", "value": "string"}], "device": {"name": "string", "serial": "string"}, "devices": [{}], "duration": 0, "errorMessage": "string", "file": {"size": 0}, "filterExpression": "string", "interface": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": "string", "process": "string", "startTs": "string", "status": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Key

Description

meraki_response

dictionary

A dictionary or list with the response returned by the Cisco Meraki Python SDK

Returned: always

Sample: {"items": [{"admin": {"id": "string", "name": "string"}, "captureId": "string", "client": {"id": "string", "mac": "string"}, "counts": {"packets": {"total": 0}}, "destination": "string", "details": [{"name": "string", "productType": "string", "value": "string"}], "device": {"name": "string", "serial": "string"}, "devices": [{}], "duration": 0, "errorMessage": "string", "file": {"size": 0}, "filterExpression": "string", "interface": "string", "name": "string", "network": {"id": "string", "name": "string"}, "ports": "string", "process": "string", "startTs": "string", "status": "string"}], "meta": {"counts": {"items": {"remaining": 0, "total": 0}}}}

Authors

Francisco Munoz (@fmunoz)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/organizations_devices_packet_capture_captures_info_module.html

cisco.meraki.organizations_devices_packet_capture_captures_info module – Information module for organizations _devices _packet _capture _captures

Synopsis

Requirements

Parameters

Notes

See Also

Examples

Return Values

Authors

Collection links