Interface INetworks

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworks

Methods

BindNetworkAsync(string, ConfigurationTemplateBindRequest, CancellationToken)

Bind a network to a template.

[Post("/networks/{networkId}/bind")]
Task BindNetworkAsync(string networkId, ConfigurationTemplateBindRequest configurationTemplateBindRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

configurationTemplateBindRequest ConfigurationTemplateBindRequest

Body for binding a network

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkAsync(string, CancellationToken)

Delete a network

[Delete("/networks/{networkId}")]
Task DeleteNetworkAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkAsync(string, CancellationToken)

Return a network

[Get("/networks/{networkId}")]
Task<Network> GetNetworkAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<Network>

Task of Object

Exceptions

ApiException

Thrown when fails to make API call

SplitNetworkAsync(string, CancellationToken)

Split a combined network into individual networks for each type of device

[Post("/networks/{networkId}/split")]
Task<SplitNetworkResponse> SplitNetworkAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<SplitNetworkResponse>

Exceptions

ApiException

Thrown when fails to make API call

UnbindNetworkAsync(string, bool?, CancellationToken)

Unbind a network from a template.

[Post("/networks/{networkId}/unbind")]
Task<Network> UnbindNetworkAsync(string networkId, bool? RetainConfigs = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

RetainConfigs bool?

Optional boolean to retain all the current configs given by the template.

cancellationToken CancellationToken

Returns

Task<Network>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkAsync(string, NetworkUpdateRequest, CancellationToken)

Update a network

[Put("/networks/{networkId}")]
Task<Network> UpdateNetworkAsync(string networkId, NetworkUpdateRequest networkUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

networkUpdateRequest NetworkUpdateRequest

Body for updating a network

cancellationToken CancellationToken

Returns

Task<Network>

Exceptions

ApiException

Thrown when fails to make API call