Interface ILiveToolsCyclePort

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

I Live Tools Cycle Port

public interface ILiveToolsCyclePort

Methods

CreateDeviceLiveToolsCyclePortAsync(string, DeviceLiveToolsCyclePortCreateRequest, CancellationToken)

Enqueue a job to perform a cycle port for the device on the specified ports. 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/cyclePort")]
Task<DeviceLiveToolsCyclePortCreateResponse> CreateDeviceLiveToolsCyclePortAsync(string serial, DeviceLiveToolsCyclePortCreateRequest request, CancellationToken cancellationToken = default)

Parameters

serial string

request DeviceLiveToolsCyclePortCreateRequest

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsCyclePortCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsCyclePortAsync(string, string, CancellationToken)

Return a cycle port live tool job.

[Get("/devices/{serial}/liveTools/cyclePort/{id}")]
Task<DeviceLiveToolsCyclePortGetResponse> GetDeviceLiveToolsCyclePortAsync(string serial, string id, CancellationToken cancellationToken = default)

Parameters

serial string

id string

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsCyclePortGetResponse>

Exceptions

ApiException

Thrown when fails to make API call