Interface IOrganizationsSwitchPortsOverview

Namespace: Meraki.Api.Interfaces.General.Organizations

Assembly: Meraki.Api.dll

Organizations Switch Ports Overview

public interface IOrganizationsSwitchPortsOverview

Methods

GetOrganizationSwitchPortsOverviewAsync(string, string?, string?, double?, CancellationToken)

Returns the counts of all active ports for the requested timespan, grouped by speed. An active port is a port that at any point during the timeframe is observed to be connected to a responsive device and isn't configured to be disabled. For a port that is observed at multiple speeds during the timeframe, it will be counted at the highest speed observed. The number of inactive ports, and the total number of ports are also provided. Only ports on switches online during the timeframe will be represented and a port is only guaranteed to be present if its switch was online for at least 6 hours of the timeframe.

[Get("/organizations/{organizationId}/switch/ports/overview")]
Task<SwitchPortsOverview> GetOrganizationSwitchPortsOverviewAsync(string organizationId, string? t0 = null, string? t1 = null, double? timespan = null, CancellationToken cancellationToken = default)

Parameters

organizationId string: The organization id
t0 string: The beginning of the timespan for the data.
t1 string: The end of the timespan for the data. t1 can be a maximum of 31 days after t0.
timespan double?: The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. Maximum = 2678400
cancellationToken CancellationToken

Returns

Task<SwitchPortsOverview>

Exceptions