How to use sub-commands to manage, test, and update edge nodes in PaperCut Hive and Pocket

This page explains how to use the command-line to manage, test, and update PaperCut Hive and Pocket edge nodes.

Perform administrative tasks on a user’s computer using the command line. Administrative tasks include updating edge node software, printing test pages, and removing older versions of the software.

Before you start

Before using sub-commands, ensure your device meets the location and access requirements.

Depending on the operating system, the edge node software is installed in the following locations:

macOS

• /Library/PaperCut Hive
• /Library/PaperCut Pocket

Windows

• C:\Program Files\PaperCut Hive\
• C:\Program Files\PaperCut Pocket\

The edge node’s sub-commands are the same for both PaperCut Hive and Pocket. Sub-commands involving the Hive embedded applet are only applicable to Hive.

To use the pc-edgenode-service sub-commands, you need:

• a Windows or macOS device with the PaperCut Hive edge node software installed
• operating system administrative privileges on the device.

Sub-commands summary and syntax

Run sub-commands within the edge node installation directory using Terminal, Command Prompt, or PowerShell (for example, /Library/PaperCut Hive/ or C:\Program Files\PaperCut Hive\).

The command syntax is: pc-edgenode-service command <SUB-COMMAND>

Valid sub-commands include:

• force-update
• update-now
• test-ipp-print
• test-ipp-operation
• test-queue-print
• uninstall
• printer-app
• remove-old-versions

How to manage edge nodes using sub-commands

Use the following sub-commands to manage software versions and perform maintenance on edge nodes.

Install the latest version of the edge node software (force-update)

Use this command to download the latest waypoint available version of the edge node software. A waypoint version is a version that each edge node has to go through.

macOS

Windows

Download and install the latest available edge node software version (update-now)

macOS

Windows

Remove old versions of edge nodes (remove-old-versions)

The remove-old-versions sub-command automatically runs during an edge node update process to clean up older builds. It retains the five most recent version folders (vYYYY-MM-DD-####) and removes the rest.

To manually remove older software versions, run:

macOS

Windows

How to test edge nodes using sub-commands

Use the following sub-commands to test network communication, printer compatibility, and local queue performance.

Test the IPP print flow (test-ipp-print)

Test the IPP print flow that PaperCut Hive and Pocket use when releasing a job to a printer. Use this for troubleshooting and testing direct IPP/IPPS printing communication from the edge node to a printer.

macOS

Windows

Test if the copier has IPP capability (test-ipp-operation)

Test the basic IPP capability of the printer.

macOS

Windows

Example

1. To send an IPP test print job, start by getting the IPP URI. In this example, the IP address of the printer is 10.10.0.1:

2. After you obtain the URI, run the IPP test:

Test printing for a local queue (test-queue-print)

Send a test print job directly through a specific local print queue hosted on an edge node.

macOS

Windows

Replace <QUEUE_NAME> with the exact name of the target local print queue installed on the machine.

In an elevated Command Prompt, Terminal, or PowerShell window within the PaperCut Hive or Pocket directory, run:

• If the queue name contains no spaces (for example, myprinter):

• If the queue name contains spaces (for example, my printer), enclose the name in quotation marks:

How to manage the PaperCut Hive embedded app using sub-commands

Use the printer-app sub-commands to install or uninstall the PaperCut Hive embedded application on multi-function devices (MFDs).

Uninstall the PaperCut Hive embedded app

Use with the printer-app sub-command to uninstall the PaperCut Hive embedded app.

Epson Full Embedded App

Epson Lite Release App

Fuji Xerox - Full Embedded app

Fuji Xerox - Lite Release App

Fujifilm Full Embedded App

Fujifilm LeSF Full Embedded App

HP OXP Full Embedded App

HP OXP Lite Release App

Konica Minolta Full Embedded App

Konica Minolta Lite Release App

Kyocera Full Embedded App

Lexmark LeSF Full Embedded App

Ricoh SmartSDK Full Embedded App

Riso Lite Release App

Sharp LeSF Full Embedded App

Sharp OSA Full Embedded App

Sharp OSA Lite Release App

Toshiba LeSF Full Embedded App

Toshiba MDS V3 Full Embedded App

Toshiba MDS V3 Lite Release App

Xerox Lite Release App

Xerox EIP 1.5 - Full Embedded App

Xerox LeSF - Full Embedded App

Note: Replace <DEVICE_HOSTNAME> with the hostname or IP address of your device.

How to install the PaperCut Hive embedded app using sub-commands

Manually install the PaperCut Hive embedded application on multi-function devices (MFDs).

To install the PaperCut Hive embedded app on an MFD, run:

Replace <DEVICE_HOSTNAME> with the hostname or IP address of your device, <PLATFORM> with the embedded platform type, and <VERSION_NUMBER> with the app version.

For further details, in the PaperCut Hive admin console, go to Printers > [Printer Name] > Apps > Installation guide.

Related pages

“Some jobs failed to print. Try again” error message