Interface IOrganizationsDevices

Namespace

Meraki.Api.Interfaces.General.Organizations

Assembly

Meraki.Api.dll

public interface IOrganizationsDevices

Extension Methods

IOrganizationsDevicesExtensions.GetOrganizationDevicesAllAsync(IOrganizationsDevices, string, string, List<string>?, List<string>?, List<string>?, string?, string?, string?, string?, string?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, CancellationToken)

IOrganizationsDevicesExtensions.GetOrganizationDevicesProvisioningStatusesAllAsync(IOrganizationsDevices, string, List<string>?, List<string>?, string?, List<string>?, List<string>?, string?, CancellationToken)

IOrganizationsDevicesExtensions.GetOrganizationDevicesStatusesAllAsync(IOrganizationsDevices, string, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, List<string>?, string?, CancellationToken)

Methods

BulkUpdateOrganizationDevicesDetailsAsync(string, BulkDevicesUpdate, CancellationToken)

Updating device details (currently only used for Catalyst devices)

[Get("/organizations/{organizationId}/devices/details/bulkUpdate")]
Task<BulkUpdatedDevices> BulkUpdateOrganizationDevicesDetailsAsync(string organizationId, BulkDevicesUpdate bulkDevicesUpdate, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

bulkDevicesUpdate BulkDevicesUpdate

The bulk devices update request

cancellationToken CancellationToken

Returns

Task<BulkUpdatedDevices>

Exceptions

ApiException

Thrown when fails to make API call

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

List the devices in an organization that have been assigned to a network.

[Get("/organizations/{organizationId}/devices")]
Task<List<OrganizationDevice>> GetOrganizationDevicesAsync(string organizationId, int? perPage = 1000, string startingAfter = null, string endingBefore = null, string configurationUpdatedAfter = null, List<string>? networksIds = null, List<string>? productTypes = null, List<string>? tags = null, string? tagsFilterType = null, string? name = null, string? mac = null, string? serial = null, string? model = null, List<string>? macs = null, List<string>? serials = null, List<string>? sensorMetrics = null, List<string>? sensorAlertProfileIds = null, List<string>? models = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. (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)

configurationUpdatedAfter string

Filter results by whether or not the device's configuration has been updated after the given timestamp (optional)

networksIds List<string>

Optional parameter to filter devices by network

productTypes List<string>

Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

tags List<string>

Optional parameter to filter devices by tags.

tagsFilterType string

Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected.

name string

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

mac string

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

serial string

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

model string

Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match

macs List<string>

Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match

serials List<string>

Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match

sensorMetrics List<string>

Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices

sensorAlertProfileIds List<string>

Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices.

models List<string>

Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match

cancellationToken CancellationToken

Returns

Task<List<OrganizationDevice>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesOverviewByModelAsync(string, List<string>?, List<string>?, List<string>?, CancellationToken)

Lists the count for each device model.

[Get("/organizations/{organizationId}/devices/overview/byModel")]
Task<DevicesOverviewByModel> GetOrganizationDevicesOverviewByModelAsync(string organizationId, List<string>? models = null, List<string>? networkIds = null, List<string>? productTypes = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

models List<string>

networkIds List<string>

productTypes List<string>

cancellationToken CancellationToken

Returns

Task<DevicesOverviewByModel>

Exceptions

ApiException

Thrown when fails to make API call

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

List the provisioning statuses information for devices in an organization.

[Get("/organizations/{organizationId}/devices/provisioning/statuses")]
Task<List<DeviceProvisioningStatus>> GetOrganizationDevicesProvisioningStatusesAsync(string organizationId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, List<string>? networkIds = null, List<string>? productTypes = null, List<string>? serials = null, string? status = null, List<string>? tags = null, string? tagsFilterType = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

startingAfter string

endingBefore string

networkIds List<string>

productTypes List<string>

serials List<string>

status string

tags List<string>

tagsFilterType string

cancellationToken CancellationToken

Returns

Task<List<DeviceProvisioningStatus>>

Exceptions

ApiException

Thrown when fails to make API call

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

List the status of every Meraki device in the organization

[Get("/organizations/{organizationId}/devices/statuses")]
Task<List<OrganizationDeviceStatus>> GetOrganizationDevicesStatusesAsync(string organizationId, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, List<string>? networkIds = null, List<string>? serials = null, List<string>? statuses = null, List<string>? productTypes = null, List<string>? models = null, List<string>? tags = null, string? tagsFilterType = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

perPage int?

startingAfter string

endingBefore string

networkIds List<string>

serials List<string>

statuses List<string>

productTypes List<string>

models List<string>

tags List<string>

tagsFilterType string

cancellationToken CancellationToken

Returns

Task<List<OrganizationDeviceStatus>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesStatusesOverviewAsync(string, List<string>?, List<string>?, CancellationToken)

Return an overview of current device statuses

[Get("/organizations/{organizationId}/devices/statuses/overview")]
Task<DeviceStatusOverview> GetOrganizationDevicesStatusesOverviewAsync(string organizationId, List<string>? productTypes, List<string>? networkIds, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

productTypes List<string>

An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, and sensor.

networkIds List<string>

An optional parameter to filter device statuses by network.

cancellationToken CancellationToken

Returns

Task<DeviceStatusOverview>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesUplinksLossAndLatencyAsync(string, string, string, double?, string, string, CancellationToken)

Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago

[Get("/organizations/{organizationId}/devices/uplinksLossAndLatency")]
Task<List<UplinksLossAndLatencyResponse>> GetOrganizationDevicesUplinksLossAndLatencyAsync(string organizationId, string t0 = null, string t1 = null, double? timespan = null, string uplink = null, string ip = null, CancellationToken cancellationToken = default)

Parameters

organizationId string

The organization id

t0 string

The beginning of the timespan for the data. The maximum lookback period is 365 days from today. (optional)

t1 string

The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past. (optional)

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 5 minutes. The default is 5 minutes. (optional)

uplink string

Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, cellular. Default will return all uplinks. (optional)

ip string

Optional filter for a specific destination IP. Default will return all destination IPs. (optional)

cancellationToken CancellationToken

Returns

Task<List<UplinksLossAndLatencyResponse>>

Exceptions

ApiException

Thrown when fails to make API call