Interface IWirelessAirMarshal

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

public interface IWirelessAirMarshal

Methods

CreateNetworkWirelessAirMarshalRuleAsync(string, AirMarshalRuleCreateUpdateRequest, CancellationToken)

Creates a new rule

[Post("/networks/{networkId}/wireless/airMarshal/rules")]
Task<AirMarshalRulesItem> CreateNetworkWirelessAirMarshalRuleAsync(string networkId, AirMarshalRuleCreateUpdateRequest airMarshalRuleUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

Network ID

airMarshalRuleUpdateRequest AirMarshalRuleCreateUpdateRequest

The update request

cancellationToken CancellationToken

The cancellation token

Returns

Task<AirMarshalRulesItem>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkWirelessAirMarshalRuleAsync(string, string, CancellationToken)

Delete an Air Marshal rule.

[Delete("/networks/{networkId}/wireless/airMarshal/rules/{ruleId}")]
Task DeleteNetworkWirelessAirMarshalRuleAsync(string networkId, string ruleId, CancellationToken cancellationToken = default)

Parameters

networkId string

Network ID

ruleId string

Rule ID

cancellationToken CancellationToken

The cancellation token

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkWirelessAirMarshalAsync(string, string, double?, CancellationToken)

List Air Marshal scan results from a network

[Get("/networks/{networkId}/wireless/airMarshal")]
Task<List<AirMarshal>> GetNetworkWirelessAirMarshalAsync(string networkId, string t0 = null, double? timespan = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today. (optional)

timespan double?

The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds and be less than or equal to 31 days. The default is 7 days. (optional)

cancellationToken CancellationToken

Returns

Task<List<AirMarshal>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWirelessAirMarshalRulesAsync(string, List<string>?, int?, string?, string?, CancellationToken)

Returns the current Air Marshal rules for this organization

[Get("/organizations/{organizationId}/wireless/airMarshal/rules")]
Task<AirMarshalRules> GetOrganizationWirelessAirMarshalRulesAsync(string organizationId, List<string>? networkIds, int? perPage, string? startingAfter, string? endingBefore, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

networkIds List<string>

(optional) The set of network IDs to include.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

cancellationToken CancellationToken

The cancellation token

Returns

Task<AirMarshalRules>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWirelessAirMarshalSettingsByNetworkAsync(string, List<string>?, int?, string?, string?, CancellationToken)

Returns the current Air Marshal settings for this network

[Get("/organizations/{organizationId}/wireless/airMarshal/settings/byNetwork")]
Task<AirMarshalSettingsByNetwork> GetOrganizationWirelessAirMarshalSettingsByNetworkAsync(string organizationId, List<string>? networkIds, int? perPage, string? startingAfter, string? endingBefore, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

networkIds List<string>

(optional) The set of network IDs to include.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

startingAfter string

A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

endingBefore string

A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

cancellationToken CancellationToken

The cancellation token

Returns

Task<AirMarshalSettingsByNetwork>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkWirelessAirMarshalRuleAsync(string, string, AirMarshalRuleCreateUpdateRequest, CancellationToken)

Update a rule

[Put("/networks/{networkId}/wireless/airMarshal/rules/{ruleId}")]
Task<AirMarshalRulesItem> UpdateNetworkWirelessAirMarshalRuleAsync(string networkId, string ruleId, AirMarshalRuleCreateUpdateRequest airMarshalRuleUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

Network ID

ruleId string

Rule ID.

airMarshalRuleUpdateRequest AirMarshalRuleCreateUpdateRequest

The update request

cancellationToken CancellationToken

The cancellation token

Returns

Task<AirMarshalRulesItem>

Exceptions

ApiException

Thrown when fails to make API call

UpdateNetworkWirelessAirMarshalSettingsAsync(string, AirMarshalSettingsUpdateRequest, CancellationToken)

Updates Air Marshal settings.

[Post("/networks/{networkId}/wireless/airMarshal/settings")]
Task<AirMarshalSettings> UpdateNetworkWirelessAirMarshalSettingsAsync(string networkId, AirMarshalSettingsUpdateRequest airMarshalSettingsUpdateRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

Network ID

airMarshalSettingsUpdateRequest AirMarshalSettingsUpdateRequest

The update request

cancellationToken CancellationToken

The cancellation token

Returns

Task<AirMarshalSettings>

Exceptions

ApiException

Thrown when fails to make API call