Class IApplianceVpnStatsExtensions

Namespace

Meraki.Api.Extensions

Assembly

Meraki.Api.dll

Provides extension methods for retrieving VPN statistics from appliance VPN interfaces.

public static class IApplianceVpnStatsExtensions

Inheritance

object

IApplianceVpnStatsExtensions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This static class contains methods that extend the functionality of the IApplianceVpnStats interface, enabling asynchronous retrieval of VPN statistics for organizations and networks.

Methods

GetOrganizationApplianceVpnStatsAllAsync(IApplianceVpnStats, string, string?, string?, double?, List<string>?, CancellationToken)

Retrieves VPN statistics for all networks in the specified organization.

public static Task<List<VpnStats>> GetOrganizationApplianceVpnStatsAllAsync(this IApplianceVpnStats applianceVpnStats, string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, List<string>? networkIds = null, CancellationToken cancellationToken = default)

Parameters

applianceVpnStats IApplianceVpnStats

The interface used to access appliance VPN statistics.

organizationId string

The unique identifier of the organization for which VPN statistics are retrieved. Cannot be null or empty.

t0 string

The start time for the statistics, in ISO 8601 format. If null, the time range is determined by timespan.

t1 string

The end time for the statistics, in ISO 8601 format. If null, the time range is determined by timespan.

timespan double?

The duration, in seconds, for which statistics are retrieved. If specified, t0 and t1 must be null.

networkIds List<string>

A list of network IDs to filter the statistics. If null, statistics for all networks in the organization are retrieved.

cancellationToken CancellationToken

A token to monitor for cancellation requests. Defaults to None.

Returns

Task<List<VpnStats>>

A task that represents the asynchronous operation. The task result contains a list of VpnStats objects representing the VPN statistics for the specified organization.

Remarks

This method asynchronously fetches VPN statistics for all networks within the given organization. The statistics can be filtered by a specific time range or timespan, and optionally by a list of network IDs.