cisco.meraki.organizations_devices_packet_capture_schedules module -- Resource module for organizations _devices _packet _capture _schedules
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_schedules.
New in cisco.meraki 1.0.0
Synopsis
Manage operations create, update and delete of the resource organizations _devices _packet _capture _schedules.
Create a schedule for packet capture.
Delete schedule from cloud.
Update a schedule for packet capture.
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 |
|---|---|
Device details. |
|
Interface to capture. |
|
Serial of the devices to schedule packet capture. |
|
Switchports to capture. |
|
Duration of the capture in seconds. |
|
Enable or disable the schedule. Choices: |
|
Filter expression for the capture. |
|
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 the packet capture file. |
|
Reason for capture. |
|
OrganizationId path parameter. Organization ID. |
|
Schedule details. |
|
End date and time of the recurring schedule entry. |
|
Frequency of the recurring schedule entry (hour, week, month, day, minute). |
|
Name of the schedule. |
|
Cardinality of the schedule frequency, ex. 1 = every day, 2 = every other day (when frequency = day). |
|
Start date and time of the recurring schedule entry. |
|
Weekdays for the schedule Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. |
|
ScheduleId path parameter. Schedule ID. |
Notes
Note
SDK Method used are organizations.Organizations.create_organization_devices_packet_capture_schedule, organizations.Organizations.delete_organization_devices_packet_capture_schedule, organizations.Organizations.update_organization_devices_packet_capture_schedule,
Paths used are post /organizations/{organizationId}/devices/packetCapture/schedules, delete /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId}, put /organizations/{organizationId}/devices/packetCapture/schedules/{scheduleId},
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 createOrganizationDevicesPacketCaptureSchedule
Complete reference of the createOrganizationDevicesPacketCaptureSchedule API.
- Cisco Meraki documentation for organizations deleteOrganizationDevicesPacketCaptureSchedule
Complete reference of the deleteOrganizationDevicesPacketCaptureSchedule API.
- Cisco Meraki documentation for organizations updateOrganizationDevicesPacketCaptureSchedule
Complete reference of the updateOrganizationDevicesPacketCaptureSchedule API.
Examples
- name: Create
cisco.meraki.organizations_devices_packet_capture_schedules:
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
devices:
- interface: TenGigabitEthernet0/0/0
serial: Q234-ABCD-5678
switchports: 1, 2
duration: 60
enabled: true
filterExpression: (icmp)
name: daily_capture_for_debugging
notes: Debugging persistent issue on device
organizationId: string
schedule:
endTs: '2021-01-01T14:00:00Z'
frequency: daily
name: Daily at 1pm
recurrence: 1
startTs: '2021-01-01T13:00:00Z'
weekdays:
- Monday
- Wednesday
- Friday
- name: Update by id
cisco.meraki.organizations_devices_packet_capture_schedules:
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
devices:
- interface: TenGigabitEthernet0/0/0
serial: Q234-ABCD-5678
switchports: 1, 2
duration: 60
enabled: true
filterExpression: (icmp)
name: daily_capture_for_debugging
notes: Debugging persistent issue on device
organizationId: string
schedule:
endTs: '2021-01-01T14:00:00Z'
frequency: daily
name: Daily at 1pm
recurrence: 1
startTs: '2021-01-01T13:00:00Z'
weekdays:
- Monday
- Wednesday
- Friday
scheduleId: string
- name: Delete by id
cisco.meraki.organizations_devices_packet_capture_schedules:
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
organizationId: string
scheduleId: 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 |