Reboot CSP

This commit is contained in:
Vinay Pamnani 2023-02-17 17:09:19 -05:00
parent 9ac51ed92b
commit 1a93c077eb
2 changed files with 288 additions and 168 deletions

View File

@ -1,79 +1,200 @@
---
title: Reboot CSP
description: Learn how the Reboot configuration service provider (CSP) is used to configure reboot settings.
ms.reviewer:
description: Learn more about the Reboot CSP.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.topic: article
ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
author: vinaypamnani-msft
ms.date: 06/26/2017
ms.topic: reference
---
<!-- Auto-Generated CSP Document -->
<!-- Reboot-Begin -->
# Reboot CSP
The table below shows the applicability of Windows:
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
<!-- Reboot-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
The Reboot configuration service provider is used to configure reboot settings.
<!-- Reboot-Editable-End -->
The following shows the Reboot configuration service provider management objects in tree format as used by Open Mobile Alliance Device Management (OMA DM), OMA Client Provisioning, and Enterprise DM.
<!-- Reboot-Tree-Begin -->
The following example shows the Reboot configuration service provider in tree format.
```text
./Device/Vendor/MSFT/Reboot
--- RebootNow
--- Schedule
------ DailyRecurrent
------ Single
```
./Device/Vendor/MSFT
Reboot
----RebootNow
----Schedule
--------Single
--------DailyRecurrent
<!-- Reboot-Tree-End -->
<!-- Device-RebootNow-Begin -->
## RebootNow
<!-- Device-RebootNow-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: 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 1607 [10.0.14393] and later |
<!-- Device-RebootNow-Applicability-End -->
<!-- Device-RebootNow-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Reboot/RebootNow
```
<!-- Device-RebootNow-OmaUri-End -->
<a href="" id="--vendor-msft-reboot"></a>**./Vendor/MSFT/Reboot**
<!-- Device-RebootNow-Description-Begin -->
<!-- Description-Source-DDF -->
This node executes a reboot of the device. RebootNow triggers a reboot within 5 minutes to allow the user to wrap up any active work. If this node is set to execute during a sync session, the device will reboot at the end of the sync session.
<!-- Device-RebootNow-Description-End -->
The root node for the Reboot configuration service provider.
<!-- Device-RebootNow-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-RebootNow-Editable-End -->
<!-- Device-RebootNow-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | null |
| Access Type | Exec, Get |
<!-- Device-RebootNow-DFProperties-End -->
<!-- Device-RebootNow-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-RebootNow-Examples-End -->
<!-- Device-RebootNow-End -->
<!-- Device-Schedule-Begin -->
## Schedule
<!-- Device-Schedule-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: 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 1607 [10.0.14393] and later |
<!-- Device-Schedule-Applicability-End -->
<!-- Device-Schedule-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Reboot/Schedule
```
<!-- Device-Schedule-OmaUri-End -->
<!-- Device-Schedule-Description-Begin -->
<!-- Description-Source-DDF -->
The supported operation is Get.
<!-- Device-Schedule-Description-End -->
<a href="" id="rebootnow"></a>**RebootNow**
<!-- Device-Schedule-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Schedule-Editable-End -->
This node executes a reboot of the device. RebootNow triggers a reboot within 5 minutes to allow the user to wrap up any active work.
<!-- Device-Schedule-DFProperties-Begin -->
**Description framework properties**:
> [!NOTE]
> If this node is set to execute during a sync session, the device will reboot at the end of the sync session.
| Property name | Property value |
|:--|:--|
| Format | node |
| Access Type | Get |
<!-- Device-Schedule-DFProperties-End -->
The supported operations are Execute and Get.
<!-- Device-Schedule-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Schedule-Examples-End -->
<a href="" id="schedule"></a>**Schedule**
<!-- Device-Schedule-End -->
The supported operation is Get.
<!-- Device-Schedule-DailyRecurrent-Begin -->
### Schedule/DailyRecurrent
<a href="" id="schedule-single"></a>**Schedule/Single**
<!-- Device-Schedule-DailyRecurrent-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: 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 1607 [10.0.14393] and later |
<!-- Device-Schedule-DailyRecurrent-Applicability-End -->
This node will execute a reboot at a scheduled date and time. The date and time value is **ISO 8601**, and both the date and time are required.
Example to configure: 2018-10-25T18:00:00
<!-- Device-Schedule-DailyRecurrent-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Reboot/Schedule/DailyRecurrent
```
<!-- Device-Schedule-DailyRecurrent-OmaUri-End -->
Setting a null (empty) date will delete the existing schedule. In accordance with the ISO 8601 format, the date and time representation needs to be 0000-00-00T00:00:00.
<!-- Device-Schedule-DailyRecurrent-Description-Begin -->
<!-- Description-Source-DDF -->
Value in ISO8601, time is required. A reboot will be scheduled each day at the configured time starting at the date and time. Setting a null (empty) date will delete the existing schedule.
<!-- Device-Schedule-DailyRecurrent-Description-End -->
- The supported operations are Get, Add, Replace, and Delete.
- The supported data type is "String".
<!-- Device-Schedule-DailyRecurrent-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Schedule-DailyRecurrent-Editable-End -->
<a href="" id="schedule-dailyrecurrent"></a>**Schedule/DailyRecurrent**
<!-- Device-Schedule-DailyRecurrent-DFProperties-Begin -->
**Description framework properties**:
This node will execute a reboot each day at a scheduled time starting at the configured starting time and date. Setting a null (empty) date will delete the existing schedule. The date and time value is ISO8601, and both the date and time are required. The CSP will return the date time in the following format: 2018-06-29T10:00:00+01:00.
Example to configure: 2018-10-25T18:00:00
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Schedule-DailyRecurrent-DFProperties-End -->
- The supported operations are Get, Add, Replace, and Delete.
- The supported data type is "String".
<!-- Device-Schedule-DailyRecurrent-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Schedule-DailyRecurrent-Examples-End -->
## Related topics
<!-- Device-Schedule-DailyRecurrent-End -->
[Configuration service provider reference](index.yml)
<!-- Device-Schedule-Single-Begin -->
### Schedule/Single
<!-- Device-Schedule-Single-Applicability-Begin -->
| Scope | Editions | Applicable OS |
|:--|:--|:--|
| :heavy_check_mark: Device <br> :x: 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 1607 [10.0.14393] and later |
<!-- Device-Schedule-Single-Applicability-End -->
<!-- Device-Schedule-Single-OmaUri-Begin -->
```Device
./Device/Vendor/MSFT/Reboot/Schedule/Single
```
<!-- Device-Schedule-Single-OmaUri-End -->
<!-- Device-Schedule-Single-Description-Begin -->
<!-- Description-Source-DDF -->
Value in ISO8601, both the date and time are required. A reboot will be scheduled at the configured date time. Setting a null (empty) date will delete the existing schedule.
<!-- Device-Schedule-Single-Description-End -->
<!-- Device-Schedule-Single-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
<!-- Device-Schedule-Single-Editable-End -->
<!-- Device-Schedule-Single-DFProperties-Begin -->
**Description framework properties**:
| Property name | Property value |
|:--|:--|
| Format | chr (string) |
| Access Type | Add, Delete, Get, Replace |
<!-- Device-Schedule-Single-DFProperties-End -->
<!-- Device-Schedule-Single-Examples-Begin -->
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
<!-- Device-Schedule-Single-Examples-End -->
<!-- Device-Schedule-Single-End -->
<!-- Reboot-CspMoreInfo-Begin -->
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
<!-- Reboot-CspMoreInfo-End -->
<!-- Reboot-End -->
## Related articles
[Configuration service provider reference](configuration-service-provider-reference.md)

View File

@ -1,31 +1,29 @@
---
title: Reboot DDF file
description: This topic shows the OMA DM device description framework (DDF) for the Reboot configuration service provider. DDF files are used only with OMA DM provisioning XML.
ms.reviewer:
description: View the XML file containing the device description framework (DDF) for the Reboot configuration service provider.
author: vinaypamnani-msft
manager: aaroncz
ms.author: vinpa
ms.topic: article
ms.date: 02/17/2023
ms.localizationpriority: medium
ms.prod: windows-client
ms.technology: itpro-manage
author: vinaypamnani-msft
ms.date: 12/05/2017
ms.topic: reference
---
<!-- Auto-Generated CSP Document -->
# Reboot DDF file
This topic shows the OMA DM device description framework (DDF) for the **Reboot** 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.
The following XML file contains the device description framework (DDF) for the Reboot configuration service provider.
```xml
<?xml version="1.0" encoding="UTF-8"?>
<!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"?>]>
<!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"?>]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD>
<MSFT:Diagnostics>
</MSFT:Diagnostics>
<Node>
<NodeName>Reboot</NodeName>
<Path>./Device/Vendor/MSFT</Path>
@ -33,6 +31,7 @@ The XML below is the current version for this CSP.
<AccessType>
<Get />
</AccessType>
<Description>The root node for the Reboot configuration service provider.</Description>
<DFFormat>
<node />
</DFFormat>
@ -43,8 +42,13 @@ The XML below is the current version for this CSP.
<Permanent />
</Scope>
<DFType>
<DDFName></DDFName>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.14393</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.0</MSFT:CspVersion>
<MSFT:EditionAllowList>0x4;0x1B;0x30;0x31;0x48;0x54;0x77;0x79;0x7A;0x7D;0x7E;0x81;0x82;0x8A;0x8B;0xA1;0xA2;0xA4;0xA5;0xAB;0xAC;0xAF;0xB4;0xBC;0xBF;0xCA;0xCB;0xCD;</MSFT:EditionAllowList>
</MSFT:Applicability>
</DFProperties>
<Node>
<NodeName>RebootNow</NodeName>
@ -53,6 +57,7 @@ The XML below is the current version for this CSP.
<Exec />
<Get />
</AccessType>
<Description>This node executes a reboot of the device. RebootNow triggers a reboot within 5 minutes to allow the user to wrap up any active work. If this node is set to execute during a sync session, the device will reboot at the end of the sync session.</Description>
<DFFormat>
<null />
</DFFormat>
@ -64,7 +69,7 @@ The XML below is the current version for this CSP.
</Scope>
<DFTitle>RebootNow</DFTitle>
<DFType>
<MIME>text/plain</MIME>
<MIME />
</DFType>
</DFProperties>
</Node>
@ -74,6 +79,7 @@ The XML below is the current version for this CSP.
<AccessType>
<Get />
</AccessType>
<Description>The supported operation is Get.</Description>
<DFFormat>
<node />
</DFFormat>
@ -84,17 +90,17 @@ The XML below is the current version for this CSP.
<Permanent />
</Scope>
<DFType>
<DDFName></DDFName>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>Single</NodeName>
<DFProperties>
<AccessType>
<Get />
<Replace />
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Value in ISO8601, both the date and time are required. A reboot will be scheduled at the configured date time. Setting a null (empty) date will delete the existing schedule.</Description>
<DFFormat>
@ -108,18 +114,20 @@ The XML below is the current version for this CSP.
</Scope>
<DFTitle>Single</DFTitle>
<DFType>
<MIME>text/plain</MIME>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>DailyRecurrent</NodeName>
<DFProperties>
<AccessType>
<Get />
<Replace />
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>Value in ISO8601, time is required. A reboot will be scheduled each day at the configured time starting at the date and time. Setting a null (empty) date will delete the existing schedule.</Description>
<DFFormat>
@ -133,26 +141,17 @@ The XML below is the current version for this CSP.
</Scope>
<DFTitle>DailyRecurrent</DFTitle>
<DFType>
<MIME>text/plain</MIME>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
</Node>
</Node>
</MgmtTree>
```
## Related topics
[Reboot CSP](reboot-csp.md)
 
 
## Related articles
[Reboot configuration service provider reference](reboot-csp.md)