Changing the system configuration

Ops Center Automator Installation and Configuration Guide

Version
11.0.x
Audience
anonymous
Part Number
MK-99AUT000-24

You can configure various Ops Center Automator settings such as logs and tasks by editing the config_user.properties file. Note that after you change and save the file, you must restart the Ops Center Automator engine web service.

You can change the following settings by editing this file:

  • Log file configuration (specify the number of logs to store).
  • Task and history configuration (specify the number of tasks and task histories to store).
  • Configuration regarding remote command execution (SSH/telnet port number)
  • Configuration information for email notification.
  • Configuration information regarding Service Builder.
  • Connection timeout value setting.
  • Maximum number of concurrent plug-in runs.

The file is located in the following folder: Automation-software-installation-folder\conf

The file uses the following format:

specification-key-name=setting

When editing the properties file, take note of the following:

  • Lines that begin with # are treated as comments
  • Blank lines are ignored
  • The encoding is ISO 8859-1
  • The contents are case sensitive
  • To specify \ in a character string, it must be written \\.
  • If value that is not valid is entered for a setting, it is set to the default value and message KNAE02022-W is sent 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 takes effect
Table. Settings in the config_user.properties file
Category Key name Setting Values Default value
HTTP connection port number server.http.port Specifies the port number to be used for HTTP communication between the Ops Center Automator server and the Common Component. 0-65535 22015
Logs1 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 (in KB) for a server. 4 - 2097151 1024
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 (in KB) for a command. 4 - 2097151 1024
logger.TA.MaxFileSize Specifies the maximum log file size (in KB) for a task. 4 - 2097151 10240
Task management tasklist.autoarchive.taskRemainingPeriod Specifies the period (in days) for tasks that have ended to remain in the task list. 1 - 90 7
tasklist.autoarchive.executeTime Specifies the time to run the automatic archiving task. 00:00:00 - 23:59:59 04:00:00
tasklist.autoarchive.maxTasks Specifies the maximum number of tasks to keep in the task list. 100 - 5000 5000
tasklist.autodelete.maxHistories Specifies the maximum number of history entries to retain. 100 - 30000 30000
Repeats foreach.max_value Specifies the maximum number of concurrent tasks that can be run by the Repeated Execution Plug-in. 1 - 99 3
Remote connection port number ssh.port.number Specifies the SSH port number of the target device. 0 - 65535 22
telnet.port.number Specifies the Telnet port number of the target device 0 - 65535 23
SSH cryptographic algorithms ssh.disable.kexAlgorithms Specifies comma-separated values of key exchange algorithms to disable for agentless connections (SSH). It is case-sensitive. Whitespace characters (half-width space) before and after the comma are ignored. Character string diffie-hellmangroup14-sha1
ssh.disable.ciphers Specifies comma-separated values of Ciphers to disable for agent-less connections (SSH). It is case-sensitive. Whitespace characters (half-width space) before and after the comma are ignored. Character string 3des-cbc,aes128-cbc,aes192-cbc,aes256-cbc
ssh.disable.macs Specifies comma-separated values of MACs to disable for agentless connections (SSH). It is case-sensitive. Whitespace characters (half-width space) before and after the comma are ignored. Character string hmac-sha1,hmac-sha1-96,hmac-sha1-etm@openssh.com
ssh.disable.publicKeyAlgorithms Specifies comma-separated values of public key algorithms for the host key to disable for agent-less connections (SSH). It is case-sensitive. Whitespace characters (half-width space) before and after the comma are ignored. Character string "" (null character)
TLS tls.client.cipherSuites Specifies comma-separated values of cipher suites to be used when connecting to Common Services and web service connection servers. You can specify cipher suites for TLS 1.2 and TLS 1.3. It is case-sensitive. Whitespace characters (half-width space) before and after the comma are ignored. String None2
General command

Remote command

File-transfer

Terminal connection

plugin.stdoutSize.wmi If the total size of the standard output and the standard error exceeds the property value, a plug-in error occurs.

Note: The property value unit is in kilobytes (KB).

This property is applied during the plug-in procedure, when the following conditions are met.

- Connection target host is Windows

- Execution target plug-in is either a General Command Plug-in or the Custom Plug-in

In Windows OS, the plug-in can continue to run, even if the number of linefeeds exceeds 65535 or more. To take advantage of this feature, you must to set the property value accordingly. For example, if this property is set to 100 KB (default value), the plug-in cannot process the maximum number of linefeeds of 65535 or more. The plug-in stops running after it reaches the 100 KB limit.

1 - 1024 100
plugin.stdoutSize.ssh If the total size of the standard output and the standard error exceeds the property value, a plug-in error occurs.

Note: The property value unit is in kilobytes (KB).

This property is applied during the plug-in procedure when the following two major conditions are met.

[Condition (1) (Note: The following target-based conditions must be met). ]

- Connection target host is Linux OS.

- Execution target plug-in is a General Command Plug-in or the custom plug-in.

[Condition (2) (Note: The following protocol and plug-in conditions must be met.)]

- Connection protocol is SSH.

- Execution target plug-in is Terminal Connect Plug-in or Terminal Command Plug-in.

1 - 1024 100
plugin.stdoutSize.telnet If the total size of the standard output and the standard error exceeds the property value, a plug-in error occurs.

Note: The property value unit is in kilobytes (KB).

This property is applied during the plug-in procedure when the following conditions are met.

- Connection protocol is Telnet.

- The target plug-in is either Terminal Connect Plug-in or Terminal Command Plug-in.

1 - 1024 100
plugin.remoteFileAccess.retry.times Specifies the number of tries for a file manipulation command run internally by a content plug-in or file-transfer plug-in. The time between tries is fixed at 100 ms.

If a temporary file access error occurs, trying the command again might result in a successful procedure. However, if the file access error is not recovered, extra time is needed for further tries until the plug-in stops. Specify this property in an environment in which file access errors occur even if there are no problems with disks.

0 - 100 0
ssh.privateKeyFile Specifies the absolute path of the private key file if public key authentication is used for SSH connections. 0 - 255 characters "" (null character)
plugin.localMode Specifies whether to enable or disable local execution mode.

true: enabled

false: disabled

true/false true
Terminal connection plugin.terminal.prompt.account Specifies the regular expression used to detect the user ID waiting state (1-1,024 characters).

If the standard output and standard error output match the specified regular expression, the Terminal Connect Plug-in (Telnet is specified for the protocol) determines that a user ID must be entered, and then it enters a user ID.

Character string that can be used in regular expression patterns

logon|Logon Name|Username|UserName

plugin.terminal.prompt.password Specifies the regular expression used to detect the password waiting state (1-1,024 characters).

If the standard output and standard error output match the specified regular expression, the Terminal Connect Plug-in (Telnet is specified for the protocol) determines that a password must be entered, and then it enters a password.

Character string that can be used in regular expression patterns

password|Password|PassWord

telnet.connect.wait Specifies the waiting time (in seconds) until the standard output is returned after an Telnet connection is established with the target device. 1 - 600 60
Remote command plugin.remoteCommand.executionDirectory.wmi Specifies the path of the execution folder that contains the custom plug-in to run if the target host is running Windows. The execution folder must be created in advance.

If the "Execution Mode" of the custom plug-in is "Script", the total string length of the specified value and the script file name do not exceed 140 characters. If the length exceeds 140 characters, transferring the script might fail. In addition, because the script file name must be specified in 90 characters or less, this value specified must be within 50 characters.

Character string of 0-128 characters "" (null character)
plugin.remoteCommand.executionDirectory.ssh Specifies the path of the execution folder to run the custom plug-in if the OS of the target host is Linux OS. The execution folder must be created in advance. Character string of 0-128 characters "" (null character)
plugin.remoteCommand.workDirectory.ssh Specifies the working folder used when the file transfer plug-in or the custom plug-in is run if the OS of the target host is Linux OS. Enter a folder or a symbolic link as an absolute path (1 - 128 characters). In addition, the symbolic link can be included as the layer of the path. 1 - 128

/tmp/Hitachi_AO

Retry remote host connection ssh.connect.retry.times Specifies the number of tries in the event of a failed SSH connection to the target device. 0 - 100 3
ssh.connect.retry.interval Specifies the time (in seconds) between tries in the event of a failed SSH connection to the target device. 1 - 600 10
wmi.connect.retry.times Specifies the number of tries in the event of a failed WMI connection to the target device. 0 - 100 3
wmi.connect.retry.interval Specifies the time (in seconds) between tries in the event of a failed WMI connection to the target device. 1 - 600 10
telnet.connect.retry.times Specifies the number of tries in the event of a failed Telnet connection to the target device. 0 - 100 3
telnet.connect.retry.interval Specifies the time (in seconds) between tries in the event of a failed Telnet connection to the target device. 1 - 600 10
Retry email notification mail.notify.retry.times Specifies the number of tries in the event of a failure of the notification function to send an email. 0 - 100 3
mail.notify.retry.interval Specifies the time (in seconds) between tries 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 tries, if a failure occurs, to send email in the Email Notification Plug-in. 0 - 100 3
mail.plugin.retry.interval Specifies the time (in seconds) between tries in the event of a failure of the Email Notification Plug-in to send an email. 1 - 600 10
Audit Log logger.Audit.command.useLoginUserID Specifies whether to output the Ops Center Automator logon user ID, in place of the user ID, to the subject identification information for the audit log when a command is run. true/false false
Window update client.events.refreshinterval Specifies the update time (in seconds) for events. 0 - 65535 5
Service Builder client.editor.sso.timeout.disable Specifies whether to always disable timeout on the Service Builder windows except for the View Flow window and the Create/Edit External Resource Provider window, regardless of the Auto-refresh setting in Ops Center Common Services. true/false false
client.editor.upload.maxfilesize Specifies the maximum file size (in MB) that can be uploaded to the server from the terminal used for operating Ops Center Automator by using the Service Builder Edit window. 1 - 10 3
client.editor.canvas.maxwidth Specifies the maximum size (in px) of the width of Flow view. 3600 - 10000 3600
client.editor.canvas.maxhigh Specifies the maximum size (in px) of the height of Flow view. 2400 - 30000 2400
server.editor.step.perTemplate.maxnum Specifies the maximum number of steps per 1 service template. 320 - 40000 320
server.editor.step.perLayer.maxnum Specifies the maximum number of steps per 1 layer. 80 - 10000 80
server.editor.publicProperty.perTemplate.maxnum Specifies the maximum number of service properties per service template. 100 - 2000 1000
server.editor.propertyGroup.perTemplate.maxnum Specifies the maximum number of property groups per service template. 5 - 1000 500
Debugger tasklist.debugger.autodelete.taskRemainingPeriod Specifies the maximum number of property groups per service template. 1 - 90 7
client.debugger.tasklog.maxfilesize Specifies the size of task logs (KB) visible in the Task Log tab. 4 - 10240 1024
logger.debugger.TA.MaxFileSize Specifies the maximum log file size (KB) for a debug task. 4 - 2097151 10240
LongRunningTask verify interval threshold server.longRunning.check.interval LongRunningTask verify the threshold between times (in minutes) 0 - 20160 2880
LongRunning Monitor interval server.longRunning.monitor.interval LongRunning monitor interval (in seconds) 1 - 3600 60
Web Client plugin.http.connect.timeout Specifies the timeout value (in seconds) when the HTTP/HTTPS connection is established. If 0 is specified, timeout does not occur. 0 - 3600 60
plugin.http.read.timeout Specifies the timeout value (in seconds) when reading the data after the HTTP/HTTPS connection is established. If 0 is specified, timeout does not occur. 0 - 86400 600
Plug-in run plugin.threadPoolSize Specify the maximum number of concurrent plug-in runs. When using only the built-in service templates, you can set this property value to 100. To also use a custom service template, make sure to evaluate the behavior after changing the default value and make sure that no problem occurs before you move to the production process. 1-100 10
SSO sso.https.certification Specifies whether to verify the certificates in SSL communication with Common Services. true/false false
SSH file transfer protocol plugin.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. true/false false
  1. You set log output thresholds for tasks in Service Share Properties.

    Example

    logger.message.server.MaxBackupIndex = 7 
    logger.message.server.MaxFileSize = 1024  
    logger.message.command.MaxBackupIndex = 7 
    logger.message.command.MaxFileSize = 1024 
    logger.TA.MaxFileSize = 1024 
    tasklist.autoarchive.taskRemainingPeriod = 7 
    tasklist.autoarchive.executeTime = 04:00:00 
    tasklist.autoarchive.maxTasks = 5000 
    tasklist.autodelete.maxHistories = 30000 
    mail.notify.retry.times = 3 
    mail.notify.retry.interval = 10 
    mail.plugin.retry.times = 3 
    mail.plugin.retry.interval = 10 
    client.events.refreshinterval = 5 
  2. By default, there is no tls.client.cipherSuites line, and Ops Center Automator works as if the following value was set:
    TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256

    If you want to change cipher suites from the default, add the tls.client.cipherSuites line if it does not exist, and specify the comma-separated values of cipher suites you want to use in the tls.client.cipherSuites line. For available cipher suites, see Cipher suites supported as a client.