Interface IOrganizationSwitches

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

List the switchports in an organization

public interface IOrganizationSwitches

Extension Methods

IOrganizationSwitchPortsStatusesExtensions.GetOrganizationSwitchPortsStatusesBySwitchAllAsync(IOrganizationSwitches, string, string?, int?, List<string>?, List<string>?, string?, string?, List<string>?, string?, List<string>?, string?, CancellationToken)

ISwitchPortsBySwitchExtensions.GetOrganizationSwitchPortsBySwitchAllAsync(IOrganizationSwitches, string, string?, List<string>?, string?, string?, string?, List<string>?, List<string>?, CancellationToken)

Methods

GetOrganizationSwitchPortsBySwitchAsync(string, int?, string?, string?, string?, List<string>?, string?, string?, string, List<string>?, List<string>?, CancellationToken)

List the switchports in an organization by switch

[Get("/organizations/{organizationId}/switch/ports/bySwitch")]
Task<List<SwitchPortsBySwitch>> GetOrganizationSwitchPortsBySwitchAsync(string organizationId, int? perPage, string? startingAfter, string? endingBefore, string? configurationUpdatedAfter, List<string>? networkIds, string? name, string? mac, string serial, List<string>? serials, List<string>? macs, CancellationToken cancellationToken = default)

Parameters

organizationId string

The OrganizationID

perPage int?

The number of entries per page returned. Acceptable range is 3 - 50. Default is 50.

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.

configurationUpdatedAfter string

Optional parameter to filter results by switches where the configuration has been updated after the given timestamp

networkIds List<string>

Optional parameter to filter switchports by network.

name string

Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.

mac string

Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.

serial string

Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.

serials List<string>

Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.

macs List<string>

Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.

cancellationToken CancellationToken

Returns

Task<List<SwitchPortsBySwitch>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSwitchPortsStatusesBySwitchAsync(string, string?, int?, int?, string?, string?, List<string>?, List<string>?, string?, string?, List<string>?, string?, List<string>?, string?, CancellationToken)

List the switchports in an organization

[Get("/organizations/{organizationId}/switch/ports/statuses/bySwitch")]
Task<List<SwitchPortsStatusesBySwitch>> GetOrganizationSwitchPortsStatusesBySwitchAsync(string organizationId, string? t0, int? timespan, int? perPage, string? startingAfter, string? endingBefore, List<string>? networkIds, List<string>? portProfileIds, string? name, string? mac, List<string>? macs, string? serial, List<string>? serials, string? configurationUpdatedAfter, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

timespan int?

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.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 50. Default is 50

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 switchports by network.

portProfileIds List<string>

Optional parameter to filter switchports belonging to the specified port profiles

name string

Optional parameter to filter switchports belonging to switches by name. All returned switches will have a name that contains the search term or is an exact match.

mac string

Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.

macs List<string>

Optional parameter to filter switchports by one or more MAC addresses belonging to devices. All switchports returned belong to MAC addresses of switches that are an exact match.

serial string

Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.

serials List<string>

Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.

configurationUpdatedAfter string

Optional parameter to filter results by switches where the configuration has been updated after the given timestamp

cancellationToken CancellationToken

Returns

Task<List<SwitchPortsStatusesBySwitch>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSwitchPortsTopologyDiscoveryByDeviceAsync(string, string?, string?, int?, int?, int?, string?, string?, string?, string?, List<string>?, string?, List<string>?, List<string>?, string?, List<string>?, CancellationToken)

List most recently seen LLDP/CDP discovery and topology information per switch port in an organization.

[Get("/organizations/{organizationId}/switch/ports/usage/history/byDevice/byInterval")]
Task<SwitchPortsTopologyDiscoveryByDevice> GetOrganizationSwitchPortsTopologyDiscoveryByDeviceAsync(string organizationId, string? t0, string? t1, int? timespan, int? interval, int? perPage, string? startingAfter, string? endingBefore, string? configurationUpdatedAfter, string? mac, List<string>? macs, string? name, List<string>? networkIds, List<string>? portProfileIds, string? serial, List<string>? serials, CancellationToken cancellationToken = default)

Parameters

organizationId string

The OrganizationID

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

t1 string

timespan int?

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.

interval int?

perPage int?

The number of entries per page returned. Acceptable range is 3 - 20. Default is 10.

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.

configurationUpdatedAfter string

Optional parameter to filter results by switches where the configuration has been updated after the given timestamp

mac string

Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.

macs List<string>

Optional parameter to filter items to switches that have one of the provided MAC addresses.

name string

Optional parameter to filter items to switches with names that contain the search term or are an exact match.

networkIds List<string>

Optional parameter to filter items to switches in one of the provided networks.

portProfileIds List<string>

Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles.

serial string

Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.

serials List<string>

Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.

cancellationToken CancellationToken

Returns

Task<SwitchPortsTopologyDiscoveryByDevice>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationSwitchPortsUsageHistoryByDeviceByIntervalAsync(string, string?, string?, int?, int?, int?, string?, string?, string?, string?, List<string>?, string?, List<string>?, List<string>?, string?, List<string>?, CancellationToken)

List the historical usage and traffic data of switchports in an organization.

[Get("/organizations/{organizationId}/switch/ports/usage/history/byDevice/byInterval")]
Task<SwitchPortsUsageHistoryByDeviceByInterval> GetOrganizationSwitchPortsUsageHistoryByDeviceByIntervalAsync(string organizationId, string? t0, string? t1, int? timespan, int? interval, int? perPage, string? startingAfter, string? endingBefore, string? configurationUpdatedAfter, string? mac, List<string>? macs, string? name, List<string>? networkIds, List<string>? portProfileIds, string? serial, List<string>? serials, CancellationToken cancellationToken = default)

Parameters

organizationId string

The OrganizationID

t0 string

The beginning of the timespan for the data. The maximum lookback period is 31 days from today.

t1 string

The end of the timespan for the data. t1 can be a maximum of 31 days after t0.

timespan int?

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. If interval is provided, the timespan will be autocalculated. maximum = 2678400

interval int?

The time interval in seconds for returned data. The valid intervals are: 300, 1200, 14400, 86400. The default is 1200. Interval is calculated if time params are provided.

perPage int?

The number of entries per page returned. Acceptable range is 3 - 50. Default is 50.

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.

configurationUpdatedAfter string

Optional parameter to filter results by switches where the configuration has been updated after the given timestamp

mac string

Optional parameter to filter switchports belonging to switches by MAC address. All returned switches will have a MAC address that contains the search term or is an exact match.

macs List<string>

Optional parameter to filter items to switches that have one of the provided MAC addresses.

name string

Optional parameter to filter items to switches with names that contain the search term or are an exact match.

networkIds List<string>

Optional parameter to filter items to switches in one of the provided networks.

portProfileIds List<string>

Optional parameter to filter items to switches that contain switchports belonging to one of the specified port profiles.

serial string

Optional parameter to filter switchports belonging to switches by serial number. All returned switches will have a serial number that contains the search term or is an exact match.

serials List<string>

Optional parameter to filter switchports belonging to switches with one or more serial numbers. All switchports returned belong to serial numbers of switches that are an exact match.

cancellationToken CancellationToken

Returns

Task<SwitchPortsUsageHistoryByDeviceByInterval>

Exceptions

ApiException

Thrown when fails to make API call