Devices¶

class py42.clients.devices.DeviceClient(session)¶

Bases: py42.clients.BaseClient

A class to interact with Code42 device/computer APIs.

block(device_id)¶

Blocks a device causing the user not to be able to login or restore.

REST Documentation

Parameters: device_id (int) – The ID of the device.
Returns: py42.response.Py42Response

deactivate(device_id)¶

Deactivates a device, causing backups to stop and archives to go to cold storage.

REST Documentation

Parameters: device_id (int) – The ID of the device.
Returns: py42.response.Py42Response

deauthorize(device_id)¶

Deauthorizes the device with the given ID. If used on a cloud connector device, it will: remove the authorization token for that account.

REST Documentation

Parameters: device_id (int) – The ID of the device.
Returns: py42.response.Py42Response

get_all(active=None, blocked=None, org_uid=None, user_uid=None, destination_guid=None, include_backup_usage=None, include_counts=True, q=None, **kwargs)¶

Gets all device information.

When no arguments are passed, all records are returned. To filter results, specify respective arguments. For example, to retrieve all active and blocked devices, pass active=true and blocked=true.

REST Documentation

Parameters

active (bool, optional) – Filters results by device state. When set to True, gets all active devices. When set to False, gets all deactivated devices. When set to None or excluded, gets all devices regardless of state. Defaults to None.
blocked (bool, optional) – Filters results by blocked status, True or False. Defaults to None.
org_uid (int, optional) – An ID of an Organization. Defaults to None.
user_uid (int, optional) – An ID of a User. Defaults to None.
destination_guid (str of int, optional) – The GUID of the server that the desktop clients back up their files to. Defaults to None.
include_backup_usage (type, bool) – A flag to denote whether to include destination and its backup summary. Defaults to None.
include_counts (bool, optional) – A flag to denote whether to include total, warning, and critical counts. Defaults to True.
q (type, optional) – Searches results flexibly by incomplete GUID, host-name, computer name, etc. Defaults to None.

Returns

An object that iterates over py42.response.Py42Response objects that each contain a page of devices.

For a logged in ordinary end user, it returns all the user’s devices.
For an organization administrator, it returns all the devices in the organization.
For a cross-organization administrator, it returns all the devices from all the user’s organizations.
Finally, for are a customer cloud administrator, it returns all devices in all organizations.

Return type

generator

get_by_guid(guid, include_backup_usage=None, **kwargs)¶

Gets device information by GUID.

REST Documentation

Parameters

guid (str) – The GUID of the device.
include_backup_usage (bool, optional) – A flag to denote whether to include its backup summary. Defaults to None.

Returns

A response containing device information.

Return type

py42.response.Py42Response

get_by_id(device_id, include_backup_usage=None, **kwargs)¶

Gets device information by ID.

REST Documentation

Parameters

device_id (int) – The ID of the device.
include_backup_usage (bool, optional) – A flag to denote whether to include its backup summary. Defaults to None.

Returns