iprntman (1)

Name

iprntman - Manage iPrint Managers and Driver Stores.

SYNTAX

This section contains iPrint commands and utilities used on the Linux platform.

iprntman <target> <command> <general-options> <options>

DESCRIPTION

Iprntman is a management tool used to manage and configure iPrint print managers, driver stores, printers, and print jobs.

Novell iPrint is a print solution that lets users have global access to printers and a customizable view of the print environment.

HELP

To display help about a specific target, use the following:

Syntax

iprntman <target> \-h or iprntman <target> --help

Example:

iprntman psm -h or iprntman ids --help

TARGET SUMMARY

A target is the iPrint object type you want to manage and includes the target's distinguished name (DN) in LDAP format. For example, if you want to modify settings for a printer with a distinguished cn=colorprinter,ou=printing,o=my_company, the command and target appear as iprntman printer cn=colorprinter,ou=printing,o=my_company.

target_type

banner

target_instance

<banner_name>

target_type

driver

target_instance

<repository_name> <driver_name>>

target_type

ids

target_instance

<IDS_DN>

target_type

job

target_instance

<printer_agent_name <JOBID>>

target_type

pool

target_instance

<pool_name>

target_type

printer

target_instance

<printer_agent_name>

target_type

profile

target_instance

<profile_name>

target_type

psm

target_instance

<print_manager_DN>

target_type

redirprinter

target_instance

<printer_name>

target_type

repos

target_instance

<repository_name>

All distinguished names (DN) should be in LDAP format. If the name of a target instance or option contains a space, use quotes, for example, "HP LaserJet 4Si".

TARGET COMMANDS

Target commands indicate which operation to perform for the specified target. For targets whose name is a distinguished name (DN), the DN is given in LDAP format. For example, to modify settings for a PSM with a DN of cn=manager,ou=printing,o=my_company, iprntman would be invoked as follows:

iprntman psm cn=manager,ou=printing,o=my_company

BANNER COMMANDS

Syntax

iprntman banner <banner_name> <command> <options>

Example

iprntman banner b1 -m -F owner:large -F job-name -F address

-c | --create

Creates a printer banner on the specified server.

-d | --delete

Deletes a printer banner. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Displays information about the specified printer banner.

-I | --property-info

Displays all banner properties.

-l | --list

Lists all printer banners on the server.

-m | --modify

Modifies banner properties. See BANNER OPTIONS for specific options.

DRIVER COMMANDS

Syntax

iprntman driver <repos_name> <driver_name> <command> <options>

Example

iprntman driver driver_windows-nt-5_x86-32_en "HP Color LaserJet 5500 PS" -i

-d | --delete

Deletes a printer driver. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Displays driver information.

-I | --property-info

Lists every object property that is using the CIM class property names.

-l | --list

Lists drivers in a repository.

--download

Downloads the driver .zip file from the IDS.

--upload

Uploads the driver to the IDS.

DRIVER STORE (IDS) COMMANDS

Syntax

iprntman ids <ids_dn> <command> <options>

Example

iprntman ids cn=ids1,ou=print,o=my_company -c --hostname printing.my_company.com --use-directory-server ds.my_company.com

-c | --create

Creates an IDS. See IDS OPTIONS for specific options.

-d | --delete

Deletes an IDS. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Lists information about an IDS.

-I | --property-info

Lists every object property for the specified IDS, using the CIM class property names.

-l | --list

Lists IDS instances.

-m | --modify

Modifies properties of an IDS. See IDS OPTIONS for specific options.

--start

Starts IDS. All IDS instances on the server are started.

--status

Displays the status of the IDS.

--stop

Stops IDS. All IDS instances on the server are stopped.

JOB COMMANDS

Syntax

iprntman job <printer_name> <job_id> <command> <options>

Example

iprntman job HP_ColorLaserJet 3 -l

-d | --delete

Deletes a print job. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Lists information about a print job.

-I | --property-info

Lists every object property for the specified print manager, using the CIM class property names.

-l | --list

Lists all jobs for the specified printer.

-m | --modify

Modifies properties of the target object or service. See OPTIONS for specific options.

--pause

Pauses the processing of a print job.

--resume

Resumes the processing of a print job.

--status

Displays the status of a print job.

POOL COMMANDS

Syntax

iprntman pool <pool_name> <command> <options>

Example

iprntman pool Xerox_printer_pool -c -s server1.my_company.com

-c | --create

Creates a printer pool on the server.

-d | --delete

Deletes a printer pool. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Displays information about a the printer pool.

-I | --property-info

Displays all pool properties.

-l | --list

Lists all printer pools on the server.

-m | --modify

Modifies properties of a printer pool.

PRINT MANAGER (PSM) COMMANDS

Syntax

iprntman psm <psm_dn> <command> <options>

Example

iprntman psm cn=PrintManager1,ou=print,o=my_company -c --hostname printing.my_company.com --use-ids cn=ids,ou=print,o=my_company --use-directory-server ds.my_company.com

-c | --create

Creates a Print Manager. See PRINT MANAGER (PSM) OPTIONS for specific options.

-d | --delete

Deletes the specified Print Manager. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Lists information about the Print Manager.

-I | --property-info

Lists every object property for the specified Print Manager using the CIM class property names.

-l | --list

Lists the Print Manager instances.

-m | --modify

Modifies properties of the specified Print Manager. See PRINT MANAGER (PSM) OPTIONS for specific options.

--defrag-database

Defragments the database of the currently running Print Manager. During the defragmentation process, all print operations are stopped. When completed the Print Manager automatically restarts and print operations resume.

--grant-manager <object_DN>

Adds the object as a manager to the Print Manager’s access control list (ACL), explicitly granting print access to the object. If the printer is a secure printer (see --ssl-required), only users with rights to the printer and supervisors can access the printer. Access can be granted to User, Group, and Container objects. Granting access to a group or container allows contained users and groups to inherit access.

--set-default

Make this Print Manager the default manager. This is useful when you have created several Print Managers running on the same machine and want to specify one to be the default on the next load. When you load a Print Manager, it is automatically set as the default.

--start

Starts the default Print Manager. If the Print Manager DN is given, it starts the Print Manager corresponding to DN; otherwise, the current default Print Manager is started. When a Print Manager is started, it becomes the default Print Manager.

--status

Displays the Print Manager status.

--stop

Stops the running Print Manager. If the Print Manager DN is given, it verifies that the running Print Manager corresponds to the Print Manager DN; otherwise, the currently running Print Manager is stopped.

--force-association

Allows association of the eDirectory printer objects of one print manager with those of another print manager.

PRINTER COMMANDS

Syntax

iprntman printer <printer_name> <command> <options>

Example

iprntman printer Xerox_Color -d -s server1.my_company.com

-c | --create

Creates a Printer Agent. See PRINTER OPTIONS for specific options.

-d | --delete

Deletes the specified Printer Agent. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Lists printer information.

-I | --property-info

Lists every object property for the specified Print Manager using the CIM class property names.

-l | --list

Lists target instances.

-m | --modify

Modifies properties of the printer. See PRINTER OPTIONS for specific options.

--csv-import <filename>

Creates printer agents using a .csv file. The Print Manager generates a text backup file that you can use to recreate a new Print Manager database, or you can add printers to an existing database with your own .csv file. If an error is received during execution of the .csv, any printers created up to the error remain in the database and execution of the file is halted.

--grant-access <object_DN>

Adds the object as a user to the printer’s access control list (ACL), explicitly granting print access to the object. If the printer is a secure printer (see --ssl-required), only supervisors and users with rights to the printer can access the printer. Access can be granted to User, Group, and Container objects. Granting access to a group or container allows contained users and groups to inherit access.

--grant-operator <object_DN>

Adds the object as an operator to the printer’s ACL list, explicitly granting Operator Role access to the object. Only supervisors and users with Operator or Manager rights to the printer can manage the printer. Access can be granted to User, Group, and Container objects. Granting access to a group or container allows contained users and groups to inherit access.

--grant-manager <object_DN>

Adds the object as a manager to the printer’s access ACL list, explicitly granting print access to the object. If the printer is a secure printer (see --ssl-required), only users with rights to the printer and supervisors can access the printer. Access can be granted to User, Group, and Container objects. Granting access to a group or container allows contained users and groups to inherit access.

--pause-input

Pauses printer input.

--pause-output

Pauses output from the printer.

--purge-all-jobs

Deletes all jobs queued for this printer.

--resume-input

Resumes printer input.

--resume-output

Resumes output from the printer.

--revoke-access <object_DN>

Removes the object as a user from the printer’s ACL list, revoking explicitly granted print access from the object.

Removing a user, group, or container from the ACL might not take away the access rights because they might also inherit access based on other permissions.

For example, suppose that the ACL contains user Bob and the group Sales, and Bob is also a member of group Sales. Revoking access from Bob is not sufficient to prohibit Bob’s access to the printer since Bob still inherits rights as a member of the group Sales.

--revoke-manager <object_DN>

Removes the object as a manager from the printer’s ACL list, revoking explicitly granted print access from the object.

Removing a user, group, or container from the ACL might not take away the access rights because they might also inherit access based on other permissions.

For example, suppose the ACL contains user Bob and the group Sales, and Bob is also a member of group Sales. Revoking access from Bob is not sufficient to prohibit Bob’s access to the printer since Bob still inherits rights as a member of the group Sales.

--revoke-operator <object_DN>

Removes the object as an operator from the printer’s ACL list, revoking explicitly granted printer access.

Removing a user, group, or container from the ACL might not take away the access rights because they might also inherit access based on other permissions.

For example, suppose that the ACL contains user Bob and the group Sales, and Bob is also a member of group Sales. Revoking access from Bob is not sufficient to prohibit Bob’s access to the printer since Bob still inherits rights as a member of the group Sales.

--start

Starts the Printer Agent when it is shut down.

--status

Displays the printer status.

--stop

Shuts down the Printer Agent.

PROFILE COMMANDS

Syntax

iprntman profile <platform> <driver_name> <profile_name> <command> <options>

Example

iprntman profile winxp "HP Color LaserJet 5500 PS" HP5500_A4 -i -s server1.my_company.com

-c | --create

Creates a printer profile on the server.

-d | --delete

Deletes a printer profile. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Displays information about the printer profile.

-I | --property info

Displays all profile properties.

-l | --list

Lists printer profiles on the server.

-m | --modify

Modifies printer profile properties.

--download

Download binary profile data.

REDIRPRINTER COMMANDS

Syntax

iprntman redirprinter <printer_name> <command> <options>

Example

iprntman redirprinter HP_5500_PS HP5500_A4 -i -s server1.my_company.com

-c | --create

Creates a redirected or deleted printer on the running Print Manager.

-d | --delete

Deletes a redirected or deleted printer from the Print Manager. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Displays information about the redirected or deleted printer.

-I | --property-info

Displays all properties.

-l | --list

Lists the redirected and deleted printers on the running Print Manager.

-m | --modify

Modifies properties of the redirected or deleted printer.

REPOSITORY (REPOS) COMMANDS

Syntax

iprntman repos <repository_name> <command> <options>

Example

iprntman repos driver_windows-nt-5_x86-32_en -i -s server1.my_company.com

-d | --delete

Deletes a REPOS. This operation prompts interactively to reduce unintentional deletes. To skip the confirmation prompt, use the -f or --force option.

-i | --info

Lists information about the REPOS.

-I | --property-info

Lists every object property, using the CIM class property names.

-l | --list

Lists REPOS instances.

OPTIONS

Options modify the command specified. General Options can be used with all commands in conjunction with target specific options.

GENERAL OPTIONS

-f | --force

Suppresses the display of interactive confirmation prompts for the delete and other operations.

-L | --from-linux

Migrate from a Linux server (OES 1 SP2 or later). If -L or -N option is not included, migration from a NetWare server to OES 2 Linux is the default option.

-N | --from-netware

Migrate from a NetWare Server. If -L or -N option is not included, migration from a NetWare server to OES 2 Linux is the default option.

-p | --passfile <filename>

Specifies a file containing a password for the eDirectory user performing the operation. By default, if a password is required, the user is prompted. For security purposes, ensure that your password file is not readable by other users.

-P | --password

Specifies the password for the eDirectory user performing the operation. Use of this option should be limited because other users can see command line options, including the password. Use--passfile instead.

-r | --requested-properties <property>

Lists the specified properties. Use the property names from--property-info option. For example, to display a list of printers with their current status and location, -r "DeviceID,Status,Location"

-s | --server <host>

Specifies a server host on which to perform the operation, where host is a hostname or IP address. Defaults to localhost.

-u | --username <username>

Specifies a username that is a CN (common name) of the eDirectory user performing the operation. For example: \-u admin

-v | -vv | -vvv | -vvvv | -verbose

Determines the level of detail to display about the execution of operations, with -v displaying a minimum amount of detail and -vvvv displaying the most detail.

-w | --warnings

Disables any warning messages from appearing.

--accept-cert

Automatically accepts any certificates when you make your first CIMOM connection.

--debug

Prints debug messages to a /var/opt/novell/log/migration/iprintmig.log file.

--update

This option synchronizes any changes that have occured in the source server data with the target server. This option must be used in conjunction with the -a option.

--resume

Using this option you can resume the migration process from where it was suspended.

--precheck

Validates the parameters passed for the migration process and return the status without actually starting the migration.

BANNER OPTIONS

--position <location>

Specifies the location of banner text: top, middle, or bottom.

-F | --field <banner_fields>:<font_size>

Specifies the fields to appear on the banner and optionally the font size as small, medium, or large. The default font size is medium.

Fields that can be specified include:

Job-name, owner, address, printer, page-count, submit-time, start-printing-time, nds-full-name, nds-surname, nds-first-name, nds-email-address, nds-telephone number, nds-location, and nds-mail-stop.

DRIVER STORE (IDS) OPTIONS

--hostname <hostname>

When creating URIs for drivers and repositories associated with this IDS, this hostname is used. If not specified, it defaults to whatever is specified by --server.

Example: --server server2.my_company.com --hostname ids.my_company.com

--use-directory-server <ds_hostname>

The directory servers this IDS uses. The hostname can be followed by an optional port, if the directory server is running on a non-standard port. This option can be specified up to three times to designate a primary server and two backup directory servers.

Example: --use-directory-server ds1.my_company.com use-directory-server ds2.my_company.com

DRIVER OPTIONS

--from-ids-zip <zipfile>

For use with the --upload command. The <zipfile> is a .zip file that came directly from an iPrint Driver Store. This option is intended to facilitate scripts for IDS backup/restore or IDS synchronization.

--from-ppd <ppdfile>

For use with the --upload command. The <ppdfile> is a .ppd file for Linux or Mac OS X clients.

POOL OPTIONS

--add-printer <printer_name>

Adds the specified printer to the indicated pool.

--remove-printer <printer_name>

Removes the specified printer from the indicated pool.

PRINT MANAGER (PSM) OPTIONS

--hostname <hostname>

When creating URIs for services associated with this Print Manager, this hostname is used. If not specified, it defaults to whatever is specified by \-\-server. You should use this option with the create (-c) and modify (-m) commands.

Example: --server server1.my_company.com --hostname printserver.my_company.com

--use-ids <DN>

Specifies the IDS that printers on this print manager will use. This option is required when creating a Print Manager.

Example: --use-ids cn=ids,ou=print,o=my_company

--use-directory-server <ds_hostname>

The directory server this print manager uses. The hostname can be followed by an optional port, if the directory server is running on a non-standard port.

Example: --use-directory-server ds1.my_company.com:663

--xml-import <filename>

Import an XML file to create a new Print Manager database.

Example: --xml-import print_system1.xml

PRINTER OPTIONS

--audit-enable <yes|no>

Enables auditing for this printer.

--banner <banner_name>

Specifies the banner you want to use for this printer.

Example: --banner BigBanner

--container <container_DN>

Only valid on printer creation. A directory object corresponding to the printer is created with the DN CN=<printer_name>,<container_DN>. If this option is not used, the print manager's object container is used.

Example: --container ou=printers,o=my_company

--description <description_string>

Set the description of the printer.

Example: --description "Marketing color laser printer"

--direct-print-enabled <yes|no>

Enables or disables iPrint Direct, which lets you print directly to the printer and bypass the iPrint Manager.

--driver-<platform> <driver_name>

Set the IDS driver associated with the printer for the specified platform (win9x, winnt, win2k, winxp, linux, or mac). The driver_name is the name of the driver in the iPrint Driver Store used by the iPrint Print Manager for the printer.

Example --driver -winxp "HP 5 Si/Mx"

--gateway-load-string <load_string>

Lets you specify the gateway load string information. This load string is usually used to specify the printer's IP address. You must use the entire syntax, as shown in the example, every time this option is used. This field is required when creating a printer agent.

Example: --gateway -load -string "iprintgw PORT=LPR HOSTNAME=192.168.0.100 PRINTERNAME=PASSTHROUGH"

If you need to connect to a printer using port 9100, use PORT=RAW.

See iprintgw for options that can be passed to the gateway in the load string.

--location <location_string>

Set the location string of the printer

Example: --location "Second floor, South West corner"

--lpr-input-enabled <yes|no>

Allows the printer to accept LPR print jobs.

--profile-<platform> <profile>

Set the printer profile you want associated with the printer for the specified platform (win9x, winnt, win2k, winxp, linux, or mac). The profile is the name of the profile used by the iPrint Print Manager for the printer.

Example --profile -winxp "HP 5 Si/Mx A4paper"

--ssl-required <yes|no>

Specifies whether or not Secure Sockets Layer (SSL) is required for clients to print to this printer.

PROFILE OPTIONS

--infile

Binary profile data file for create or modify.

--outfile

Output file for download.

--printer-model

Printer model with which this profile was created.

NOTE:Modifying the printer model for profile is not supported.

REDIRECTED (REDIRPRINTER) PRINTER OPTIONS

--time-accessed <last_access_time>

Specifies the date and time a printer was last referenced by a workstation. Enter time in a format such as 25 June 2008 15:27:59. This option is used primarily for migration and disaster recovery.

--time-deleted <deletion_time>

Specifies the date and time a printer was deleted. Enter time in a format such as 25 June 200815:27:59. This option is used primarily for migration and disaster recovery.

--url <printer_url>

Specifies the location of the printer.

EXAMPLES

CREATING A DRIVER STORE

Syntax

iprntman ids <IDS_DN> -c --hostname <DNS_name> --use-directory-server <ds_hostname>

Example

iprntman ids cn=ids1,ou=print,o=my_company -c --hostname printing.my_company.com --use-directory-server ds.my_company.com

CREATING A PRINT MANAGER

Syntax

iprntman psm <print_manager_DN> -c --hostname <DNS_name> --use-ids <IDS_DN> --use-directory-server <ds_hostname>

Example

iprntman psm cn=PrintManager1,ou=print,o=my_company -c --hostname printing.my_company.com --use-ids cn=ids,ou=print,o=my_company --use-directory-server ds.my_company.com

CREATING A PRINTER

Syntax

iprntman printer <printer_agent_name> -c --container <container_DN> --gateway-load-string "iprintgw port=lpr hostaddress=<IP_address> printername=passthrough"

Example

iprntman printer "HP Color LaserJet 5000" -c --container ou=print,o=my_company --gateway-load-string 'iprintgw port=lpr hostaddress=192.0.34.166 printername=passthrough'

LIST IDS REPOSITORIES

Syntax

iprntman repos -l

Example

iprntman repos -l

LIST PRINTER DRIVERS IN REPOSITORY FOR WINDOWS 2000

Syntax

iprntman driver <repository_name> -l

Example

iprntman driver driver_windows-nt-5_x86-32_en -l

UPLOAD PRINTER DRIVER

Syntax

iprntman driver <repository_name <driver_name>> --upload

Example

iprntman driver driver_windows-nt-5_x86-32_en "HP Color LaserJet 5500 PS" --upload

ASSIGN PRINT DRIVER TO PRINTER

Syntax

iprntman printer <printer_agent_name> -m --driver-<platform> <driver_name>

Example

iprntman printer "HP LaserJet 4" -m --driver-winxp "HP LaserJet 4Si"

ENABLE AUDITING AND SSL ON PRINTER

Syntax

iprntman printer <printer_agent_name> -m --audit-enabled yes --ssl-required yes

Example

iprntman printer "HP LaserJet 4" -m --audit-enabled yes --ssl-required yes

MODIFY PRINTER LOCATION AND DESCRIPTION

Syntax

iprntman printer <printer_agent_name> -m --location <location_info> --description <description_info>

Example

iprntman printer "HP LaserJet 4" -m --location "Next to front desk" --description "Color printer with envelope tray"

DELETE A PRINTER

Syntax

iprntman printer <printer_agent_name> -d

Example

iprntman printer "HP Color LaserJet 5000" -d

SPECIFY BANNER INFORMATION

Syntax

iprntman banner <banner_name> -m -F <banner_options>:<font_size>

Example

iprntman banner b1 -m -F owner:large -F job-name -F address

DISPLAY INFORMATION ABOUT A PRINTER

Syntax

iprntman printer <printer_agent_name> -i

Example

iprntman printer "HP LaserJet 4Si" -i

ASSOCIATE DRIVERS TO AN EXISTING PRINTER

Syntax

iprntman printer <printer_agent_name> -m --driver-<platform> <driver_name>

Examples

iprntman printer printer1 -m --driver-winxp "HP LaserJet 4200 PCL 5e"

iprntman printer printer1 -m --driver-win2k "HP LaserJet 3200 Series PCL 5e"

iprntman printer printer1 -m --driver-linux "HP LaserJet 8000 Series"

You can list the drivers in the Driver Store using the following Linux command:

ll /var/opt/novell/iprint/resdir/<platform>

FILES

~/.iprntman/known_hosts

Contains the certificate DN and public key of trusted CIMOMs.

Authors

Copyright 2005-2009, Novell, Inc. All rights reserved. http://www.novell.com

See Also

legal(5)

For more information see the iPrint Administration Guide for Linux at www.novell.com/documentation/oes2/iprint_lx/data/front.html.