adding UniversalPrint CSP

This commit is contained in:
MandiOhlinger
2022-06-02 16:15:11 -04:00
parent c28ee49206
commit 011be562a9
3 changed files with 329 additions and 0 deletions

View File

@ -904,6 +904,11 @@ items:
items:
- name: UnifiedWriteFilter DDF file
href: unifiedwritefilter-ddf.md
- name: Universal Print CSP
href: universalprint-csp.md
items:
- name: Universal Print DDF file
href: universalprint-ddf-file.md
- name: Update CSP
href: update-csp.md
items:

View File

@ -0,0 +1,110 @@
---
title: UniversalPrint CSP
description: Learn how the UniversalPrint configuration service provider (CSP) is used to install printers on Windows client devices.
ms.author: mandia
ms.topic: article
ms.prod: w10
ms.technology: windows
author: MandiOhlinger
ms.date: 06/02/2022
ms.reviewer: jimwu
manager: dougeby
---
# UniversalPrint CSP
The table below shows the applicability of Windows:
|Edition|Windows 11|
|--- |--- |
|Home|No|
|Pro|Yes|
|Windows SE|Yes|
|Business|Yes|
|Enterprise|Yes|
|Education|Yes|
The UniversalPrint configuration service provider (CSP) is used to add Universal Print-compatible printers to Windows client endpoints. Universal Print is a cloud-based printing solution that runs entirely in Microsoft Azure. It doesn't require any on-premises infrastructure. For more specific information, go to [What is Universal Print](/universal-print/fundamentals/universal-print-whatis).
This CSP was added in Windows 11.
The following shows the UniversalPrint configuration service provider in tree format.
```console
./Vendor/MSFT
PrinterProvisioning
----UPPrinterInstalls
--------<GUID> (PrinterSharedID)
--------CloudDeviceID
--------PrinterSharedName
--------Install
--------Status
--------ErrorCode
```
<a href="" id="PrinterProvisioning"></a>**./Vendor/MSFT/PrinterProvisioning**
The root node for the Universal Print PrinterProvisioning configuration service provider.
<a href="" id="upprinterinstalls"></a>**UPPrinterInstalls**
This setting will install or uninstall a specific printer to a targeted user account.
Valid values:
- Install (default) - The printer is installed.
- Uninstall - The printer is uninstalled.
The data type is string. Supported operations are Get, Replace, and Delete.
<a href="" id="guidprintersharedid)"></a>**`<GUID>` (PrinterSharedID)**
Identifies the Universal Print printer, by its Share ID, you want to install on the targeted user account. You can get the printer's Share ID in the printer's properties in the [Universal Print portal](/universal-print/portal/navigate-up).
The data type is GUID. Supported operations are ??.
> [!NOTE]
> The targeted user account must have access rights to the printer and to the Universal Print service.
<a href="" id="clouddeviceid"></a>**CloudDeviceID**
Identifies the Universal Print printer, by its Printer ID, you want to install on the targeted user account. You can get the printer's Printer ID in the printer's properties in the [Universal Print portal](/universal-print/portal/navigate-up).
The data type is GUID. Supported operations are ??.
> [!NOTE]
> The targeted user account must have access rights to the printer and to the Universal Print service.
<a href="" id="printersharedname"></a>**PrinterSharedName**
Identifies the Universal Print printer, by its Share Name, you want to install on the targeted user account. You can get the printer's Share Name in the printer's properties in the [Universal Print portal](/universal-print/portal/navigate-up).
The data type is string. Supported operations are ??.
> [!NOTE]
> The targeted user account must have access rights to the printer and to the Universal Print service.
<a href="" id="install"></a>**Install**
Installs Universal Print printer. Supports async execute.
The data type is boolean. Supported operations are ??.
<a href="" id="status"></a>**Status**
The result status of the printer installation.
Valid values:
- 1 (default) - Installation completed successfully.
- 2 - Installation is in progress after receiving execute cmd.
- 4 - Installation failed.
- 8 - Installation initial status
- 32 - Unknown (not used)
The data type is integer. Supported operations are ??.
<a href="" id="errorcode"></a>**ErrorCode**
HRESULT of the last installation returned code.
The data type is string. Supported operations are ??.

View File

@ -0,0 +1,214 @@
---
title: UniversalPrint DDF file
description: UniversalPrint DDF file
ms.author: mandia
ms.topic: article
ms.prod: w10
ms.technology: windows
author: MandiOhlinger
ms.date: 06/02/2022
ms.reviewer: jimwu
manager: dougeby
---
# UniversalPrint DDF file
This topic shows the OMA DM device description framework (DDF) for the **UniversalPrint** configuration service provider.
Looking for the DDF XML files? See [CSP DDF files download](configuration-service-provider-reference.md#csp-ddf-files-download).
The XML below is the current version for this CSP.
```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"?>]>
<MgmtTree xmlns:MSFT="http://schemas.microsoft.com/MobileDevice/DM">
<VerDTD>1.2</VerDTD>
<Node>
<NodeName>PrinterProvisioning</NodeName>
<Path>./User/Vendor/MSFT</Path>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>Printer Provisioning</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<MIME>com.microsoft/1.0/MDM/PrinterProvisioning</MIME>
</DFType>
</DFProperties>
<Node>
<NodeName>UPPrinterInstalls</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>This setting will take the action on the specified user account to install or uninstall the specified printer. Install action is selected by default.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Permanent />
</Scope>
<DFType>
<DDFName></DDFName>
</DFType>
</DFProperties>
<Node>
<NodeName></NodeName>
<DFProperties>
<AccessType>
<Get />
<Add />
<Delete />
</AccessType>
<Description>Identifies the Universal Print printer, by its Share ID, you wish to install on the targeted user account. The printer's Share ID can be found in the printer's properties via the Universal Print portal. Note: the targeted user account must have access rights to both the printer and to the Universal Print service.</Description>
<DFFormat>
<node />
</DFFormat>
<Occurrence>
<OneOrMore />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFTitle>PrinterSharedID</DFTitle>
<DFType>
<DDFName></DDFName>
</DFType>
<DynamicNodeNaming>
<UniqueName>PrinterSharedID from the Universal Print system, which is used to discover and install Univeral Print printer</UniqueName>
</DynamicNodeNaming>
<TrackedResource />
<AsynchronousTracking ResourceInProgressValues="2,8" ResourceFailureValues="4,32" ResourceSuccessURI="UPPrinterInstalls/@#ResourcePlaceholder@/status" ResourceSuccessValues="1" />
</DFProperties>
<Node>
<NodeName>CloudDeviceID</NodeName>
<DFProperties>
<AccessType>
<Get />
<Add />
<Delete />
<Replace />
</AccessType>
<Description>Identifies the Universal Print printer, by its Printer ID, you wish to install on the targeted user account. The printer's Printer ID can be found in the printer's properties via the Universal Print portal. Note: the targeted user account must have access rights to both the printer and to the Universal Print service.</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>Install</NodeName>
<DFProperties>
<AccessType>
<Get />
<Exec />
</AccessType>
<Description>Support async execute. Install Universal Print printer.</Description>
<DFFormat>
<null />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>Status</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>1 finished installation successfully, 2 installation in progress after receiving execute cmd, 4 installation failed, 8 installation initial status, 32 unknown (not used).</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>ErrorCode</NodeName>
<DFProperties>
<AccessType>
<Get />
</AccessType>
<Description>HRESULT of the last installation returned code.</Description>
<DFFormat>
<int />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
<Node>
<NodeName>PrinterSharedName</NodeName>
<DFProperties>
<AccessType>
<Get />
<Add />
<Delete />
<Replace />
</AccessType>
<Description>Identifies the Universal Print printer, by its Share Name, you wish to install on the targeted user account. The printer's Share Name can be found in the printer's properties via the Universal Print portal. Note: the targeted user account must have access rights to both the printer and to the Universal Print service.</Description>
<DFFormat>
<chr />
</DFFormat>
<Occurrence>
<One />
</Occurrence>
<Scope>
<Dynamic />
</Scope>
<DFType>
<MIME>text/plain</MIME>
</DFType>
</DFProperties>
</Node>
</Node>
</Node>
</Node>
</MgmtTree>
```