Previous topic

Command

Next topic

Organization

This Page

Device

class commandment.models.Device(**kwargs)[source]

An enrolled device.

Table:devices
activation_lock_escrow_key

The activation lock bypass code generated by the device

Type:activation_lock_escrow_key (str)
asset_tag

The device asset tag, if provided by Apple.

Type:asset_tag (str)
available_device_capacity

available capacity (base 1024 gigabytes)

Type:device_available_capacity (float)
awaiting_configuration

True if device is waiting at Setup Assistant

Type:awaiting_configuration (bool)
battery_level

battery level, between 0.0 and 1.0. -1.0 if information is not available.

Type:battery_level (float)
block_all_incoming

All incoming connections are blocked.

Type:block_all_incoming (bool)
bluetooth_mac

The bluetooth MAC address

Type:bluetooth_mac (str)
build_version

DeviceInformation BuildVersion

Type:build_version (str)
carrier_settings_version

Version of the current carrier settings file.

Type:carrier_settings_version (str)
cellular_technology

cellular technology.

Type:cellular_technology (CellularTechnology)
color

The device color indicated by DEP

Type:color
Type:(str)
current_carrier_network

Name of the current carrier network.

Type:current_carrier_network (str)
current_mcc

Current Mobile Country Code (numeric)

Type:current_mcc (str)
current_mnc

Current Mobile Network Code (numeric)

Type:current_mnc (str)
data_roaming_enabled

Data Roaming is enabled in settings.

Type:data_roaming_enabled (bool)
description

The DEP description which is often identical to the SKU description on the invoice.

Type:description (str)
device_assigned_by

The email of the person who assigned the device.

Type:device_assigned_by (str)
device_assigned_date

The date and time the device was recorded into DEP.

Type:device_assigned_date (datetime)
device_capacity

total capacity (base 1024 gigabytes)

Type:device_capacity (float)
device_family

The device’s Apple product family returned by DEP.

Type:device_family (str)
device_id

Device ID (ATV)

Type:device_id (str)
device_name

Name of the device

Type:device_name (str)
eas_device_identifier

Exchange ActiveSync Identifier

Type:eas_device_identifier (str)
fde_enabled

Whether full disk encryption is enabled or not.

Type:fde_enabled (bool)
fde_has_irk

Whether FDE has an institutional recovery key set.

Type:fde_has_irk (bool)
fde_has_prk

Whether FDE has a personal recovery key set.

Type:fde_has_prk (bool)
fde_personal_recovery_key_cms

If Escrow is enabled, contains the encrypted PRK

Type:fde_personal_recovery_key_cms (bytes)
fde_personal_recovery_key_device_key

type: fde_personal_recovery_key_device_key (str)

firewall_enabled

Application firewall is enabled.

Type:firewall_enabled (bool)
hex_token

Retrieve the device token in hex encoding, necessary for the APNS2 client.

hostname

type: hostname (str)

iccid

The ICC identifier for the SIM card.

Type:iccid (str)
id

type: id (int)

imei

IMEI number (if device is GSM).

Type:imei (str)
is_activation_lock_enabled

Device has Activation Lock enabled.

Type:is_activation_lock_enabled (bool)
is_cloud_backup_enabled

iCloud backup is enabled.

Type:is_cloud_backup_enabled (bool)
is_dep

This device has been synced from DEP. False indicates a manual or AC2 enrolment

Type:is_dep (bool)
is_device_locator_service_enabled

Find My iPhone/Mac enabled.

Type:is_device_locator_service_enabled (bool)
is_do_not_disturb_in_effect

Device has DND enabled.

Type:is_do_not_disturb_in_effect (bool)
is_enrolled

Whether the MDM should consider this device enrolled.

Type:is_enrolled (bool)
is_mdm_lost_mode_enabled

MDM Lost mode is enabled.

Type:is_mdm_lost_mode_enabled (bool)
is_roaming

The device is currently roaming.

Type:is_roaming (bool)
is_supervised

Device is supervised

Type:is_supervised (bool)
itunes_store_account_hash

a hash of the iTunes Store account currently logged in.

Type:itunes_store_account_hash (str)
itunes_store_account_is_active

the user is currently logged into an active iTunes Store account.

Type:itunes_store_account_is_active (bool)
last_apns_id

The UUID of the last apns command sent.

Type:last_apns_id (str)
last_cloud_backup_date

The date of the last iCloud backup.

Type:last_cloud_backup_date (datetime)
last_push_at

The datetime when the last push was sent to APNS for this device.

Type:last_push_at (datetime.datetime)
last_seen

When the device last contacted the MDM.

Type:last_seen (datetime.datetime)
local_hostname

type: local_hostname (str)

maximum_resident_users

Maximum number of users that can use Shared iPad.

Type:maximum_resident_users (int)
meid

MEID number (if device is CSMA).

Type:meid (str)
model

Name of the hardware model

Type:model (str)
model_name

Longer name of the hardware model

Type:model_name (str)
modem_firmware_version

The baseband firmware version.

Type:modem_firmware_version (str)
os

iOS, OSX or tvOS

Type:os (str)
Type:The device operating system returned by DEP
os_version

The operating system version number.

Type:os_version (str)
osu_catalog_url

Software Update Catalog URL.

Type:osu_catalog_url (str)
passcode_compliant

The passcode is compliant with all requirements (incl Exchange accounts).

Type:passcode_compliant (bool)
passcode_compliant_with_profiles

The passcode is compliant with profile requirements.

Type:passcode_compliant_with_profiles (bool)
passcode_lock_grace_period_enforced

The current enforced time in seconds before unlock passcode will be required.

Type:passcode_lock_grace_period_enforced (int)
passcode_present

Device has a passcode.

Type:passcode_present (bool)
personal_hotspot_enabled

Personal HotSpot is currently turned on.

Type:personal_hotspot_enabled (bool)
phone_number

Raw phone number without punctuation.

Type:phone_number (str)
product_name

The base product name of the hardware

Type:product_name (str)
profile_assign_time

The date and time indicating when the DEP profile was assigned

Type:profile_assign_time (datetime)
profile_push_time

The date and time indicating when the DEP profile was pushed.

Type:profile_push_time (datetime)
profile_status

empty, assigned, pushed or removed.

Type:profile_status (str)
Type:The status of profile installation
profile_uuid

The UUID of the assigned DEP profile

Type:profile_uuid (str)
push_magic

The UUID that establishes a unique relationship between the device and the MDM.

Type:push_magic (str)
serial_number

The hardware serial number

Type:serial_number (str)
sim_carrier_network

Name of the home carrier network.

Type:sim_carrier_network (str)
sip_enabled

System Integrity Protection is enabled.

Type:sip_enabled (bool)
stealth_mode_enabled

Stealth mode is enabled.

Type:stealth_mode_enabled (bool)
subscriber_carrier_network

Name of the home carrier network (replaces sim_carrier_network).

Type:subscriber_carrier_network (str)
subscriber_mcc

Home Mobile Country Code (numeric)

Type:subscriber_mcc (str)
subscriber_mnc

Home Mobile Network Code (numeric)

Type:subscriber_mnc (str)
topic

The APNS topic the device is listening on.

Type:topic (str)
udid

Unique Device Identifier

Type:udid (str)
voice_roaming_enabled

Voice Roaming is enabled in settings.

Type:voice_roaming_enabled (bool)
wifi_mac

The WiFi MAC address

Type:wifi_mac (str)