You are here: Administration > Tools - database, server-command scripting, and APIs (Advanced) > Server commands (server-command)

Server commands (server-command)

The server-command tool provides access to dozens of server operations ranging from user management, system maintenance, account manipulation and printer control. The server-command tool is ideal for controlling the PaperCut NG Application ServerAn Application Server is the primary server program responsible for providing the PaperCut user interface, storing data, and providing services to users. PaperCut uses the Application Server to manage user and account information, manage printers, calculate print costs, provide a web browser interface to administrators and end users, and much more. via the command-line or automating via scripts.

Some examples of how an Administrator might use the server-command tool:

  • Scheduling of online backups and data snapshots.

  • Scheduling user and/or group synchronization tasks.

  • Automating the addition of new users after the accounts are added to the network.

  • Performing account transactions such as adding funds/quota to user accounts.

  • Automating user account creation using custom scripts.

  • Disabling/Enabling printers.

  • Disabling/Enabling printing for users.

  • Controlling user restriction levels.

  • Managing shared accounts.

The server-command program is a command-line tool. It accepts the commands as arguments and outputs the results of the command on the console (standard-out). For security reasons only users with read access to the server.properties (normally only the Administrators group) have rights to execute the commands.

Typical use on a Windows system:

Add $10.00 to a user named 'testuser':

C:\> cd [app-path]\server\bin\win

C:\> server-command adjust-user-account-balance "testuser" 10.00 \ "Added $10.00 to your account"

Note:

Backslash indicates text should be on the same line.

Accessing server commands remotely

Server commands can also be called remotely using standard remote command tools.

On Windows

Use PsExec - a remote command program provided by the Sysinternals team at Microsoft. For example, (all on one line):

psexec.exe \\remoteserver \

"C:\Program Files\PaperCut NG\server\bin\win\server-command.exe" \

disable-printer printsrv1 labprinter -1

On Linux/Novell/Mac

Use SSH - a secure remote command/shell program. You can run SSH non-interactively in scripts with the use of an authorized public key added under the papercut account's ~/.ssh/authorized_keys list. For example, (all on one line):

ssh papercut@remoteserver \

"/home/papercut/server/bin/linux-x64/server-command \

disable-printer printsrv1 labprinter -1"

Available commands

A full list of commands is available via server-command --help.

Usage: server-command COMMAND [ARGS...]

COMMAND : The server command name.

ARGS : A list of arguments to supply to the command.

 

COMMANDS:

user-exists <username>

Test to see if a user exists.

<username> - the username to test.

 

get-user-account-balance <username> [<account>]

Get a user's current account balance.

<username> - the user's username.

[<account>] - Optional personal account name. Used only when multiple personal accountsA personal account is the individual user's account that is charged by default. Each user has their own personal account. are enabled. Leave blank for a total balance.

 

get-user-property <username> <property>

Gets a user property.

<username> - the name of the user.

<property> - the name of the property to get. Valid properties include:

account-selection.mode - the user's current account selection mode

account-selection.can-charge-personal - whether or not the user can charge to their personal account

account-selection.can-charge-shared-from-list - whether or not the user can charge to a shared accountA shared account is an account that is shared by multiple users. For example, in business, shared accounts can be used to track printing costs by business unit, project, or client. Organizations like legal firms, engineering firms, or accounting offices often have long lists of accounts, projects, clients, or matters. In a school or university, shared accounts can be used to track printing by departments, classes, or subjects., selected from a list

account-selection.can-charge-shared-by-pin - whether or not the user can charge to a shared account, selected by PIN

auto-release-jobs - whether or not the user's jobs will always be released on device log in

auto-shared-account - the user's automatically selected shared account name

balance - the user's current account balance

card-pin - the user's card pin number

default-shared-account - the user's default shared account name

department - the user's department

disabled-net - whether or not the user's internet access is currently disabled (deprecated)

disabled-print - whether or not the user's printing is currently disabled

dont-apply-printer-filter-rules - whether or not the printer’s filter settings are applied to the user's jobs

dont-archive - whether or not the user's jobs will be archived

dont-hold-jobs-in-release-station - whether or not the user's job will bypass release queues

email - the user's email

full-name - the user's full name

home - the user's home folder (a double-quoted UNC path)

net-stats.data-mb - the internet data (in MB) used by the user (deprecated)

net-stats.time-hours - the internet time (in hours) used by the user (deprecated)

notes - notes for the user

office - the user's office

other-emails - the user's other emails

overdraft-amount - for restricted usersRestricted users are not allowed to print when their balance reaches zero, or if they have an overdraft, when the overdraft limit is reached., the user’s overdraft limit

primary-card-number - the user's primary card number

print-stats.job-count - the total print job count for the user

print-stats.page-count - the total printed page count for the user

printer-cost-adjustment-rate-percent - percentage rate by which to adjust the user's job cost.

restricted - whether or not the user is currently restricted

secondary-card-number - the user's secondary card number

unauthenticated - whether or not the user is an unauthenticated user

username - alias - the user's alias. Only used when username aliasing is enabled.

 

set-user-property <username> <property> <value>

Sets a user property.

<username> - the name of the user.

<property> - the name of the property to set. Valid properties and values include:

auto-release-jobs - whether or not the user's jobs will always be released on device log in (TRUE or FALSE). Note: If you set this property and the Override printer/device settings check box on the User Details page is not selected in the Admin web interface, all settings below Override printer/device settings will be removed, and only this setting will apply.

balance - the user's current account balance (a decimal number)

card-pin - the user's card pin number (any text)

default-shared-account - the user's default shared account name

department - the user's department (any text)

disabled-net - whether or not the user's internet access is currently disabled (TRUE or FALSE)(deprecated)

disabled-print - whether or not the user's printing is currently disabled (TRUE or FALSE)

dont-apply-printer-filter-rules - whether or not to apply the printer’s filter settings to the user's jobs(TRUE or FALSE). Note: If you set this property and the Override printer/device settings check box on the User Details page is not selected in the Admin web interface, all settings below Override printer/device settings will be removed, and only this setting will apply.

dont-archive - whether or not the user's jobs will be archived (TRUE or FALSE).Note: If you set this property and the Override printer/device settings check box on the User Details page is not selected in the Admin web interface, all settings below Override printer/device settings will be removed, and only this setting will apply.

dont-hold-jobs-in-release-station - whether or not the user's job will bypass release queues (TRUE or FALSE).Note: If you set this property and the Override printer/device settings check box on the User Details page is not selected in the Admin web interface, all settings below Override printer/device settings will be removed, and only this setting will apply.

email - the user's email (an email address, or any text)

full-name - the user's full name (any text)

home - the user's home folder (a double-quoted UNC path)

notes - notes for the user (any text)

office - the user's office (any text)

other-emails - the user's other emails (a comma separated list). Use blank to clear all other emails

overdraft-amount - for restricted users with an overdraft mode of “INDIVIDUAL”, the user’s overdraft limit(a decimal number)

password - the user's password (for internal users only) (any text)

primary-card-number - the user's card number (any text)

printer-cost-adjustment-rate-percent - percentage rate by which to adjust the user's job cost. If equal to or above 0, sets the percentage to <number>. If less than 0 or not a number, display an error. If <number> is blank (""), turn off the “Multiply job costs by” flag. Note: If you set this property and the Override printer/device settings check box on the User Details page is not selected in the Admin web interface, all settings below Override printer/device settings will be removed, and only this setting will apply.

restricted - whether or not the user is currently restricted (TRUE or FALSE)

secondary-card-number - the user's secondary card number (any text)

unauthenticated - whether or not the user is an unauthenticated user (TRUE or FALSE)

username-alias - the user's alias. Only used when username aliasing is enabled.

<value> - the value to set (see <property> for valid values).

 

clear-user-advanced-printer-settings <username>

Clear the Override printer/device settings check box and all settings under it on the User Details page.

Note: This behavior differs from the Admin web interface, in that in the Admin web interface, when you clear the Override printer/device setting check box, all of the settings under it remain.

<username> - the name of the user.

 

adjust-user-account-balance <username> <adjustment> <comment> [<account>]

Adjust a user's account balance.

<username> - the user's username.

<adjustment> - the adjustment amount as a number. +ve or -ve.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

adjust-user-account-balance-if-available <username> <adjustment> \

<comment> [<account>]

Adjust a user's account balance if there is enough credit available.

<username> - the user's username.

<adjustment> - the adjustment amount as a number. +ve or -ve.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

adjust-user-account-balance-if-available-leave-remaining <username> \

<adjustment> <leave-remaining> <comment> [<account>]

Adjust a user's account balance if there is enough credit available

to leave the given amount available in the account.

<username> - the user's username.

<adjustment> - the adjustment amount as a number. +ve or -ve.

<leave-remaining> - the amount to leave in the account.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

adjust-user-account-balance-by-group <group> <adjustment> <comment> \

[<account>]

Adjust the account balance for all users in a group. This process happens in the background.

<group> - the group for which all users' accounts are to be adjusted.

<adjustment> - the adjustment amount as a number. +ve or -ve.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

adjust-user-account-balance-by-group-up-to <group> <adjustment> <limit>

<comment> [<account>]

Adjust the account balance for all users in a group, but don't increase user balance beyond the given limit. This process happens in the background.

<group> - the group for which all users' accounts are to be adjusted.

<adjustment> - the adjustment amount as a number. Must be +ve.

<limit> - don't increase user balance beyond this limit.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

set-user-account-balance <username> <balance> <comment> [<account>]

Set a user's account balance to a set value.

<username> - the user's username.

<balance> - set the account to this value. +ve or -ve.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

 

set-user-account-balance-by-group <group> <balance> <comment> [<account>]

Set the balance for each member of a group to the given value. This process happens in the background.

<group> - the group for which all users' balance is to be set.

<balance> - the value to set all users' balance to. +ve or -ve.

<comment> - a comment to be associated with the transaction.

[<account>] - Optional personal account name. Only used when multiple personal accounts are enabled.

get-user-overdraft-mode <username> <overdraft-mode>

Get a restricted user's overdraft mode.

<username> - the restricted user's username.

<overdraft-mode> - the restricted user’s overdraft mode. Valid values are:

DEFAULT - use the default overdraft limit that is applied to all users and shared accounts.

INDIVIDUAL - use an individual overdraft limit that is specific to the user.

 

set-user-overdraft-mode <username> <overdraft-mode>

Set a restricted user's overdraft mode.

<username> - the restricted user's username.

<overdraft-mode> - set the user’s overdraft mode. Valid values are:

DEFAULT - use the default overdraft limit that is applied to all users and shared accounts.

INDIVIDUAL - use an individual overdraft limit that is specific to the user.

reset-user-counts <username> <reset_by>

Reset the page and job counts associated with a user.

<username> - the user's username.

<reset_by> - name of the user/script/process resetting the counts.

 

re-apply-initial-user-settings <username>

Re-applies initial settings on the user. Initial user settings are based on group membership.

<username> - the user's username.

 

disable-printing-for-user <username> <minutes_disabled>

Disable printing for a user for a set period of time.

<username> - the name of the user to disable printing for.

<minutes_disabled> - the time in minutes to disable. -1 indicates forever.

 

add-new-user <username>

Trigger the process of adding a new user account. Assuming the user exists in the OS/Network/Domain user directory, the account is created with the correct initial settings as defined by the rules set up in the Admin web interface on the Groups tab.

<username> - the user's system username.

 

rename-user <current_username> <new_username>

Rename the given existing user. Use this method with care. Renaming a user should be performed in conjunction with renaming the user in the OS/Network/Domain.

<current_username> - the name of the user to rename.

<new_username> - the user's new name.

 

export-user-data-history <username> <savelocation>

To comply with the EU General Data Protection Regulation (GDPR) Right to Access, export user data from the following reports into five CSV files:

User list

User printing - logs

Shared account security access

User environmental impact - summary

Transaction logs

Note: The files will be owned by the system account running the PaperCut NG process. The output folder must also have write permissions for this user.

<username> - the user's system username.

<savelocation> - the storage location for the five CSV files. This can be a relative path or an absolute path under the home directory of the Application Server's install location. e.g. <home>/server/tmp

delete-existing-user <username> [<flags>]

Delete a user account from the system. Use this with care as this is a one-way operation that cannot be undone. Calling this permanently deletes the user account from the user list (print history records remain).

<username> - the user's system username.

[<flags>] - Available flags include:

permanently-redact-user-data - permanently removes (redact) identifiable user information to comply with the EU General Data Protection Regulation (GDPR) Right to be Forgotten.

The Application Log in the Admin web interface displays the redact event associated with the user.

Data identifying the user is displayed as redacted in the following places:

User Details in the Admin web interface

Application Log

Job Logs in the Admin web interface

Reports

Data identifying the user is no longer displayed in the following places:

Audit Log in the Admin web interface

User environmental impact - summary report of the redacted user

The following user-identifying data elements are unaffected:

Email addresses of the redacted user that are not specified in the User Details in the Admin web interface, for example, scan to email addresses.

Thumbnail previews of archived print jobs containing information that could identify the redacted user.

 

add-new-internal-user <username> <password> <full_name> <email> <card-id>

<pin>

Create a new internal user. Username and password are required. You can omit other properties. Properties can be changed after creation using 'set-user-property'. For more information about internal users, see the user manual section 'Internal users'.

<username> - (required) the username of the new internal user.

<password> - (required) user's password.

<full_name> - (optional) user's full name.

<email> - (optional) user's email address.

<card-id> - the user's card or identity number.

<pin> - the user's card/id PIN.

 

look-up-user-name-by-id-no <id-no>

Looks up the user with the given user id number and prints out their user name. If no match was found an empty line is printed out.

<id-no> - The user id number to look up.

 

look-up-user-name-by-card-no <card-no>

Looks up the user with the given user card number and prints out their user name. If no match was found an empty line is printed out.

<card-no> - The user card number to look up.

 

add-user-to-group <username> <group>

Add a user to the specified group. It changes the group membership within the application not in the OS/Network/Domain user directory.

<username> - the name of the user.

<group> - the name of the group to which the user needs to be added.

 

remove-user-from-group <username> <group>

Remove a user from the specified group. It changes the group membership within the application not in the OS/Network/Domain user directory.

<username> - the name of the user.

<group> - the name of the group from which the user needs to be removed.

 

add-admin-access-user <username>

Add a user as an admin with default admin rights.

<username> - the name of the user.

 

remove-admin-access-user <username>

Remove an admin user from the list of admins.

<username> - the name of the user.

 

add-admin-access-group <groupname>

Add a group as an admin group with default admin rights.

<groupname> - the name of the group.

 

remove-admin-access-group <groupname>

Remove a group from the list of admin groups.

<groupname> - the name of the group.

 

set-user-account-selection-auto-select-shared-account

<username>

<account_name>

<charge_personal>

Sets a user's account selection to charge to a single shared account.

<username> - the name of the user.

<account_name> - Full name of the shared account to charge to.

<charge_personal> - whether or not personal account will be charged. (TRUE or FALSE)

 

set-user-account-selection-auto-charge-personal <username>

Sets a user's account selection to automatically charge to personal. account.

<username> - the name of the user.

 

set-user-account-selection-standard-popup

<username>

<allow_personal>

<allow_list_selection>

<allow_pin_code>

<allow_printing_as_another_user>

<charge_to_personal>

[<default_shared_account>]

Sets a user's account selection to standard account selection popupThe standard account selection popup is a mode for the account selection popup that provides the basic features required to charge to shared accounts. It is ideal for sites with a small number of accounts..

<username> - the name of the user.

<allow_personal> - allow user to charge to personal account.

<allow_list_selection> - allow user to select a shared account from list. (TRUE or FALSE) <allow_pin_code> - allow user to select a shared account using pin.

<allow_printing_as_another_user> - allow user to print as another user.

<charge_to_personal> - when shared account is selected charge to personal account. (TRUE or FALSE)

[<default_shared_account>] - Optional default shared account

 

list-user-accounts

List the names of all the user accounts in the system, sorted by username, one per line.

 

get-total-users

Gets a count of all the users in the system.

 

list-shared-accounts

List the names of all the shared accounts in the system, sorted by shared account name, one per line.

 

list-user-shared-accounts <username> [<ignoreAccountMode>]

List the names of all the shared accounts accessible by the given user sorted by account name, one per line.

<username> - User for which to list accounts

[<ignoreAccountMode>] - Optional. Specify TRUE to ignore user's account selection mode. (TRUE or FALSE)

 

shared-account-exists <account_name>

Test to see if a shared account exists.

<account_name> - the shared account name to test.

 

get-shared-account-account-balance <account_name>

Get shared account's current account balance.

<account_name> - the shared account's full name.

get-shared-account-overdraft-mode <shared_account_name> <overdraft-mode>

Get a restricted shared account's overdraft mode.

<shared_account_name> - the restricted shared account's full name.

<overdraft-mode> - the restricted shared account’s overdraft mode. Valid values are:

DEFAULT - the default overdraft limit that is applied to all restricted users and shared accounts.

INDIVIDUAL - an individual overdraft limit that is specific to the restricted shared account.

 

get-shared-account-property <account_name> <property>

Gets a shared account property.

<account_name> - the name of the shared account.

<property> - the name of the property to get. Valid properties include:

access-groups - the shared account's access groups (a comma separated list). Use blank to clear all groups

access-users - the shared account's access users (a comma separated list). Use blank to clear all users

balance - the shared account's current balance

comment-option - the shared account's commenting option

disabled - whether or not the shared account is currently disabled

invoice-option - the shared account's invoicing option

notes - notes for the shared account

overdraft-amount - for restricted accounts with an overdraft mode of “INDIVIDUAL”, the shared account’s overdraft limit

pin - the shared account's PIN

restricted - whether or not the shared account is currently restricted

 

set-shared-account-property <account_name> <property> <value>

Sets a shared account property.

<account_name> - the name of the shared account.

<property> - the name of the property to set. Valid properties and values include:

access-groups - the shared account's access groups) (a comma separated list)

access-users - the shared account's access users (a comma separated list)

balance - the shared account's current balance (a decimal number)

comment-option - the shared account's commenting option. One of:

NO_COMMENT - no comment can be entered

COMMENT_REQUIRED - a comment must be entered

COMMENT_OPTIONAL - the user can enter a comment or not disabled - whether or not the shared account is currently disabled (TRUE or FALSE)

invoice-option - the shared account's invoicing option. One of:

ALWAYS_INVOICE - print jobs are be invoiced

NEVER_INVOICE - print jobs are never invoiced

USER_CHOICE_ON - the user can choose (default on/yes)

USER_CHOICE_OFF - the user can choose (default off/no)

notes - notes for the shared account (any text)

overdraft-amount - for restricted accounts with an overdraft mode of “Individual”, the shared account’s overdraft limit(a decimal number)

pin - the shared account's PIN (any text, must be unique)

restricted - whether or not the shared account is currently

restricted (TRUE or FALSE)

<value> - the value to set (see <property> for valid values).

 

adjust-shared-account-account-balance <account_name> <adjustment> <comment>

Adjust a shared account's account balance.

<account_name> - the shared account's full name.

<adjustment> - the adjustment amount as a number. +ve or -ve.

<comment> - a comment to be associated with the transaction.

 

set-shared-account-account-balance <account_name> <balance> <comment>

Set a shared account's balance to a set value.

<account_name> - the shared account's full name.

<balance> - set the account to this value. +ve or -ve.

<comment> - a comment to be associated with the transaction.

set-shared-account-overdraft-mode <account_name> <overdraft-mode>

Set a restricted shared account's overdraft mode.

<account_name> - the restricted shared account's full name.

<overdraft-mode> - set the restricted shared account’s overdraft mode. Valid values are:

DEFAULT - the default overdraft limit that is applied to all restricted users and shared accounts.

INDIVIDUAL - an individual overdraft limit that is specific to the restricted shared account.

 

add-new-shared-account <shared_account_name>

Add a new shared account.

<shared_account_name> - the name of the shared account.

 

rename-shared-account <curr_shared_account_name> <new_shared_account_name>

Rename an existing shared account.

<curr_shared_account_name> - Current shared account name. Use a '\' to denote a subaccount e.g.: 'parent\sub'

<new_shared_account_name> - New shared account name.

 

delete-existing-shared-account <shared_account_name>

Delete a shared account from the system. Use this method with care. Calling this permanently deletes it from the shared account list (print history records remain).

<shared_account_name> - the name of the shared account to delete.

 

add-shared-account-access-user <shared_account_name> <username>

Allow the given user access to the given shared account without using a pin.

<shared_account_name> - the name of the shared account to allow access to.

<username> - the name of the user to give access to.

 

add-shared-account-access-group <shared_account_name> <group_name>

Allow the given group access to the given shared account without using a pin.

<shared_account_name> - the name of the shared account to allow access to.

<group_name> - the name of the group to give access to.

 

remove-shared-account-access-user <shared_account_name> <username>

Revoke the given user'- access to the given shared account.

<shared_account_name> - the name of the shared account to revoke access to. <username> - the name of the user to revoke access for.

 

remove-shared-account-access-group <shared_account_name> <group_name>

Revoke the given group's access to the given shared account.

<shared_account_name> - the name of the shared account to revoke access to.

<group_name> - the name of the group to revoke access for.

 

get-printer-property <server_name> <printer_name> <property>

Gets a printer property.

<server_name> - the name of the server the printer is hosted on.

<printer_name> - the name of the printer.

<property> - the name of the property to get. Valid properties include:

disabled - whether or not the printer is currently disabled

print-stats.job-count - the total print job count for this printer

print-stats.page-count - the total printed page count for this printer

cost-model - the cost model used by the printer (e.g. SIMPLE)

advanced-config.<advanced config keyA config key stores information about a specific advanced setting in PaperCut. Config keys are editable by an administrator in the Config Editor. name> - get the advanced config key value that has been set for a device.

custom-field-1 - the value for custom field 1 if set.

custom-field-2 - the value for custom field 2 if set.

custom-field-3 - the value for custom field 3 if set.

custom-field-4 - the value for custom field 4 if set.

custom-field-5 - the value for custom field 5 if set.

custom-field-6 - the value for custom field 6 if set.

 

set-printer-property <server_name> <printer_name> <property> <value>

Sets a printer property.

<server_name> - the name of the server the printer is hosted on.

<printer_name> - the name of the printer.

<property> - the name of the property to set. Valid properties and values include:

disabled - whether or not the printer is currently disabled (TRUE or FALSE)

advanced-config.<advanced config key name> - set an advanced config key value for a device.

custom-field-1 - the value for custom field 1

custom-field-2 - the value for custom field 2

custom-field-3 - the value for custom field 3

custom-field-4 - the value for custom field 4

custom-field-5 - the value for custom field 5

custom-field-6 - the value for custom field 6

override-user-level-settings - whether or not printer should override user level settings. (TRUE or FALSE)

override-user-level-settings-charge-to - the name of the shared account. Use "[personal]" for personal account. Use blank to disable charge to settings.

<value> - the value to set (see <property> for valid values).

 

list-printers

List the names of all the printers in the system, sorted by printer name, one per line.

 

set-printer-cost-simple <server_name> <printer_name> <cost_per_page>

Sets the printer's page cost (using SIMPLE charging model).

<server_name> - the name of the server the printer is hosted on.

<printer_name> - the name of the printer.

<cost_per_page> - the cost per page (simple charging model)

 

get-printer-cost-simple <server_name> <printer_name>

Get the printer's page cost (using SIMPLE charging model).

<server_name> - the name of the server the printer is hosted on.

<printer_name> - the name of the printer.

 

reset-printer-counts <server_name> <printer_name> <reset_by>

Reset the page and job counts associated with a printer.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name.

<reset_by> - name of the user/script/process resetting the counts.

 

add-printer-group <server_name> <printer_name> <printer_group_name>

Add a printer to a single printer groupPrinter groups allow administrators to tag or group printers by attributes. Group names are user definable and can represent any attribute appropriate for printer management. For example, you can group printers by printer type, location, make, function, owner, age, and so on. You can report by printer group and also send notifications per printer group. in addition to existing printer group membership.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name.

<printer_group_name> - name of a printer group.

 

set-printer-groups <server_name> <printer_name> <printer_group_names>

Set the printer groups a printer belongs to, overwriting any existing group membership.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name.

<printer_group_names> - a comma separated list of printer group names. To clear all group association set to "".

 

enable-printer <server_name> <printer_name>

Enable a printer.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name.

 

disable-printer <server_name> <printer_name> <minutes_disabled>

Disable a printer for a set period of time.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name.

<minutes_disabled> - the time in minutes to disable. -1 indicates forever.

 

delete-printer <server_name> <printer_name>

Delete a printer.

<server_name> - the name of the server hosting the printer.

<printer_name> - the printer's name. Use "[All Printers]" to delete all printers on the specified server.

 

rename-printer <server_name> <printer_name> <new_server_name>

<new_printer_name>

Rename a printer. This is useful after migrating a print queueA print queue displays information about documents that are waiting to be printed, such as the printing status, document owner, and number of pages to print. You can use the print queue to view, pause, resume, restart, and cancel print jobs. or print serverA print server is a system responsible for hosting print queues and sharing printer resources to desktops. Users submit print jobs to a print server rather then directly to the printer itself. A print server can be a dedicated server but on many networks this server also performs other tasks, such as file serving (i.e. the printer retains its history and settings under the new name). Note that in some cases case sensitivity is important, so take care to enter the name exactly as it is displayed in the OS.

<server_name> - the existing printer's server name

<printer_name> - the existing printer's queue name

<new_server_name> - the new printer's server name

<new_printer_name> - the new printer's queue name

 

add-printer-access-group <server_name> <printer_name> <group_name>

Adds the user group to the printer's access group list.

<server_name> - the printer's server name

<printer_name> - the printer's queue name

<group_name> - the name of the user group that needs to be added.

 

remove-printer-access-group <server_name> <printer_name> <group_name>

Removes the user group from the printer's access group list.

<server_name> - the printer's server name

<printer_name> - the printer's queue name

<group_name> - the name of the user group that needs to be removed.

 

add-new-group <group_name>

Add a new group to the system's group list. The group should already exist in network directory.

<group_name> - The name of the group to add.

 

sync-group <group_name>

Syncs an existing group with the configured directory server, updates group membership in the system.

<group_name> - The name of the group to sync.

 

remove-group <group_name>

Removes the group.

<group_name> - The name of the group to remove.

 

get-user-groups <user_name>

Retrieves all groups a single user belongs to.

<user_name> - The name of the user to query.

 

list-user-groups

List the names of all the user groups in the system, sorted by groupname, one per line.

 

group-exists <group_name>

Test to see if a group exists.

<group_name> - the group name to test.

 

set-group-quota <group_name> <quota_amount> <period> <quota_max_accum>

<group_name> - the name of the group to set.

<quota_amount> - the quota amount.

<period> - the schedule period (i.e. DAILY, WEEKLY, MONTHLY).

<quota_max_accum> - the quota maximum accumulation amount. Set to 0.0 to have no limit.

 

get-group-quota <group_name>

Get the group quota allocation settings on a given group.

Returns the quota amount, the schedule period and the quota maximumn accumulation amount.

<group_name> - the name of the group to get.

 

use-card <user_name> <card_number>

Redeem a card and place the credit on the user's account.

<user_name> - the name of the user with the account to credit.

<card_number> - the number of the card to use.

 

perform-online-backup

Start an online backup. The back file is written to ~/server/data/backups. as a dated, zipped XML file. This process happens in the background.

 

perform-group-sync

Start the process of synchronizing the system's group membership with the OS/Network/Domain's group membership. A call to this method starts the sync process and the operation completes in the background.

 

perform-user-and-group-sync

Start a full user and group synchronization. This is equivalent to clicking "Synchronize Now" in the Admin web interface. No existing users are removed. Whether or not full details for existing users are updated depends on the current user/group sync settings as defined in the Admin web interface. A call to this method starts the sync process and the operation completes in the background.

 

perform-user-and-group-sync-advanced <delete_old_users> <update_details>

An advanced version of the user and group synchronization process providing control over the sync settings. A call to this method starts the sync process and the operation completes in the background.

<delete_old_users> - set to TRUE remove old users, else FALSE.

<update_details> - set to TRUE if existing users details (e.g. email, full-name, etc) are to be updated.

 

add-new-users

Calling this method starts a specialized user and group synchronization process optimized for tracking down adding any new users who exist in the OS/Network/Domain user directory and not in the system. Any existing user accounts are not modified. A group synchronization is performed only if new users are actually added to the system.

 

is-task-complete

Returns TRUE if a long running task such as perform-group-sync, perform-user-and-group-sync, or add-new-users has completed.

 

get-task-status

Returns status information such as progress, completion status and, error messages, on the current or last run long running task such as perform-group-sync, perform-user-and-group-sync, or add-new-users.

 

batch-import-shared-accounts <import_file> <test>

<delete_non_existent_accounts>

Import the shared accounts contained in the given tab-delimited import file.

<import_file> - the import file location.

<test> - (TRUE or FALSE) If TRUE, perform a test only. The printed statistics show what would have occurred if testing wasn't enabled. No accounts are modified.

<delete_non_existent_accounts> - (TRUE or FALSE) If TRUE, accounts that do not exist in the import file but exist in the system are deleted. If FALSE, they are ignored.

 

batch-import-users <import_file> <create_new_users>

Import the users contained in the given tab-delimited import file. See the user manual section 'Batch User Data Import and Update' for a description of the file format.

<import_file> - the import file location.

<create_new_users>

If TRUE, users only existing in the import file are newly created, otherwise ignored.

 

batch-import-internal-users <import_file> <overwrite_existing_passwords>

<overwrite_existing_pins>

Import the internal users contained in the given tab-delimited import file. See the user manual section section 'Batch internal user import file format' for a description of the file format.

<import_file> - the import file location.

<overwrite_existing_passwords> (optional, default TRUE) - (TRUE or FALSE) If TRUE, passwords from the import file overwrite existing passwords where a user already has a has a password set. If FALSE, existing passwords are not changed.

<overwrite_existing_pins> (optional, default TRUE) - (TRUE or FALSE). If TRUE, PINs from the import file overwrite existing PINs where a user already has a has a PIN set. If FALSE, existing PINs are not changed.

 

batch-import-user-card-id-numbers <import_file> <overwrite_existing_pins>

Import the user card/ID numbers and PINs contained in the given tab-delimited import file. See the user manual section 'Advanced User Management' for a description of the file format).

<import_file> - the import file location.

<overwrite_existing_pins> (optional, default TRUE) - (TRUE or FALSE). If TRUE, PINs from the import file overwrites existing PINs where a user already has a has a PIN set. If FALSE, existing PINs are not changed.

 

create-user-client-accounts-file

Saves a file containing shared accounts data for the User ClientThe User Client tool is an add-on that resides on a user's desktop. It allows users to view their current account balance via a popup window, provides users with the opportunity to confirm what they are about to print, allows users to select shared accounts via a popup, if administrators have granted access to this feature, and displays system messages, such as the "low credit" warning message or print policy popups.. See the manual for more information on how you can use this feature. The file is saved on the server to the location:

[app-path]\server\data\client\client-accounts.dat

If this file already exists it is over-written.

 

get-config <config-name>

Gets the value of the given config value printing the result. If the config value does not exist, a blank string is displayed.

<config-name> - the name of the config value to get.

 

set-config <config-name> <config-value>

Sets the value of the give config item.

NOTE: Take care updating config values. You might cause serious problems that can be fixed only by reinstallation of the application. Use the set-config command at your own risk.

<config-name> - the name of the config value to set.

<config-value> - the value to set.

 

process-job <job-details>

Takes the details of a job and logs and charges as if it were a "real" job. Jobs processed via this method are not susceptible to filtersFilters allow you to control attributes of the print settings by either forcing a particular attribute or denying a a print job that does not meet specific criteria. There are two types of print filters: conversions and restrictions., popups, hold/release queues etc., they are logged. See the user manual section "Importing Job Details" for more information and the format of <job-details>.

<job-details> - the details of the job to log.

 

run-command command-name [command args]

Runs a custom command on the server. By default the server does not include any custom commands. The command arguments depend on the custom command being run.

Tip:

Comments

Share your findings and experience with other PaperCut users. Feel free to add comments and suggestions about this Knowledge Base article. Please don't use this for support requests.