PLOSSYS CLI¶

PLOSSYS CLI is the command line interface for PLOSSYS Output Engine. It is used for administrating the system configuration, the services, the flows, the printers, additional printer configurations and the jobs.

Requirements¶

Call PLOSSYS CLI¶

Windows: In a Command Prompt or in a PowerShell
Linux: In a Linux shell

Usage: plossys [options] [command]

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  job             manage jobs
  printer         manage printers
  printer-config  manage printer configurations
  config          manage configuration
  log             show human-readable log
  license         manage license
  service         manage services
  flow            manage flows
  security        manage security configurations
  help [command]  display help for command

Privileges¶

The commands for administrating the services execute PowerShell scripts on Windows and bash scripts on Linux. For more information about the privileges for this, refer to the installation requirements for Windows or for Linux.

Environment Variables¶

When using an OIDC identity provider for user authentication, environment variables have to be set for calling PLOSSYS CLI. For how to configure the environment for PLOSSYS CLI, refer to the configuration steps for the Output Engine server on Windows or on Linux.

Display the Version of PLOSSYS CLI¶

plossys --version

Display the Usage of PLOSSYS CLI¶

plossys --help

PLOSSYS CLI Commands in Detail¶

Refer to the description of the specific PLOSSYS CLI commands: