Interface ISwitchQosRules

Namespace

Meraki.Api.Interfaces.Products.Switch

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ISwitchQosRules

Methods

CreateNetworkSwitchQosRuleAsync(string, SwitchSettingsQosRuleCreationRequest, CancellationToken)

Add a quality of service rule

[Post("/networks/{networkId}/switch/qosRules")]
Task<QosRule> CreateNetworkSwitchQosRuleAsync(string networkId, SwitchSettingsQosRuleCreationRequest createNetworkSwitchSettingsQosRule, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkSwitchSettingsQosRule SwitchSettingsQosRuleCreationRequest

cancellationToken CancellationToken

Returns

Task<QosRule>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkSwitchQosRuleAsync(string, string, CancellationToken)

Delete a quality of service rule

[Delete("/networks/{networkId}/switch/qosRules/{qosRuleId}")]
Task DeleteNetworkSwitchQosRuleAsync(string networkId, string qosRuleId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qosRuleId string

The quality of service rule id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchQosRuleAsync(string, string, CancellationToken)

Return a quality of service rule

[Get("/networks/{networkId}/switch/qosRules/{qosRuleId}")]
Task<QosRule> GetNetworkSwitchQosRuleAsync(string networkId, string qosRuleId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qosRuleId string

The quality of service rule id

cancellationToken CancellationToken

Returns

Task<QosRule>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchQosRulesAsync(string, CancellationToken)

List quality of service rules

[Get("/networks/{networkId}/switch/qosRules")]
Task<List<QosRule>> GetNetworkSwitchQosRulesAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<List<QosRule>>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkSwitchQosRulesOrderAsync(string, CancellationToken)

Return the quality of service rule IDs by order in which they will be processed by the switch

[Get("/networks/{networkId}/switch/qosRules/order")]
Task<QosRulesOrder> GetNetworkSwitchQosRulesOrderAsync(string networkId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

cancellationToken CancellationToken

Returns

Task<QosRulesOrder>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSwitchQosRuleAsync(string, string, SwitchSettingsQosRuleUpdateRequest, CancellationToken)

Update a quality of service rule

[Put("/networks/{networkId}/switch/qosRules/{qosRuleId}")]
Task<QosRule> UpdateNetworkSwitchQosRuleAsync(string networkId, string qosRuleId, SwitchSettingsQosRuleUpdateRequest updateNetworkSwitchSettingsQosRule, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qosRuleId string

updateNetworkSwitchSettingsQosRule SwitchSettingsQosRuleUpdateRequest

cancellationToken CancellationToken

Returns

Task<QosRule>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkSwitchQosRulesOrderAsync(string, QosRulesOrder, CancellationToken)

Update the order in which the rules should be processed by the switch

[Put("/networks/{networkId}/switch/qosRules/order")]
Task<QosRulesOrder> UpdateNetworkSwitchQosRulesOrderAsync(string networkId, QosRulesOrder qosRulesOrder, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

qosRulesOrder QosRulesOrder

cancellationToken CancellationToken

Returns

Task<QosRulesOrder>

Exceptions

ApiException

Thrown when fails to make API call