Devices (Batch)

Update the cellular band masks for a device.

API documentation: createDeviceCellularUplinksBandsMasksUpdate

Parameters:

• serial (str) –

  Serial.

• slot (CreateDeviceCellularUplinksBandsMasksUpdateSlot) –

  Required parameter for the SIM slot to update the cellular band mask for.

• type_ (CreateDeviceCellularUplinksBandsMasksUpdateType) –

  Required parameter for the signal type to update the cellular band mask for.

• masked (list[str]) –

  Required parameter for the band identifiers to mask for the given SIM slot and signal type. For LTE use bands identifiers like '30' and for 5G use band identifiers like 'n30'. Maximum 256 bands.

Enqueue a job to blink LEDs on a device.

API documentation: createDeviceLiveToolsLedsBlink

Parameters:

• serial (str) –

  Serial.

• duration (int) –

  The duration in seconds to blink LEDs.

• callback (CreateDeviceLiveToolsLedsBlinkCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Enqueue a job to test a device throughput, the test will run for 10 secs to test throughput.

API documentation: createDeviceLiveToolsThroughputTest

Parameters:

• serial (str) –

  Serial.

• callback (CreateDeviceLiveToolsThroughputTestCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Update the attributes of a device.

API documentation: updateDevice

Parameters:

• serial (str) –

  Serial.

• name (str | None, default: None ) –

  The name of a device.

• tags (list[str] | None, default: None ) –

  The list of tags of a device.

• lat (float | None, default: None ) –

  The latitude of a device.

• lng (float | None, default: None ) –

  The longitude of a device.

• address (str | None, default: None ) –

  The address of a device.

• notes (str | None, default: None ) –

  The notes for the device. String. Limited to 255 characters.

• move_map_marker (bool | None, default: None ) –

  Whether or not to set the latitude and longitude of a device based on the new address. Only applies when lat and lng are not specified.

• switch_profile_id (str | None, default: None ) –

  The ID of a switch template to bind to the device (for available switch templates, see the 'Switch Templates' endpoint). Use null to unbind the switch device from the current profile. For a device to be bindable to a switch template, it must (1) be a switch, and (2) belong to a network that is bound to a configuration template.

• floor_plan_id (str | None, default: None ) –

  The floor plan to associate to this device. null disassociates the device from the floorplan.

Update the enablement of the geolocation feature for a device.

API documentation: updateDeviceCellularGeolocations

Parameters:

• serial (str) –

  Serial.

• enabled (bool) –

  Required parameter for the state to update the geolocation settings to (true to enable, false to disable).

Update the management interface settings for a device.

API documentation: updateDeviceManagementInterface

Parameters:

• serial (str) –

  Serial.

• wan1 (UpdateDeviceManagementInterfaceWan1 | None, default: None ) –

  WAN 1 settings.

• wan2 (UpdateDeviceManagementInterfaceWan2 | None, default: None ) –

  WAN 2 settings (only for MX devices).