Table of Contents

Class IOrganizationsDevicesExtensions

Namespace
Meraki.Api.Extensions
Assembly
Meraki.Api.dll
public static class IOrganizationsDevicesExtensions
Inheritance
IOrganizationsDevicesExtensions
Inherited Members

Methods

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)

List all devices in an organization

public static Task<List<OrganizationDevice>> GetOrganizationDevicesAllAsync(this IOrganizationsDevices organizationDevices, string organizationId, 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

organizationDevices IOrganizationsDevices
organizationId string

The organization id

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

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

List the provisioning status of every Meraki device in the organization

public static Task<List<DeviceProvisioningStatus>> GetOrganizationDevicesProvisioningStatusesAllAsync(this IOrganizationsDevices organizationDevices, string organizationId, List<string>? networkIds = null, List<string>? serials = null, string? status = null, List<string>? productTypes = null, List<string>? tags = null, string? tagsFilterType = null, CancellationToken cancellationToken = default)

Parameters

organizationDevices IOrganizationsDevices
organizationId string

The organization id

networkIds List<string>

Optional parameter to filter devices by network ids.

serials List<string>

Optional parameter to filter devices by serials.

status string

Optional parameter to filter devices by statuses. Valid statuses are ["online", "alerting", "offline", "dormant"].

productTypes List<string>

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

tags List<string>

An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).

tagsFilterType string

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

cancellationToken CancellationToken

Returns

Task<List<DeviceProvisioningStatus>>

Exceptions

ApiException

Thrown when fails to make API call

GetOrganizationDevicesStatusesAllAsync(IOrganizationsDevices, 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

public static Task<List<OrganizationDeviceStatus>> GetOrganizationDevicesStatusesAllAsync(this IOrganizationsDevices organizationDevices, string organizationId, 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

organizationDevices IOrganizationsDevices
organizationId string

The organization id

networkIds List<string>

Optional parameter to filter devices by network ids.

serials List<string>

Optional parameter to filter devices by serials.

statuses List<string>

Optional parameter to filter devices by statuses. Valid statuses are ["online", "alerting", "offline", "dormant"].

productTypes List<string>

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

models List<string>

Optional parameter to filter devices by models.

tags List<string>

An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below).

tagsFilterType string

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

cancellationToken CancellationToken

Returns

Task<List<OrganizationDeviceStatus>>

Exceptions

ApiException

Thrown when fails to make API call

Edit this page