#!/usr/bin/python
# -*- coding: utf-8 -*-

# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)

DOCUMENTATION = r"""
module: devices_live_tools_ping_device_info
short_description: Information module for devices _livetools _pingdevice
description:
  - Information module for Devices Livetools Pingdevice Info.
  - Get devices _livetools _pingdevice by id.
  - Return a ping device job. Latency unit in response is in milliseconds. Size is
    in bytes.
version_added: '1.0.0'
extends_documentation_fragment:
  - cisco.meraki.module_info
author: Francisco Munoz (@fmunoz)
options:
  headers:
    description: Additional headers.
    type: dict
  serial:
    description:
      - Information module for Devices Livetools Pingdevice Info.
      - Serial path parameter.
    type: str
  id:
    description:
      - Information module for Devices Livetools Pingdevice Info.
      - Id path parameter.
    type: str
requirements:
  - meraki >= 2.4.9
  - python >= 3.5
seealso:
  - name: Cisco Meraki documentation for devices getDeviceLiveToolsPingDevice
    description: Complete reference of the getDeviceLiveToolsPingDevice API.
    link: https://developer.cisco.com/meraki/api-v1/#!get-device-live-tools-ping-device
notes:
  - SDK Method used are
    devices.Devices.get_device_live_tools_ping_device,
  - Paths used are
    get /devices/{serial}/liveTools/pingDevice/{id},
"""

EXAMPLES = r"""
- name: Get devices _livetools _pingdevice by id
  cisco.meraki.devices_live_tools_ping_device_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 }}"
    serial: string
    id: string
  register: result
"""
RETURN = r"""
meraki_response:
  description: A dictionary or list with the response returned by the Cisco Meraki Python SDK
  returned: always
  type: dict
  sample: >
    {
      "pingId": "string",
      "url": "string",
      "request": {
        "serial": "string",
        "count": 0
      },
      "status": "string",
      "results": {
        "sent": 0,
        "received": 0,
        "loss": {
          "percentage": 0
        },
        "latencies": {
          "minimum": 0,
          "average": 0,
          "maximum": 0
        },
        "replies": [
          {
            "sequenceId": 0,
            "size": 0,
            "latency": 0
          }
        ]
      },
      "callback": {
        "id": "string",
        "url": "string",
        "status": "string"
      }
    }
"""
