deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 05:17:22 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
windows-itpro-docs/windows/client-management/mdm/devicestatus-csp.md
Vinay Pamnani 089d6c2989 Metadata Changes
2022-08-10 18:08:08 -04:00

14 KiB
Raw Blame History

title, description, ms.reviewer, manager, ms.author, ms.topic, ms.prod, ms.technology, author, ms.date
title description ms.reviewer manager ms.author ms.topic ms.prod ms.technology author ms.date
DeviceStatus CSP Learn how the DeviceStatus configuration service provider keeps track of device inventory and queries the compliance state of devices within the enterprise. aaroncz vinpa article w10 windows vinaypamnani-msft 06/25/2021

DeviceStatus CSP

The table below shows the applicability of Windows:

Edition Windows 10 Windows 11
Home Yes Yes
Pro Yes Yes
Windows SE No Yes
Business Yes Yes
Enterprise Yes Yes
Education Yes Yes

The DeviceStatus configuration service provider is used by the enterprise to keep track of device inventory and query the state of compliance of these devices with their enterprise policies.

The following example shows the DeviceStatus configuration service provider in tree format.

./Vendor/MSFT
DeviceStatus
----SecureBootState
----CellularIdentities
--------IMEI
------------IMSI
------------ICCID
------------PhoneNumber
------------CommercializationOperator
------------RoamingStatus
------------RoamingCompliance
----NetworkIdentifiers
--------MacAddress
------------IPAddressV4
------------IPAddressV6
------------IsConnected
------------Type
----Compliance
--------EncryptionCompliance
----TPM
--------SpecificationVersion
----OS
--------Edition
--------Mode
----Antivirus
--------SignatureStatus
--------Status
----Antispyware
--------SignatureStatus
--------Status
----Firewall
--------Status
----UAC
--------Status
----Battery
--------Status
--------EstimatedChargeRemaining
--------EstimatedRuntime
----DomainName
----DeviceGuard
--------VirtualizationBasedSecurityHwReq
--------VirtualizationBasedSecurityStatus
--------LsaCfgCredGuardStatus

DeviceStatus
The root node for the DeviceStatus configuration service provider.

DeviceStatus/SecureBootState
Indicates whether secure boot is enabled. The value is one of the following values:

  • 0 - Not supported
  • 1 - Enabled
  • 2 - Disabled

Supported operation is Get.

DeviceStatus/CellularIdentities
Required. Node for queries on the SIM cards.

Note

Multiple SIMs are supported.

DeviceStatus/CellularIdentities/IMEI
The unique International Mobile Station Equipment Identity (IMEI) number of the mobile device. An IMEI is present for each SIM card on the device.

DeviceStatus/CellularIdentities/IMEI/IMSI
The International Mobile Subscriber Identity (IMSI) associated with the IMEI number.

Supported operation is Get.

DeviceStatus/CellularIdentities/IMEI/ICCID
The Integrated Circuit Card ID (ICCID) of the SIM card associated with the specific IMEI number.

Supported operation is Get.

DeviceStatus/CellularIdentities/IMEI/PhoneNumber
Phone number associated with the specific IMEI number.

Supported operation is Get.

DeviceStatus/CellularIdentities/IMEI/CommercializationOperator
The mobile service provider or mobile operator associated with the specific IMEI number.

Supported operation is Get.

DeviceStatus/CellularIdentities/IMEI/RoamingStatus
Indicates whether the SIM card associated with the specific IMEI number is roaming.

Supported operation is Get.

DeviceStatus/CellularIdentities/IMEI/RoamingCompliance
Boolean value that indicates compliance with the enforced enterprise roaming policy.

Supported operation is Get.

DeviceStatus/NetworkIdentifiers
Node for queries on network and device properties.

DeviceStatus/NetworkIdentifiers/MacAddress
MAC address of the wireless network card. A MAC address is present for each network card on the device.

DeviceStatus/NetworkIdentifiers/MacAddress/IPAddressV4
IPv4 address of the network card associated with the MAC address.

Supported operation is Get.

DeviceStatus/NetworkIdentifiers/MacAddress/IPAddressV6
IPv6 address of the network card associated with the MAC address.

Supported operation is Get.

DeviceStatus/NetworkIdentifiers/MacAddress/IsConnected
Boolean value that indicates whether the network card associated with the MAC address has an active network connection.

Supported operation is Get.

DeviceStatus/NetworkIdentifiers/MacAddress/Type
Type of network connection. The value is one of the following values:

  • 2 - WLAN (or other Wireless interface)
  • 1 - LAN (or other Wired interface)
  • 0 - Unknown

Supported operation is Get.

DeviceStatus/Compliance
Node for the compliance query.

DeviceStatus/Compliance/EncryptionCompliance
Boolean value that indicates compliance with the enterprise encryption policy for OS (system) drives. The value is one of the following values:

  • 0 - Not encrypted
  • 1 - Encrypted

Supported operation is Get.

DeviceStatus/TPM
Added in Windows, version 1607. Node for the TPM query.

Supported operation is Get.

DeviceStatus/TPM/SpecificationVersion
Added in Windows, version 1607. String that specifies the specification version.

Supported operation is Get.

DeviceStatus/OS
Added in Windows, version 1607. Node for the OS query.

Supported operation is Get.

DeviceStatus/OS/Edition
Added in Windows, version 1607. String that specifies the OS edition.

Supported operation is Get.

DeviceStatus/OS/Mode
Added in Windows, version 1803. Read only node that specifies the device mode.

Valid values:

  • 0 - The device is in standard configuration.
  • 1 - The device is in S mode configuration.

Supported operation is Get.

DeviceStatus/Antivirus
Added in Windows, version 1607. Node for the antivirus query.

Supported operation is Get.

DeviceStatus/Antivirus/SignatureStatus
Added in Windows, version 1607. Integer that specifies the status of the antivirus signature.

Valid values:

  • 0 - The security software reports that it isn't the most recent version.
  • 1 (default) - The security software reports that it's the most recent version.
  • 2 – Not applicable. It is returned for devices like the phone that don't have an antivirus (where the API doesn’t exist.)

Supported operation is Get.

If more than one antivirus provider is active, this node returns:

  • 1 – If every active antivirus provider has a valid signature status.
  • 0 – If any of the active antivirus providers has an invalid signature status.

This node also returns 0 when no antivirus provider is active.

DeviceStatus/Antivirus/Status
Added in Windows, version 1607. Integer that specifies the status of the antivirus.

Valid values:

  • 0 – Antivirus is on and monitoring.
  • 1 – Antivirus is disabled.
  • 2 – Antivirus isn't monitoring the device/PC or some options have been turned off.
  • 3 (default) – Antivirus is temporarily not completely monitoring the device/PC.
  • 4 – Antivirus not applicable for this device. This value is returned for devices like the phone that don't have an antivirus (where the API doesn’t exist.)

Supported operation is Get.

DeviceStatus/Antispyware
Added in Windows, version 1607. Node for the anti-spyware query.

Supported operation is Get.

DeviceStatus/Antispyware/SignatureStatus
Added in Windows, version 1607. Integer that specifies the status of the anti-spyware signature.

Valid values:

  • 0 - The security software reports that it isn't the most recent version.
  • 1 - The security software reports that it's the most recent version.
  • 2 - Not applicable. This value is returned for devices like the phone that don't have an antivirus (where the API doesn’t exist.)

Supported operation is Get.

If more than one anti-spyware provider is active, this node returns:

  • 1 – If every active anti-spyware provider has a valid signature status.
  • 0 – If any of the active anti-spyware providers has an invalid signature status.

This node also returns 0 when no anti-spyware provider is active.

DeviceStatus/Antispyware/Status
Added in Windows, version 1607. Integer that specifies the status of the anti-spyware.

Valid values:

  • 0 - The status of the security provider category is good and doesn't need user attention.
  • 1 - The status of the security provider category isn't monitored by Windows Security.
  • 2 - The status of the security provider category is poor and the computer may be at risk.
  • 3 - The security provider category is in snooze state. Snooze indicates that the Windows Security Service isn't actively protecting the computer.

Supported operation is Get.

DeviceStatus/Firewall
Added in Windows, version 1607. Node for the firewall query.

Supported operation is Get.

DeviceStatus/Firewall/Status
Added in Windows, version 1607. Integer that specifies the status of the firewall.

Valid values:

  • 0 – Firewall is on and monitoring.
  • 1 – Firewall has been disabled.
  • 2 – Firewall isn't monitoring all networks or some rules have been turned off.
  • 3 (default) – Firewall is temporarily not monitoring all networks.
  • 4 – Not applicable. This value is returned for devices like the phone that don't have an antivirus (where the API doesn’t exist.)

Supported operation is Get.

DeviceStatus/UAC
Added in Windows, version 1607. Node for the UAC query.

Supported operation is Get.

DeviceStatus/UAC/Status
Added in Windows, version 1607. Integer that specifies the status of the UAC.

Supported operation is Get.

DeviceStatus/Battery
Added in Windows, version 1607. Node for the battery query.

Supported operation is Get.

DeviceStatus/Battery/Status
Added in Windows, version 1607. Integer that specifies the status of the battery

Supported operation is Get.

DeviceStatus/Battery/EstimatedChargeRemaining
Added in Windows, version 1607. Integer that specifies the estimated battery charge remaining. This value is the one that is returned in BatteryLifeTime in SYSTEM_POWER_STATUS structure.

The value is the number of seconds of battery life remaining when the device isn't connected to an AC power source. When it's connected to a power source, the value is -1. When the estimation is unknown, the value is -1.

Supported operation is Get.

DeviceStatus/Battery/EstimatedRuntime
Added in Windows, version 1607. Integer that specifies the estimated runtime of the battery. This value is the one that is returned in BatteryLifeTime in SYSTEM_POWER_STATUS structure.

The value is the number of seconds of battery life remaining when the device isn't connected to an AC power source. When it's connected to a power source, the value is -1. When the estimation is unknown, the value is -1.

Supported operation is Get.

DeviceStatus/DomainName
Added in Windows, version 1709. Returns the fully qualified domain name of the device (if any). If the device isn't domain-joined, it returns an empty string.

Supported operation is Get.

DeviceStatus/DeviceGuard
Added in Windows, version 1709. Node for Device Guard query.

Supported operation is Get.

DeviceStatus/DeviceGuard/VirtualizationBasedSecurityHwReq
Added in Windows, version 1709. Virtualization-based security hardware requirement status. The value is a 256 value bitmask.

  • 0x0: System meets hardware configuration requirements
  • 0x1: SecureBoot required
  • 0x2: DMA Protection required
  • 0x4: HyperV not supported for Guest VM
  • 0x8: HyperV feature isn't available

Supported operation is Get.

DeviceStatus/DeviceGuard/VirtualizationBasedSecurityStatus
Added in Windows, version 1709. Virtualization-based security status. Value is one of the following:

  • 0 - Running
  • 1 - Reboot required
  • 2 - 64-bit architecture required
  • 3 - Not licensed
  • 4 - Not configured
  • 5 - System doesn't meet hardware requirements
  • 42 – Other. Event logs in Microsoft-Windows-DeviceGuard have more details.

Supported operation is Get.

DeviceStatus/DeviceGuard/LsaCfgCredGuardStatus
Added in Windows, version 1709. Local System Authority (LSA) credential guard status.

  • 0 - Running
  • 1 - Reboot required
  • 2 - Not licensed for Credential Guard
  • 3 - Not configured
  • 4 - VBS not running

Supported operation is Get.

Related topics

Configuration service provider reference