Interface IWirelessRfProfiles

Namespace

Meraki.Api.Interfaces.Products.Wireless

Assembly

Meraki.Api.dll

public interface IWirelessRfProfiles

Extension Methods

IWirelessRfProfilesExtensions.GetOrganizationWirelessRfProfilesAssignmentsByDeviceAllAsync(IWirelessRfProfiles, string, List<string>?, List<ProductType>, string?, string?, string?, string?, List<string>?, List<string>?, List<string>?, CancellationToken)

Methods

CreateNetworkWirelessRfProfileAsync(string, WirelessRfProfileCreateUpdateRequest, CancellationToken)

Creates new RF profile for this network

[Post("/networks/{networkId}/wireless/rfProfiles")]
Task<WirelessRfProfile> CreateNetworkWirelessRfProfileAsync(string networkId, WirelessRfProfileCreateUpdateRequest createNetworkWirelessRfProfile, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

createNetworkWirelessRfProfile WirelessRfProfileCreateUpdateRequest

Body for creating an RF profile

cancellationToken CancellationToken

Returns

Task<WirelessRfProfile>

Exceptions

ApiException

Thrown when fails to make API call

DeleteNetworkWirelessRfProfileAsync(string, string, CancellationToken)

Delete a RF Profile

[Delete("/networks/{networkId}/wireless/rfProfiles/{rfProfileId}")]
Task DeleteNetworkWirelessRfProfileAsync(string networkId, string rfProfileId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

rfProfileId string

The RF profile id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkWirelessRfProfileAsync(string, string, CancellationToken)

Return a RF profile

[Get("/networks/{networkId}/wireless/rfProfiles/{rfProfileId}")]
Task<WirelessRfProfile> GetNetworkWirelessRfProfileAsync(string networkId, string rfProfileId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

rfProfileId string

The RF profile id

cancellationToken CancellationToken

Returns

Task<WirelessRfProfile>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkWirelessRfProfilesAsync(string, bool?, CancellationToken)

List the non-basic RF profiles for this network

[Get("/networks/{networkId}/wireless/rfProfiles")]
Task<List<WirelessRfProfile>> GetNetworkWirelessRfProfilesAsync(string networkId, bool? includeTemplateProfiles = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

includeTemplateProfiles bool?

If the network is bound to a template, this parameter controls whether or not the non-basic RF profiles defined on the template should be included in the response alongside the non-basic profiles defined on the bound network. Defaults to false. (optional)

cancellationToken CancellationToken

Returns

Task<List<WirelessRfProfile>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationWirelessRfProfilesAssignmentsByDeviceAsync(string, int?, string?, string?, List<string>?, List<ProductType>, string?, string?, string?, string?, List<string>?, List<string>?, List<string>?, CancellationToken)

List the non-basic RF profiles for this network.

[Get("/organizations/{organizationId}/wireless/rfProfiles/assignments/byDevice")]
Task<List<RfProfilesByDevice>> GetOrganizationWirelessRfProfilesAssignmentsByDeviceAsync(string organizationId, int? perPage, string? startingAfter, string? endingBefore, List<string>? networkIds, List<ProductType> productTypes, string? name, string? mac, string? serial, string? model, List<string>? macs, List<string>? serials, List<string>? models, CancellationToken cancellationToken = default)

Parameters

organizationId string

Organization ID.

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.

networkIds List<string>

Optional parameter to filter devices by network.

productTypes List<ProductType>

Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

name string

Optional parameter to filter RF profiles by device name. All returned devices will have a name that contains the search term or is an exact match.

mac string

Optional parameter to filter RF profiles by device MAC address. All returned devices will have a MAC address that contains the search term or is an exact match.

serial string

Optional parameter to filter RF profiles by device serial number. All returned devices will have a serial number that contains the search term or is an exact match.

model string

Optional parameter to filter RF profiles by device model. All returned devices will have a model that contains the search term or is an exact match.

macs List<string>

Optional parameter to filter RF profiles by one or more device MAC addresses. All returned devices will have a MAC address that is an exact match.

serials List<string>

Optional parameter to filter RF profiles by one or more device serial numbers. All returned devices will have a serial number that is an exact match.

models List<string>

Optional parameter to filter RF profiles by one or more device models. All returned devices will have a model that is an exact match.

cancellationToken CancellationToken

The cancellation token.

Returns

Task<List<RfProfilesByDevice>>

Exceptions

ApiException

Thrown when fails to make API call.

UpdateNetworkWirelessRfProfileAsync(string, string, WirelessRfProfileCreateUpdateRequest, CancellationToken)

Updates specified RF profile for this network

[Put("/networks/{networkId}/wireless/rfProfiles/{rfProfileId}")]
Task<WirelessRfProfile> UpdateNetworkWirelessRfProfileAsync(string networkId, string rfProfileId, WirelessRfProfileCreateUpdateRequest updateNetworkWirelessRfProfile, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

rfProfileId string

The RF profile id

updateNetworkWirelessRfProfile WirelessRfProfileCreateUpdateRequest

Body for updating a specified RF profile

cancellationToken CancellationToken

Returns

Task<WirelessRfProfile>

Exceptions

ApiException

Thrown when fails to make API call