Table of Contents

Interface ISwitchStacks

Namespace
Meraki.Api.Interfaces.Products.Switch
Assembly
Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ISwitchStacks

Methods

AddNetworkSwitchStackAsync(string, string, NetworkSwitchStackCreationRequest, CancellationToken)

Add a switch to a stack

[Post("/networks/{networkId}/switch/stacks/{switchStackId}/add")]
Task<SwitchStack> AddNetworkSwitchStackAsync(string networkId, string switchStackId, NetworkSwitchStackCreationRequest addNetworkSwitchStack, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

addNetworkSwitchStack NetworkSwitchStackCreationRequest
cancellationToken CancellationToken

Returns

Task<SwitchStack>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkSwitchStackAsync(string, SwitchStackCreationRequest, CancellationToken)

Create a switch stack

[Post("/networks/{networkId}/switch/stacks")]
Task<SwitchStack> CreateNetworkSwitchStackAsync(string networkId, SwitchStackCreationRequest createNetworkSwitchStack, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkSwitchStack SwitchStackCreationRequest
cancellationToken CancellationToken

Returns

Task<SwitchStack>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkSwitchStackRoutingInterfaceAsync(string, string, RoutingInterfaceCreateRequest, CancellationToken)

Create a layer 3 interface for a switch stack

[Post("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces")]
Task<RoutingInterface> CreateNetworkSwitchStackRoutingInterfaceAsync(string networkId, string switchStackId, RoutingInterfaceCreateRequest routingInterface, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string
routingInterface RoutingInterfaceCreateRequest
cancellationToken CancellationToken

The cancellation token

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

CreateNetworkSwitchStackRoutingStaticRouteAsync(string, string, SwitchStaticRouteCreationRequest, CancellationToken)

Create a layer 3 static route for a switch stack

[Post("/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes")]
Task<SwitchStaticRoute> CreateNetworkSwitchStackRoutingStaticRouteAsync(string networkId, string switchStackId, SwitchStaticRouteCreationRequest createNetworkSwitchStackRoutingStaticRoute, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

createNetworkSwitchStackRoutingStaticRoute SwitchStaticRouteCreationRequest
cancellationToken CancellationToken

Returns

Task<SwitchStaticRoute>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkSwitchStackAsync(string, string, CancellationToken)

Delete a stack

[Delete("/networks/{networkId}/switch/stacks/{switchStackId}")]
Task DeleteNetworkSwitchStackAsync(string networkId, string switchStackId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkSwitchStackRoutingInterfaceAsync(string, string, string, CancellationToken)

Delete a layer 3 interface from a switch stack

[Delete("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}")]
Task DeleteNetworkSwitchStackRoutingInterfaceAsync(string networkId, string switchStackId, string interfaceId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string
interfaceId string
cancellationToken CancellationToken

The cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkSwitchStackRoutingStaticRouteAsync(string, string, string, CancellationToken)

Delete a layer 3 static route for a switch stack

[Delete("/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}")]
Task DeleteNetworkSwitchStackRoutingStaticRouteAsync(string networkId, string switchStackId, string staticRouteId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

staticRouteId string

The static route id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackAsync(string, string, CancellationToken)

Show a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}")]
Task<SwitchStack> GetNetworkSwitchStackAsync(string networkId, string switchStackId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

cancellationToken CancellationToken

Returns

Task<SwitchStack>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackRoutingInterfaceAsync(string, string, string, CancellationToken)

Return a layer 3 interface from a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}")]
Task<RoutingInterface> GetNetworkSwitchStackRoutingInterfaceAsync(string networkId, string switchStackId, string interfaceId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string
interfaceId string
cancellationToken CancellationToken

The cancellation token

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackRoutingInterfaceDhcpAsync(string, string, string, CancellationToken)

Return a layer 3 interface DHCP configuration for a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp")]
Task<RoutingInterfaceDhcp> GetNetworkSwitchStackRoutingInterfaceDhcpAsync(string networkId, string switchStackId, string interfaceId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

interfaceId string

The interface id

cancellationToken CancellationToken

Returns

Task<RoutingInterfaceDhcp>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackRoutingInterfacesAsync(string, string, CancellationToken)

List layer 3 interfaces for a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces")]
Task<List<RoutingInterface>> GetNetworkSwitchStackRoutingInterfacesAsync(string networkId, string switchStackId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string
cancellationToken CancellationToken

The cancellation token

Returns

Task<List<RoutingInterface>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackRoutingStaticRouteAsync(string, string, string, CancellationToken)

Return a layer 3 static route for a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}")]
Task<SwitchStaticRoute> GetNetworkSwitchStackRoutingStaticRouteAsync(string networkId, string switchStackId, string staticRouteId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

staticRouteId string

The static route id

cancellationToken CancellationToken

Returns

Task<SwitchStaticRoute>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStackRoutingStaticRoutesAsync(string, string, CancellationToken)

List layer 3 static routes for a switch stack

[Get("/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes")]
Task<List<SwitchStaticRoute>> GetNetworkSwitchStackRoutingStaticRoutesAsync(string networkId, string switchStackId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

cancellationToken CancellationToken

Returns

Task<List<SwitchStaticRoute>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchStacksAsync(string, CancellationToken)

List the switch stacks in a network

[Get("/networks/{networkId}/switch/stacks")]
Task<List<SwitchStack>> GetNetworkSwitchStacksAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<SwitchStack>>

Exceptions

ApiException

Thrown when fails to make API call

RemoveNetworkSwitchStackAsync(string, string, RemoveNetworkSwitchStack, CancellationToken)

Remove a switch from a stack

[Post("/networks/{networkId}/switch/stacks/{switchStackId}/remove")]
Task<SwitchStack> RemoveNetworkSwitchStackAsync(string networkId, string switchStackId, RemoveNetworkSwitchStack removeNetworkSwitchStack, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

removeNetworkSwitchStack RemoveNetworkSwitchStack
cancellationToken CancellationToken

Returns

Task<SwitchStack>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSwitchStackRoutingInterfaceAsync(string, string, string, RoutingInterfaceUpdateRequest, CancellationToken)

Update a layer 3 interface for a switch stack

[Put("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}")]
Task<RoutingInterface> UpdateNetworkSwitchStackRoutingInterfaceAsync(string networkId, string switchStackId, string interfaceId, RoutingInterfaceUpdateRequest routingInterface, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string
interfaceId string
routingInterface RoutingInterfaceUpdateRequest
cancellationToken CancellationToken

The cancellation token

Returns

Task<RoutingInterface>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSwitchStackRoutingInterfaceDhcpAsync(string, string, string, RoutingInterfaceDhcp, CancellationToken)

Update a layer 3 interface DHCP configuration for a switch stack

[Put("/networks/{networkId}/switch/stacks/{switchStackId}/routing/interfaces/{interfaceId}/dhcp")]
Task<RoutingInterfaceDhcp> UpdateNetworkSwitchStackRoutingInterfaceDhcpAsync(string networkId, string switchStackId, string interfaceId, RoutingInterfaceDhcp routingInterfaceDhcp, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

interfaceId string

The interface id

routingInterfaceDhcp RoutingInterfaceDhcp
cancellationToken CancellationToken

Returns

Task<RoutingInterfaceDhcp>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSwitchStackRoutingStaticRouteAsync(string, string, string, SwitchStaticRouteCreationRequest, CancellationToken)

Update a layer 3 static route for a switch stack

[Put("/networks/{networkId}/switch/stacks/{switchStackId}/routing/staticRoutes/{staticRouteId}")]
Task<SwitchStaticRoute> UpdateNetworkSwitchStackRoutingStaticRouteAsync(string networkId, string switchStackId, string staticRouteId, SwitchStaticRouteCreationRequest updateNetworkSwitchStackRoutingStaticRoute, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

switchStackId string

The switch stack id

staticRouteId string

The static route id

updateNetworkSwitchStackRoutingStaticRoute SwitchStaticRouteCreationRequest
cancellationToken CancellationToken

Returns

Task<SwitchStaticRoute>

Exceptions

ApiException

Thrown when fails to make API call

Edit this page