Parameter Details - primalcurve/better-jamf-printer-policy GitHub Wiki

Mode (Add or Remove)

This is looking for literally Add or Remove.

Add

If you are adding a Printer, the following parameters are required:

  1. Printer Name
  2. Printer URI
  3. Path to PPD
  4. Jamf Event for PPD Install

Remove

If you are removing a printer, only the Printer Name parameter is required.

Printer Name

This is the name of the printer on the back end. CUPS printer names cannot contain whitespace (Space and Tab) or # or /. If you would like spaces in your name for your users, use the Printer Description parameter.

Printer Options CSV

If you have a printer with more than one option, you will need to separate those options by commas. For more information on how to obtain the options in the correct format, see Gathering Information Needed for a Printer Policy.

Note that this script disables Printer Sharing on every printer it installs.

Printer URI

This is the Uniform Resource Identifier of the printer. This basically just tells CUPS what protocol to use, what address the printer is on, and what queue to use.

Examples

lpd://printserver.yourcompany.com/lobby_printer

ipp://192.168.50.123/printer

smb://printserver421.ad.yourcompany.com/secret_color_printer

Path to PPD

This is the path to the installed PPD. If requested, this script will always install the PPD using the Overwrite PPD switch. However, if the PPD does not exist, then the script will attempt to install it even if it is not requested.

This step is required in order for CUPS to properly configure the printer.

Printer Description (Optional)

The Printer Description is a friendly name for the printer that can use a larger character set. Use this if the printer names are vague or ugly.

Jamf Event for PPD Install

This is required so that the script knows which event to call if the PPD is not installed. This will trigger a jamf policy -event <event_name>. You'll need to Create a PPD Install Policy in order to make this work.

Overwrite PPD

Do we want to overwrite the existing PPD installation or not? You might not want to for some common printer models that are preinstalled by macOS or your imaging process, but what about if the PPDs are regularly updated by the printer manufacturer and you want to make sure that its always up-to-date? That part is up to you.

This parameter is optional, but that's because the default is to overwrite. Literally anything but the word overwrite will stop this from happening.

⚠️ **GitHub.com Fallback** ⚠️