Interface IApplianceWarmSpare

Namespace

Meraki.Api.Interfaces.Products.Appliance

Assembly

Meraki.Api.dll

public interface IApplianceWarmSpare

Methods

GetNetworkApplianceWarmSpareAsync(string, CancellationToken)

Return MX warm spare settings

[Get("/networks/{networkId}/appliance/warmSpare")]
Task<WarmSpare> GetNetworkApplianceWarmSpareAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<WarmSpare>

Exceptions

ApiException

Thrown when fails to make API call

SwapNetworkApplianceWarmSpareAsync(string, WarmSpare, CancellationToken)

Swap MX primary and warm spare appliances

[Post("/networks/{networkId}/appliance/warmSpare/swap")]
Task<WarmSpare> SwapNetworkApplianceWarmSpareAsync(string networkId, WarmSpare warmSpare, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

warmSpare WarmSpare

cancellationToken CancellationToken

The cancellation token

Returns

Task<WarmSpare>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkApplianceWarmSpareAsync(string, WarmSpareUpdateRequest, CancellationToken)

Update MX warm spare settings

[Put("/networks/{networkId}/appliance/warmSpare")]
Task<WarmSpare> UpdateNetworkApplianceWarmSpareAsync(string networkId, WarmSpareUpdateRequest updateWarmSpare, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

updateWarmSpare WarmSpareUpdateRequest

Body for updating warm spare settings

cancellationToken CancellationToken

Returns

Task<WarmSpare>

Exceptions

ApiException

Thrown when fails to make API call