Interface ILiveToolsTraceRoute

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

I Live Tools Trace Route

public interface ILiveToolsTraceRoute

Methods

CreateDeviceLiveToolsTraceRouteAsync(string, DeviceLiveToolsTraceRouteCreateRequest, CancellationToken)

Enqueue a job to run trace route in the device. This endpoint has a sustained rate limit of one request every five seconds per device, with an allowed burst of five requests.

[Post("/devices/{serial}/liveTools/traceRoute")]
Task<DeviceLiveToolsTraceRouteCreateResponse> CreateDeviceLiveToolsTraceRouteAsync(string serial, DeviceLiveToolsTraceRouteCreateRequest request, CancellationToken cancellationToken = default)

Parameters

serial string

request DeviceLiveToolsTraceRouteCreateRequest

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsTraceRouteCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetTraceRouteAsync(string, string, CancellationToken)

Return a trace route job

[Get("/devices/{serial}/liveTools/traceRoute/{traceRouteId}")]
Task<DeviceLiveToolsTraceRouteGetResponse> GetTraceRouteAsync(string serial, string traceRouteId, CancellationToken cancellationToken = default)

Parameters

serial string

traceRouteId string

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsTraceRouteGetResponse>

Exceptions

ApiException

Thrown when fails to make API call