Interface ILiveToolsPingDevice

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

public interface ILiveToolsPingDevice

Methods

CreateDeviceLiveToolsPingDeviceAsync(string, LiveToolsPing, CancellationToken)

Enqueue a job to check connectivity status to the device

[Post("/devices/{serial}/liveTools/pingDevice")]
Task<LiveToolsPing> CreateDeviceLiveToolsPingDeviceAsync(string serial, LiveToolsPing createDeviceLiveToolsPingDevice, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

createDeviceLiveToolsPingDevice LiveToolsPing

Body

cancellationToken CancellationToken

Returns

Task<LiveToolsPing>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsPingDeviceAsync(string, string, CancellationToken)

Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.

[Get("/devices/{serial}/liveTools/pingDevice/{id}")]
Task<LiveToolsPing> GetDeviceLiveToolsPingDeviceAsync(string serial, string id, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

id string

cancellationToken CancellationToken

Returns

Task<LiveToolsPing>

Exceptions

ApiException

Thrown when fails to make API call