Printing

The printing payload manages printers that should be added to the user’s computer, as well as restrictions on how the user may print.

Summary

PayloadType:com.apple.mcxprinting
Supervised Only:
 N/A
macOS:N/A
macOS Deprecated:
 N/A
iOS:N/A
iOS Deprecated:N/A
Highlander:N/A
Name Type Title Description Required
DefaultPrinter dict Default Printer Configuration Default Printer Configuration n/a
UserPrinterList dict Installed Printers A list of printers to manage. The PPD software must already exist on the target n/a
RequireAdminToAddPrinters boolean Modification Requires Administrator Only administrators may modify the printer list n/a
AllowLocalPrinters boolean Allow Local Printers Allow printers that connect directly to user’s computer n/a
RequireAdminToPrintLocally boolean Require administrator password to print locally Require an administrator password to print to locally connected printers n/a
ShowOnlyManagedPrinters boolean Only show managed printers Only show printers managed by profiles n/a
PrintFooter boolean Print page footer Print a page footer including the user name and date n/a
PrintMACAddress boolean Include MAC Address on footer Include the MAC address of the user’s computer in the footer n/a
FooterFontSize string Footer font size The font size (in points) of the footer n/a
FooterFontName string Footer font name The name of the font to use for the footer eg. Courier n/a

Keys

DefaultPrinter

Default Printer Configuration

Default Printer Configuration

Type Default Required Regex iOS macOS Supervised
dict N/A N/A N/A N/A N/A N/A
Name Type Title Description Required
DeviceURI string Device URI The device URI of the Default Printer always
DisplayName string Display Name The display name of the Default Printer always

UserPrinterList

Installed Printers

A list of printers to manage. The PPD software must already exist on the target

Type Default Required Regex iOS macOS Supervised
dict N/A N/A N/A N/A N/A N/A
Name Type Title Description Required
QueueName dict Printer Queue Name The queue name of the printer, must not include spaces or special characters. Not shown to the user. n/a
Name Type Title Description Required
DeviceURI string Device URI The printer device URI, as would be passed to CUPS eg. lpd://printer.name/queue always
DisplayName string Display Name The display name shown to the user when choosing a printer. always
Location string Location The printer location n/a
Model string Model The printer model usually corresponding to the PPD model name eg 2nd column of `lpinfo -m`. n/a
PrinterLocked boolean Require Administrator Password The printer requires an administrator password n/a
PPDURL string PPD Path The path to the PPD file. Local file URLs should be prefixed with file://localhost/ n/a
Option dict Printer Options Printer Options. A dict of key to value including options normally supplied to lpadmin n/a

RequireAdminToAddPrinters

Modification Requires Administrator

Only administrators may modify the printer list

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

AllowLocalPrinters

Allow Local Printers

Allow printers that connect directly to user’s computer

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

RequireAdminToPrintLocally

Require administrator password to print locally

Require an administrator password to print to locally connected printers

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

ShowOnlyManagedPrinters

Only show managed printers

Only show printers managed by profiles

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

PrintFooter

Print page footer

Print a page footer including the user name and date

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

PrintMACAddress

Include MAC Address on footer

Include the MAC address of the user’s computer in the footer

Type Default Required Regex iOS macOS Supervised
boolean N/A N/A N/A N/A N/A N/A

FooterFontSize

Footer font size

The font size (in points) of the footer

Type Default Required Regex iOS macOS Supervised
string 7 N/A N/A N/A N/A N/A

FooterFontName

Footer font name

The name of the font to use for the footer eg. Courier

Type Default Required Regex iOS macOS Supervised
string Courier N/A N/A N/A N/A N/A