deepblue/windows-itpro-docs
1
0
Fork 0
mirror of https://github.com/MicrosoftDocs/windows-itpro-docs.git synced 2025-05-12 13:27:23 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Office CSP

Browse Source
This commit is contained in:
Vinay Pamnani 2023-02-17 17:35:59 -05:00
parent 2e1afb9ed1
commit 86872f94fc
3 changed files with 838 additions and 367 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

630
windows/client-management/mdm/office-csp.md
View File

@ -1,102 +1,523 @@
--- ---
title: Office CSP 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.author: vinpa
ms.topic: article ms.date: 02/17/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: 08/15/2018
ms.reviewer:
manager: aaroncz
--- ---
<!-- Auto-Generated CSP Document -->
<!-- Office-Begin -->
# Office CSP # Office CSP
The table below shows the applicability of Windows: <!-- Office-Editable-Begin -->
<!-- Add any additional information about this policy here. Anything outside this section will get overwritten. -->
|Edition|Windows 10|Windows 11|
|--- |--- |--- |
|Home|No|No|
|Pro|Yes|Yes|
|Windows SE|No|Yes|
|Business|Yes|Yes|
|Enterprise|Yes|Yes|
|Education|Yes|Yes|
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). 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). ```text
./Device/Vendor/MSFT/Office
The following shows the Office configuration service provider in tree format. --- Installation
------ {id}
```console --------- FinalStatus
./Vendor/MSFT --------- Install
Office --------- Status
----Installation ------ CurrentStatus
--------id ./User/Vendor/MSFT/Office
------------Install --- Installation
------------Status ------ {id}
--------- FinalStatus
--------- Install
./Device/Vendor/MSFT --------- Status
Office ------ CurrentStatus
----Installation
--------id
------------Install
------------Status
./Vendor/MSFT
./Device/Vendor/MSFT
Office
----Installation
--------id
------------Install
------------Status
``` ```
<!-- Office-Tree-End -->
<a href="" id="office"></a>**./Device/Vendor/MSFT/Office/ or ./User/Vendor/MSFT/Office** <!-- Device-Installation-Begin -->
The root node for the Office configuration service provider.</p> ## Device/Installation
<a href="" id="installation"></a>**Installation** <!-- Device-Installation-Applicability-Begin -->
Specifies the options for the Microsoft Office installation. | 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_** <!-- Device-Installation-Description-Begin -->
Specifies a unique identifier that represents the ID of the Microsoft Office product to install. <!-- 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** <!-- Device-Installation-DFProperties-Begin -->
Installs Office by using the XML data specified in the configuration.xml file. **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** <!-- Device-Installation-Examples-Begin -->
The Microsoft Office installation status. <!-- 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** <!-- Device-Installation-{id}-Begin -->
Added in Windows 10, version 1809. Indicates the status of the Final Office 365 installation. ### 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 -->
- When Office CSP is triggered to install, it will first check if the FinalStatus node exists or not. If the node exists, delete it. ```Device
- When Office installation reaches any terminal states (either success or failure), this node is created that contains the following values: ./Device/Vendor/MSFT/Office/Installation/{id}
- When status = 0: 70 (succeeded) ```
- When status!= 0: 60 (failed) <!-- Device-Installation-{id}-OmaUri-End -->
<a href="" id="currentstatus"></a>**Installation/CurrentStatus** <!-- Device-Installation-{id}-Description-Begin -->
Returns an XML of current Office 365 installation status on the device. <!-- Description-Source-DDF -->
A unique identifier which represents the installation instance id.
<!-- Device-Installation-{id}-Description-End -->
The only supported operation is Get. <!-- 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 -->
<!-- Device-Installation-{id}-FinalStatus-DFProperties-Begin -->
**Description framework properties**:
| 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 ## Examples
Sample SyncML to install Microsoft 365 Apps for business Retail from current channel. Sample SyncML to install Microsoft 365 Apps for business Retail from current channel.
@ -147,38 +568,45 @@ To get the current status of Office 365 on the device.
```xml ```xml
<SyncML xmlns="SYNCML:SYNCML1.2"> <SyncML xmlns="SYNCML:SYNCML1.2">
  <SyncBody> <SyncBody>
    <Get> <Get>
      <CmdID>7</CmdID> <CmdID>7</CmdID>
        <Item> <Item>
          <Target> <Target>
            <LocURI>./Vendor/MSFT/Office/Installation/CurrentStatus</LocURI> <LocURI>./Vendor/MSFT/Office/Installation/CurrentStatus</LocURI>
          </Target> </Target>
        </Item> </Item>
    </Get> </Get>
    <Final/> <Final />
  </SyncBody> </SyncBody>
</SyncML> </SyncML>
``` ```
## Status code ## Status code
|Status|Description|Comment| | Status | Description | Comment |
|--- |--- |--- | |------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|0|Installation succeeded|OK| | 0 | Installation succeeded | OK |
|997|Installation in progress|| | 997 | Installation in progress | |
|13|ERROR_INVALID_DATA <br>Cannot verify signature of the downloaded Office Deployment Tool (ODT)|Failure| | 13 | ERROR_INVALID_DATA <br>Cannot verify signature of the downloaded Office Deployment Tool (ODT) | Failure |
|1460|ERROR_TIMEOUT <br>Failed to download ODT|Failure| | 1460 | ERROR_TIMEOUT <br>Failed to download ODT | Failure |
|1602|ERROR_INSTALL_USEREXIT <br>User canceled the installation|Failure| | 1602 | ERROR_INSTALL_USEREXIT <br>User canceled the installation | Failure |
|1603|ERROR_INSTALL_FAILURE<br>Failed any pre-req check.<li>SxS (Tried to install when 2016 MSI is installed)<li>Bit mismatch between the currently installed Office and the Office that was attempting to be installed (such as when you try to install a 32-bit version while 64-bit version is currently installed.)|Failure| | 1603 | ERROR_INSTALL_FAILURE<br>Failed any pre-req check.<li>SxS (Tried to install when 2016 MSI is installed)<li>Bit mismatch between the currently installed Office and the Office that was attempting to be installed (such as when you try to install a 32-bit version while 64-bit version is currently installed.) | Failure |
|17000|ERROR_PROCESSPOOL_INITIALIZATION <br/>Failed to start C2RClient|Failure| | 17000 | ERROR_PROCESSPOOL_INITIALIZATION <br/>Failed to start C2RClient | Failure |
|17001|ERROR_QUEUE_SCENARIO <br/>Failed to queue installation scenario in C2RClient|Failure| | 17001 | ERROR_QUEUE_SCENARIO <br/>Failed to queue installation scenario in C2RClient | Failure |
|17002|ERROR_COMPLETING_SCENARIO <br>Failed to complete the process. Possible reasons:<li>Installation canceled by user<li>Installation canceled by another installation<li>Out of disk space during installation <li>Unknown language ID|Failure| | 17002 | ERROR_COMPLETING_SCENARIO <br>Failed to complete the process. Possible reasons:<li>Installation canceled by user<li>Installation canceled by another installation<li>Out of disk space during installation <li>Unknown language ID | Failure |
|17003|ERROR_ANOTHER_RUNNING_SCENARIO <br>Another scenario is running|Failure| | 17003 | ERROR_ANOTHER_RUNNING_SCENARIO <br>Another scenario is running | Failure |
|17004|ERROR_COMPLETING_SCENARIO_NEED_CLEAN_UP<br>Possible reasons:<li>Unknown SKUs<li>Content does't exist on CDN<ul><li>Such as trying to install an unsupported LAP, like zh-sg<li>CDN issue that content is not available</li></ul><li>Signature check issue, such as failed the signature check for Office content<li>User canceled|Failure| | 17004 | ERROR_COMPLETING_SCENARIO_NEED_CLEAN_UP<br>Possible reasons:<li>Unknown SKUs<li>Content does't exist on CDN<ul><li>Such as trying to install an unsupported LAP, like zh-sg<li>CDN issue that content is not available</li></ul><li>Signature check issue, such as failed the signature check for Office content<li>User canceled | Failure |
|17005|ERROR_SCENARIO_CANCELLED_AS_PLANNED|Failure| | 17005 | ERROR_SCENARIO_CANCELLED_AS_PLANNED | Failure |
|17006|ERROR_SCENARIO_CANCELLED<br>Blocked update by running apps|Failure| | 17006 | ERROR_SCENARIO_CANCELLED<br>Blocked update by running apps | Failure |
|17007|ERROR_REMOVE_INSTALLATION_NEEDED<br>The client is requesting client clean-up in a "Remove Installation" scenario|Failure| | 17007 | ERROR_REMOVE_INSTALLATION_NEEDED<br>The client is requesting client clean-up in a "Remove Installation" scenario | Failure |
|17100|ERROR_HANDLING_COMMAND_LINE<br>C2RClient command-line error|Failure| | 17100 | ERROR_HANDLING_COMMAND_LINE<br>C2RClient command-line error | Failure |
|0x80004005|E_FAIL <br>ODT cannot be used to install Volume license|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| | 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)

573
windows/client-management/mdm/office-ddf.md
View File

@ -1,61 +1,112 @@
--- ---
title: Office DDF title: Office DDF file
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. description: View the XML file containing the device description framework (DDF) for the Office configuration service provider.
ms.reviewer: author: vinaypamnani-msft
manager: aaroncz manager: aaroncz
ms.author: vinpa ms.author: vinpa
ms.topic: article ms.date: 02/17/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: 08/15/2018
--- ---
# 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 following XML file contains the device description framework (DDF) for the Office configuration service provider.
The XML below is for Windows 10, version 1809.
```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>
<NodeName>Office</NodeName>
<Path>./User/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Root of the office CSP.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<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>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Installation options for the office CSP.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node> <Node>
<NodeName>Office</NodeName> <NodeName>
<Path>./User/Vendor/MSFT</Path> </NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Add />
<Delete />
<Get /> <Get />
</AccessType> </AccessType>
<Description>Root of the office CSP.</Description> <Description>A unique identifier which represents the installation instance id.</Description>
<DFFormat> <DFFormat>
<node /> <node />
</DFFormat> </DFFormat>
<Occurrence> <Occurrence>
<One /> <ZeroOrMore />
</Occurrence> </Occurrence>
<Scope> <Scope>
<Permanent /> <Dynamic />
</Scope> </Scope>
<DFTitle>id</DFTitle>
<DFType> <DFType>
<MIME>com.microsoft/1.5/MDM/Office</MIME> <DDFName />
</DFType> </DFType>
<MSFT:DynamicNodeNaming>
<MSFT:UniqueName>A unique identifier which represents the installation instance id.</MSFT:UniqueName>
</MSFT:DynamicNodeNaming>
</DFProperties> </DFProperties>
<Node> <Node>
<NodeName>Installation</NodeName> <NodeName>Install</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Exec />
<Get /> <Get />
</AccessType> </AccessType>
<Description>Installation options for the office CSP.</Description> <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> <DFFormat>
<node /> <chr />
</DFFormat> </DFFormat>
<Occurrence> <Occurrence>
<One /> <One />
@ -64,149 +115,21 @@ The XML below is for Windows 10, version 1809.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<DDFName></DDFName> <MIME />
</DFType> </DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties> </DFProperties>
<Node>
<NodeName></NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
<Replace />
</AccessType>
<Description>A unique identifier which represents the instalation instance id.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<ZeroOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>id</DFTitle>
<DFType>
<DDFName></DDFName>
</DFType>
</DFProperties>
<Node>
<NodeName>Install</NodeName>
<DFProperties>
<AccessType>
<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>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>Status</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The installation status of the CSP.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>FinalStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Final Office 365 installation status.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
</Node>
<Node>
<NodeName>CurrentStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The current Office 365 installation status on the machine</Description>
<DFFormat>
<xml />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
</Node> </Node>
</Node>
<Node>
<NodeName>Office</NodeName>
<Path>./Device/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>com.microsoft/1.5/MDM/Office</MIME>
</DFType>
</DFProperties>
<Node> <Node>
<NodeName>Installation</NodeName> <NodeName>Status</NodeName>
<DFProperties> <DFProperties>
<AccessType> <AccessType>
<Get /> <Get />
</AccessType> </AccessType>
<Description>The installation status of the CSP.</Description>
<DFFormat> <DFFormat>
<node /> <int />
</DFFormat> </DFFormat>
<Occurrence> <Occurrence>
<One /> <One />
@ -215,117 +138,237 @@ The XML below is for Windows 10, version 1809.
<Permanent /> <Permanent />
</Scope> </Scope>
<DFType> <DFType>
<DDFName></DDFName> <MIME />
</DFType> </DFType>
</DFProperties> </DFProperties>
<Node> </Node>
<NodeName>id</NodeName> <Node>
<DFProperties> <NodeName>FinalStatus</NodeName>
<AccessType> <DFProperties>
<Add /> <AccessType>
<Delete /> <Get />
<Get /> </AccessType>
</AccessType> <Description>Final Office 365 installation status.</Description>
<Description>A unique identifier which represents the instalation instance id.</Description> <DFFormat>
<DFFormat> <int />
<node /> </DFFormat>
</DFFormat> <Occurrence>
<Occurrence> <One />
<ZeroOrMore /> </Occurrence>
</Occurrence> <Scope>
<Scope> <Permanent />
<Dynamic /> </Scope>
</Scope> <DFType>
<DFTitle>id</DFTitle> <MIME />
<DFType> </DFType>
<DDFName></DDFName> <MSFT:Applicability>
</DFType> <MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
</DFProperties> <MSFT:CspVersion>1.5</MSFT:CspVersion>
<Node> </MSFT:Applicability>
<NodeName>Install</NodeName> </DFProperties>
<DFProperties>
<AccessType>
<Exec />
<Get />
</AccessType>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>Status</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>FinalStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Final Office 365 installation status.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
</Node>
<Node>
<NodeName>CurrentStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The current Office 365 installation status on the machine</Description>
<DFFormat>
<xml />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
</Node> </Node>
</Node> </Node>
<Node>
<NodeName>CurrentStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The current Office 365 installation status on the machine</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.16299</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.3</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties>
</Node>
</Node>
</Node>
<Node>
<NodeName>Office</NodeName>
<Path>./Device/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Root of the office CSP.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<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>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Installation options for the office CSP.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName />
</DFType>
</DFProperties>
<Node>
<NodeName>
</NodeName>
<DFProperties>
<AccessType>
<Add />
<Delete />
<Get />
</AccessType>
<Description>A unique identifier which represents the installation instance id.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<ZeroOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>id</DFTitle>
<DFType>
<DDFName />
</DFType>
<MSFT:DynamicNodeNaming>
<MSFT:UniqueName>A unique identifier which represents the installation instance id.</MSFT:UniqueName>
</MSFT:DynamicNodeNaming>
</DFProperties>
<Node>
<NodeName>Install</NodeName>
<DFProperties>
<AccessType>
<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>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:AllowedValues ValueType="None">
</MSFT:AllowedValues>
</DFProperties>
</Node>
<Node>
<NodeName>Status</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The installation status of the CSP.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>FinalStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Final Office 365 installation status.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.17763</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.5</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties>
</Node>
</Node>
<Node>
<NodeName>CurrentStatus</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>The current Office 365 installation status on the machine</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME />
</DFType>
<MSFT:Applicability>
<MSFT:OsBuildVersion>10.0.16299</MSFT:OsBuildVersion>
<MSFT:CspVersion>1.3</MSFT:CspVersion>
</MSFT:Applicability>
</DFProperties>
</Node>
</Node>
</Node>
</MgmtTree> </MgmtTree>
``` ```
## Related articles
[Office configuration service provider reference](office-csp.md)

2
windows/client-management/mdm/toc.yml
View File

@ -794,7 +794,7 @@ items:
- name: Office - name: Office
href: office-csp.md href: office-csp.md
items: items:
- name: Office DDF - name: Office DDF file
href: office-ddf.md href: office-ddf.md
- name: PassportForWork - name: PassportForWork
href: passportforwork-csp.md href: passportforwork-csp.md