Hitachi

JP1 Version 11 JP1/Automatic Operation Configuration Guide 


2.6 Connection-destination property file (connection-destination-name.properties)

This is the definition file for setting information used to establish connections when the following plug-ins are executed:

Format

specification-key-name=setting

Installation folder

For non-cluster systems:

JP1/AO-installation-folder\conf\plugin\destinations or /opt/jp1ao/conf/plugin/destinations

For cluster systems:

shared-folder-name\jp1ao\conf\plugin\destinations or shared-folder-name/jp1ao/conf/plugin/destinations

Trigger for applying definitions

Executing a plug-in that references the connection-destination property file

Description

One specification key and setting can be specified per line. Note the following points when coding the connection-destination property file.

Settings

Table 2‒9: Settings in the connection-destination property file

Key name

Settings

Specifiable 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 user-specified 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:

  • General command plug-in

  • File-transfer plug-in

  • Terminal connect plug-in

  • Content plug-in

This setting has priority over the ssh.port.number setting in the user-specified 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. You can use 1 to 1,024 characters. For example, specify Username:.

Character string that can be used 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. You can use 1 to 1,024 characters. For example, specify Password:.

Character string that can be used 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. You can use 1 to 1,024 characters. To specify multiple port numbers, use a comma as a separator.

0-65535, and commas (,)

wmi.workDirectory.sharedPath

Specifies the absolute path of the shared folder that stores the file to be transferred during command execution when a general command plug-in, file-transfer plug-in, or content plug-in is executed. The absolute path that you specify can have a maximum of 80 characters.

The value-of-this-property\Hitachi\CMALib\JP1AO folder is created, and then, in that folder, the home and launcher folders are created.

You must specify this property in the following cases:

  • The OS of the operation target device is Windows Server 2012 or Windows Server 2012 R2 in a cluster configuration.

  • The logical host name or logical IP address is used to connect to the operation target device.

If you specify this property, you must also specify the wmi.workDirectory.sharedName property. In addition, you must specify the same folder name for this property and the wmi.workDirectory.sharedName property.

If you do not specify this property, the following folder is created.

  • When JP1/AO is in a non-cluster configuration or is on the active server of a cluster configuration:

    %windir%\Hitachi\CMALib\JP1AO

  • When JP1/AO is on the standby server of a cluster configuration:

    %windir%\Hitachi\CMALib\JP1AO_2

Single-byte alphanumeric characters, backslashes (\), colons (:), hyphens (-), underscores (_), and periods (.)

wmi.workDirectory.sharedName

Specifies the name of the shared folder that stores the file to be transferred during command execution when a general command plug-in, file-transfer plug-in, or content plug-in is executed. The shared folder name that you specify can have a maximum of 80 characters.

The value-of-this-property\Hitachi\CMALib\JP1AO folder is created, and then, in that folder, the home and launcher folders are created.

You must specify this property in the following cases:

  • The OS of the operation target device is Windows Server 2012 or Windows Server 2012 R2 in a cluster configuration.

  • The logical host name or logical IP address is used to connect to the operation target device.

This property must be specified together with the wmi.workDirectory.sharedPath property. Furthermore, the folder name specified for this property must be the same as the folder name in the path specified for the wmi.workDirectory.sharedPath property, as in the following example:

wmi.workDirectory.sharedPath = F:\\work

wmi.workDirectory.sharedName = work

Single-byte alphanumeric characters, hyphens (-), underscores (_), and periods (.)

ssh.workDirectory

Specifies the absolute path of the work folder that is used when a file-transfer plug-in or content plug-in is executed for an operation target device whose OS is UNIX. #1 The absolute path you specify can have a maximum of 128 characters.

You can specify a folder or symbolic link. You can also include a symbolic link in the path. If the specified value is invalid, the file-transfer plug-in or content plug-in terminates abnormally.

This product does not support a case where a file-transfer plug-in is executed for the folder whose path is specified in this property or for the parent folder of that folder.

The permission setting of the work folder must grant read, write, and execute permissions to the connected user.

If the path specified in this property does not exist when a file-transfer plug-in or content plug-in is executed, a folder is created when the plug-in is executed. If the folder cannot be created, the plug-in terminates abnormally. The permission setting of the work folder must be changed to 777 regardless of whether the work folder already exists or is newly created.

Single-byte alphanumeric characters, forward slashes (/), hyphens (-), underscores (_), and periods (.)

common.executionDirectory

If the OS of the operation target device is Windows#2

This property specifies the path of the execution directory that is used to execute a content plug-in. Note that the execution directory must be created in advance on the same drive as the work folder. If necessary, the permission settings of that directory must also be changed. At least the user who executes the plug-in must be given execute permission.

If Execution Mode of a content plug-in is Script, the total length of the value specified here and script file name must not exceed 140 characters. If the total length exceeds 140 characters, transfer of the script file might fail. Note that the maximum length of the script file is 90 characters. Therefore, we recommend that you use a maximum of 50 characters to specify the value of this property.

If the OS of the operation target device is Linux#3

This property specifies the path of the execution directory that is used to execute a content plug-in. Note that the execution directory must be created in advance. If necessary, the permission settings of that directory must also be changed. At least the user who executes the plug-in must be given execute permission.

Character string having a maximum of 128 characters

#1

The work directory is decided based on the following priority.

Priority

Setting value

1

Value specified for ssh.workDirectory

2

Value specified for plugin.remoteCommand.workDirectory.ssh in the user-specified properties file (config_user.properties)

3

/tmp/Hitachi_AO

#2

The execution directory name is determined from the following candidate values based on the indicated priority:

Priority

Candidate value

1

Execution directory value defined in the plug-in

2

Value specified for the common.executionDirectory key

3

Value specified for the plugin.remoteCommand.executionDirectory.wmi key in the user-specified properties file (config_user.properties)

4

Value of the Windows %TEMP% environment variable at the connection destination of the operation target device

#3

The execution directory name is determined from the following candidate values based on the indicated priority:

Priority

Candidate value

1

Execution directory value defined in the plug-in

2

Value specified for the common.executionDirectory key

3

Value specified for the plugin.remoteCommand.executionDirectory.ssh key in the user-specified properties file (config_user.properties)

4

/tmp

Example definition

terminal.charset=UTF-8
telnet.port=23
ssh.port=22
telnet.prompt.account=login
telnet.prompt.password=password
telnet.noStdout.port.list=25,80,110