mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-05-12 13:27:23 +00:00
Office CSP
This commit is contained in:
Vinay Pamnani
parent
2e1afb9ed1
commit
86872f94fc
@ -1,102 +1,523 @@
|
||||
---
|
||||
title: Office CSP
|
||||
description: The Office configuration service provider (CSP) enables a Microsoft Office client to be installed on a device. This CSP was added in Windows 10, version 1703.
|
||||
description: Learn more about the Office 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: 08/15/2018
|
||||
ms.reviewer:
|
||||
manager: aaroncz
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
<!-- Auto-Generated CSP Document -->
|
||||
|
||||
<!-- Office-Begin -->
|
||||
# Office 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|
|
||||
|
||||
<!-- Office-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
The Office configuration service provider (CSP) enables a Microsoft Office client to be installed on a device via the Office Deployment Tool (ODT). For more information, see [Configuration options for the Office Deployment Tool](/deployoffice/office-deployment-tool-configuration-options) and [How to assign Office 365 apps to Windows 10 devices with Microsoft Intune](/intune/apps-add-office365).
|
||||
<!-- Office-Editable-End -->
|
||||
|
||||
This CSP was added in Windows 10, version 1703.
|
||||
<!-- Office-Tree-Begin -->
|
||||
The following example shows the Office configuration service provider in tree format.
|
||||
|
||||
For more information, see [Office DDF](office-ddf.md).
|
||||
|
||||
The following shows the Office configuration service provider in tree format.
|
||||
|
||||
```console
|
||||
./Vendor/MSFT
|
||||
Office
|
||||
----Installation
|
||||
--------id
|
||||
------------Install
|
||||
------------Status
|
||||
|
||||
|
||||
./Device/Vendor/MSFT
|
||||
Office
|
||||
----Installation
|
||||
--------id
|
||||
------------Install
|
||||
------------Status
|
||||
|
||||
|
||||
./Vendor/MSFT
|
||||
./Device/Vendor/MSFT
|
||||
Office
|
||||
----Installation
|
||||
--------id
|
||||
------------Install
|
||||
------------Status
|
||||
```text
|
||||
./Device/Vendor/MSFT/Office
|
||||
--- Installation
|
||||
------ {id}
|
||||
--------- FinalStatus
|
||||
--------- Install
|
||||
--------- Status
|
||||
------ CurrentStatus
|
||||
./User/Vendor/MSFT/Office
|
||||
--- Installation
|
||||
------ {id}
|
||||
--------- FinalStatus
|
||||
--------- Install
|
||||
--------- Status
|
||||
------ CurrentStatus
|
||||
```
|
||||
<!-- Office-Tree-End -->
|
||||
|
||||
<a href="" id="office"></a>**./Device/Vendor/MSFT/Office/ or ./User/Vendor/MSFT/Office**
|
||||
The root node for the Office configuration service provider.</p>
|
||||
<!-- Device-Installation-Begin -->
|
||||
## Device/Installation
|
||||
|
||||
<a href="" id="installation"></a>**Installation**
|
||||
Specifies the options for the Microsoft Office installation.
|
||||
<!-- Device-Installation-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-Installation-Applicability-End -->
|
||||
|
||||
The supported operations are Add, Delete, and Get.
|
||||
<!-- Device-Installation-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation
|
||||
```
|
||||
<!-- Device-Installation-OmaUri-End -->
|
||||
|
||||
<a href="" id="id"></a>**Installation/_id_**
|
||||
Specifies a unique identifier that represents the ID of the Microsoft Office product to install.
|
||||
<!-- Device-Installation-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
Installation options for the office CSP.
|
||||
<!-- Device-Installation-Description-End -->
|
||||
|
||||
The supported operations are Add, Delete, and Get.
|
||||
<!-- Device-Installation-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-Editable-End -->
|
||||
|
||||
<a href="" id="install"></a>**Installation/_id_/Install**
|
||||
Installs Office by using the XML data specified in the configuration.xml file.
|
||||
<!-- Device-Installation-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
The supported operations are Get and Execute.
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | node |
|
||||
| Access Type | Get |
|
||||
<!-- Device-Installation-DFProperties-End -->
|
||||
|
||||
<a href="" id="status"></a>**Installation/_id_/Status**
|
||||
The Microsoft Office installation status.
|
||||
<!-- Device-Installation-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-Examples-End -->
|
||||
|
||||
The only supported operation is Get.
|
||||
<!-- Device-Installation-End -->
|
||||
|
||||
<a href="" id="finalstatus"></a>**Installation/_id_/FinalStatus**
|
||||
Added in Windows 10, version 1809. Indicates the status of the Final Office 365 installation.
|
||||
<!-- Device-Installation-{id}-Begin -->
|
||||
### Device/Installation/{id}
|
||||
|
||||
The only supported operation is Get.
|
||||
<!-- Device-Installation-{id}-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-Installation-{id}-Applicability-End -->
|
||||
|
||||
Behavior:
|
||||
<!-- Device-Installation-{id}-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation/{id}
|
||||
```
|
||||
<!-- Device-Installation-{id}-OmaUri-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
A unique identifier which represents the installation instance id.
|
||||
<!-- Device-Installation-{id}-Description-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Editable-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | node |
|
||||
| Access Type | Add, Delete, Get |
|
||||
| Dynamic Node Naming | UniqueName: A unique identifier which represents the installation instance id. |
|
||||
<!-- Device-Installation-{id}-DFProperties-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Examples-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-Begin -->
|
||||
#### Device/Installation/{id}/FinalStatus
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-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 1809 [10.0.17763] and later |
|
||||
<!-- Device-Installation-{id}-FinalStatus-Applicability-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation/{id}/FinalStatus
|
||||
```
|
||||
<!-- Device-Installation-{id}-FinalStatus-OmaUri-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
Final Office 365 installation status.
|
||||
<!-- Device-Installation-{id}-FinalStatus-Description-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
- When Office CSP is triggered to install, it will first check if the FinalStatus node exists or not. If the node exists, delete it.
|
||||
- When Office installation reaches any terminal states (either success or failure), this node is created that contains the following values:
|
||||
- When status = 0: 70 (succeeded)
|
||||
- When status != 0: 60 (failed)
|
||||
<!-- Device-Installation-{id}-FinalStatus-Editable-End -->
|
||||
|
||||
<a href="" id="currentstatus"></a>**Installation/CurrentStatus**
|
||||
Returns an XML of current Office 365 installation status on the device.
|
||||
<!-- Device-Installation-{id}-FinalStatus-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
The only supported operation is Get.
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | int |
|
||||
| Access Type | Get |
|
||||
<!-- Device-Installation-{id}-FinalStatus-DFProperties-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-FinalStatus-Examples-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-FinalStatus-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-Begin -->
|
||||
#### Device/Installation/{id}/Install
|
||||
|
||||
<!-- Device-Installation-{id}-Install-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-Installation-{id}-Install-Applicability-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation/{id}/Install
|
||||
```
|
||||
<!-- Device-Installation-{id}-Install-OmaUri-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office.
|
||||
<!-- Device-Installation-{id}-Install-Description-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Install-Editable-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | chr (string) |
|
||||
| Access Type | Exec, Get |
|
||||
<!-- Device-Installation-{id}-Install-DFProperties-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Install-Examples-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Install-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-Begin -->
|
||||
#### Device/Installation/{id}/Status
|
||||
|
||||
<!-- Device-Installation-{id}-Status-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-Installation-{id}-Status-Applicability-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation/{id}/Status
|
||||
```
|
||||
<!-- Device-Installation-{id}-Status-OmaUri-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The installation status of the CSP.
|
||||
<!-- Device-Installation-{id}-Status-Description-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Status-Editable-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | int |
|
||||
| Access Type | Get |
|
||||
<!-- Device-Installation-{id}-Status-DFProperties-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-{id}-Status-Examples-End -->
|
||||
|
||||
<!-- Device-Installation-{id}-Status-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-Begin -->
|
||||
### Device/Installation/CurrentStatus
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-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 1709 [10.0.16299] and later |
|
||||
<!-- Device-Installation-CurrentStatus-Applicability-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-OmaUri-Begin -->
|
||||
```Device
|
||||
./Device/Vendor/MSFT/Office/Installation/CurrentStatus
|
||||
```
|
||||
<!-- Device-Installation-CurrentStatus-OmaUri-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The current Office 365 installation status on the machine.
|
||||
<!-- Device-Installation-CurrentStatus-Description-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-CurrentStatus-Editable-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | chr (string) |
|
||||
| Access Type | Get |
|
||||
<!-- Device-Installation-CurrentStatus-DFProperties-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- Device-Installation-CurrentStatus-Examples-End -->
|
||||
|
||||
<!-- Device-Installation-CurrentStatus-End -->
|
||||
|
||||
<!-- User-Installation-Begin -->
|
||||
## User/Installation
|
||||
|
||||
<!-- User-Installation-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-Installation-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation
|
||||
```
|
||||
<!-- User-Installation-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
Installation options for the office CSP.
|
||||
<!-- User-Installation-Description-End -->
|
||||
|
||||
<!-- User-Installation-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-Editable-End -->
|
||||
|
||||
<!-- User-Installation-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | node |
|
||||
| Access Type | Get |
|
||||
<!-- User-Installation-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-Examples-End -->
|
||||
|
||||
<!-- User-Installation-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Begin -->
|
||||
### User/Installation/{id}
|
||||
|
||||
<!-- User-Installation-{id}-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-Installation-{id}-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-{id}-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation/{id}
|
||||
```
|
||||
<!-- User-Installation-{id}-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
A unique identifier which represents the installation instance id.
|
||||
<!-- User-Installation-{id}-Description-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Editable-End -->
|
||||
|
||||
<!-- User-Installation-{id}-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | node |
|
||||
| Access Type | Add, Delete, Get |
|
||||
| Dynamic Node Naming | UniqueName: A unique identifier which represents the installation instance id. |
|
||||
<!-- User-Installation-{id}-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Examples-End -->
|
||||
|
||||
<!-- User-Installation-{id}-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-Begin -->
|
||||
#### User/Installation/{id}/FinalStatus
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-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 1809 [10.0.17763] and later |
|
||||
<!-- User-Installation-{id}-FinalStatus-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation/{id}/FinalStatus
|
||||
```
|
||||
<!-- User-Installation-{id}-FinalStatus-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
Final Office 365 installation status.
|
||||
<!-- User-Installation-{id}-FinalStatus-Description-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-FinalStatus-Editable-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | int |
|
||||
| Access Type | Get |
|
||||
<!-- User-Installation-{id}-FinalStatus-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-FinalStatus-Examples-End -->
|
||||
|
||||
<!-- User-Installation-{id}-FinalStatus-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-Begin -->
|
||||
#### User/Installation/{id}/Install
|
||||
|
||||
<!-- User-Installation-{id}-Install-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-Installation-{id}-Install-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation/{id}/Install
|
||||
```
|
||||
<!-- User-Installation-{id}-Install-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office.
|
||||
<!-- User-Installation-{id}-Install-Description-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Install-Editable-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | chr (string) |
|
||||
| Access Type | Exec, Get |
|
||||
<!-- User-Installation-{id}-Install-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Install-Examples-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Install-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-Begin -->
|
||||
#### User/Installation/{id}/Status
|
||||
|
||||
<!-- User-Installation-{id}-Status-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-Installation-{id}-Status-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation/{id}/Status
|
||||
```
|
||||
<!-- User-Installation-{id}-Status-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The installation status of the CSP.
|
||||
<!-- User-Installation-{id}-Status-Description-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Status-Editable-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | int |
|
||||
| Access Type | Get |
|
||||
<!-- User-Installation-{id}-Status-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-{id}-Status-Examples-End -->
|
||||
|
||||
<!-- User-Installation-{id}-Status-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-Begin -->
|
||||
### User/Installation/CurrentStatus
|
||||
|
||||
<!-- User-Installation-CurrentStatus-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 1709 [10.0.16299] and later |
|
||||
<!-- User-Installation-CurrentStatus-Applicability-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-OmaUri-Begin -->
|
||||
```User
|
||||
./User/Vendor/MSFT/Office/Installation/CurrentStatus
|
||||
```
|
||||
<!-- User-Installation-CurrentStatus-OmaUri-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-Description-Begin -->
|
||||
<!-- Description-Source-DDF -->
|
||||
The current Office 365 installation status on the machine.
|
||||
<!-- User-Installation-CurrentStatus-Description-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-Editable-Begin -->
|
||||
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|
||||
<!-- User-Installation-CurrentStatus-Editable-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-DFProperties-Begin -->
|
||||
**Description framework properties**:
|
||||
|
||||
| Property name | Property value |
|
||||
|:--|:--|
|
||||
| Format | chr (string) |
|
||||
| Access Type | Get |
|
||||
<!-- User-Installation-CurrentStatus-DFProperties-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-Examples-Begin -->
|
||||
<!-- Add any examples for this policy here. Examples outside this section will get overwritten. -->
|
||||
<!-- User-Installation-CurrentStatus-Examples-End -->
|
||||
|
||||
<!-- User-Installation-CurrentStatus-End -->
|
||||
|
||||
<!-- Office-CspMoreInfo-Begin -->
|
||||
<!-- Add any additional information about this CSP here. Anything outside this section will get overwritten. -->
|
||||
## Examples
|
||||
|
||||
Sample SyncML to install Microsoft 365 Apps for business Retail from current channel.
|
||||
@ -147,24 +568,24 @@ To get the current status of Office 365 on the device.
|
||||
|
||||
```xml
|
||||
<SyncML xmlns="SYNCML:SYNCML1.2">
|
||||
<SyncBody>
|
||||
<Get>
|
||||
<CmdID>7</CmdID>
|
||||
<Item>
|
||||
<Target>
|
||||
<LocURI>./Vendor/MSFT/Office/Installation/CurrentStatus</LocURI>
|
||||
</Target>
|
||||
</Item>
|
||||
</Get>
|
||||
<Final/>
|
||||
</SyncBody>
|
||||
<SyncBody>
|
||||
<Get>
|
||||
<CmdID>7</CmdID>
|
||||
<Item>
|
||||
<Target>
|
||||
<LocURI>./Vendor/MSFT/Office/Installation/CurrentStatus</LocURI>
|
||||
</Target>
|
||||
</Item>
|
||||
</Get>
|
||||
<Final />
|
||||
</SyncBody>
|
||||
</SyncML>
|
||||
```
|
||||
|
||||
## Status code
|
||||
|
||||
| Status | Description | Comment |
|
||||
|--- |--- |--- |
|
||||
|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|
||||
| 0 | Installation succeeded | OK |
|
||||
| 997 | Installation in progress | |
|
||||
| 13 | ERROR_INVALID_DATA <br>Cannot verify signature of the downloaded Office Deployment Tool (ODT) | Failure |
|
||||
@ -182,3 +603,10 @@ To get the current status of Office 365 on the device.
|
||||
| 17100 | ERROR_HANDLING_COMMAND_LINE<br>C2RClient command-line error | Failure |
|
||||
| 0x80004005 | E_FAIL <br>ODT cannot be used to install Volume license | Failure |
|
||||
| 0x8000ffff | E_UNEXPECTED<br>Tried to uninstall when there is no C2R Office on the machine. | Failure |
|
||||
<!-- Office-CspMoreInfo-End -->
|
||||
|
||||
<!-- Office-End -->
|
||||
|
||||
## Related articles
|
||||
|
||||
[Configuration service provider reference](configuration-service-provider-reference.md)
|
||||
|
||||
@ -1,31 +1,29 @@
|
||||
---
|
||||
title: Office DDF
|
||||
description: This topic shows the OMA DM device description framework (DDF) for the Office configuration service provider. DDF files are used only with OMA DM provisioning XML.
|
||||
ms.reviewer:
|
||||
title: Office DDF file
|
||||
description: View the XML file containing the device description framework (DDF) for the Office 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: 08/15/2018
|
||||
ms.topic: reference
|
||||
---
|
||||
|
||||
# Office DDF
|
||||
<!-- Auto-Generated CSP Document -->
|
||||
|
||||
This topic shows the OMA DM device description framework (DDF) for the **Office** configuration service provider. DDF files are used only with OMA DM provisioning XML.
|
||||
# Office DDF file
|
||||
|
||||
Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-ddf.md).
|
||||
|
||||
The XML below is for Windows 10, version 1809.
|
||||
The following XML file contains the device description framework (DDF) for the Office 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>Office</NodeName>
|
||||
<Path>./User/Vendor/MSFT</Path>
|
||||
@ -44,8 +42,13 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>com.microsoft/1.5/MDM/Office</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.15063</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>Installation</NodeName>
|
||||
@ -64,19 +67,19 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<DDFName></DDFName>
|
||||
<DDFName />
|
||||
</DFType>
|
||||
</DFProperties>
|
||||
<Node>
|
||||
<NodeName></NodeName>
|
||||
<NodeName>
|
||||
</NodeName>
|
||||
<DFProperties>
|
||||
<AccessType>
|
||||
<Add />
|
||||
<Delete />
|
||||
<Get />
|
||||
<Replace />
|
||||
</AccessType>
|
||||
<Description>A unique identifier which represents the instalation instance id.</Description>
|
||||
<Description>A unique identifier which represents the installation instance id.</Description>
|
||||
<DFFormat>
|
||||
<node />
|
||||
</DFFormat>
|
||||
@ -88,8 +91,11 @@ The XML below is for Windows 10, version 1809.
|
||||
</Scope>
|
||||
<DFTitle>id</DFTitle>
|
||||
<DFType>
|
||||
<DDFName></DDFName>
|
||||
<DDFName />
|
||||
</DFType>
|
||||
<MSFT:DynamicNodeNaming>
|
||||
<MSFT:UniqueName>A unique identifier which represents the installation instance id.</MSFT:UniqueName>
|
||||
</MSFT:DynamicNodeNaming>
|
||||
</DFProperties>
|
||||
<Node>
|
||||
<NodeName>Install</NodeName>
|
||||
@ -109,8 +115,10 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:AllowedValues ValueType="None">
|
||||
</MSFT:AllowedValues>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
<Node>
|
||||
@ -130,7 +138,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
@ -148,11 +156,15 @@ The XML below is for Windows 10, version 1809.
|
||||
<One />
|
||||
</Occurrence>
|
||||
<Scope>
|
||||
<Dynamic />
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
|
||||
<MSFT:CspVersion>1.5</MSFT:CspVersion>
|
||||
</MSFT:Applicability>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
</Node>
|
||||
@ -164,17 +176,21 @@ The XML below is for Windows 10, version 1809.
|
||||
</AccessType>
|
||||
<Description>The current Office 365 installation status on the machine</Description>
|
||||
<DFFormat>
|
||||
<xml />
|
||||
<chr />
|
||||
</DFFormat>
|
||||
<Occurrence>
|
||||
<One />
|
||||
</Occurrence>
|
||||
<Scope>
|
||||
<Permanent />
|
||||
<Dynamic />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.16299</MSFT:OsBuildVersion>
|
||||
<MSFT:CspVersion>1.3</MSFT:CspVersion>
|
||||
</MSFT:Applicability>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
</Node>
|
||||
@ -186,6 +202,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<AccessType>
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>Root of the office CSP.</Description>
|
||||
<DFFormat>
|
||||
<node />
|
||||
</DFFormat>
|
||||
@ -196,8 +213,13 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>com.microsoft/1.5/MDM/Office</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.15063</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>Installation</NodeName>
|
||||
@ -205,6 +227,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<AccessType>
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>Installation options for the office CSP.</Description>
|
||||
<DFFormat>
|
||||
<node />
|
||||
</DFFormat>
|
||||
@ -215,18 +238,19 @@ The XML below is for Windows 10, version 1809.
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<DDFName></DDFName>
|
||||
<DDFName />
|
||||
</DFType>
|
||||
</DFProperties>
|
||||
<Node>
|
||||
<NodeName>id</NodeName>
|
||||
<NodeName>
|
||||
</NodeName>
|
||||
<DFProperties>
|
||||
<AccessType>
|
||||
<Add />
|
||||
<Delete />
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>A unique identifier which represents the instalation instance id.</Description>
|
||||
<Description>A unique identifier which represents the installation instance id.</Description>
|
||||
<DFFormat>
|
||||
<node />
|
||||
</DFFormat>
|
||||
@ -238,8 +262,11 @@ The XML below is for Windows 10, version 1809.
|
||||
</Scope>
|
||||
<DFTitle>id</DFTitle>
|
||||
<DFType>
|
||||
<DDFName></DDFName>
|
||||
<DDFName />
|
||||
</DFType>
|
||||
<MSFT:DynamicNodeNaming>
|
||||
<MSFT:UniqueName>A unique identifier which represents the installation instance id.</MSFT:UniqueName>
|
||||
</MSFT:DynamicNodeNaming>
|
||||
</DFProperties>
|
||||
<Node>
|
||||
<NodeName>Install</NodeName>
|
||||
@ -248,6 +275,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<Exec />
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>The install action will install office given the configuration in the data. The string data is the xml configuration to use in order to install office.</Description>
|
||||
<DFFormat>
|
||||
<chr />
|
||||
</DFFormat>
|
||||
@ -258,8 +286,10 @@ The XML below is for Windows 10, version 1809.
|
||||
<Dynamic />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:AllowedValues ValueType="None">
|
||||
</MSFT:AllowedValues>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
<Node>
|
||||
@ -268,6 +298,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<AccessType>
|
||||
<Get />
|
||||
</AccessType>
|
||||
<Description>The installation status of the CSP.</Description>
|
||||
<DFFormat>
|
||||
<int />
|
||||
</DFFormat>
|
||||
@ -278,7 +309,7 @@ The XML below is for Windows 10, version 1809.
|
||||
<Dynamic />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
@ -296,11 +327,15 @@ The XML below is for Windows 10, version 1809.
|
||||
<One />
|
||||
</Occurrence>
|
||||
<Scope>
|
||||
<Dynamic />
|
||||
<Permanent />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
|
||||
<MSFT:CspVersion>1.5</MSFT:CspVersion>
|
||||
</MSFT:Applicability>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
</Node>
|
||||
@ -312,20 +347,28 @@ The XML below is for Windows 10, version 1809.
|
||||
</AccessType>
|
||||
<Description>The current Office 365 installation status on the machine</Description>
|
||||
<DFFormat>
|
||||
<xml />
|
||||
<chr />
|
||||
</DFFormat>
|
||||
<Occurrence>
|
||||
<One />
|
||||
</Occurrence>
|
||||
<Scope>
|
||||
<Permanent />
|
||||
<Dynamic />
|
||||
</Scope>
|
||||
<DFType>
|
||||
<MIME>text/plain</MIME>
|
||||
<MIME />
|
||||
</DFType>
|
||||
<MSFT:Applicability>
|
||||
<MSFT:OsBuildVersion>10.0.16299</MSFT:OsBuildVersion>
|
||||
<MSFT:CspVersion>1.3</MSFT:CspVersion>
|
||||
</MSFT:Applicability>
|
||||
</DFProperties>
|
||||
</Node>
|
||||
</Node>
|
||||
</Node>
|
||||
</MgmtTree>
|
||||
```
|
||||
|
||||
## Related articles
|
||||
|
||||
[Office configuration service provider reference](office-csp.md)
|
||||
|
||||
@ -794,7 +794,7 @@ items:
|
||||
- name: Office
|
||||
href: office-csp.md
|
||||
items:
|
||||
- name: Office DDF
|
||||
- name: Office DDF file
|
||||
href: office-ddf.md
|
||||
- name: PassportForWork
|
||||
href: passportforwork-csp.md
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user