Interface ILiveToolsPing

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

public interface ILiveToolsPing

Methods

CreateDeviceLiveToolsPingAsync(string, LiveToolsPingCreate, CancellationToken)

Enqueue a job to ping a target host from the device

[Post("/devices/{serial}/liveTools/ping")]
Task<LiveToolsPing> CreateDeviceLiveToolsPingAsync(string serial, LiveToolsPingCreate createDeviceLiveToolsPing, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

createDeviceLiveToolsPing LiveToolsPingCreate

Body

cancellationToken CancellationToken

Returns

Task<LiveToolsPing>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsPingAsync(string, string, CancellationToken)

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

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

Parameters

serial string

The serial number

id string

The device id

cancellationToken CancellationToken

Returns

Task<LiveToolsPing>

Exceptions

ApiException

Thrown when fails to make API call