4.7.10 Obtain Status of JP1/Base
Function
This component obtains the status of JP1/Base on the execution target server in Windows or UNIX.
Additionally, you can suspend the completion of the component until JP1/Base achieves a specific status.
The server's prerequisites for this component are described below.
- Execution target server
Target server for executing this component
The script in this component executes the following process.
- Execute the following command:
jbs_spmd_status [-h "value of logical host name (JP1.logicalHostName property)"]
[-t "value of time option (JP1.timeOption property)"]
- If you specify the return value of the waiting status (JP1.waitStatusReturnCode property), the jbs_spmd_status command is executed repeatedly at the interval of the retries specified for the verification of the waiting status (JP1.waitStatusRetryInterval property) until the waiting status becomes the specified value or until the number of retries to verify the waiting status (JP1.waitStatusRetryCount property) is fulfilled.
For details on the jbs_spmd_status command of JP1/Base, see the description for the command in the JP1/Base manuals.
Use situation
Use this component when you restart JP1/Base after modifying the JP1/Base settings to make the modification take effect.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
(1)JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1)Job Management Partner 1/Base 09-00 or later, or
JP1/Base 11-00 or later
[Prerequisite product OS running in the execution target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(5) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
[Usage conditions for required products on the execution target server]
(1) If the execution target server's JP1/Base has a cluster configuration, specify in the plugin.destinationHost property the name of the physical host on which JP1/Base's logical host is running, and specify in the JP1.logicalHostName property JP1/Base's logical host name.
Cautions
(1) For the properties of this plug-in, do not specify a string that includes a double quotation mark (") or single quotation mark (').
(2) For other notes on the command, see the JP1/Base manual.
Execution privilege
Windows: Administrator permission
UNIX: root permission
Version
02.02.00
Plug-in tags
Gather JP1 information,Base,Windows,Linux
Plug-in name displayed in the task log
jp1baseGetStatus
Return code
0: Normal
12: Error (mistake by user) Invalid property
21: Error (invalid environment) Command cannot be found (error detected in the plug-in script)
27: Error (check task logs for the nature of error)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
JP1.logicalHostName |
Logical host name for the execution target server |
Specify the JP1 logical host name of the execution target server. |
-- |
Input |
O |
JP1.timeOption |
time(t) option |
If you want to set the [Time(t)] option for the command to be executed, specify the time. If this is omitted, the [Time(t)] option is not set. |
-- |
Input |
O |
JP1.waitStatusReturnCode |
wait status return code |
Executes the status checking command repeatedly until the return value of the status acquisition command becomes the specified value. If this is omitted, the repeated process is not performed. |
-- |
Input |
O |
JP1.waitStatusRetryCount |
wait status retry count |
Specify the number of retries when executing the status acquisition command. |
60 |
Input |
O |
JP1.waitStatusRetryInterval |
wait status retry interval |
Specify the retry interval in seconds when executing the status acquisition command. |
10 |
Input |
O |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |
common.commandExitCode |
Return value for the execution command |
The return value for the execution command is stored. |
-- |
Output |
O |
common.commandOutput |
Output of the execution command |
The standard output and standard error output of the execution command are stored. |
-- |
Output |
O |