ajsagtalt

Organization of this page

Format
Description
Execution privileges
Arguments
Notes
Return values
Example 1
Example 2
Example 3
Example 4

Format

ajsagtalt
     [-h logical-host-name]
     {-a execution-agent-name
        [-s execution-host-name]
        [-c time-time=maximum-number-of-concurrently-executable-jobs,...]
        [-d description] |
      -a execution-agent-name -t {e|i|h|b} |
      -g execution-agent-group-name -d comment |
      -g execution-agent-group-name -l execution-agent-name[:priority] |
      -g execution-agent-group-name -m execution-agent-name[:priority] |
      -g execution-agent-group-name -u execution-agent-name |
      -g execution-agent-group-name -t {e|i|h|b} |
      -a execution-agent-name -e {u|m}}

Format1 (for changing the execution agent settings)

ajsagtalt
     [-h logical-host-name]
     -a execution-agent-name
     [-s exec-host-name]
     [-c time-time=maximum-number-of-concurrently-executable-jobs,...]
     [-d description]

Format2 (for changing the execution agent group settings)

ajsagtalt
     [-h logical-host-name]
     -g execution-agent-group-name
     -d description

Format3 (for adding an execution agent to an execution agent group)

ajsagtalt
     [-h logical-host-name]
     -g execution-agent-group-name
     -l execution-agent-name[:priority]

Format4 (for changing the priority of an execution agent in an execution agent group)

ajsagtalt
     [-h logical-host-name]
     -g execution-agent-group-name
     -m execution-agent-name[:priority]

Format5 (for removing an execution agent from an execution agent group)

ajsagtalt
     [-h logical-host-name]
     -g execution-agent-group-name
     -u execution-agent-name

Format6 (for changing the job transfer restriction status of an execution agent)

ajsagtalt
     [-h logical-host-name]
     -a execution-agent-name
     -t {e|i|h|b}

Format7 (for changing the job transfer restriction status of an execution agent group)

ajsagtalt
     [-h logical-host-name]
     -g execution-agent-group-name
     -t {e|i|h|b}

Format8 (for changing the status of an execution agent)

ajsagtalt
     [-h logical-host-name]
     -a execution-agent-name
     -e {u|m}

To Page Top

Description

The ajsagtalt command changes the settings of an execution agent or execution agent group, or changes the job transfer restriction status of an execution agent or execution agent group.

To Page Top

Execution privileges

This command can be executed by a user at either of the following JP1 permission levels:

JP1_JPQ_Admin privilege
JP1_JPQ_Operator privilege

Users at this permission level can only perform either of the following operations:
- Changing the job transfer restriction status of an execution agent or execution agent group (-t option).
- Changing the status of an execution agent (-e option).

To Page Top

Arguments

`-h` `logical-host-name`

Specify the logical host name of the local host on which the execution agent or execution agent group whose settings you want to change is registered.

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

If this option is omitted, the logical host name specified in the JP1_HOSTNAME environment variable is assumed. If the JP1_HOSTNAME environment variable is not specified, the physical host name is assumed.

For a physical host, make sure that you specify neither this option nor the JP1_HOSTNAME environment variable.

`-a` `execution-agent-name`

Specify the name of the execution agent whose settings you want to change.

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

`-g` `execution-agent-group-name`

Specify the name of the execution agent group whose settings you want to change.

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

`-s` `exec-host-name`

Specify the execution host name (agent host name).

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

You can specify this option only if the -a option is specified.

The name of the execution host to be specified must be resolved correctly. Before executing the command, set the name of the execution host to be specified in the hosts file or on a DNS server. If an execution host name that a manager host cannot resolve is specified, command execution might take a long time.

For details about name resolution, see 2.2.2(4) Notes on manager/agent system configurations in the JP1/Automatic Job Management System 3 System Design (Configuration) Guide.

`-c` `time-time=maximum-number-of-concurrently-executable-jobs,...`

Specify the time periods for which you want to change the maximum number of concurrently executable jobs, together with the new values for the maximum number of concurrently executable jobs.

By specifying the maximum number of concurrently executable jobs, you can limit the number of jobs that can concurrently be executed on this execution agent. The specified limit is applied to UNIX, PC, flexible, HTTP connection, action, custom, and passing information setting jobs. If an attempt is made to execute a job when the number of concurrently executing jobs has already reached the maximum, the job is queued to wait until the number of concurrently executing jobs becomes smaller than the maximum.

The time period is specified by using the start and end times separated by a hyphen (-). Both times are specified in hh:mm format where mm is specified in units of 30 minutes.

For hh, you can specify 0 or a value in the range from 00 to 23 (hours).

For mm, you can specify 0, 00, or 30 (minutes).

For maximum-number-of-concurrently-executable-jobs, you can specify a value from 0 to 4,294,967,295.

You can specify multiple combinations of time period and maximum number of concurrently executable jobs. To do this, use a comma (,) to separate each occurrence of time-time=maximum-number-of-concurrently-executable-jobs without inserting a space. You can specify a maximum of 48 time periods. If you specify overlapping time periods, the last specified value takes effect for the maximum number of concurrently executable jobs. For example, if you specify -c 1:00-2:30=5,2:00-4:00=10, the time period from 2:00 to 2:30 overlaps. For this time period, 10 is applied as the maximum number of concurrently executable jobs.

For time periods that are not specified, the maximum number of concurrently executable jobs is not changed.

If the command is executed during a specified time period, the maximum number of concurrently executable jobs for the time period is immediately changed.

You can specify this option only if the -a option is specified.

`-d` `description`

Specify a comment on the execution agent or execution agent group.

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

You can specify this option only if the -a or -g option is specified.

`-l` `execution-agent-name[:priority]`

Specify the name of an execution agent to be associated with the execution agent group. Following the execution agent name, you can also specify the priority of the execution agent in the execution agent group. If you specify the priority, place a colon (:) as a separator between the execution agent name and the priority.

Make sure that you specify an execution agent name that has already been registered.

You can use 1 to 255 bytes to specify an execution agent name.

As the priority value, you can specify 1 to 16 where 1 is lowest and 16 is highest. A job with a higher priority value is executed earlier. If the priority is omitted, 16 is assumed.

You can specify this option only if the -g option is specified.

`-m` `execution-agent-name[:priority]`

Specify this option if you want to change the priority of an execution agent in the execution agent group. Specify the execution agent name and the new priority with an intervening colon (:).

You can use 1 to 255 bytes to specify the execution agent name.

As the priority value, you can specify 1 to 16 where 1 is lowest and 16 is highest. A job with a higher priority value is executed earlier. If the priority is omitted, 16 is assumed.

You can specify this option only if the -g option is specified.

`-u` `execution-agent-name`

Specify the name of an execution agent you want to remove from the execution agent group.

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

You can specify this option only if the -g option is specified.

`-t {e|i|h|b}`

Specify this option if you want to change the job transfer restriction status of an execution agent or execution agent group to be added.

Value	Status	Description
`e`	Effective	Jobs are accepted and then delivered to the target host.
`i`	Ineffective	New jobs are not accepted but the jobs that have already been accepted are delivered to the target host.
`h`	Hold	Jobs are accepted but are not delivered to the target host.
`b`	Blockade	Jobs are neither accepted nor delivered to the target host.

You can specify this option only if the -a or -g option is specified.

`-e {u|m}`

Specify this option to change the status of an execution agent. You cannot change the status to Connectable or Unconnectable.

Value	Status	Description
`u`	Not checked	The communication status will be checked. After the check is completed, the status will change to Connectable or Unconnectable.
`m`	Unavailable	Suppress job distribution.

This option can be executed only when the job distribution delay reduction function is enabled. If this function is disabled, an error occurs.

If you stop the JP1/AJS3 service when the status of the execution agent is not Unavailable, the status changes to Not checked.

If you add an execution agent by using the ajsagtadd command or by using the automatic agent definition function, the status of the added execution agent will be Not checked.

If you change the execution host name by using the -s option, the status of the execution agent is set to Not checked. However, if the execution host name is set again to the same host name, the status is not changed. The execution host name field is not case sensitive.

If different execution agents are registered on the same execution host, you need to execute the command for each execution agent.

To Page Top

Notes

The maximum number of concurrently executable jobs, the job transfer restriction status, and the execution agent priority specified by this command are not applied to event jobs and custom event jobs.
This command cannot be used for a request from JP1/AJS3 to JP1/OJE for VOS3.
This command cannot be executed for JP1/AJS3 - Manager installed on another host.
If any jobs (PC jobs, Unix jobs, flexible jobs, HTTP connection jobs, custom jobs, or action jobs) are running, you must include an execution agent in an execution agent group.
If any jobs (PC jobs, Unix jobs, flexible jobs, HTTP connection jobs, custom jobs, action jobs, event jobs, or custom event jobs) are running, you cannot change the execution host.
You cannot change the execution host used as the default execution agent (named @SYSTEM). For details about the default execution agent, see 5.1.4 Default execution agent in the manual JP1/Automatic Job Management System 3 Overview.
Consecutive single-byte space characters at the end of explanatory text might become invalid. Do not end explanatory text with single-byte space characters.
When a command with the -u option specified is being executed, if a job is executed in an execution agent in the execution agent group specified by the -g option, start of the job execution might be delayed (in a queuing state) by a maximum of 20 seconds depending on timing. For this reason, execute the command when no job in a queuing state exists in the execution agent group specified by the -g option.
The maximum number of ajsagtadd, ajsagtalt, and ajsagtdel commands that can be executed concurrently on the same host is five. If you attempt to execute more than five commands, the commands terminate abnormally.

To Page Top

Return values

0	Normal end.
4	An environment variable used for command execution is incorrect. The JP1/AJS3 service is not running. The `-h` option is specified but the specified logical host does not exist or environment settings are incorrect. The specified execution agent does not exist. The specified execution agent group does not exist. The authentication server is not running. A job is running. An error occurred in communication with the JP1/AJS3 service. When the `-e` option was specified, the job distribution delay reduction function was disabled.
8	An argument specified in the command is incorrect.
12	Memory became insufficient during command processing.
16	File capacity is insufficient.
20	An attempt to access shared memory failed because the access target was locked.
24	Permission to execute the command is not granted.
40	A system limit was exceeded during allocation of shared memory, file descriptors, or resources for exclusive use.
120	An unexpected error was detected for an OS system call. The database area is not enough. Alternatively, secondary allocation of the database area failed. An attempt to access the database failed because the access target was locked. A database input or output error occurred.
124	An unexpected error was detected in JP1/AJS internal processing.

To Page Top

Example 1

To change the maximum number of concurrently executable jobs to 1 for the time period from 1:00 to 5:00 on execution agent AP1, execute the following command:

ajsagtalt -a AP1 -c 01:00-05:00=1

To Page Top

Example 2

To add execution agent AP2 (with a priority of 1) to execution agent group APG1, execute the following command:

ajsagtalt -g APG1 -l AP2:1

To Page Top

Example 3

To remove execution agent AP3 from execution agent group APG1, execute the following command:

ajsagtalt -g APG1 -u AP3

To Page Top

Example 4

To change the status of execution agent AP1 to Unavailable, execute the following command:

ajsagtalt -a AP1 -e m

To Page Top