Save System using BRM (SAVSYSBRM)
| Where allowed to run: All environments (*ALL) Threadsafe: No |
Parameters Examples Error messages |
The Save System using BRM (SAVSYSBRM) command saves a copy of the Licensed Internal Code and the QSYS library in a format compatible with the installation of the operating system. It does not save objects from any other library. In addition, it saves security and configuration objects that can also be saved using the Save Security Data (SAVSECDTA) and Save Configuration (SAVCFG) commands.
Virtual media and devices can be used with this command. The following restrictions apply to the use of virtual media and virtual devices.
- The Device (DEV) parameter is limited on only one device or *MEDCLS special value for serial operations.
- Execute authority is required to the Load or Unload Image Catalog (LODIMGCLG) command.
- *CHANGE authority is required to the image catalogs.
- Execute (*X) authority is required to each directory in the image catalog path name.
- Read, write, execute (*RWX) authority is required to each image file in the parent directory that will be loaded or mounted.
- *USE authority is required to the virtual devices using the image catalogs.
To use this command, you must have the Backup Recovery and Media Services for IBM i licensed program installed.
Restrictions:
- You must have authority to the SAVSYS command to use this command.
- You must have *SAVSYS special authority to use this command.
- You must have *USE authority to all online auxiliary storage pool devices.
- All subsystems will be ended when using the SAVSYSBRM command and the controlling subsystem will be started once the SAVSYSBRM is complete. You must have job control (*JOBCTL) authority to use the ENDSYS or the ENDSBS command.
- Volumes created using this command that will be used for installation should be initialized with a media class with a density that is supported by the current alternate IPL device. If this is not done, the current IPL volume will have to be changed to a device that supports the density of the created SAVSYSBRM volumes before installation begins.
- Volumes created using the SAVSYSBRM command cannot be used for automatic installation.
- The media class associated with the device must specify Shared media *NO.
- This command should not be used by control group *EXIT item processing as results will be unpredictable.
| Top |
Parameters
| Keyword | Description | Choices | Notes |
|---|---|---|---|
| DEV | Device | Single values: *NONE Other values (up to 4 repetitions): Name, *MEDCLS |
Required, Positional 1 |
| MEDPCY | Media policy | Name, *NONE, *SYSPCY | Required, Positional 2 |
| DTACPR | Data compression | *DEV, *NO, *YES | Optional |
| COMPACT | Data compaction | *DEV, *NO | Optional |
| CTLGRP | Control group | Name, *NONE, *ARCGRP, *BKUGRP, *SYSGRP, *SYSTEM | Optional |
| ENDOPT | End of media option | *REWIND, *LEAVE, *UNLOAD | Optional |
| USEOPTBLK | Use optimum block size | *BKUPCY, *DEV, *NO, *YES | Optional |
| OMIT | Omit | Single values: *BKUPCY, *NONE Other values (up to 3 repetitions): *CFG, *SECDTA, *SYSDTA, *USRASPAUT |
Optional |
| CLEAR | Clear | *NONE, *AFTER, *ALL | Optional |
| STRCTLSBS | Start controlling subsystem | *YES, *NO | Optional |
| EXPDATE | Expiration date | Date, *MEDPCY, *PERM | Optional |
| MOVPCY | Move policy | Name, *MEDPCY, *NONE | Optional |
| MEDCLS | Media class | Character value, *MEDPCY, *SYSPCY | Optional |
| LOC | Location | Name, *MEDPCY, *ANY, *HOME | Optional |
| VOLSEC | Secure volume | *MEDPCY, *NO, *YES | Optional |
| MINVOL | Required volumes | 1-9999, *MEDPCY, *NONE | Optional |
| MARKDUP | Mark volumes for duplication | *MEDPCY, *NO, *YES | Optional |
| MARKHST | Mark history for duplication | *MEDPCY, *NO, *YES | Optional |
| ASPDEV | Auxiliary storage pool | Name, *ALLAVL, *CURASPGRP, *SYSBAS | Optional |
| Top |
Device (DEV)
Specifies the names of the devices used for the save system operation. Each device name must already be known on the system in the BRMS device table. If multiple devices are specified, they must use compatible media classes. If more than one device is used, specify the names of the devices in the order in which they are used. A maximum of four device names can be specified.
This is a required parameter.
You can enter multiple values for this parameter.
- device-name
- Specify the name of the device or devices that you want to use for the system save operation.
Note: Only one media library device or one virtual device can be specified.
- *MEDCLS
- Any device that supports the media class specified in the media policy for this save can be used for this save operation.
| Top |
Media policy (MEDPCY)
Specifies the media policy for the volumes you are creating as a result of processing a system save.
Media policies are used to determine:
- The type of retention to use, such as days, date or version, for media used in control group processing.
- The move policy to use with this media policy.
- The media class to use.
- Whether or not to use save files.
- The type of retention to use, such as days or date for save files created in control group processing.
The media policy you specify must be a media policy that is in the BRMS media policy table.
This a required parameter.
- *NONE
- No media policy is specified for this save operation. Media policy values must be supplied with the save command for each parameter that has a default of *MEDPCY.
- *SYSPCY
- The media policy specified in the system policy is assigned to output volumes from this save operation.
- media-policy
- Specify the name of the media policy that you want to use with this save operation.
| Top |
Data compression (DTACPR)
Specifies whether data compression is used.
- *DEV
- If the save is to tape and the target device supports compression, hardware compression is performed. Otherwise, no data compression is performed.
Note: If *DEV is specified on both the Data compression (DTACPR) parameter and the Data compaction (COMPACT) parameter, only device data compaction is performed if device data compaction is supported on the device. Otherwise, data compression is performed if supported on the device.
If *YES is specified on the Data compression (DTACPR) parameter and *DEV is specified on the Data compaction (COMPACT) parameter, both device data compaction and device data compression are performed if supported on the device.
- *NO
- No data compression is performed.
- *YES
- If the target device supports compression, hardware compression is performed. if compression is not supported, software compression is performed.
| Top |
Data compaction (COMPACT)
Specifies whether data compaction is performed.
Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.
- *DEV
- Device data compaction is performed if the data is saved to tape and all devices specified on the Device (DEV) parameter support the compaction feature.
Note: If *DEV is specified on both the Data compression (DTACPR) parameter and the Data compaction (COMPACT) parameter, only device data compaction is performed if device data compaction is supported on the device. Otherwise, data compression is performed if supported on the device.
If *YES is specified on the Data compression (DTACPR) parameter and *DEV is specified on the Data compaction (COMPACT) parameter, both device data compaction and device data compression are performed if supported on the device.
- *NO
- No data compaction is performed.
| Top |
Control group (CTLGRP)
Specifies the name of the control group that you want to associate with the objects saved by this command. The control group name is stored with the media information and can be used with the Control group (CTLGRP) parameter on other BRMS commands to filter the media information or recover saved objects by control group.
Note: None of the attributes of the control group are used for the save. However, the TEXT field will be updated with text of the control group entries for SAVxxxBRM commands.
If you are using version control for the items you are saving, this save operation will be recorded as part of the specified version control. Version control is specified in the media policy associated with this control group and can be reviewed by using the Work with Media Policies display.
- *NONE
- Do not specify a control group name for this command.
- *ARCGRP
- The name of the default archive control group.
Note: The BRMS Advanced feature (Option 2) is required to use this value.
- *BKUGRP
- The name of the default backup control group used to save all user data.
- *SYSGRP
- The name of the default system control group used to save all system data.
- *SYSTEM
- The name of the default system control group used to save the entire system.
- control-group-name
- Specify the name of the control group to be assigned to the items you are saving.
| Top |
End of media option (ENDOPT)
Specifies the operation that is automatically done on the tape or optical volume after the save operation ends. If more than one volume is included, this parameter applies only to the last volume used; all other volumes are rewound and unloaded when the end of the volume is reached.
Note: For optical devices, *UNLOAD is the only special value supported, *REWIND and *LEAVE will be ignored.
If you specify *LEAVE and the device is a shared device, the device will not be varied off after the save operation. If you specify *LEAVE and the device is not a shared device, the device will be varied off after the save operation.
- *REWIND
- The volume is automatically rewound, but not unloaded, after the operation has ended.
- *LEAVE
- The volume does not rewind or unload after the operation ends. It remains at the current position on the device.
- *UNLOAD
- The volume is automatically rewound and unloaded after the operation ends.
| Top |
Use optimum block size (USEOPTBLK)
Specifies whether or not the optimum block size is used for the save operation.
Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.
- *BKUPCY
- Use the value from the backup policy for the Use optimum block size parameter.
- *DEV
- Use the value specified on the Work with Devices display for the Use optimum block size parameter.
- *NO
- The optimum block size supported by the device is not used. Save commands use the default block size supported by all device types. The tape volume can be duplicated to any media format using the Duplicate Tape (DUPTAP) command or the Duplicate Media using BRM (DUPMEDBRM) command.
- *YES
- The optimum block size supported by the device is used for Save commands. If the block size used is larger than a block size that is supported by all device types then:
- Performance may improve.
- The tape file that is created is only compatible with a device that supports the block size used. Commands such as Duplicate Tape (DUPTAP) and Duplicate Media using BRM (DUPMEDBRM) do not duplicate files unless the files are being duplicated to a device which supports the same block size that was used.
- The value for the Data Compression (DTACPR) parameter is ignored.
| Top |
Omit (OMIT)
Specifies whether system information, configuration objects, security objects or additional basic user auxiliary storage pool information should be omitted during a system save.
Single values
- *BKUPCY
- Use the values specified in the items to omit for the *SAVSYS special value in the backup policy.
- *NONE
- No omissions are to be made for this system save operation.
Other values (up to 3 repetitions)
- *CFG
- All configuration objects are to be omitted for this system save operation.
- *SECDTA
- All security objects are to be omitted for this system save operation.
- *SYSDTA
- The Licensed Internal Code and the QSYS library are to be omitted for this system save operation.
- *USRASPAUT
- Omit the BRMS save of additional authority information for objects in basic user auxiliary storage pools (2-32). This authority information includes the object owner, authority list and primary group.
| Top |
Clear (CLEAR)
Specifies whether uncleared volumes or save files encountered during the save operation are automatically cleared.
- *NONE
- None of the uncleared volumes or save files encountered during the save operation are automatically cleared. If the save operation cannot proceed because an uncleared volume is encountered, an inquiry message is sent to the operator, allowing the ending of the save operation, or specifying that the currently selected volume be cleared so the operation can continue.
If a save file is not cleared, the inquiry message is sent to the work station message queue for an interactive job, or to the operator for a batch job. All volumes used to perform the save operation should be cleared, or the save file must be empty, before the save command is issued.
- *AFTER
- All the uncleared volumes after the initial volume are automatically cleared. This option is not valid for save or restore operations to a save file. If the operation cannot proceed because the first volume is uncleared, an inquiry message is sent to the system operator, allowing him to end the operation or to specify that the currently selected volume be cleared so the operation can continue.
- *ALL
- All the uncleared volumes or save files encountered during the save operation are automatically cleared. If tapes are used and a sequence number is specified, the volume is cleared and, starting with that sequence number, all volumes following the first volume are cleared.
| Top |
Start controlling subsystem (STRCTLSBS)
Specifies whether the controlling subsystem should be automatically restarted when the system save is complete.
- *YES
- The controlling subsystem is restarted when the save operation is complete.
- *NO
- The controlling subsystem is not restarted when the save operation is complete.
| Top |
Expiration date (EXPDATE)
Specifies the expiration that you want to use for output volumes created as a result of this save operation.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *PERM
- Output volumes from this save operation are assigned a permanent expiration.
- expiration-date
- Specify an expiration date with or without date separators that will be assigned to output volumes from this save operation.
| Top |
Move policy (MOVPCY)
Specifies the move policy that you want to use for output volumes created as a result of this save operation.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NONE
- There is not a move policy associated with the output volumes that are created as a result of this save operation.
- move-policy
- Specify a move policy that will be assigned to output volumes from this save operation.
| Top |
Media class (MEDCLS)
Specifies the media class that you want to use for selection of output volumes used in this save operation.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NONE
- There is not a media class associated with the output volumes that are selected for this save operation.
- *SYSPCY
- The value for the media class in the system policy will used to select output volumes for this save operation.
- media-class
- Specify a media class that will be used to select output volumes for this save operation.
| Top |
Location (LOC)
Specifies the location that you want to use for selection of output volumes used in this save operation.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *ANY
- Volumes from any location are selected as output volumes for this save operation.
- *HOME
- Volumes from the home location are selected as output volumes for this save operation.
- location
- Specify the location from which volumes are selected as output volumes for this save operation.
| Top |
Secure volume (VOLSEC)
Specifies whether you want to apply volume security to volumes in this media class. Volumes that are secured can only be read by users with the special authorities *ALLOBJ or *SAVSYS.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NO
- Volume security has not been applied to this media class. Volumes that do not have volume security can be read by anyone.
- *YES
- Only users with special authorities *ALLOBJ or *SAVSYS can read media volumes in this media class.
| Top |
Require volumes (MINVOL)
Specifies the minimum number of expired volumes that must be present before any save can be done using this media policy. The value can also be checked by user jobs using the Check Expired Media for BRM (CHKEXPBRM) command.
Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NONE in this parameter. If you specify MINVOL(*MEDPCY), then the value of the Required volumes field in the referenced media policy must be *NONE.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NONE
- There is no check done to determine the minimum number of required volumes before a save operation begins.
- number-of-volumes
- Specify the number of expired media volumes that must be available before any BRMS save operation will begin. The number can range from 1 to 9999.
| Top |
Mark volumes for duplication (MARKDUP)
Specifies whether media volumes will be marked for duplication. When *YES is selected, all volumes used during a save operation are marked for duplication. You can use VOL(*SEARCH) on the Duplicate Media using BRM command to duplicate the saved items after the save has completed.
Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKDUP(*MEDPCY), then the value of the Mark for duplication attribute in the referenced media policy must be *NO.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NO
- Volumes written to during a save operation will not be marked for duplication.
- *YES
- Volumes written to during the save operation will be marked for duplication.
| Top |
Mark history for duplication (MARKHST)
Specifies whether history items will be marked for duplication. When *YES is selected, all history items created during a save operation are marked for duplication. You must use VOL(*SCHHST) on the Duplicate Media using BRM command to duplicate the saved items.
Note: If the save operation that you are performing is saving data using media of class *ADSM (TSM server), you must specify *NO in this parameter. If you specify MARKHST(*MEDPCY), then the value of the Mark history for duplication attribute in the referenced media policy must be *NO.
Note: This parameter is ignored if the Device (DEVICE) parameter specified is an optical device.
- *MEDPCY
- The value for this parameter is specified in the media policy that is specified in the Media policy (MEDPCY) parameter of this save command.
Note: If *NONE is specified in the Media policy (MEDPCY) parameter, you cannot specify *MEDPCY in this parameter.
- *NO
- History items created during the save operation will not be marked for duplication.
- *YES
- History items created during the save operation will be marked for duplication.
| Top |
Auxiliary storage pool device (ASPDEV)
Use this parameter to specify the auxiliary storage pools from which libraries and objects can be included in the save operation.
- *ALLAVL
- Specifies the save of the backup item is to include objects from the system (1) and basic user auxiliary storage pools (2-32) and all available primary, secondary and UDFS auxiliary storage pools.
- *CURASPGRP
- Specifies libraries or objects from only the auxiliary storage pool group currently set for the job are included in the save. Libraries or objects from the system (1) and basic user auxiliary storage pools (2-32) are omitted from the save.
- *SYSBAS
- Specifies libraries or objects from only the system (1) and basic user auxiliary storage pools (2-32) are included in the save.
- auxiliary-storage-pool-device-name
- Specifies libraries or objects from the named auxiliary storage pool device are included in the save operation. This must be the name of a primary or secondary auxiliary storage pool. Libraries or objects from the system (1) and basic user auxiliary storage pools (2-32) are omitted from the save.
| Top |
Examples
SAVSYSBRM DEV(TAP09) MEDPCY(SAVSYS)
This command saves a copy of the Licensed Internal Code and the QSYS library. In this example, you are saving to device TAP09 using a media policy named SAVSYS.
| Top |
Error messages
*ESCAPE Messages
- BRM1917
- Feature not installed.
- BRM1921
- Feature not licensed.
- BRM4040
- Access denied for user &1.
- BRM40A2
- BRMS product initialization required.
- CPF3700
- All CPF37xx messages could be signaled. xx is from 01 to FF.
- CPF3800
- All CPF38xx messages could be signaled. xx is from 01 to FF.
- CPF9800
- All CPF98xx messages could be signaled. xx is from 01 to FF.
| Top |