Before Ops Center Automator plug-ins and services can communicate with remote machines on which the plug-ins run tasks and perform actions, you must configure remote machine connection information.
Before you begin, verify the following:
- All the files located in the following path are regarded as destination properties files.
Automation-software-installation-folder\Automation\conf\plugin\destinations
- The file name uses the following format:
Host-name.properties, IPv4-address.properties, IPv6-address.properties
Note: Because you cannot use the colon ":" within an IPv6 address within the file name, replace it with a dash (-); for example: change "2001::234:abcd" to "2001--234-abcd.properties".
You can view a sample file in the following location:
Automation-software-installation-folder\Automation\conf\plugin\destinations\#sample.properties
When editing the properties file, take note of the following:
- Lines that begin with # are treated as comments.
- Blank lines are ignored.
- Encoding is ISO 8859-1.
- Contents are case sensitive
- To specify a forward slash (\) in a character string, you must use a double forward slash (\\).
- If you specify an value in the destination properties file that is not valid, an execution error occurs in the plug-in that references the destination properties file.
- If you enter the same specification key multiple times in a file, the last one you specify takes effect.
- If you edited the destination properties file, the new definitions are applied when the plug-in that references the file is run.
Use the following configuration information to connect with the target machine.
Guidelines when the target machine is part of a cluster environment
When entering information for a cluster target machine:
- If the OS of the target machine is a Windows Server cluster environment, the working folders (wmi.workDirectory.sharedName and wmi.workDirectory.sharedPath) must be set. Otherwise, the plug-in causes a connection error.
- If you run the script with the Custom Plug-in, you must specify the execution folder (common.executionDirectory). Otherwise, the script is not forwarded.
| Key name | Setting | Valid values |
|---|---|---|
| terminal.charset | Specifies the character set used for communication. |
EUC-JP eucjp ibm-943C ISO-8859-1 MS932 PCK Shift_JIS UTF-8 windows-31j |
| telnet.port | Specifies the port number used for a Telnet connection by using the Terminal Connect Plug-in. This setting has priority over the "telnet.port.number setting" in the properties file (config_user.properties). | 0-65535 |
| ssh.port | Specifies the port number used for an SSH connection by using one
of the following plug-ins:
This setting has priority over the "ssh.port.number" setting in the properties file (config_user.properties). |
0-65535 |
| telnet.prompt.account | Specifies a regular expression pattern used to detect the character string that is output for prompting the user to enter a user ID to establish a connection with the target device by using the Terminal Connect Plug-in. For example, specify Username:. | Character string from 1 to 1,024 characters for use in regular expression patterns. |
| telnet.prompt.password | Specifies a regular expression pattern used to detect the character string that is output for prompting the user to enter a password to establish a connection with the target device by using the Terminal Connect Plug-in. For example, specify Password:. | Character string from 1 to 1,024 characters for use in regular expression patterns. |
| telnet.noStdout.port.list | Specifies the port number of the service that does not return the standard output after a connection is established by using the Terminal Connect Plug-in. To specify multiple port numbers, use a comma as a separator. | 0-65535, and commas (,) from 1 to 1,024 characters |
| wmi.workDirectory.sharedName | This is a property for Windows target machines. Specifies the shared folder name of the shared folder to which the file transmitted when running a command on the target . The folder must be the same as wmi.workDirectory.sharedPath. If using this property, the administrative shared setting of a target is unnecessary. | Single-byte alphanumeric characters, "-", "_", and ".". Specify a character string from 0 to 80 characters. |
| wmi.workDirectory.sharedPath | This is a property for Windows target machines. Specifies the absolute path of the shared folder to which the file transmitted when running a command on the target. If using the General Command Plug-in, the execution folder becomes "\Hitachi\CMALib\HAD\home" under the path listed for this property. The folder must be the same as wmi.workDirectory.sharedName. If using this property, the administrative shared setting of a target is unnecessary. | Single-byte alphanumeric characters, ":", "\", "-", "_", and ".". Specify a character string from 0 to 80 characters. |
| ssh.workDirectory | This is a property for Linux OS target machines. Specifies the absolute path of the directory to which the file for a transmission is placed for the File-Transfer or the Custom Plug-in. Neither the path specified in this property nor the path of the parent directory can be specified as the destination and the receiver of File-Transfer Plug-in. For the working directory, the read, write, and execute privilege for the connected user are required. If the path specified in this property does not exist when the plug-in is used, it is created when the plug-in is run. If the directory cannot be created, the plug-in execution ends abnormally. You must ensure that the access permission for the new directory is 777. Priority is given over the value of "plugin.remoteCommand.workDirectory.ssh" defined in the config_user.properties file. | Single-byte alphanumeric characters, "/", "-", "_", and ".". Specify a character string from 0 to 128 characters. |
| common.executionDirectory | Specifies the execution folder at the time of running the Custom Plug-in on the target. If the value of the execution folder defined in the plug-in definition is not set, the value of this property is applied. Priority is given over the value of "plugin.remoteCommand.executionDirectory.wmi" and "plugin.remoteCommand.executionDirectory.ssh" defined in the config_user.properties file. | Any characters Specify a character string from 0 to 128 characters. |
| sftp.enable | Specifies whether to use SFTP when sending/receiving files using SSH in the File Transfer Plug-in and Custom plug-in. If true, SFTP is used, and if false, SCP is used. This setting has priority over the "plugin.sftp.enable" setting in the properties file (config_user.properties). | true/false |