Interface INetworksClients

Namespace

Meraki.Api.Interfaces.General.Networks

Assembly

Meraki.Api.dll

public interface INetworksClients

Methods

GetNetworkClientAsync(string, string, CancellationToken)

Return the client associated with the given identifier. Clients can be identified by a client key or either the MAC or IP depending on whether the network uses Track-by-IP.

[Get("/networks/{networkId}/clients/{clientId}")]
[QueryUriFormat(UriFormat.Unescaped)]
Task<Client> GetNetworkClientAsync(string networkId, string clientId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

clientId string

The client id

cancellationToken CancellationToken

Returns

Task<Client>

Exceptions

ApiException

Thrown when fails to make API call

GetNetworkClientsAsync(string, string, double?, int?, string, string, string?, string?, string?, string?, string?, string?, string?, string?, List<string>?, CancellationToken)

List the clients that have used this network in the timespan

[Get("/networks/{networkId}/clients")]
[QueryUriFormat(UriFormat.Unescaped)]
Task<List<Client>> GetNetworkClientsAsync(string networkId, string t0 = null, double? timespan = null, int? perPage = 1000, string startingAfter = null, string endingBefore = null, string? statuses = null, string? ip = null, string? ip6 = null, string? ip6Local = null, string? mac = null, string? os = null, string? pskGroup = null, string? description = null, List<string>? recentDeviceConnections = 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 1 day. (optional)

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10. (optional)

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. (optional)

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. (optional)

statuses string

Filters clients based on status. Can be one of 'Online' or 'Offline'.

ip string

Filters clients based on a partial or full match for the ip address field.

ip6 string

Filters clients based on a partial or full match for the ip6 address field.

ip6Local string

Filters clients based on a partial or full match for the ip6Local address field.

mac string

Filters clients based on a partial or full match for the mac address field.

os string

Filters clients based on a partial or full match for the os (operating system) field.

pskGroup string

Filters clients based on partial or full match for the iPSK name field.

description string

Filters clients based on a partial or full match for the description field.

recentDeviceConnections List<string>

Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'.

cancellationToken CancellationToken

Returns

Task<List<Client>>

Exceptions

ApiException

Thrown when fails to make API call

ProvisionNetworkClientsAsync(string, ClientProvisionRequest, CancellationToken)

Provisions a client with a name and policy

[Post("/networks/{networkId}/clients/provision")]
Task<ClientProvisionRequest> ProvisionNetworkClientsAsync(string networkId, ClientProvisionRequest clientProvisionRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

clientProvisionRequest ClientProvisionRequest

Body for provisioning a client

cancellationToken CancellationToken

Returns

Task<ClientProvisionRequest>

Exceptions

ApiException

Thrown when fails to make API call