2.2 User-specified properties file (config_user.properties)
This is the definition file used for various JP1/AO settings such as logs, tasks, and JP1 events.
Format
specification-key-name=setting
Installation folder
- For non-cluster systems:
JP1/AO-installation-folder\conf or /opt/jp1ao/conf
- For cluster systems:
shared-folder-name\jp1ao\conf or shared-folder-name/jp1ao/conf
Trigger for applying definitions
Restarting JP1/AO
Description
Specify one specification key name and its setting (value) in pairs per line. Note the following points when coding the user-specified properties file:
Lines that begin with a hash mark (#) are treated as comments.
Blank lines are ignored.
The encoding is ISO 8859-1.
The entries are case sensitive.
To specify a backslash (\) in a character string, two backslashes (\\) must be entered.
In this case, assume two backslashes as one byte to calculate the size.
If an invalid value is entered for a setting, it is set to its default value, and the KNAE02022-W message is output to the integrated trace log and public log.
If the same specification key is entered multiple times in a file, the last one that is specified will take effect.
Settings
Classification |
Key name |
Settings |
Specifiable values |
Default value |
|---|---|---|---|---|
|
Logs#1 |
logger.message.server.MaxBackupIndex |
Specifies the maximum number of log backup files for a server. |
1-16 |
7 |
logger.message.server.MaxFileSize |
Specifies the maximum log file size (KB) for a server. |
4-2,097,151 |
1,024 |
|
| logger.message.server.outputTaskDetail.enable | Specify whether to output detailed task information (KNAE01360-I, KNAE01361-W, or KNAE01362-E) to the server log. Nothing is output while debugging is being executed. |
|
false | |
logger.message.command.MaxBackupIndex |
Specifies the maximum number of log backup files for a command. |
1-16 |
7 |
|
logger.message.command.MaxFileSize |
Specifies the maximum log file size (KB) for a command. |
4-2,097,151 |
1,024 |
|
logger.TA.MaxFileSize |
Specifies the maximum log file size (KB) for a task. |
4-2,097,151 |
10,240 |
|
|
Task management |
tasklist.autoarchive.taskRemainingPeriod |
Specifies the period (days) that tasks whose execution has terminated are retained in the task list. |
1-90 |
7 |
tasklist.autoarchive.executeTime |
Specifies the time at which the following processing is executed:
Invalid regions in the database are also released at this time. |
00:00:00-23:59:59 |
04:00:00 |
|
tasklist.autoarchive.maxTasks |
Specifies the maximum sum of the number of tasks that can be kept in the task list and the number of debug tasks that can be kept in the debug task list. |
100-5,000 |
5,000 |
|
tasklist.autodelete.maxHistories |
Specifies the maximum number of history entries that can be retained. |
100-30,000 |
30,000 |
|
|
task.periodicalTaskArchive.enable |
Specify whether to periodically archive tasks and periodically delete task histories. |
|
false |
|
|
task.periodicalTaskArchive.period |
Specify the execution intervals (unit: hour) for functions that periodically archive tasks and periodically delete task histories. Execution intervals are based on the execution time of the function that automatically archives tasks. |
- 1 - 2 - 3 - 4 - 6 - 8 - 12 - 24 |
24 |
|
|
task.periodicalTaskArchive.taskCountThreshold |
Specify the threshold value of the number of tasks for periodically archiving tasks. Tasks are archived when the number of tasks exceeds the threshold value specified for this property. The value of this property must be less than the value of the tasklist.autoarchive.maxTasks key. |
0-5000 |
4000 | |
|
task.periodicalTaskArchive.taskCountAfterArchive |
Specify the number of remaining tasks for periodically archiving tasks. Tasks are periodically archived until the number of remaining tasks after archiving is the same as the value specified for this property. The value of this property must be less than the value of the task.periodicalTaskArchive.taskCountThreshold key. |
0-5000 |
3000 |
|
| task.execute.skip.serverStart#10 |
Specifies the behavior of the task whose scheduled start time has passed when the JP1/AO service is restarted. |
|
false |
|
Local execution of plug-ins |
plugin.localMode |
If you specify true, the execution user of the plug-in will be the System account or the root user. Note that the plug-in might not execute correctly if it uses resources that are unavailable to these users. |
|
false |
Service management |
packagemanager.maxServiceTemplates |
Specifies the maximum number of service templates that can be managed in JP1/AO (total number of created and imported service templates). |
1-3,000 |
1,000 |
packagemanager.maxServices |
Specifies the maximum number of services (including the debug service) that can be created. |
1-3,000 |
1,000 |
|
JP1 event notifications |
notification.jp1event |
Specifies whether to send JP1 events in the notification function. |
|
false |
Execution of plug-ins |
plugin.threadPoolSize |
Specifies the maximum number of plug-ins that can be executed concurrently. |
|
10 |
Repeats |
foreach.max_value |
Specifies the maximum number of concurrent tasks that can be executed by a Repeated Execution Plug-in. |
1-99 |
3 |
Remote connection port number |
ssh.port.number |
Specifies the SSH port number of the operation target device. |
0-65535 |
22 |
telnet.port.number |
Specifies the Telnet port number of the operation target device. |
0-65535 |
23 |
|
Terminal connection |
plugin.terminal.prompt.account |
Specifies a regular expression pattern (1-1,024 characters) used to detect the user ID waiting state. To establish a Telnet connection with the operation target device, if the standard output and standard error output match the specified regular expression, the terminal connect plug-in determines that a user ID must be entered. Then, this plug-in enters a user ID. |
Character string that can be used in regular expression patterns |
login|Login Name|Username|UserName |
plugin.terminal.prompt.password |
Specifies a regular expression pattern (1-1,024 characters) used to detect the password waiting state. To establish a Telnet connection with the operation target device, if the standard output and standard error output match the specified regular expression, the terminal connect plug-in determines that a password must be entered. Then this plug-in enters a password. |
Character string that can be used in regular expression patterns |
password|Password|PassWord |
|
telnet.connect.wait |
Specifies the waiting time (seconds) until the standard output is returned after a Telnet connection is established with the operation target device. |
1-600 |
60 |
|
ssh.privateKeyFile |
Specifies the absolute path of the private key file if public key authentication is used for SSH connections. |
Character string of 0-255 characters |
" " (null character) |
|
|
Remote command |
plugin.remoteCommand.executionDirectory.wmi#2 |
If the OS of the operation target device is Windows, this property specifies the path to the execution directory used to execute a content plug-in. Note that the execution directory must be created on the same drive as the work folder in advance. If necessary, the access permission settings of the execution directory must also be changed. At least the user who executes the plug-in must be given execute permission. If the execution mode of the content plug-in is Script, make sure that the total length (character count) of the value specified here and the script file name does not exceed 140 characters. If the total length exceeds 140 characters, forwarding of the script file might fail. We recommend that the value specified here is 50 or less characters because the script file name is specified using 90 or less characters. |
Character string of 0-128 characters |
" " (null character) |
plugin.remoteCommand.executionDirectory.ssh#3 |
If the OS of the operation target device is UNIX, this property specifies the path to the execution directory used to execute a content plug-in. Note that the execution directory must be created in advance. If necessary, the access permission settings of the execution directory must also be changed. At least the user who executes the plug-in must be given execute permission. |
Character string of 0-128 characters |
" " (null character) |
|
plugin.remoteCommand.workDirectory.ssh#4 |
If the OS of the operation target device is UNIX, this property specifies a work folder #3 used to execute file-transfer plug-ins and content plug-ins. Enter a folder or symbolic link, using an absolute path of 1-128 characters. Symbolic links can be included in a layer of paths.#5 |
Single-byte alphanumeric characters, and the following symbols: / (used as a path separator), -, _, . |
/tmp/Hitachi_AO |
|
|
plugin.wmi.win32.UACAdministratorsExec |
Specify whether to enable the function for executing plug-ins by a user other than the System account when the OS of the destination host is Windows and UAC is enabled. |
|
false |
|
|
plugin.wmi.win32.CreationFlags.CREATE_NO_WINDOW |
Enable this when the OS of the destination host is Windows and the command like that displays the progress bar may not work correctly if a user other than the System account executes the command. |
|
true |
|
Web client |
plugin.http.connect.timeout |
Specifies the timeout value (seconds) for establishing an HTTP or HTTPS connection. If you specify 0, no timeout occurs. |
0-3,600 |
60 |
plugin.http.read.timeout |
Specifies the timeout value (seconds) for reading data through an HTTP or HTTPS connection. If you specify 0, no timeout occurs. |
0-86,400 |
600 |
|
|
remote host connection |
plugin.adapter.timeout#10 |
Specifies the timeout value (seconds) for exclusive processing. |
0-2147483647 |
2147483647 |
Retry remote host connection |
ssh.connect.retry.times |
Specifies the number of retries, in the event of a failed SSH connection to the operation target device. |
0-100 |
3 |
ssh.connect.retry.interval |
Specifies the interval (seconds) between retries, in the event of a failed SSH connection to the operation target device. |
1-600 |
10 |
|
wmi.connect.retry.times |
Specifies the number of retries, in the event of a failed Windows connection to the operation target device. |
0-100 |
3 |
|
wmi.connect.retry.interval |
Specifies the interval (seconds) between retries, in the event of a failed Windows connection to the operation target device. |
1-600 |
10 |
|
telnet.connect.retry.times |
Specifies the number of retries, in the event of a failed Telnet connection to the operation target device. |
0-100 |
3 |
|
telnet.connect.retry.interval |
Specifies the interval (seconds) between retries, in the event of a failed Telnet connection to the operation target device. |
1-600 |
10 |
|
Retry remote file operation |
plugin.remoteFileAccess.retry.times |
Specifies the number of retries for a file manipulation command executed internally by a content plug-in or file-transfer plug-in. The retry interval is fixed at 100 ms. If a temporary file access error occurs, retrying the command might result in successful operation. However, if the file access error is not recovered, extra time is required for retries until the plug-in terminates. Specify this property in an environment in which file access errors occur even if there are no problems with disks. |
0-100 |
0 |
Retry email sending |
mail.notify.retry.times |
Specifies the number of retries, in the event of a failure of the notification function to send an email. |
0-100 |
3 |
mail.notify.retry.interval |
Specifies the interval (seconds) between retries, in the event of a failure of the notification function to send an email. |
1-600 |
10 |
|
mail.plugin.retry.times |
Specifies the number of retries, in the event of a failure of the Email Notification Plug-in to send an email. |
0-100 |
3 |
|
mail.plugin.retry.interval |
Specifies the interval (seconds) between retries, in the event of a failure of the Email Notification Plug-in to send an email. |
1-600 |
10 |
|
Audit log |
logger.Audit.enable |
Specifies whether to output the audit log. |
|
0 |
logger.Audit.path |
Specifies the output destination path of the audit log, using 1-244 bytes. |
Single-byte alphanumeric characters, single-byte spaces, and the following symbols: !, #, $, &, (, ), +, ,, -, ., ;, =, @, [, ], ?, _, `, {, }, ~ |
|
|
logger.Audit.MaxBackupIndex |
Specifies the maximum number of log backup files for the audit log. |
1-16 |
7 |
|
logger.Audit.MaxFileSize |
Specifies the maximum log file size (KB) for the audit log. |
4-2,097,151 |
1,024 |
|
logger.Audit.command.useLoginUserID#7 |
Specifies whether to output the JP1/AO login user ID, in place of the user ID, to the subject identification information for the audit log when a command is executed. |
|
false |
|
Window refresh |
client.events.refreshinterval |
Specifies the refresh interval(seconds) for the Component area of the Service Builder window. |
0-65,535 |
5 |
Service Builder |
client.editor.upload.maxfilesize |
Specifies the maximum file size (MB) that can be specified when one of the files is uploaded by using the Service Builder window:
|
1-10 |
3 |
server.editor.step.perTemplate.maxnum#8 |
Specifies the maximum number of steps per service template. |
320-40,000 #9 |
320 |
|
server.editor.step.perLayer.maxnum#8 |
Specifies the maximum number of steps per layer. |
80-10,000 #9 |
80 |
|
server.editor.publicProperty.perTemplate.maxnum |
Specifies the maximum number of service properties per service template. |
100-2,000 |
1,000 |
|
server.editor.propertyGroup.perTemplate.maxnum |
Specifies the maximum number of property groups per service template. |
5-1,000 |
500 |
|
client.editor.canvas.maxwidth#8 |
Specifies the maximum width (unit: px) of the operational region in the Flow area. The estimate expression is as follows: Width (px) = (number-of-steps-to-be-deployed-horizontally + 1) x 90 (px) |
3,600-10,000 |
3,600 |
|
client.editor.canvas.maxhigh#8 |
Specifies the maximum height (unit: px) of the operational region in the Flow area. The estimate expression is as follows: Height (px) = number-of-steps-to-be-deployed-vertically x 300 (px) |
2,400-30,000 |
2,400 |
|
Debug |
tasklist.debugger.autodelete.taskRemainingPeriod |
Specifies the period (days) that debug tasks whose execution has terminated are retained in the debug task list. |
1-90 |
7 |
client.debugger.tasklog.maxfilesize |
Specifies the size of task logs (KB) displayed in the Task Log tab. |
4-10,240 |
1,024 |
|
logger.debugger.TA.MaxFileSize |
Specifies the maximum log file size (KB) for a debug task. |
4-2,097,151 |
10,240 |
|
|
Long-running tasks |
server.longRunning.check.interval |
Specifies the time (minutes) before the task is judged to be in Long Running status. If you specify 0, this judgment is not performed. |
0-20,160 |
2,880 |
server.longRunning.monitor.interval |
Specifies the interval time (seconds) at which to monitor the tasks in Long Running status. |
1-3,600 |
60 |
|
|
Output of plug-ins |
plugin.stdoutSize.wmi |
Specifies the maximum value (KB) of the total size of the standard output and standard error output if the connection target host is Windows in General Command Plug-in or the content plug-in. If the output exceeds the maximum value, execution of the plug-in becomes an error. If the number of line feeds in output becomes 65535 or more, since the plug-in remains running, specify a size that is within 65534. |
1-1,024 |
100 |
|
plugin.stdoutSize.ssh |
Specifies the maximum value (KB) of the total size of the standard output and standard error output if the connection target host is UNIX, or if the connection protocol is SSH in Terminal Connect Plug-in or Terminal Command Plug-in. If the output exceeds the maximum value, execution of the plug-in be comes an error. |
1-1,024 |
100 |
|
|
plugin.stdoutSize.telnet |
Specifies the maximum value (KB) of the total size of the standard output and standard error output if the connection protocol is Telnet in Terminal Connect Plug-in or Terminal Command Plug-in. |
1-1,024 |
100 |
|
|
HTTP port number of Common Component |
server.http.port |
Specifies the HTTP port number of communication between JP1/AO server and Common Component |
0-65535 |
22015 |
- #1
The log output threshold for tasks can be set in the Service Share Properties.
- #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 in the connection-destination property file (file name: connection destination name + .properties)
3
Value specified in plugin.remoteCommand.executionDirectory.wmi
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 in the connection-destination property file (file name: connection destination name + .properties)
3
Value specified in plugin.remoteCommand.executionDirectory.ssh
4
/tmp
- #4
Do not specify the path specified for this property or its parent folder's path for the source or destination folder for a file-transfer plug-in. If you specify such a folder, the property is not supported by the product.
- #5
The work folder must have read, write, and execution permissions for the connected user.
When a file-transfer plug-in or content plug-in is executed, the access permission setting of the work folder is changed to 777, which permits all users to access the folder. If the path specified for the work folder does not exist when a file-transfer plug-in or content plug-in is executed, a work folder is created during execution of the plug-in. If an attempt to create the work folder fails, execution of the plug-in terminates abnormally.
- #6
The name of an output file is Audit[n].log, where an integer indicating the number of files is displayed in [n].
- #7
The user ID to be output to the subject identification information for the audit log can be changed when one of the following commands is executed:
deleteservicetemplate command
importservicetemplate command
listservices command
listtasks command
stoptask command
submittask command
- #8
These properties are defined to provide compatibility with JP1/AO 10-02 or earlier.
- #9
Edit these definitions only when all the conditions shown below exist. Note that the definitions must be edited before you duplicate or edit a service template.
You are going to edit a service template created in JP1/AO 10-02 or earlier.
The total number of steps in the service template to be edited exceeds 320, or the number of steps per layer exceeds 80.
- #10
-
By default there is no key name in the file.
Example definitions
logger.message.server.MaxBackupIndex = 7 logger.message.server.MaxFileSize = 1024 logger.message.command.MaxBackupIndex = 7 logger.message.command.MaxFileSize = 1024 logger.TA.MaxFileSize = 10240 tasklist.autoarchive.taskRemainingPeriod = 7 tasklist.autoarchive.executeTime = 04:00:00 tasklist.autoarchive.maxTasks = 5000 tasklist.autodelete.maxHistories = 30000 task.periodicalTaskArchive.enable = false task.periodicalTaskArchive.period = 24 task.periodicalTaskArchive.taskCountThreshold = 4000 task.periodicalTaskArchive.taskCountAfterArchive = 3000 plugin.localMode = false packagemanager.maxServiceTemplates = 1000 packagemanager.maxServices = 1000 notification.jp1event = false plugin.threadPoolSize = 10 foreach.max_value = 3 ssh.port.number = 22 telnet.port.number = 23 plugin.terminal.prompt.account = login|Login Name|Username|UserName plugin.terminal.prompt.password = password|Password|PassWord telnet.connect.wait = 60 ssh.privateKeyFile = C:\\ssh\\id_rsa plugin.remoteCommand.executionDirectory.wmi = C:\\jp1ao plugin.remoteCommand.executionDirectory.ssh = /home/jp1ao plugin.remoteCommand.workDirectory.ssh = /tmp/Hitachi_AO plugin.http.connect.timeout = 60 plugin.http.read.timeout = 600 ssh.connect.retry.times = 3 ssh.connect.retry.interval = 10 wmi.connect.retry.times = 3 wmi.connect.retry.interval = 10 telnet.connect.retry.times = 3 telnet.connect.retry.interval = 10 plugin.remoteFileAccess.retry.times = 0 mail.notify.retry.times = 3 mail.notify.retry.interval = 10 mail.plugin.retry.times = 3 mail.plugin.retry.interval = 10 logger.Audit.enable = 0 logger.Audit.path = C:\\Program Files\\Hitachi\\JP1AO\\logs logger.Audit.MaxBackupIndex = 7 logger.Audit.MaxFileSize = 1024 logger.Audit.command.useLoginUserID = false client.events.refreshinterval = 5 client.editor.upload.maxfilesize = 3 server.editor.step.perTemplate.maxnum = 320 server.editor.step.perLayer.maxnum = 80 server.editor.publicProperty.perTemplate.maxnum = 1000 server.editor.propertyGroup.perTemplate.maxnum = 500 client.editor.canvas.maxwidth = 3600 client.editor.canvas.maxhigh = 2400 tasklist.debugger.autodelete.taskRemainingPeriod = 7 client.debugger.tasklog.maxfilesize = 1024 logger.debugger.TA.MaxFileSize = 10240 server.longRunning.check.interval = 2880 server.longRunning.monitor.interval = 60 plugin.stdoutSize.wmi = 100 plugin.stdoutSize.ssh = 100 plugin.stdoutSize.telnet = 100 server.http.port = 22015