Class NetworksClientsSection

Namespace

Meraki.Api.Sections.General.Networks

Assembly

Meraki.Api.dll

Provides access to networks clients API endpoints

public class NetworksClientsSection

Inheritance

object

NetworksClientsSection

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

INetworkClientsExtensions.GetNetworkClientsAllAsync(NetworksClientsSection, string, string, double?, string?, string?, string?, string?, string?, string?, string?, string?, List<string>?, CancellationToken)

Constructors

NetworksClientsSection()

public NetworksClientsSection()

Properties

ApplicationUsage

Return the application usage data for clients. Usage data is in kilobytes.

public INetworksClientsApplicationUsage ApplicationUsage { get; }

Property Value

INetworksClientsApplicationUsage

Policy

Return the policy assigned to a client on the network

public INetworksClientsPolicy Policy { get; }

Property Value

INetworksClientsPolicy

SplashAuthorizationStatus

Return the splash authorization for a client, for each SSID they've associated with through splash

public INetworksClientsSplashAuthorizationStatus SplashAuthorizationStatus { get; }

Property Value

INetworksClientsSplashAuthorizationStatus

TrafficHistory

Return the client's network traffic data over time

public INetworksClientsTrafficHistory TrafficHistory { get; }

Property Value

INetworksClientsTrafficHistory

UsageHistories

Return the usage histories for clients.

public INetworksClientsUsageHistories UsageHistories { get; }

Property Value

INetworksClientsUsageHistories

UsageHistory

Return the client's daily usage history

public INetworksClientsUsageHistory UsageHistory { get; }

Property Value

INetworksClientsUsageHistory

Methods

GetNetworkClientAsync(string, string, CancellationToken)

public Task<Client> GetNetworkClientAsync(string networkId, string clientId, CancellationToken cancellationToken = default)

Parameters

networkId string

clientId string

cancellationToken CancellationToken

Returns

Task<Client>

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

public 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

t0 string

timespan double?

perPage int?

startingAfter string

endingBefore string

statuses string

ip string

ip6 string

ip6Local string

mac string

os string

pskGroup string

description string

recentDeviceConnections List<string>

cancellationToken CancellationToken

Returns

Task<List<Client>>

ProvisionNetworkClientsAsync(string, ClientProvisionRequest, CancellationToken)

public Task<ClientProvisionRequest> ProvisionNetworkClientsAsync(string networkId, ClientProvisionRequest clientProvisionRequest, CancellationToken cancellationToken = default)

Parameters

networkId string

clientProvisionRequest ClientProvisionRequest

cancellationToken CancellationToken

Returns

Task<ClientProvisionRequest>