Skip to main content

Pdftools Licensing Shell commands

The Pdftools Licensing Shell (ptl) is a command-line interface for managing licenses associated with your Pdftools products. To list the commands on your machine, run ptl help.

The command name depends on how you installed the LGS, for example licgwy.ptl for the snap or sudo ptl for the DEB and RPM packages. For the full list, refer to Use the CLI utility. In full offline mode, the name also differs between the offline and online machines, as listed in Activate license keys offline. The examples on this page use ptl.

General commands​

The following commands work in every mode:

  • ptl help: Get instructions on how to use the CLI with a full list of commands.
  • ptl version: Get the version number.
  • ptl status: Check the licensing service status.
  • ptl list: Get information about added license keys and for how long they are valid.

Connected mode commands​

The following commands need a connection to the Pdftools Licensing Service. For details, refer to Connected mode.

  • ptl add "LICENSE_KEY_VALUE": Add a new license key.
  • ptl remove "LICENSE_KEY_VALUE": Remove a license key.
  • ptl remove-all: Remove all license keys.
  • ptl sync: Connect to the Pdftools Licensing Server on demand, which refreshes the time on all borrowed licenses.

Full offline mode commands​

Run the following commands on the offline machine. For details, refer to Activate license keys offline.

  • ptl export-activation "LICENSE_KEY_VALUE": Export an activation request.
  • ptl import-activation LICENSE_ACTIVATION_TOKEN: Import an activation response.
  • ptl export-deactivation "LICENSE_KEY_VALUE": Export a deactivation request.
  • ptl import-deactivation LICENSE_DEACTIVATION_TOKEN: Import a deactivation response.

Run the following commands on the machine with internet access (online machine):

  • ptl activate TOKEN: Activate an offline token. Auto-detects single and batch tokens.
  • ptl deactivate TOKEN: Deactivate an offline token. Auto-detects single and batch tokens.

Batch commands​

The following commands work on multiple LGS instances. For details, refer to Activate license keys on multiple LGS instances.

  • ptl activate-all "LICENSE_KEY" [ENDPOINT...]: Activate a license key across multiple LGS endpoints in one step.
  • ptl deactivate-all "LICENSE_KEY" [ENDPOINT...]: Deactivate a license key across multiple LGS endpoints in one step.
  • ptl batch-export-activation "LICENSE_KEY" [ENDPOINT...]: Export a batch activation token from multiple LGS endpoints.
  • ptl batch-import-activation TOKEN: Import a batch activation response to all LGS endpoints.
  • ptl batch-export-deactivation "LICENSE_KEY" [ENDPOINT...]: Export a batch deactivation token from multiple LGS endpoints.
  • ptl batch-import-deactivation TOKEN: Import a batch deactivation response to all LGS endpoints.

Endpoint management commands​

The following commands manage the stored LGS endpoints that the batch commands use. For details, refer to Manage stored endpoints.

  • ptl endpoints-add <url>: Save an LGS endpoint URL.
  • ptl endpoints-remove <url>: Remove a stored endpoint.
  • ptl endpoints-list: List all stored endpoints.