Interface ISwitchRoutingInterfaces

Namespace

Meraki.Api.Interfaces.Products.Switch

Assembly

Meraki.Api.dll

public interface ISwitchRoutingInterfaces

Methods

CreateDeviceSwitchRoutingInterfaceAsync(string, RoutingInterfaceCreateRequest, CancellationToken)

Create a layer 3 interface for a switch

[Post("/devices/{serial}/switch/routing/interfaces")]
Task<RoutingInterface> CreateDeviceSwitchRoutingInterfaceAsync(string serial, RoutingInterfaceCreateRequest routingInterface, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

routingInterface RoutingInterfaceCreateRequest

cancellationToken CancellationToken

The cancellation token

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

DeleteDeviceSwitchRoutingInterfaceAsync(string, string, CancellationToken)

Delete a layer 3 interface from the switch

[Delete("/devices/{serial}/switch/routing/interfaces/{interfaceId}")]
Task DeleteDeviceSwitchRoutingInterfaceAsync(string serial, string interfaceId, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

interfaceId string

The interface id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceSwitchRoutingInterfaceAsync(string, string, CancellationToken)

Return a layer 3 interface for a switch

[Get("/devices/{serial}/switch/routing/interfaces/{interfaceId}")]
Task<RoutingInterface> GetDeviceSwitchRoutingInterfaceAsync(string serial, string interfaceId, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

interfaceId string

The interface id

cancellationToken CancellationToken

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceSwitchRoutingInterfaceDhcpAsync(string, string, CancellationToken)

Return a layer 3 interface DHCP configuration for a switch

[Get("/devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp")]
Task<RoutingInterfaceDhcp> GetDeviceSwitchRoutingInterfaceDhcpAsync(string serial, string interfaceId, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

interfaceId string

The interface id

cancellationToken CancellationToken

Returns

Task<RoutingInterfaceDhcp>

Exceptions

ApiException

Thrown when fails to make API call

GetDeviceSwitchRoutingInterfacesAsync(string, L3InterfaceMode?, L3InterfaceProtocol?, CancellationToken)

List layer 3 interfaces for a switch. Those for a stack may be found under switch stack routing.

[Get("/devices/{serial}/switch/routing/interfaces")]
Task<List<RoutingInterface>> GetDeviceSwitchRoutingInterfacesAsync(string serial, L3InterfaceMode? mode = null, L3InterfaceProtocol? protocol = null, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

mode L3InterfaceMode?

Optional parameter to filter L3 interfaces by mode.

protocol L3InterfaceProtocol?

Optional parameter to filter L3 interfaces by protocol.

cancellationToken CancellationToken

The cancellation token

Returns

Task<List<RoutingInterface>>

Exceptions

ApiException

Thrown when fails to make API call

UpdateDeviceSwitchRoutingInterfaceAsync(string, string, RoutingInterfaceUpdateRequest, CancellationToken)

Return a layer 3 interface for a switch

[Put("/devices/{serial}/switch/routing/interfaces/{interfaceId}")]
Task<RoutingInterface> UpdateDeviceSwitchRoutingInterfaceAsync(string serial, string interfaceId, RoutingInterfaceUpdateRequest updateRoutingInterface, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

interfaceId string

The interface id

updateRoutingInterface RoutingInterfaceUpdateRequest

Body for returning an interface

cancellationToken CancellationToken

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

UpdateDeviceSwitchRoutingInterfaceDhcpAsync(string, string, RoutingInterfaceDhcp, CancellationToken)

Update a layer 3 interface DHCP configuration for a switch

[Put("/devices/{serial}/switch/routing/interfaces/{interfaceId}/dhcp")]
Task<RoutingInterfaceDhcp> UpdateDeviceSwitchRoutingInterfaceDhcpAsync(string serial, string interfaceId, RoutingInterfaceDhcp updateDeviceSwitchRoutingInterfaceDhcp, CancellationToken cancellationToken = default)

Parameters

serial string

The serial number

interfaceId string

The interface id

updateDeviceSwitchRoutingInterfaceDhcp RoutingInterfaceDhcp

Body for updating an interface

cancellationToken CancellationToken

Returns

Task<RoutingInterfaceDhcp>

Exceptions

ApiException

Thrown when fails to make API call