SAVLICPGM (Save Licensed Program)

SAVLICPGM Command syntax diagram

 

Purpose

The Save Licensed Program (SAVLICPGM) command saves a copy of the objects that make up a licensed program. It saves the licensed program in a form that can be restored by the Restore Licensed Program (RSTLICPGM) command.

 

Restrictions

  1. This command is shipped with public *EXCLUDE authority.

  2. Some licensed programs can only be saved if the user is enrolled in the system distribution directory. See the publication for each licensed program for a description of this restriction.

  3. This command does not save code or language objects for the base OS/400 system.

 

Required Parameters

LICPGM
Specifies the 7-character identifier of the licensed program to be saved. A list of the IBM-supplied licensed programs is in the Software Installation Link to PDF book.

DEV
Specifies the name of the device on which the objects are saved. The device name must already be known on the system by a device description.

Up to four tape device names can be specified. Only one save file name can be specified and only one media library device name can be specified.

*SAVF: The product is saved in the save file specified on the SAVF parameter.

optical-device-name: Specify the name of the optical device used for the save operation.

tape-media-library-device-name: Specify the name of the tape media library device used for the save operation.

tape-device-name: Specify the names of one or more tape devices used for the save operation. If multiple tape devices are used, they must have compatible media formats and their names must be specified in the order in which they are used. Using more than one tape device permits one tape volume to be rewound and unloaded while another tape device processes the next tape volume.

 

Optional Parameters

OPTION
Specifies which of the optional parts of the licensed program given in the LICPGM parameter are saved.

*BASE: Only the base part of the licensed program is saved.

number-of-licensed-program-option: Specify the number of the optional part of the listed licensed program that is saved.

RLS
Specifies which version, release, and modification level of the product is saved.

*ONLY: Only one version, release, and modification level is installed for the product option.

release-level: Specify the release level in VxRyMz format, where Vx is the version number, Ry is the release number, and Mz is the modification level. The variables x and y can be a number from 0 through 9, and the variable z can be a number from 0 through 9 or a letter from A through Z.

LNG
Specifies the language saved for the product specified.

Note: This parameter is ignored when OBJTYPE(*PGM) is specified.

*PRIMARY: The primary language is saved. The primary language is the language of the operating system.

*ALL: All languages for this product option are saved.

feature-code: Specify the language feature identifier for the language that is saved for the product.

OBJTYPE
Specifies the type of product objects being saved.

*ALL: Program and language objects specified on the LNG parameter are saved.

*PGM: Only the program objects for the product are saved.

*LNG: The objects associated with the language identified on the LNG parameter are saved.

CHKSIG
Specifies if the digital signatures of objects being saved with the licensed program are to be checked.

*SIGNED: Objects with digital signatures are checked. Objects that are not digitally signed will not have their signatures verified. Any signed object with a signature that is not valid will be identified in a message in the job log and the save will fail.

*ALL: All objects that can be digitally signed are checked. Any object that can be signed but has no signature will be identified in a message in the job log. The save will not be terminated for unsigned objects. Any signed object with a digital signature that is not valid will be identified in a message in the job log and the save will fail.

*NONE: Digital signatures of objects will not be checked.>

VOL
Specifies the volume identifiers of the tape volumes on which the product data is saved. The volumes must be placed in the tape device in the same order as the volume identifiers are specified in this parameter. Up to 75 entries can be specified.

*MOUNTED: The licensed program data is saved on whatever volumes are placed in the tape device. For a media library device, the volume to be used is the next cartridge in the category mounted by the Set Tape Category (SETTAPCGY) command.

volume-identifier: Specify the identifiers of one or more volumes in the order they are placed in the tape device and used to save the licensed program.

SEQNBR
Specifies which sequence number is used for the save operation.

*END: The system saves the licensed program starting after the last sequence number on the first tape. If the first tape is full, an error message is issued and the operation ends.

file-sequence-number: Specify the sequence number of the file. Valid values range from 1 through 16777215.

EXPDATE
Specifies the end date of the tape save/restore files. If a date is specified, the files are protected and cannot be overwritten until the specified expiration date.

*PERM: The save and restore files are permanently protected.

expiration-date: Specify the date when the save/restore files are no longer protected.

ENDOPT
Specifies the operation that is automatically performed on the tape or optical volume after the save operation ends. If one or more volumes of tape is involved, this parameter applies only to the last volume.

Note: This parameter is valid only if a tape or optical device name is specified on the DEV parameter. For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.

*REWIND: The tape is automatically rewound, but not unloaded, after the operation has ended.

*LEAVE: The tape does not rewind or unload after the operation ends. It remains at the current position on the tape drive.

*UNLOAD: The tape is automatically rewound and unloaded after the operation ends. Some optical devices will eject the volume after the operation ends.

SAVF
Specifies the qualified name of the save file used to contain the save data. The save file must be empty or CLEAR(*ALL) must be specified.

The name of the save file can be qualified by one of the following library values:

*LIBL: All libraries in the job's library list are searched until the first match is found.

*CURLIB: The current library for the job is searched. If no library is specified as the current library for the job, the QGPL library is used.

library-name: Specify the name of the library to be searched.

save-file-name: Specify the name of the save file.

TGTRLS
Specifies the release level of the operating system on which you intend to restore and use the product. When specifying the target-release value, the format VxRxMx is used to specify the release, where Vx is the version, Rx is the release, and Mx is the modification level. For example, V3R6M0 is version 3, release 6, modification level 0.

Valid values depend on the current version, release, and modification level, and they change with each new release. See the Valid Values for TGTRLS Parameter table in the Backup and recovery topic in the Information Center for a complete list of valid values.

Note: This value is limited by the minimum operating system release specified when the product was created.

*CURRENT: The product is to be restored to, and used on, the release of the operating system currently running on your system. The product can also be restored to a system with any subsequent release of the operating system installed.

*PRV: The product is to be restored to the previous release with modification level 0 of the operating system. The product can also be restored to a system with any subsequent release of the operating system installed.

target-release: Specify the release in the format VxRxMx. The product can be restored to a system with the specified release or with any subsequent release of the operating system restore.

CLEAR
Specifies whether tapes, diskettes, or save files that contain active data are automatically cleared, or optical volumes are automatically initialized. Active data is any media file that has not expired.

 

Notes

  1. Clearing a tape does not initialize it. You should initialize tapes to a standard label format before the save command is issued by using the Initialize Tape (INZTAP) command and specifying a value on the NEWVOL parameter.

  2. Clearing an optical volume does initialize it.

*NONE: None of the media is automatically cleared. If the save operation encounters active data on a tape, diskette, or save file, an inquiry message is sent, allowing the operator to either end the save operation or clear the media. If the save operation encounters the specified optical file, an inquiry message is sent, allowing the operator to either end the save operation or replace the file.

*ALL: All of the media is automatically cleared.

If tapes are used and a sequence number is specified on the SEQNBR parameter, the first tape is cleared beginning at that sequence number. All tapes following that first tape are completely cleared. To clear the entire first tape, SEQNBR(1) must be specified.

*AFTER: All media after the first volume is automatically cleared. If the save operation encounters active data on the first tape or diskette, an inquiry message is sent, allowing the operator to either end the save operation or clear the media. If the save operation encounters the specified optical file on the first volume, an inquiry message is sent, allowing the operator to either end the save operation or replace the file.

Note: The *AFTER value is not valid for save files.

*REPLACE: Active data on the media is automatically replaced. Tapes are automatically cleared in the same way as the *ALL value.

DTACPR
Specifies whether data compression is performed.

*DEV: If the tape device has the hardware compression feature installed, processing proceeds as if DTACPR(*YES) is specified. If the compression feature is not specified or if save data is written to optical or a save file, processing proceeds as if DTACPR(*NO) is specified.

*NO: No data compression is performed.

*YES: Program data compression is performed. If the program is saved to tape and the target device has the hardware compression feature, hardware compression is performed. If the feature is not present or if the product is being saved to an optical or save file, software compression is performed. If the save operation is running while other jobs on the system are active, and software compression is used, there may be an effect on the overall system performance.

LICACPRQD
Specifies whether or not the user will be prompted for license acceptance when the saved licensed program is restored. If the licensed program being saved does not have online software agreements, no prompt will be done at restore time. This parameter does not affect the license acceptance status of the licensed program currently installed.

Note:

  1. If the software agreement of the product has not previously been accepted, as will be the case for a product that is being created and is only packaged, then this parameter is ignored.

*NO: License acceptance will not be required when the saved licensed program is restored.

*YES: License acceptance will be required when the saved licensed program is restored, if the licensed program being saved has online software agreements.>

Examples for SAVLICPGM

Example 1: Tapes Cleared Automatically 

SAVLICPGM   LICPGM(5716WP1)  DEV(TAP01)  CLEAR(*ALL)

This command saves the *BASE option of the OfficeVision licensed program. It is saved on the tape that is in the TAP01 tape drive. Each uncleared tape is cleared automatically when it is encountered, and the save operation continues without operator intervention.

Example 2: Saving on Labeled Tape Volume 

SAVLICPGM   LICPGM(5716WP1)  DEV(TAP01)  VOL(ABCDE)

The *BASE option of the OfficeVision licensed program is saved on the TAP01 tape drive, starting on the tape volume labeled ABCDE. If the save operation exceeds the storage capacity of one tape, a message requesting that another volume be placed in the TAP01 tape drive is shown to the operator.

Example 3: Saving on Multiple Volumes 

SAVLICPGM   LICPGM(5716SS1)  OPTION(2)  DEV(TAP01 TAP02)

The online help option of the OS/400 system is saved on tape drives TAP01 and TAP02 in alternating order. If the save operation exceeds the storage capacity of two tapes, a message requesting that another volume be put on TAP01 is shown to the operator. The tapes are rewound at the completion of the save operation.

Example 4: Saving to Save Files Cleared Automatically 

SAVLICPGM   LICPGM(5716WP1)  DEV(*SAVF)
  CLEAR(*ALL)  SAVF(MYLIB/MYSAVF)

This command saves the base option of the OfficeVision licensed program. It is saved to the save file MYSAVF in the library MYLIB. The save file MYSAVF is cleared automatically and the save operation continues without operator intervention.

Example 5: Saving program objects to a save file 

SAVLICPGM   LICPGM(1MYPROD)  OPTION(*BASE)
  DEV(*SAVF)  RLS(*ONLY)  OBJTYPE(*PGM)
  SAVF(MYLIB/MYSAVF)

The 1MYPROD product consists of two libraries and does not have any folders. Only the program objects for 1MYPROD product will be saved in the save file, MYSAVF, in MYLIB library.

Example 6: Saving all objects in one library to a save file 

SAVLICPGM   LICPGM(1MYPROD)  OPTION(*BASE)
  DEV(*SAVF)  RLS(*ONLY)  LNG(2924)
  OBJTYPE(*ALL)  SAVF(MYLIB/MYSAVF)

The 1MYPROD product consists of only one library and does not have any folders. The program objects and language objects for the NLV 2924 of 1MYPROD product will be saved in the save file, MYSAVF, in MYLIB library.

Example 7: Saving all objects in two libraries to a save file 

SAVLICPGM   LICPGM(1MYPROD)  OPTION(*BASE)
  DEV(*SAVF)  RLS(*ONLY)   LNG(2924)
  OBJTYPE(*ALL)  SAVF(MYLIB/MYSAVF)

The 1MYPROD product consists of two libraries and has one root folder with the *PGM objects, and one subfolder of that root folder with the *LNG objects. The program objects and language objects for the NLV 2924 of 1MYPROD product will be saved in the save file, MYSAVF, in MYLIB library.

Example 8: Saving for a previous release. 

SAVLICPGM   LICPGM(1MYPROD)  DEV(TAP01)  TGTRLS(*PRV)

The 1MYPROD product will be saved to TAP01 and may be restored on a system with the previous release of the operating system installed.

Error messages for SAVLICPGM

*ESCAPE Messages

CPF37A2
Licensed program &1 not valid.
CPF3728
Device &1 specified with other devices.
CPF3733
&2 &1 in &3 previously damaged.
CPF3884
Licensed program &1 option &2 not processed.