ajsbackup

Organization of this page

Format
Description
Execution privileges
Arguments
Notes
Return values
Additional information
Example

Format

ajsbackup
     [-F service-name]
     [-b backup-information-directory-name]
     [-R]
     [-E|-L]
     [-T]
     [{-G|-N|-J}]
     [{-i|-e|-f}]
     [{-m|-a}]
     -n backup-box-name
     unit-name...

To Page Top

Description

Converts a unit into a backup file and stores it in a backup box.

Executing this command causes a single backup file to be created in the specified backup box. The system names the backup file using the least unused value within the range of 0001 to 1024.

If the AJSPRINTNETSCHPRF environment setting parameter specifies the dependency on the schedule for the upper-level jobnet, you can specify either of the following methods to output the unit definition information for the nested jobnet having a schedule rule:

Enable the schedule rule and do not depend on the schedule for the upper-level jobnet.
Delete the schedule rule and depend on the schedule for the upper-level jobnet.

For details about how to set the AJSPRINTNETSCHPRF environment setting parameter, see 20.4.2(79) AJSPRINTNETSCHPRF in the JP1/Automatic Job Management System 3 Configuration Guide

To Page Top

Execution privileges

You must have any of the following JP1 privileges:

JP1_AJS_Admin privilege
JP1_AJS_Manager privilege
JP1_AJS_Editor privilege
JP1_AJS_Operator privilege
JP1_AJS_Guest privilege

We recommend that the user who executes this command have administrator privileges (in Windows systems) or superuser privileges (in UNIX systems).

To Page Top

Arguments

`-F` `service-name`

Specify the name of the target scheduler service.

You can specify a character string of 1 to 30 bytes.

`-b` `backup-information-directory-name`

Specify the full path of the directory if you use a directory other than the backup information directory^# specified at the time of configuration.

You can specify a character string of 1 to 255 bytes.

By default, the system assumes the backup information directory^# specified at the time of configuration.

#: It refers to the directory name specified by the AJSBKUROOT environment setting parameter.

`-R`

Backs up all units in the specified job group or jobnet repeatedly by layers (for details, see Additional information below).

We recommend that you specify the -R option with the -T option. In that case, you can collectively back up each layer of units, thus reducing the size of the entire backup information. If you specify the -R option with the -E, -L, -G, -N, and/or -J options, the system backs up units according to the specification by each option.

`-E`

Backs up jobnets and jobs contained in the jobnets registered for execution.

If you specify this option with the -T, -N, and/or -J options, the system backs up units according to the specification by each option.

`-L`

Backs up jobnets and jobs contained in the jobnets not registered for execution.

If you specify this option with the -T, -N, and/or -J options, the system backs up units according to the specification by each option. You cannot specify this option with the -G option.

`-T`

Backs up root jobnets or recovery jobnets.

If you specify this option with the -L option, the system backs up units according to the specification by the -L option. You cannot specify this option with the -G or -J option.

`-G`

Backs up job groups.

You cannot specify this option with the -L or -T option.

`-N`

Backs up jobnets or recovery jobnets.

If you specify this option with the -L option, the system backs up units according to the specification by the -L option.

`-J`

Backs up jobs, including recovery jobs, QUEUE jobs, recovery QUEUE jobs, OR jobs, and event jobs.

You cannot specify this option with the -T option.

`-i`

Displays a message with a confirmation prompt if the backup destination contains a unit having the same name as a unit to be backed up.

`-e`

Generates an error (without updating information), if the backup destination contains a unit having the same name as a unit to be backed up.

`-f`

Enforces backup (and updates information) if the backup destination contains a unit having the same name as a unit to be backed up.

`-m`

Creates a new backup box before backing up units.

The command terminates abnormally if a backup box has already been created.

`-a`

Adds a backup file to a backup box.

The command terminates abnormally if no backup box has been created.

`-n` `backup-box-name`

Specify the name of the backup box.

You can specify a character string of 1 to 50 bytes.

The name of the backup box depends on the file system of your operating system. It is case-sensitive if you are using UNIX and case-insensitive if you are using Windows.

`unit-name`

Specify the name of the unit to be backed up.

You can specify a character string of 1 to 930 bytes.

You can specify one or more units. If you specify the -R option with the -E, -L, -T, -G, -N, and/or -J options, the system backs up units according to the specification of each option.

You cannot specify a logical host name or execution ID as a unit name.

To Page Top

Notes

Either of the following users can back up a unit:
- A user who has reference privileges for the units to be backed up and the update privilege for the backup box
- A JP1 user mapped to the OS user who has Administrators or superuser privileges
  
  Note, however, that if yes is set after changing the ADMACLIMIT environment setting parameter from its default, even a JP1 user who was mapped to an OS user with Administrators or superuser privileges must have the reference privilege for all units and the update privilege for the backup box.
You can create up to 1,024 backup files in a single backup box. You cannot create 1,025 or more backup files.
If the command is executed for a release target jobnet (root jobnet for which release entry is made), the jobnet definitions in Being applied status are backed up. However, the unit definition information to be backed up does not include the release information.

To Page Top

Return values

0	Normal end
Multiple of 4 within the range from 4 to 124	Abnormal end

To Page Top

Additional information

The following describes an example for backing up units repeatedly by layers:

Example:

If you specify the -R option to back up a job group (group1) having the following structure, the system backs up elements of layers (A) to (H) in separate backup files.

[Figure]

To Page Top

Example

The following command backs up all units contained in job group /Materials/ShipManagement to a newly created backup box, BOX1:

ajsbackup -RTmn BOX1 /Materials/ShipManagement

To Page Top