Interface ISmDevices

Namespace

Meraki.Api.Interfaces.Products.Sm

Assembly

Meraki.Api.dll

Represents a collection of functions to interact with the API endpoints

public interface ISmDevices

Methods

CheckinNetworkSmDevicesAsync(string, SmDevicesCheckinRequest, CancellationToken)

Force check-in a set of devices

[Post("/networks/{networkId}/sm/devices/checkin")]
Task<SmDevicesCheckinRequest> CheckinNetworkSmDevicesAsync(string networkId, SmDevicesCheckinRequest checkinNetworkSmDevices, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

checkinNetworkSmDevices SmDevicesCheckinRequest

Body for check-in of device

cancellationToken CancellationToken

Returns

Task<SmDevicesCheckinRequest>

Exceptions

ApiException

Thrown when fails to make API call

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

List the devices enrolled in an SM network with various specified fields and filters

[Get("/networks/{networkId}/sm/devices")]
Task<List<SmDevice>> GetNetworkSmDevicesAsync(string networkId, List<string> fields = null, List<string> wifiMacs = null, List<string> serials = null, List<string> ids = null, List<string> scope = null, int? perPage = 1000, string? startingAfter = null, string? endingBefore = null, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

fields List<string>

Additional fields that will be displayed for each device. Multiple fields can be passed in as comma separated values. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, and androidSecurityPatchVersion. (optional)

wifiMacs List<string>

Filter devices by wifi mac(s). Multiple wifi macs can be passed in as comma separated values. (optional)

serials List<string>

Filter devices by serial(s). Multiple serials can be passed in as comma separated values. (optional)

ids List<string>

Filter devices by id(s). Multiple ids can be passed in as comma separated values. (optional)

scope List<string>

Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags as comma separated values. (optional)

perPage int?

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

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.

cancellationToken CancellationToken

Returns

Task<List<SmDevice>>

Exceptions

ApiException

Thrown when fails to make API call

LockNetworkSmDevicesAsync(string, SmDevicesCheckinRequest, CancellationToken)

Lock a set of devices

[Post("/networks/{networkId}/sm/devices/lock")]
Task<SmDevicesCheckinRequest> LockNetworkSmDevicesAsync(string networkId, SmDevicesCheckinRequest lockNetworkSmDevices, CancellationToken cancellationToken = default)

Parameters

networkId string

lockNetworkSmDevices SmDevicesCheckinRequest

Body for locking a set of devices

cancellationToken CancellationToken

Returns

Task<SmDevicesCheckinRequest>

Exceptions

ApiException

Thrown when fails to make API call

ModifyNetworkSmDevicesTagsAsync(string, ModifyNetworkDeviceTags, CancellationToken)

Add, delete, or update the tags of a set of devices

[Post("/networks/{networkId}/sm/devices/modifyTags")]
Task<List<SmDevicesCheckinRequest>> ModifyNetworkSmDevicesTagsAsync(string networkId, ModifyNetworkDeviceTags modifyNetworkSmDevicesTags, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

modifyNetworkSmDevicesTags ModifyNetworkDeviceTags

cancellationToken CancellationToken

Returns

Task<List<SmDevicesCheckinRequest>>

Exceptions

ApiException

Thrown when fails to make API call

MoveNetworkSmDevicesAsync(string, MoveNetworkSmDevicesRequest, CancellationToken)

Move a set of devices to a new network

[Post("/networks/{networkId}/sm/devices/move")]
Task<MoveNetworkSmDevicesRequest> MoveNetworkSmDevicesAsync(string networkId, MoveNetworkSmDevicesRequest moveNetworkSmDevices, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

moveNetworkSmDevices MoveNetworkSmDevicesRequest

Body for moving devices

cancellationToken CancellationToken

Returns

Task<MoveNetworkSmDevicesRequest>

Exceptions

ApiException

Thrown when fails to make API call

RefreshNetworkSmDeviceDetailsAsync(string, string, CancellationToken)

Refresh the details of a device

[Post("/networks/{networkId}/sm/devices/{deviceId}/refreshDetails")]
Task RefreshNetworkSmDeviceDetailsAsync(string networkId, string deviceId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

deviceId string

The device id

cancellationToken CancellationToken

Returns

Task

Exceptions

ApiException

Thrown when fails to make API call

UnenrollNetworkSmDeviceAsync(string, string, CancellationToken)

Unenroll a device

[Post("/networks/{networkId}/sm/devices/{deviceId}/unenroll")]
Task<ActionResponse> UnenrollNetworkSmDeviceAsync(string networkId, string deviceId, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

deviceId string

The device id

cancellationToken CancellationToken

Returns

Task<ActionResponse>

Exceptions

ApiException

Thrown when fails to make API call

WipeNetworkSmDevicesAsync(string, WipeNetworkSmDeviceRequest, CancellationToken)

Wipe a device

[Post("/networks/{networkId}/sm/devices/wipe")]
Task<WipeNetworkSmDeviceRequest> WipeNetworkSmDevicesAsync(string networkId, WipeNetworkSmDeviceRequest wipeNetworkSmDevices, CancellationToken cancellationToken = default)

Parameters

networkId string

The network id

wipeNetworkSmDevices WipeNetworkSmDeviceRequest

Body for wiping a device

cancellationToken CancellationToken

Returns

Task<WipeNetworkSmDeviceRequest>

Exceptions

ApiException

Thrown when fails to make API call