Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command, Definition File and API Reference


jcashowa

Organization of this page

Function

This command displays the results of executing automated actions stored in an action information file. Automated action execution results can be displayed for an event that was registered at a specified date and time, or for all events that were registered during a specified period of time, or for all actions.

Format

jcashowa [-d {[MM/dd/hh:mm][, [MM/dd/hh:mm]]}]
         [-h logical-host-name]
         [action-information-file-name]

Execution permission

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In UNIX: None

Storage directory

In Windows:

Console-path\bin\

In UNIX:

/opt/jp1cons/bin/

Arguments

-d {[MM/dd/hh:mm][, [MM/dd/hh:mm]]}

Specifies the time that the events subject to the actions stored in the action information file were registered. Use a comma (,) to separate the beginning date and time from the ending date and time. The command displays information about the actions for events that were registered during the specified period of time. When this option is omitted, the command displays information about all the actions stored in the action information file.

About the date/time specification (MM/dd/hh:mm):

You can use the formats shown in the table below for the date/time specification. Use the format appropriate to your operation.

Table 1‒4: Date/time specification formats

Date/time specification pattern

Description

MM/dd/hh:mm

Specify month in MM, date in dd, hour in hh, and minute in mm.

MM/dd/hh

Specify month in MM, date in dd, and hour in hh.

For the omitted mm, the command assumes 00.

MM/dd

Specify month in MM and date in dd.

For the omitted hh and mm, the command assumes 00 for both.

dd

Specify date in dd.

For the omitted MM, the command assumes the month the jcashowa command was executed. For hh and mm, the command assumes 00 for both.

dd/hh:mm

Specify date in dd, hour in hh, and minute in mm.

For the omitted MM, the command assumes the month the jcashowa command was executed.

hh:mm

Specify hour in hh and minute in mm.

For the omitted MM, the command assumes the month the jcashowa command was executed. For dd, the command assumes the date the jcashowa command was executed.

About the date/time range specification ([MM/dd/hh:mm][, [MM/dd/hh:mm]]):

You can use the formats shown in the table below for the date/time range specification. Use the format appropriate to your operation.

Table 1‒5: Date/time range specification formats

Range specification pattern

Description

-d datetime

By specifying datetime, you can display the result of an action that was executed for an event registered at a specific date and time.

For example, to display the result of an action that was executed for an event registered at 22:00 on October 24, specify as follows:

jcashowa -d 10/24/22:00

-d datetime,datetime

By specifying datetime,datetime, you can display the results of all actions that were executed for the events registered during a specified period (range) of time.

For example, to display the results of the actions that were executed for all events registered from 22:00 on October 24 through 10:00 on November 24, specify as follows:

jcashowa -d 10/24/22:00,11/24/10:00

-d datetime,

By specifying datetime,, you can display the results of all actions that were executed for the events registered on and subsequent to the specified date and time.

For example, to display the results of the actions that were executed for the events registered at 22:00 on October 24 and thereafter, specify as follows:

jcashowa -d 10/24/22:00,

-d ,datetime

By specifying ,datetime, you can display the results of all actions that were executed for the events registered at and before the specified date and time.

For example, to display the results of the actions that were executed for the events registered up to (and including) 10:00 on November 24, specify as follows:

jcashowa -d ,11/24/10:00

About the default year:

If the specified beginning month value is greater than the value for the month during which the jcashowa command is executed, the command assumes the specified date and time belong to the previous year and treats the specification as being from the beginning date and time in the previous year to the ending date and time in the current year.

  • When the specified beginning month value is greater than the value for the month during which the jcashowa command is executed:

    12 (December) ≥ value specified as the beginning month > value for the month during which the jcashowa command is executed

    The command assumes that the year for the specified beginning date and time is the year preceding the year during which the jcashowa command is executed.

  • When the specified beginning month value is less than the value for the month during which the jcashowa command is executed:

    Value for the month during which the jcashowa command is executed ≥ value specified as the beginning month ≥ 01 (January)

    The command assumes that the year for the specified beginning date and time is the same as the year during which the jcashowa command is executed.

Example 1 (if the jcashowa command is executed on 2003/10/31):

# jcashowa -d 11/01/0:00,10/01/23:59

The command assumes the specified time range is from 2002/11/01 0:00 to 2003/10/01 23:59 and performs processing normally.

Example 2 (if the jcashowa command is executed on 2003/11/01):

# jcashowa -d 11/01/0:00,10/01/23:59

The command assumes the specified time range is from 2003/11/01 0:00 to 2003/10/01 23:59 and displays the message KAVB4009-W because the specified date and time are not in chronological order.

The specification of the -d option determines the chronicity of the specified dates/times. If the specified beginning and ending dates/times are not in chronological order, an error results.

About the seconds specification

For the seconds specification, 00 is assumed as the beginning time and 59 is assumed as the ending time.

Example 1 (if the jcashowa command is executed as follows):

# jcashowa -d 10/24/22:00

The results of actions executed from October 24, 22:00:00 to October 24, 22:00:59 are displayed.

Example 2 (if the jcashowa command is executed as follows):

# jcashowa -d 10/24/22:00,11/24/10:00

The results of actions executed from October 24, 22:00:00 to November 24, 10:00:59 are displayed.

-h logical-host-name

When you are operating in a cluster system, this option specifies the logical host name. The command displays action execution results for the specified logical host. 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. If you are not using a cluster system, specification of this option is not needed.

action-information-file-name

Specifies the full path of the file to be used for the action information file.

If you specify an action information file at the physical host, do not specify the -h option or the JP1_HOSTNAME environment variable.

If you specify an action information file at the logical host, specify the logical host name in the -h option or the JP1_HOSTNAME environment variable.

The action information file name can consists of a maximum of 255 bytes.

The specified action information file will be used to store information about the executed actions.

This option must be the final option specified in the command. It must be specified after you have specified all other options that need to be specified.

Return values

0

Normal termination

3

Argument error

6

System error

7

No permission to execute the command (Windows)

Output format

When you execute the jcashowa command, automated action information is output in the following format:

Event information#1 event-IDΔserial-numberΔregistered-timeΔevent-arrival-time

Action information#2 action-serial-numberΔaction-typeΔstatusΔdelay-statusΔPIDΔexecution-host-name

Action information action-inserted-timeΔaction-starting-timeΔaction-ending-timeΔreturn-code

Command command

Message message

#1

If an AND condition is specified in the automated action settings, the command outputs only information about the last event received among all the events set in the execution condition.

#2

If no delay monitoring setting is specified for the action or the action is not delayed, the command outputs the following information:

Action information action-serial-numberΔaction-typeΔstatusΔPIDΔexecution-host-name

The following table lists and described each item that is output.

Table 1‒6: Automated action information output items

Item

Description

event-ID

Event ID, in the format basic-code:extended-code.

serial-number

Serial number of the event.

registered-time

Event registration time, in the format month/date hour:minute:second.

event-arrival-time

Event arrival time, in the format month/date hour:minute:second.

action-serial-number

Action serial number of the action that is to be executed.

action-type

One of the following action types:

  • Command (command)

  • Rule (rule startup request to JP1/IM - Rule Operation)

status

One of the following character strings indicating the action's execution status:

  • running (running)

  • ended (terminated)

  • none (none)

  • fail (not executable; error occurred before the execution request was passed to JP1/Base)

  • error (execution failed; error occurred within JP1/Base command control)

  • unknown (status unknown; command's execution result could not be determined)

  • wait (waiting for termination of the preceding command)

  • send (command is being transmitted)

  • queue (waiting for command execution in JP1/Base)

  • cancel (canceled)

  • kill (forced termination)

  • deterrent (suppressed)

If the action is canceled from JP1/IM - View or by the jcacancel command, the cancellation status is displayed following the applicable status shown above.

The action cancellation statuses are as follows:

  • canceling (being canceled). Example: queue (canceling)

  • miss (cancellation failed). Example: ended (miss)

If the command is re-executed during a restart of the Automatic Action Service or the action is output to the action re-execution file, -R is appended to the above status (example: ended-R).

If the action is re-executed from JP1/IM - View, -RU is appended to the above status (example: ended-RU).

If a suppressed action is re-executed from JP1/IM - View, -RUD is appended to the above status (example: ended-RUD).

If a suppressed action is re-executed from JP1/IM - View and then re-executed again or output to the action re-execution file because the Automatic Action Service was restarted (including node switching) during the re-execution, -RD is appended to the status (example: ended-RD).

If a suppressed action's status is fail (not executable), -D is appended to fail (example: fail-D).

delay-status

Action's delay status.

If the action is delayed, delay is displayed.

If the action is not delayed, nothing is displayed.

PID

Process ID of the execution action.

When action information is entered into the action re-execution file because of node switching, OUTPUT is displayed.

execution-host-name

Name of the host that executed the action.

action-inserted-time

Insertion time of the action to be executed, in the format month/date hour:minute:second.

If the action has not been inserted, **/** **:**:** is displayed.

action-starting-time

Action start time, in the format month/date hour:minute:second.

If the action has not started, **/** **:**:** is displayed.

action-ending-time

Action end time, in the format month/date hour:minute:second.

If the action has not ended, **/** **:**:** is displayed.

return-code

Return code from the executed action.

If the action has not ended, *** is displayed.

command

Command executed as the action.

message

Message displayed by the command.

Example output

Example 1:

The command terminated abnormally and a message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 23000 Command ended 27934 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    12/03 12:09:17 1
Command:            /usr/local/action
Message:            abc was not found.
Example 2:

Execution of the command is underway and no message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 23000 Command running 27934 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    **/** **:**:** ***
Command:           /usr/local/executing
Example 3:

The command status is running, the cancellation status is canceling, and no message has been output:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 10 Command running(canceling) 15236 raysol
Action information: 12/03 12:09:15 12/03 12:09:16
                    **/** **:**:** ***
Command:           /usr/local/action
Example 4:

There are results for multiple actions:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 380 Command ended 233 raysol
Action information: 12/03 12:09:13 12/03 12:09:14
                    12/03 12:09:14 20
Command:            /usr/local/action
Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 381 Command ended 279 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/05 10:39:23 128
Command:            /usr/local/action2
Message:            No permission
Execute as a superuser
Processing is canceled
Example 5:

There are multiple actions for a single event because a parameter group was specified:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 987 Command running 2904 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/03 12:09:13 0
Command:            /usr/local/first
Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 988 Command ended 2906 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    12/06 21:02:54 0
Command:            /usr/local/second
Example 6:

Action information was entered in the action re-execution file due to node switching:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 45687 Command ended-R OUTPUT
Action information: **/** **:**:** *** **/** **:**:** ***
                    /****:**:** ***
Example 7:

The action being executed is delayed:

Event information:  00002000:00000000 20 12/03 12:03:26
                    12/03 12:03:26
Action information: 987 Command running delay 2904 raysol
Action information: 12/05 10:39:20 12/05 10:39:21
                    **/** **:**:** ***
Command:            /usr/local/executing
Example 8:

The command was executed with no arguments specified (the JP1/IM - Rule Operation linkage function is enabled):

Event information:  00000111:00000000 628 03/13 16:18:24
                    03/13 16:18:24
Action information: 523 Rule ended 3016 raysol
Action information: 03/13 16:18:24 03/13 16:18:24
                    03/13 16:18:28 0
Command:      jrmexecrule -c raysol -s 628 -t 1142234304
Message:      KAJX4101-I The rule started successfully.
List of start rules:
RuleOperation/rule005
Event information:  00000111:00000000 628 03/13 16:18:24
                    03/13 16:18:24
Action information: 524 Command ended 3156 raysol
Action information: 03/13 16:18:24 03/13 16:18:28  03/13 16:18:28 0
Command:            hostname
Message:            raysol