deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-06-17 11:23:45 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

NodeCache CSP

Browse Source
This commit is contained in:
Vinay Pamnani
2023-02-21 12:49:11 -05:00
parent afc9df8126
commit df70010de2
2 changed files with 1249 additions and 573 deletions
Download Patch File Download Diff File Expand all files Collapse all files

866
windows/client-management/mdm/nodecache-csp.md
View File

@ -1,29 +1,23 @@
--- ---
title: NodeCache CSP title: NodeCache CSP
description: Use the NodeCache configuration service provider (CSP) to synchronize, monitor, and manage the client cache. description: Learn more about the NodeCache CSP.
ms.reviewer: author: vinaypamnani-msft
manager: aaroncz manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/21/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 06/26/2017
--- ---
<!-- Auto-Generated CSP Document -->
<!-- NodeCache-Begin -->
# NodeCache CSP # NodeCache CSP
The table below shows the applicability of Windows: <!-- NodeCache-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|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 NodeCache configuration service provider is used to manage the client cache. This configuration service provider is to be used only by enterprise management servers. It provides a level of abstraction that decouples the management of the node list from a specific backing store. It synchronizes the client cache with the server side cache. It also provides an API for monitoring device-side cache changes. The NodeCache configuration service provider is used to manage the client cache. This configuration service provider is to be used only by enterprise management servers. It provides a level of abstraction that decouples the management of the node list from a specific backing store. It synchronizes the client cache with the server side cache. It also provides an API for monitoring device-side cache changes.
NodeCache supports the comparison of hash values instead of actual node values: NodeCache supports the comparison of hash values instead of actual node values:
@ -35,90 +29,347 @@ application/x-nodemon-sha256
``` ```
NodeCache will hash the values and compare with a hash value that was sent down by the server. This process supports checking a parent node and its children recursively. NodeCache will hash the values and compare with a hash value that was sent down by the server. This process supports checking a parent node and its children recursively.
<!-- NodeCache-Editable-End -->
<!-- NodeCache-Tree-Begin -->
The following example shows the NodeCache configuration service provider in tree format. The following example shows the NodeCache configuration service provider in tree format.
```text
./Device/Vendor/MSFT/NodeCache
--- {ProviderID}
------ CacheVersion
------ ChangedNodes
------ ChangedNodesData
------ Nodes
--------- {NodeID}
------------ AutoSetExpectedValue
------------ ExpectedValue
------------ NodeURI
./User/Vendor/MSFT/NodeCache
--- {ProviderID}
------ CacheVersion
------ ChangedNodes
------ ChangedNodesData
------ Nodes
--------- {NodeID}
------------ AutoSetExpectedValue
------------ ExpectedValue
------------ NodeURI
``` ```
./User/Vendor/MSFT <!-- NodeCache-Tree-End -->
NodeCache
----ProviderID
--------CacheVersion
--------ChangedNodes
--------ChangedNodesData
--------Nodes
------------NodeID
----------------NodeURI
----------------ExpectedValue
----------------AutoSetExpectedValue
<!-- Device-{ProviderID}-Begin -->
## Device/{ProviderID}
./Device/Vendor/MSFT <!-- Device-{ProviderID}-Applicability-Begin -->
NodeCache | Scope | Editions | Applicable OS |
----ProviderID |:--|:--|:--|
--------CacheVersion | :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
--------ChangedNodes <!-- Device-{ProviderID}-Applicability-End -->
--------ChangedNodesData
--------Nodes
------------NodeID
----------------NodeURI
----------------ExpectedValue
----------------AutoSetExpectedValue
<!-- Device-{ProviderID}-OmaUri-Begin -->
./User/Vendor/MSFT ```Device
./Device/Vendor/MSFT ./Device/Vendor/MSFT/NodeCache/{ProviderID}
NodeCache
----ProviderID
--------CacheVersion
--------ChangedNodes
--------ChangedNodesData
--------Nodes
------------NodeID
----------------NodeURI
----------------ExpectedValue
----------------AutoSetExpectedValue
``` ```
<a href="" id="--device-vendor-msft"></a>**./Device/Vendor/MSFT and ./User/Vendor/MSFT** <!-- Device-{ProviderID}-OmaUri-End -->
Required. The root node for the NodeCache object. Supported operation is Get. This configuration service provider is used for enterprise device management only. This parameter's value is a predefined MIME type to identify this managed object in OMA DM syntax.
<a href="" id="providerid"></a>***ProviderID*** <!-- Device-{ProviderID}-Description-Begin -->
Optional. Group settings per DM server. Each group of settings is distinguished by the server’s Provider ID. It should be the same DM server **PROVIDER-ID** value that was supplied through the [w7 APPLICATION configuration service provider](w7-application-csp.md) XML during the enrollment process. Only one enterprise management server is supported. That is, there should be only one **ProviderID** node under **NodeCache**. Scope is dynamic. <!-- Description-Source-DDF -->
Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the [w7 APPLICATION](w7-application-csp.md) configuration service provider XML during the enrollment process. In Windows Phone 8, only one enterprise management server is supported. That is, there should be only one ProviderID node under NodeCache.
<!-- Device-{ProviderID}-Description-End -->
Supported operations are Get, Add, and Delete. <!-- Device-{ProviderID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Editable-End -->
<a href="" id="providerid-cacheversion"></a>***ProviderID*/CacheVersion** <!-- Device-{ProviderID}-DFProperties-Begin -->
Optional. Character string representing the cache version set by the server. Scope is dynamic. **Description framework properties**:
Data type is string. Supported operations are Get, Add, and Replace. | Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | UniqueName: It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process. |
<!-- Device-{ProviderID}-DFProperties-End -->
<a href="" id="providerid-changednodes"></a>***ProviderID*/ChangedNodes** <!-- Device-{ProviderID}-Examples-Begin -->
Optional. List of nodes whose values don't match their expected values as specified in **/*NodeID*/ExpectedValue**. Scope is dynamic. <!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Examples-End -->
Data type is string. Supported operation is Get. <!-- Device-{ProviderID}-End -->
<a href="" id="providerid-changednodesdata"></a>***ProviderID*/ChangedNodesData** <!-- Device-{ProviderID}-CacheVersion-Begin -->
Added in Windows 10, version 1703. Optional. XML containing nodes whose values don't match their expected values as specified in /NodeID/ExpectedValue. ### Device/{ProviderID}/CacheVersion
Supported operation is Get. <!-- Device-{ProviderID}-CacheVersion-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-CacheVersion-Applicability-End -->
<a href="" id="providerid-nodes"></a>***ProviderID*/Nodes** <!-- Device-{ProviderID}-CacheVersion-OmaUri-Begin -->
Required. Root node for cached nodes. Scope is dynamic. ```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/CacheVersion
```
<!-- Device-{ProviderID}-CacheVersion-OmaUri-End -->
Supported operation is Get. <!-- Device-{ProviderID}-CacheVersion-Description-Begin -->
<!-- Description-Source-DDF -->
Character string representing the cache version set by the server.
<!-- Device-{ProviderID}-CacheVersion-Description-End -->
<a href="" id="-nodes-nodeid"></a>**/Nodes/**<strong>*NodeID*</strong> <!-- Device-{ProviderID}-CacheVersion-Editable-Begin -->
Optional. Information about each cached node is stored under *NodeID* as specified by the server. This value must not contain a comma. Scope is dynamic. <!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-CacheVersion-Editable-End -->
Supported operations are Get, Add, and Delete. <!-- Device-{ProviderID}-CacheVersion-DFProperties-Begin -->
**Description framework properties**:
<a href="" id="-nodeid-nodeuri"></a>**/*NodeID*/NodeURI** | Property name | Property value |
Required. This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree. Scope is dynamic. |:--|:--|
| Format | chr (string) |
| Access Type | Add, Get, Replace |
<!-- Device-{ProviderID}-CacheVersion-DFProperties-End -->
Data type is string. Supported operations are Get, Add, and Delete. <!-- Device-{ProviderID}-CacheVersion-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-CacheVersion-Examples-End -->
<a href="" id="-nodeid-expectedvalue"></a>**/*NodeID*/ExpectedValue** <!-- Device-{ProviderID}-CacheVersion-End -->
Required. The server expects this value to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value. Scope is dynamic. Supported values are string and x-nodemon-nonexistent.
Supported operations are Get, Add, and Delete. <!-- Device-{ProviderID}-ChangedNodes-Begin -->
### Device/{ProviderID}/ChangedNodes
<!-- Device-{ProviderID}-ChangedNodes-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-ChangedNodes-Applicability-End -->
<!-- Device-{ProviderID}-ChangedNodes-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/ChangedNodes
```
<!-- Device-{ProviderID}-ChangedNodes-OmaUri-End -->
<!-- Device-{ProviderID}-ChangedNodes-Description-Begin -->
<!-- Description-Source-DDF -->
List of nodes whose values do not match their expected values as specified in /NodeID/ExpectedValue.
<!-- Device-{ProviderID}-ChangedNodes-Description-End -->
<!-- Device-{ProviderID}-ChangedNodes-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-ChangedNodes-Editable-End -->
<!-- Device-{ProviderID}-ChangedNodes-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Get |
<!-- Device-{ProviderID}-ChangedNodes-DFProperties-End -->
<!-- Device-{ProviderID}-ChangedNodes-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-ChangedNodes-Examples-End -->
<!-- Device-{ProviderID}-ChangedNodes-End -->
<!-- Device-{ProviderID}-ChangedNodesData-Begin -->
### Device/{ProviderID}/ChangedNodesData
<!-- Device-{ProviderID}-ChangedNodesData-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- Device-{ProviderID}-ChangedNodesData-Applicability-End -->
<!-- Device-{ProviderID}-ChangedNodesData-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/ChangedNodesData
```
<!-- Device-{ProviderID}-ChangedNodesData-OmaUri-End -->
<!-- Device-{ProviderID}-ChangedNodesData-Description-Begin -->
<!-- Description-Source-DDF -->
XML containing nodes whose values do not match their expected values as specified in /NodeID/ExpectedValue.
<!-- Device-{ProviderID}-ChangedNodesData-Description-End -->
<!-- Device-{ProviderID}-ChangedNodesData-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-ChangedNodesData-Editable-End -->
<!-- Device-{ProviderID}-ChangedNodesData-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | xml |
| Access Type | Get |
<!-- Device-{ProviderID}-ChangedNodesData-DFProperties-End -->
<!-- Device-{ProviderID}-ChangedNodesData-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-ChangedNodesData-Examples-End -->
<!-- Device-{ProviderID}-ChangedNodesData-End -->
<!-- Device-{ProviderID}-Nodes-Begin -->
### Device/{ProviderID}/Nodes
<!-- Device-{ProviderID}-Nodes-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-Nodes-Applicability-End -->
<!-- Device-{ProviderID}-Nodes-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/Nodes
```
<!-- Device-{ProviderID}-Nodes-OmaUri-End -->
<!-- Device-{ProviderID}-Nodes-Description-Begin -->
<!-- Description-Source-DDF -->
Root node for cached nodes.
<!-- Device-{ProviderID}-Nodes-Description-End -->
<!-- Device-{ProviderID}-Nodes-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-Editable-End -->
<!-- Device-{ProviderID}-Nodes-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-{ProviderID}-Nodes-DFProperties-End -->
<!-- Device-{ProviderID}-Nodes-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-Examples-End -->
<!-- Device-{ProviderID}-Nodes-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Begin -->
#### Device/{ProviderID}/Nodes/{NodeID}
<!-- Device-{ProviderID}-Nodes-{NodeID}-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-Nodes-{NodeID}-Applicability-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}
```
<!-- Device-{ProviderID}-Nodes-{NodeID}-OmaUri-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Description-Begin -->
<!-- Description-Source-DDF -->
Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.
<!-- Device-{ProviderID}-Nodes-{NodeID}-Description-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Editable-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | ServerGeneratedUniqueIdentifier |
<!-- Device-{ProviderID}-Nodes-{NodeID}-DFProperties-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-Examples-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Begin -->
##### Device/{ProviderID}/Nodes/{NodeID}/AutoSetExpectedValue
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Applicability-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/AutoSetExpectedValue
```
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-OmaUri-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Description-Begin -->
<!-- Description-Source-DDF -->
This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Description-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Editable-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | null |
| Access Type | Add, Delete, Get |
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-DFProperties-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Examples-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Begin -->
##### Device/{ProviderID}/Nodes/{NodeID}/ExpectedValue
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Applicability-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/ExpectedValue
```
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-OmaUri-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Description-Begin -->
<!-- Description-Source-DDF -->
This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Description-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
Supported values are string and x-nodemon-nonexistent.
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Editable-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get |
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-DFProperties-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
**Example**:
Here's an example for setting the ExpectedValue to nonexistent. Here's an example for setting the ExpectedValue to nonexistent.
@ -127,7 +378,7 @@ Here's an example for setting the ExpectedValue to nonexistent.
<CmdID>10</CmdID> <CmdID>10</CmdID>
<Item> <Item>
<Target> <Target>
<LocURI>./Vendor/MSFT/NodeCache/MDMSRV1/Nodes/Node_0002/ExpectedValue</LocURI> <LocURI>./Device/Vendor/MSFT/NodeCache/MDMSRV1/Nodes/Node_0002/ExpectedValue</LocURI>
</Target> </Target>
<Meta> <Meta>
<Format xmlns="syncml:metinf">chr</Format> <Format xmlns="syncml:metinf">chr</Format>
@ -136,60 +387,449 @@ Here's an example for setting the ExpectedValue to nonexistent.
</Item> </Item>
</Add> </Add>
``` ```
<!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Examples-End -->
<a href="" id="-nodeid-autosetexpectedvalue"></a>**/*NodeID*/AutoSetExpectedValue** <!-- Device-{ProviderID}-Nodes-{NodeID}-ExpectedValue-End -->
Added in Windows 10, version 1703. Required. This parameter's value automatically sets the value on the device to match the actual value of the node. The node is specified in NodeURI.
Supported operations are Add, Get, and Delete. <!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Begin -->
##### Device/{ProviderID}/Nodes/{NodeID}/NodeURI
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1511 [10.0.10586] and later |
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Applicability-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/NodeURI
```
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-OmaUri-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Description-Begin -->
<!-- Description-Source-DDF -->
This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Description-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Editable-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get |
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-DFProperties-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-Examples-End -->
<!-- Device-{ProviderID}-Nodes-{NodeID}-NodeURI-End -->
<!-- User-{ProviderID}-Begin -->
## User/{ProviderID}
<!-- User-{ProviderID}-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Applicability-End -->
<!-- User-{ProviderID}-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}
```
<!-- User-{ProviderID}-OmaUri-End -->
<!-- User-{ProviderID}-Description-Begin -->
<!-- Description-Source-DDF -->
Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the [w7 APPLICATION](w7-application-csp.md) configuration service provider XML during the enrollment process. In Windows Phone 8, only one enterprise management server is supported. That is, there should be only one ProviderID node under NodeCache.
<!-- User-{ProviderID}-Description-End -->
<!-- User-{ProviderID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-Editable-End -->
<!-- User-{ProviderID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | UniqueName: It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process. |
<!-- User-{ProviderID}-DFProperties-End -->
<!-- User-{ProviderID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-Examples-End -->
<!-- User-{ProviderID}-End -->
<!-- User-{ProviderID}-CacheVersion-Begin -->
### User/{ProviderID}/CacheVersion
<!-- User-{ProviderID}-CacheVersion-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-CacheVersion-Applicability-End -->
<!-- User-{ProviderID}-CacheVersion-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/CacheVersion
```
<!-- User-{ProviderID}-CacheVersion-OmaUri-End -->
<!-- User-{ProviderID}-CacheVersion-Description-Begin -->
<!-- Description-Source-DDF -->
Character string representing the cache version set by the server.
<!-- User-{ProviderID}-CacheVersion-Description-End -->
<!-- User-{ProviderID}-CacheVersion-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-CacheVersion-Editable-End -->
<!-- User-{ProviderID}-CacheVersion-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Get, Replace |
<!-- User-{ProviderID}-CacheVersion-DFProperties-End -->
<!-- User-{ProviderID}-CacheVersion-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-CacheVersion-Examples-End -->
<!-- User-{ProviderID}-CacheVersion-End -->
<!-- User-{ProviderID}-ChangedNodes-Begin -->
### User/{ProviderID}/ChangedNodes
<!-- User-{ProviderID}-ChangedNodes-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-ChangedNodes-Applicability-End -->
<!-- User-{ProviderID}-ChangedNodes-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/ChangedNodes
```
<!-- User-{ProviderID}-ChangedNodes-OmaUri-End -->
<!-- User-{ProviderID}-ChangedNodes-Description-Begin -->
<!-- Description-Source-DDF -->
List of nodes whose values do not match their expected values as specified in /NodeID/ExpectedValue.
<!-- User-{ProviderID}-ChangedNodes-Description-End -->
<!-- User-{ProviderID}-ChangedNodes-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-ChangedNodes-Editable-End -->
<!-- User-{ProviderID}-ChangedNodes-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Get |
<!-- User-{ProviderID}-ChangedNodes-DFProperties-End -->
<!-- User-{ProviderID}-ChangedNodes-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-ChangedNodes-Examples-End -->
<!-- User-{ProviderID}-ChangedNodes-End -->
<!-- User-{ProviderID}-ChangedNodesData-Begin -->
### User/{ProviderID}/ChangedNodesData
<!-- User-{ProviderID}-ChangedNodesData-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-ChangedNodesData-Applicability-End -->
<!-- User-{ProviderID}-ChangedNodesData-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/ChangedNodesData
```
<!-- User-{ProviderID}-ChangedNodesData-OmaUri-End -->
<!-- User-{ProviderID}-ChangedNodesData-Description-Begin -->
<!-- Description-Source-DDF -->
XML containing nodes whose values do not match their expected values as specified in /NodeID/ExpectedValue.
<!-- User-{ProviderID}-ChangedNodesData-Description-End -->
<!-- User-{ProviderID}-ChangedNodesData-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-ChangedNodesData-Editable-End -->
<!-- User-{ProviderID}-ChangedNodesData-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | xml |
| Access Type | Get |
<!-- User-{ProviderID}-ChangedNodesData-DFProperties-End -->
<!-- User-{ProviderID}-ChangedNodesData-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-ChangedNodesData-Examples-End -->
<!-- User-{ProviderID}-ChangedNodesData-End -->
<!-- User-{ProviderID}-Nodes-Begin -->
### User/{ProviderID}/Nodes
<!-- User-{ProviderID}-Nodes-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Nodes-Applicability-End -->
<!-- User-{ProviderID}-Nodes-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/Nodes
```
<!-- User-{ProviderID}-Nodes-OmaUri-End -->
<!-- User-{ProviderID}-Nodes-Description-Begin -->
<!-- Description-Source-DDF -->
Root node for cached nodes.
<!-- User-{ProviderID}-Nodes-Description-End -->
<!-- User-{ProviderID}-Nodes-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-Editable-End -->
<!-- User-{ProviderID}-Nodes-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- User-{ProviderID}-Nodes-DFProperties-End -->
<!-- User-{ProviderID}-Nodes-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-Examples-End -->
<!-- User-{ProviderID}-Nodes-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Begin -->
#### User/{ProviderID}/Nodes/{NodeID}
<!-- User-{ProviderID}-Nodes-{NodeID}-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Nodes-{NodeID}-Applicability-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}
```
<!-- User-{ProviderID}-Nodes-{NodeID}-OmaUri-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Description-Begin -->
<!-- Description-Source-DDF -->
Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.
<!-- User-{ProviderID}-Nodes-{NodeID}-Description-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Editable-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Add, Delete, Get |
| Dynamic Node Naming | ServerGeneratedUniqueIdentifier |
<!-- User-{ProviderID}-Nodes-{NodeID}-DFProperties-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-Examples-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Begin -->
##### User/{ProviderID}/Nodes/{NodeID}/AutoSetExpectedValue
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Applicability-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/AutoSetExpectedValue
```
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-OmaUri-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Description-Begin -->
<!-- Description-Source-DDF -->
This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Description-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Editable-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | null |
| Access Type | Add, Delete, Get |
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-DFProperties-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-Examples-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-AutoSetExpectedValue-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Begin -->
##### User/{ProviderID}/Nodes/{NodeID}/ExpectedValue
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Applicability-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/ExpectedValue
```
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-OmaUri-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Description-Begin -->
<!-- Description-Source-DDF -->
This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Description-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
Supported values are string and x-nodemon-nonexistent.
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Editable-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get |
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-DFProperties-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
**Example**:
Here's an example for setting the ExpectedValue to nonexistent.
```xml
<Add>
<CmdID>10</CmdID>
<Item>
<Target>
<LocURI>./User/Vendor/MSFT/NodeCache/MDMSRV1/Nodes/Node_0002/ExpectedValue</LocURI>
</Target>
<Meta>
<Format xmlns="syncml:metinf">chr</Format>
<Type xmlns="syncml:metinf">application/x-nodemon-nonexistent</Type>
</Meta>
</Item>
</Add>
```
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-Examples-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-ExpectedValue-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Begin -->
##### User/{ProviderID}/Nodes/{NodeID}/NodeURI
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :heavy_check_mark: User | :x: Home <br> :heavy_check_mark: Pro <br> :heavy_check_mark: Enterprise <br> :heavy_check_mark: Education <br> :heavy_check_mark: Windows SE | :heavy_check_mark: Windows 10, version 1703 [10.0.15063] and later |
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Applicability-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-OmaUri-Begin -->
```User
./User/Vendor/MSFT/NodeCache/{ProviderID}/Nodes/{NodeID}/NodeURI
```
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-OmaUri-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Description-Begin -->
<!-- Description-Source-DDF -->
This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Description-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Editable-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get |
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-DFProperties-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-Examples-End -->
<!-- User-{ProviderID}-Nodes-{NodeID}-NodeURI-End -->
<!-- NodeCache-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
## A typical DM session with the NodeCache configuration service provider ## A typical DM session with the NodeCache configuration service provider
1. The device connects to a DM server. 1. The device connects to a DM server.
2. The server queries the **NodeCache** version by issuing a Get operation for ./Vendor/MSFT/NodeCache/*ProviderID*/CacheVersion LocURI 2. The server queries the **NodeCache** version by issuing a Get operation for ./Vendor/MSFT/NodeCache/*ProviderID*/CacheVersion LocURI
3. If the device **CacheVersion** and the server-side cache differ (due to a device crash or server crash), the server can clear the server-side cache and go to Step 5. 3. If the device **CacheVersion** and the server-side cache differ (due to a device crash or server crash), the server can clear the server-side cache and go to Step 5.
4. The server updates the server-side cache: 4. The server updates the server-side cache:
1. Sends a Get operation for ./Vendor/MSFT/NodeCache/*ProviderID*/ChangedNodes LocURI 1. Sends a Get operation for ./Vendor/MSFT/NodeCache/*ProviderID*/ChangedNodes LocURI
2. Response is a list of changed node IDs. Each ID in the list corresponds to a node under ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes root 2. Response is a list of changed node IDs. Each ID in the list corresponds to a node under ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes root
3. For each node in the invalid nodes list, the server sends a `GET` command to retrieve the actual value of the node. For example, `GET <NodeURI>`, where `NodeURI` is a full device LocURI that corresponds to the invalid cache node. 3. For each node in the invalid nodes list, the server sends a `GET` command to retrieve the actual value of the node. For example, `GET <NodeURI>`, where `NodeURI` is a full device LocURI that corresponds to the invalid cache node.
4. Nodes in the server-side cache are updated with the actual values received from the device. 4. Nodes in the server-side cache are updated with the actual values received from the device.
5. For each updated node, a `REPLACE` command is sent to the device to update the device-side cache: 5. For each updated node, a `REPLACE` command is sent to the device to update the device-side cache:
`REPLACE ./Vendor/MSFT/NodeCache/ProviderID/Nodes/NodeID/ExpectedValue => ActualValue` `REPLACE ./Vendor/MSFT/NodeCache/ProviderID/Nodes/NodeID/ExpectedValue => ActualValue`
6. A new cache version is created and sent to the device: 6. A new cache version is created and sent to the device:
`REPLACE ./Vendor/MSFT/NodeCache/ProviderID/CacheVersion => new_version` `REPLACE ./Vendor/MSFT/NodeCache/ProviderID/CacheVersion => new_version`
The `new_version` value is stored by the server. The `new_version` value is stored by the server.
5. The management server retrieves the corresponding value from the server-side cache: 5. The management server retrieves the corresponding value from the server-side cache:
1. If a value already exists in the server-side cache, retrieve the value from the server-side cache instead of going to the device. 1. If a value already exists in the server-side cache, retrieve the value from the server-side cache instead of going to the device.
2. If a value doesn't exist in the server-side cache, do the following tasks: 2. If a value doesn't exist in the server-side cache, do the following tasks:
1. Create a new entry with a unique *NodeID* in the server-side cache. 1. Create a new entry with a unique *NodeID* in the server-side cache.
2. Query the device to retrieve the actual value of the URI. 2. Query the device to retrieve the actual value of the URI.
3. Create a new node under ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes with *NodeID* value. 3. Create a new node under ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes with *NodeID* value.
4. Set up **NodeURI** and **ExpectedValue** for the ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes/*NodeID* node. 4. Set up **NodeURI** and **ExpectedValue** for the ./Vendor/MSFT/NodeCache/*ProviderID*/Nodes/*NodeID* node.
5. Update the **CachedNodes** version. 5. Update the **CachedNodes** version.
## OMA DM examples ## OMA DM examples
Creating settings for node caching: Creating settings for node caching:
```xml ```xml
@ -377,13 +1017,14 @@ For AutoSetExpectedValue, a Replace operation with empty data will query the ./D
</Replace> </Replace>
``` ```
A Get operation on ./Vendor/MSFT/NodeCache/MDM%20SyncML%20Server/Nodes/20/ExpectedValue returns what the Device Name was when the AutoSet was called. A Get operation on `./Vendor/MSFT/NodeCache/MDM%20SyncML%20Server/Nodes/20/ExpectedValue` returns what the Device Name was when the AutoSet was called.
A Get operation on the ChangedNodesData returns an encoded XML. Here's an example: A Get operation on the ChangedNodesData returns an encoded XML. Here's an example:
```xml ```xml
<Nodes><Node Id="10" Uri=""></Node><Node Id="20" Uri="./DevDetail/Ext/Microsoft/DeviceName">U09NRU5FV1ZBTFVF</Node></Nodes> <Nodes><Node Id="10" Uri=""></Node><Node Id="20" Uri="./DevDetail/Ext/Microsoft/DeviceName">U09NRU5FV1ZBTFVF</Node></Nodes>
``` ```
It represents this example: It represents this example:
```xml ```xml
@ -397,19 +1038,10 @@ Id is the node ID that was added by the MDM server, and Uri is the path that the
If a Uri is not set, the node will always be reported as changed, as in Node ID 10. If a Uri is not set, the node will always be reported as changed, as in Node ID 10.
The value inside of the node tag is the actual value returned by the Uri, which means that for Node ID 20 the DeviceName did not match what was previously expected, and the device name is now U09NRU5FV1ZBTFVF instead of what it was previously. The value inside of the node tag is the actual value returned by the Uri, which means that for Node ID 20 the DeviceName did not match what was previously expected, and the device name is now U09NRU5FV1ZBTFVF instead of what it was previously.
<!-- NodeCache-CspMoreInfo-End -->
<!-- NodeCache-End -->
## Related topics ## Related articles
[Configuration service provider reference](index.yml)
[Configuration service provider reference](configuration-service-provider-reference.md)

174
windows/client-management/mdm/nodecache-ddf-file.md
View File

@ -1,32 +1,29 @@
--- ---
title: NodeCache DDF file title: NodeCache DDF file
description: Learn about the OMA DM device description framework (DDF) for the NodeCache configuration service provider (CSP). description: View the XML file containing the device description framework (DDF) for the NodeCache configuration service provider.
ms.reviewer: author: vinaypamnani-msft
manager: aaroncz manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/21/2023
ms.localizationpriority: medium
ms.prod: windows-client ms.prod: windows-client
ms.technology: itpro-manage ms.technology: itpro-manage
author: vinaypamnani-msft ms.topic: reference
ms.date: 12/05/2017
--- ---
<!-- Auto-Generated CSP Document -->
# NodeCache DDF file # NodeCache DDF file
The following XML file contains the device description framework (DDF) for the NodeCache configuration service provider.
This topic shows the OMA DM device description framework (DDF) for the **NodeCache** configuration service provider. DDF files are used only with OMA DM provisioning XML.
Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md).
The XML below is the current version for this CSP.
```xml ```xml
<?xml version="1.0" encoding="UTF-8"?> <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" <!DOCTYPE MgmtTree PUBLIC " -//OMA//DTD-DM-DDF 1.2//EN" "http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"[<?oma-dm-ddf-ver supported-versions="1.2"?>]>
"http://www.openmobilealliance.org/tech/DTD/DM_DDF-V1_2.dtd"
[<?oma-dm-ddf-ver supported-versions="1.2"?>]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM"> <MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD> <VerDTD>1.2</VerDTD>
<MSFT:Diagnostics>
</MSFT:Diagnostics>
<Node> <Node>
<NodeName>NodeCache</NodeName> <NodeName>NodeCache</NodeName>
<Path>./User/Vendor/MSFT</Path> <Path>./User/Vendor/MSFT</Path>
@ -45,18 +42,24 @@ The XML below is the current version for this CSP.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<MIME>com.microsoft/1.2/MDM/NodeCache</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.15063</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
</MSFT:Applicability>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName></NodeName> <NodeName>
</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process.</Description> <Description>Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process. In Windows Phone 8, only one enterprise management server is supported. That is, there should be only one ProviderID node under NodeCache.</Description>
<DFFormat> <DFFormat>
<node /> <node />
</DFFormat> </DFFormat>
@ -68,15 +71,18 @@ The XML below is the current version for this CSP.
</Scope> </Scope>
<DFTitle>ProviderID</DFTitle> <DFTitle>ProviderID</DFTitle>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:UniqueName> It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process.</MSFT:UniqueName>
</MSFT:DynamicNodeNaming>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>CacheVersion</NodeName> <NodeName>CacheVersion</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Get />
<Replace /> <Replace />
</AccessType> </AccessType>
<Description>Character string representing the cache version set by the server.</Description> <Description>Character string representing the cache version set by the server.</Description>
@ -90,8 +96,10 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
@ -111,7 +119,7 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
</DFProperties> </DFProperties>
</Node> </Node>
@ -132,8 +140,12 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.15063</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
@ -153,16 +165,17 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName></NodeName> <NodeName>
</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.</Description> <Description>Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.</Description>
<DFFormat> <DFFormat>
@ -176,16 +189,21 @@ The XML below is the current version for this CSP.
</Scope> </Scope>
<DFTitle>NodeID</DFTitle> <DFTitle>NodeID</DFTitle>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:ServerGeneratedUniqueIdentifier />
</MSFT:DynamicNodeNaming>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>NodeURI</NodeName> <NodeName>NodeURI</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.</Description> <Description>This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.</Description>
<DFFormat> <DFFormat>
@ -198,17 +216,19 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
<NodeName>ExpectedValue</NodeName> <NodeName>ExpectedValue</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.</Description> <Description>This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.</Description>
<DFFormat> <DFFormat>
@ -221,17 +241,19 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
<NodeName>AutoSetExpectedValue</NodeName> <NodeName>AutoSetExpectedValue</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.</Description> <Description>This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.</Description>
<DFFormat> <DFFormat>
@ -244,8 +266,12 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.15063</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties> </DFProperties>
</Node> </Node>
</Node> </Node>
@ -270,18 +296,24 @@ The XML below is the current version for this CSP.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<MIME>com.microsoft/1.2/MDM/NodeCache</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.10586</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.0</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x62;0x63;0x64;0x65;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x87;0x88;0x88*;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
</MSFT:Applicability>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName></NodeName> <NodeName>
</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process.</Description> <Description>Group settings per DM server. Each group of settings is distinguished by the server's Provider ID. It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process. In Windows Phone 8, only one enterprise management server is supported. That is, there should be only one ProviderID node under NodeCache.</Description>
<DFFormat> <DFFormat>
<node /> <node />
</DFFormat> </DFFormat>
@ -293,15 +325,18 @@ The XML below is the current version for this CSP.
</Scope> </Scope>
<DFTitle>ProviderID</DFTitle> <DFTitle>ProviderID</DFTitle>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:UniqueName> It should be the same DM server PROVIDER-ID value that was supplied through the w7 APPLICATION configuration service provider XML during the enrollment process.</MSFT:UniqueName>
</MSFT:DynamicNodeNaming>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>CacheVersion</NodeName> <NodeName>CacheVersion</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Get />
<Replace /> <Replace />
</AccessType> </AccessType>
<Description>Character string representing the cache version set by the server.</Description> <Description>Character string representing the cache version set by the server.</Description>
@ -315,8 +350,10 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
@ -336,7 +373,7 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
</DFProperties> </DFProperties>
</Node> </Node>
@ -357,8 +394,12 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.15063</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
@ -378,16 +419,17 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName></NodeName> <NodeName>
</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.</Description> <Description>Information about each cached node is stored under NodeID as specified by the server. This value must not contain a comma.</Description>
<DFFormat> <DFFormat>
@ -401,16 +443,21 @@ The XML below is the current version for this CSP.
</Scope> </Scope>
<DFTitle>NodeID</DFTitle> <DFTitle>NodeID</DFTitle>
<DFType> <DFType>
<DDFName></DDFName> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:ServerGeneratedUniqueIdentifier />
</MSFT:DynamicNodeNaming>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>NodeURI</NodeName> <NodeName>NodeURI</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.</Description> <Description>This node's value is a complete OMA DM node URI. It can specify either an interior or leaf node in the device management tree.</Description>
<DFFormat> <DFFormat>
@ -423,17 +470,19 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
<NodeName>ExpectedValue</NodeName> <NodeName>ExpectedValue</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.</Description> <Description>This is the value that the server expects to be on the device. When the configuration service provider initiates a session, it checks the expected value against the node's actual value.</Description>
<DFFormat> <DFFormat>
@ -446,17 +495,19 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
</Node> </Node>
<Node> <Node>
<NodeName>AutoSetExpectedValue</NodeName> <NodeName>AutoSetExpectedValue</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get />
<Add /> <Add />
<Delete /> <Delete />
<Get />
</AccessType> </AccessType>
<Description>This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.</Description> <Description>This will automatically set the value on the device to match the node's actual value. The node is specified in NodeURI.</Description>
<DFFormat> <DFFormat>
@ -469,8 +520,12 @@ The XML below is the current version for this CSP.
<Dynamic /> <Dynamic />
</Scope> </Scope>
<DFType> <DFType>
<MIME>text/plain</MIME> <MIME />
</DFType> </DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.15063</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.1</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties> </DFProperties>
</Node> </Node>
</Node> </Node>
@ -480,17 +535,6 @@ The XML below is the current version for this CSP.
</MgmtTree> </MgmtTree>
``` ```
## Related topics ## Related articles
[NodeCache configuration service provider](nodecache-csp.md)
 
 
[NodeCache configuration service provider reference](nodecache-csp.md)