2.8.1 Execute Remote Command
Function
Executes commands stored on a specified server and outputs the results.
Assumptions about the server in this service template are as follows:
- Execution target server
This is the server where a version of Windows or Unix specified in the requirements is installed. The execution commands must already have been stored on the server.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Prerequisite products in the system executing the service template]
None.
[Prerequisite product OS running in the system executing the service template]
(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) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
(12) HP-UX 11i V3 (IPF)
(13) Solaris 10 (SPARC), Solaris 11 (SPARC)
(14) AIX V6
(15) AIX V7
Cautions
(1) If the standard output result of the executed command exceeds 100 KB, the service ends abnormally.
(2) Up to 1,024 characters of the standard output result of the executed command are stored in property common.stdoutProperty; any output in excess of that is discarded.
(3) Interactive commands and script that seek user input and commands that do not end automatically using a GUI display or the like cannot be executed.
(4) If the OS running on the execution target server is Unix, the command is executed in the default locale defined in the agentless-connection target for the connected user. For details, see "Locale set for operation target devices during plug-in execution" and "Character set used for communication by this product during plug-in execution" in the this product manual.
(5) When using non-ASCII characters for the common.remoteCommand property and common.remoteCommandParameter property in non-Linux Unix servers, the requirements described in the Service Template Reference for execution of command lines containing non-ASCII characters in Unix must be satisfied.
(6) For other usage notes, see the usage notes of the General command plugin in the Service Template Reference.
Version
02.50.00
Tags
Execute Script,Linux,Windows,AIX,Solaris,HP-UX
Property list
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
|---|---|---|---|---|---|
|
common.targetHost |
Host name of execution target server |
Specifies the host name or IP address of the execution target server. IPv6 addresses are not supported. |
Input |
Disabled |
R |
|
common.remoteCommand |
Command |
Specify the full path of the command to be executed on the execution target server. If the path contains a space, enclose the entire path in double quotation marks. |
Input |
Disabled |
R |
|
common.remoteCommandParameter |
Command parameters |
Specify the parameters for the command to be executed on the execution target server. If a parameter contains a space, enclose the entire parameter in double quotation marks. |
Input |
Disabled |
O |
The following shows the list of the properties to be displayed in the "Task Details" window only:
|
Property key |
Property name |
Description |
I/O type |
Shared |
|---|---|---|---|---|
|
common.stdoutProperty |
Standard output string |
This property contains the character string output to standard output by the specified command. |
Output |
Disabled |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
common.targetHost |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
common.remoteCommand |
A character string of no more than 256 characters can be entered. |
|
common.remoteCommandParameter |
A character string of no more than 1024 characters can be entered. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
remoteHostCommandExe |
General command plug-in |
Executes a command on the remote execution target server and displays the results. |
Eliminate the cause of the error, and then re-execute the service. |