From 011be562a96afc91700a2ceb27a8e8223968bbdb Mon Sep 17 00:00:00 2001 From: MandiOhlinger Date: Thu, 2 Jun 2022 16:15:11 -0400 Subject: [PATCH 1/3] adding UniversalPrint CSP --- windows/client-management/mdm/toc.yml | 5 + .../mdm/universalprint-csp.md | 110 +++++++++ .../mdm/universalprint-ddf-file.md | 214 ++++++++++++++++++ 3 files changed, 329 insertions(+) create mode 100644 windows/client-management/mdm/universalprint-csp.md create mode 100644 windows/client-management/mdm/universalprint-ddf-file.md diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index 33c45dd2be..442ca6fbb7 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -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: diff --git a/windows/client-management/mdm/universalprint-csp.md b/windows/client-management/mdm/universalprint-csp.md new file mode 100644 index 0000000000..6efac67063 --- /dev/null +++ b/windows/client-management/mdm/universalprint-csp.md @@ -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 +-------- (PrinterSharedID) +--------CloudDeviceID +--------PrinterSharedName +--------Install +--------Status +--------ErrorCode +``` + +**./Vendor/MSFT/PrinterProvisioning** +The root node for the Universal Print PrinterProvisioning configuration service provider. + +**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. + +**`` (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. + +**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. + +**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. + +**Install** + +Installs Universal Print printer. Supports async execute. + +The data type is boolean. Supported operations are ??. + +**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 ??. + +**ErrorCode** + +HRESULT of the last installation returned code. + +The data type is string. Supported operations are ??. diff --git a/windows/client-management/mdm/universalprint-ddf-file.md b/windows/client-management/mdm/universalprint-ddf-file.md new file mode 100644 index 0000000000..1e27082cec --- /dev/null +++ b/windows/client-management/mdm/universalprint-ddf-file.md @@ -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 + +]> + + 1.2 + + PrinterProvisioning + ./User/Vendor/MSFT + + + + + Printer Provisioning + + + + + + + + + + + com.microsoft/1.0/MDM/PrinterProvisioning + + + + UPPrinterInstalls + + + + + This setting will take the action on the specified user account to install or uninstall the specified printer. Install action is selected by default. + + + + + + + + + + + + + + + + + + + + + + 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. + + + + + + + + + + PrinterSharedID + + + + + PrinterSharedID from the Universal Print system, which is used to discover and install Univeral Print printer + + + + + + CloudDeviceID + + + + + + + + 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. + + + + + + + + + + + text/plain + + + + + Install + + + + + + Support async execute. Install Universal Print printer. + + + + + + + + + + + text/plain + + + + + Status + + + + + 1 finished installation successfully, 2 installation in progress after receiving execute cmd, 4 installation failed, 8 installation initial status, 32 unknown (not used). + + + + + + + + + + + text/plain + + + + + ErrorCode + + + + + HRESULT of the last installation returned code. + + + + + + + + + + + text/plain + + + + + PrinterSharedName + + + + + + + + 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. + + + + + + + + + + + text/plain + + + + + + + +``` From ab2b6e3a691454eb247dd876caad2f7fb5f19792 Mon Sep 17 00:00:00 2001 From: MandiOhlinger Date: Thu, 2 Jun 2022 16:25:14 -0400 Subject: [PATCH 2/3] review updates --- windows/client-management/mdm/toc.yml | 4 ++-- windows/client-management/mdm/universalprint-csp.md | 10 +++++----- .../client-management/mdm/universalprint-ddf-file.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/windows/client-management/mdm/toc.yml b/windows/client-management/mdm/toc.yml index 442ca6fbb7..a95c47c94f 100644 --- a/windows/client-management/mdm/toc.yml +++ b/windows/client-management/mdm/toc.yml @@ -904,10 +904,10 @@ items: items: - name: UnifiedWriteFilter DDF file href: unifiedwritefilter-ddf.md - - name: Universal Print CSP + - name: UniversalPrint CSP href: universalprint-csp.md items: - - name: Universal Print DDF file + - name: UniversalPrint DDF file href: universalprint-ddf-file.md - name: Update CSP href: update-csp.md diff --git a/windows/client-management/mdm/universalprint-csp.md b/windows/client-management/mdm/universalprint-csp.md index 6efac67063..926b5fa2b3 100644 --- a/windows/client-management/mdm/universalprint-csp.md +++ b/windows/client-management/mdm/universalprint-csp.md @@ -28,7 +28,7 @@ The UniversalPrint configuration service provider (CSP) is used to add Universal This CSP was added in Windows 11. -The following shows the UniversalPrint configuration service provider in tree format. +The following example shows the UniversalPrint configuration service provider in tree format. ```console ./Vendor/MSFT @@ -58,7 +58,7 @@ The data type is string. Supported operations are Get, Replace, and Delete. **`` (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 Share ID is used to identify the Universal Print printer 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 ??. @@ -67,7 +67,7 @@ The data type is GUID. Supported operations are ??. **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 Printer ID is used to identify the Universal Print printer 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 ??. @@ -76,7 +76,7 @@ The data type is GUID. Supported operations are ??. **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 Share Name is used to identify the Universal Print printer 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 ??. @@ -85,7 +85,7 @@ The data type is string. Supported operations are ??. **Install** -Installs Universal Print printer. Supports async execute. +Installs the Universal Print printer. Supports async execute. The data type is boolean. Supported operations are ??. diff --git a/windows/client-management/mdm/universalprint-ddf-file.md b/windows/client-management/mdm/universalprint-ddf-file.md index 1e27082cec..cc624c9c29 100644 --- a/windows/client-management/mdm/universalprint-ddf-file.md +++ b/windows/client-management/mdm/universalprint-ddf-file.md @@ -13,7 +13,7 @@ manager: dougeby # UniversalPrint DDF file -This topic shows the OMA DM device description framework (DDF) for the **UniversalPrint** configuration service provider. +This article 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). From fa3101e3dc3534f4e97796d044107b0715d46f8e Mon Sep 17 00:00:00 2001 From: MandiOhlinger Date: Thu, 2 Jun 2022 19:20:55 -0400 Subject: [PATCH 3/3] Added data types and supported operations --- .../client-management/mdm/universalprint-csp.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/windows/client-management/mdm/universalprint-csp.md b/windows/client-management/mdm/universalprint-csp.md index 926b5fa2b3..e7ca5d359c 100644 --- a/windows/client-management/mdm/universalprint-csp.md +++ b/windows/client-management/mdm/universalprint-csp.md @@ -54,13 +54,13 @@ 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. +The data type is node (XML node). Supported operation is Get. **`` (PrinterSharedID)** The Share ID is used to identify the Universal Print printer 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 ??. +The data type is node (XML node). Supported operations are Get, Add, and Delete. > [!NOTE] > The targeted user account must have access rights to the printer and to the Universal Print service. @@ -69,7 +69,7 @@ The data type is GUID. Supported operations are ??. The Printer ID is used to identify the Universal Print printer 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 ??. +The data type is string/text (GUID). Supported operations are Get, Add, Delete, and Replace. > [!NOTE] > The targeted user account must have access rights to the printer and to the Universal Print service. @@ -78,7 +78,7 @@ The data type is GUID. Supported operations are ??. The Share Name is used to identify the Universal Print printer 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 ??. +The data type is string/text. Supported operations are Get, Add, Delete, and Replace. > [!NOTE] > The targeted user account must have access rights to the printer and to the Universal Print service. @@ -87,7 +87,7 @@ The data type is string. Supported operations are ??. Installs the Universal Print printer. Supports async execute. -The data type is boolean. Supported operations are ??. +The data type is string/text (empty string). Supported operations are Get and Execute. **Status** @@ -101,10 +101,10 @@ Valid values: - 8 - Installation initial status - 32 - Unknown (not used) -The data type is integer. Supported operations are ??. +The data type is int. Supported operations is Get. **ErrorCode** HRESULT of the last installation returned code. -The data type is string. Supported operations are ??. +The data type is int. Supported operation is Get.