Interface ILiveToolsOspfNeighbors

Namespace

Meraki.Api.Interfaces.General.LiveTools

Assembly

Meraki.Api.dll

I Live Tools Ospf Neighbors

public interface ILiveToolsOspfNeighbors

Methods

CreateDeviceLiveToolsOspfNeighborAsync(string, DeviceLiveToolsOspfNeighborCreateRequest, CancellationToken)

Enqueue a job to perform a OSPF neighbors request for the device. This endpoint currently supports switches. 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/ospfNeighbors")]
Task<DeviceLiveToolsOspfNeighborCreateResponse> CreateDeviceLiveToolsOspfNeighborAsync(string serial, DeviceLiveToolsOspfNeighborCreateRequest request, CancellationToken cancellationToken = default)

Parameters

serial string

request DeviceLiveToolsOspfNeighborCreateRequest

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsOspfNeighborCreateResponse>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceLiveToolsOspfNeighborAsync(string, string, CancellationToken)

Return an OSPF neighbors live tool job.

[Get("/devices/{serial}/liveTools/ospfNeighbors/{ospfNeighborsId}")]
Task<DeviceLiveToolsOspfNeighborGetResponse> GetDeviceLiveToolsOspfNeighborAsync(string serial, string ospfNeighborsId, CancellationToken cancellationToken = default)

Parameters

serial string

ospfNeighborsId string

cancellationToken CancellationToken

Returns

Task<DeviceLiveToolsOspfNeighborGetResponse>

Exceptions

ApiException

Thrown when fails to make API call