Interface ILiveToolsThroughputTest

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

public interface ILiveToolsThroughputTest

Methods

CreateDeviceLiveToolsThroughputTestAsync(string, LiveToolsThroughputTestCreateRequest, CancellationToken)

Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput

[Post("/devices/{serial}/liveTools/throughputTest")]
Task<LiveToolsThroughputTestCreateResponse> CreateDeviceLiveToolsThroughputTestAsync(string serial, LiveToolsThroughputTestCreateRequest createDeviceLiveToolsThroughputTest, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

createDeviceLiveToolsThroughputTest LiveToolsThroughputTestCreateRequest

Body

cancellationToken CancellationToken

Returns

Task<LiveToolsThroughputTestCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsThroughputTestAsync(string, string, CancellationToken)

Return a throughput test job

[Get("/devices/{serial}/liveTools/throughputTest/{throughputTestId}")]
Task<LiveToolsThroughputTest> GetDeviceLiveToolsThroughputTestAsync(string serial, string throughputTestId, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

throughputTestId string

Throughput test ID

cancellationToken CancellationToken

Returns

Task<LiveToolsThroughputTest>

Exceptions

ApiException

Thrown when fails to make API call