dpfcmd command: controls DPF receivers in InfoPrint Manager for Windows and InfoPrint Manager for Linux

Syntax

dpfcmd [-a copies] [-b start-page] [-c] [-d actual-destination] [-e 0|1] [-f number-of-days]
[-g 0|1] [-i inactivity-limit] [-j job-directory] [-k 0|1|2] [-l class] [-m 0|1] [-n description]
[-o submission-priority] [-p port] [-q 0|1] [-r resource-directory] [-s 0|1] [-t]
[-u number-of-hours] [-v 0|1 [-w 0|1] command [receiver-name]

Description

Use dpfcmd to control InfoPrint Manager DPF receivers. All flags apply only to the add and modify commands except -t.

Required flags

-c

Indicates that a configuration file should be used for the add command. It cannot be used together with others flags or with the modify command.

The location of the configuration file is

for Windows:
- ...\var\dpf\receivers\<receiver-name>\
for Linux:
- /var/dpf/receivers/<receiver-name>/

The caller creates all directories and subdirectories in the specified path (receiver-name, jobs, and resources directories).

-d actual-destination

Identifies the actual destination for the add and modify commands.

-p port

Identifies the port number for the add and modify commands.

Optional flags

-a copiesDEFAULT=1: Indicates class copies. Only available if class is specified.
-b start-pageDEFAULT=1: Identifies the start page. Only available if class is specified.
-e {0 | 1} DEFAULT=0: Suppresses end sheets for auxiliary sheets.
-f number-of-daysDEFAULT=0: Identifies the number of days for retention period. Only available if class is specified and class disposition is set to retain or print-and-retain.
-g {0 | 1} DEFAULT=0: Identifies SSL/TLS availability.
-i inactivity-limitDEFAULT=9999: Identifies the inactivity limit.
-j job-directoryDEFAULT=...\var\dpf\receivers\<receiver-name>\jobs\ (for Windows)DEFAULT=/var/dpf/receivers/<receiver-name>/jobs/ (for Linux): Specifies the full path to jobs directory.
-k {0 | 1 | 2} DEFAULT=0: Identifies class disposition. 0: print; 1: retain; 2: print-and-retain. Only available if class is specified.
-l classDEFAULT=A: Identifies class.
-m {0 | 1} DEFAULT=0: Suppresses separator sheets for auxiliary sheets.
-n descriptionDEFAULT=empty string: Identifies the description of the receiver.
-o submission-priorityDEFAULT=50: Identifies the submission priority.
-q {0 | 1} DEFAULT=0: Obtains printer characteristics at start.
-r resource-directoryDEFAULT=...\var\dpf\receivers\<receiver-name>\ (for Windows)DEFAULT=/var/dpf/receivers/<receiver-name>/ (for Linux): Specifies the full path to the resources directory.
-s {0 | 1} DEFAULT=0: Saves resources.
-t: Enables traces. Disables traces with the reset_trace command.
-u number-of-hoursDEFAULT=0: Identifies the number of hours for the retention period. Only available if class is specified and class disposition is set to retain or print-and-retain.
-v {0 | 1} DEFAULT=0: Identifies the forever retention period. Only available if class is specified and class disposition is set to retain or print-and-retain.
-w {0 | 1} DEFAULT=0: Suppresses start sheets for auxiliary sheets.

Note:

The default value applies to the add command. The default value for the modify command is the currently configured value.

Commands

These are the commands to be issued to the DPF receiver. All commands require receiver-name except for the reset_trace command:

add: Adds the specified receiver.
modify: Modifies the specified receiver.
start: Starts the specified receiver.
pause: Pauses the specified receiver.
resume: Resumes the specified receiver.
cancel: Cancels the specified receiver.
nop: Takes no action on the specified receiver.
stop: Stops the specified receiver.
delete: Deletes the specified receiver.
stmopc: Retrieves a new STM/OPC for the specified receiver.
reset-trace: Resets the trace file and tracing options. Omitting a receiver name resets the DPF service tracing.

receiver name is the name of the target receiver. This name is case sensitive. If there are blanks in the receiver name, enclose the receiver name in double quotes.

Examples

Create a DPF receiver
To create the receiver, enter:
```
dpfcmd -p 5010 -d my-ld add dpf1
```
Modify a DPF receiver
To modify the receiver, enter:
```
dpfcmd -g 1 -i 100 modify dpf1
```
Start a DPF receiver
To start the receiver, enter:
```
dpfcmd start dpf1
```
Stop a DPF receiver
To stop the receiver, enter:
```
dpfcmd stop dpf1
```
Delete a DPF receiver
To delete the receiver, enter:
```
dpfcmd delete dpf1
```

RICOH InfoPrint Manager™ for Windows