Hitachi

JP1 Version 12 JP1/Automatic Operation 構築ガイド 


2.2 ユーザー設定プロパティファイル(config_user.properties)

ログ,タスク,JP1イベントなどJP1/AOの各種設定をするための定義ファイルです。

形式

指定キー名=設定値

格納先フォルダ

非クラスタシステムの場合

JP1/AOのインストール先フォルダ\confまたは/opt/jp1ao/conf

クラスタシステムの場合

共有フォルダ名\jp1ao\confまたは共有フォルダ名/jp1ao/conf

定義の反映契機

JP1/AOの再起動

記述内容

指定キー名と設定値を1行に1つずつ指定します。ユーザー設定プロパティファイルを記述するときは,次の点に注意してください。

設定項目

表2‒2 ユーザー設定プロパティファイルの設定項目

分類

キー名

設定項目

設定できる値

デフォルト値

ログ※1

logger.message.server.MaxBackupIndex

サーバ用ログバックアップファイルの最大面数を指定する。

1~16

7

logger.message.server.MaxFileSize

サーバ用ログファイルサイズの最大値(単位:KB)を指定する。

4~2097151

1024

logger.message.server.outputTaskDetail.enable

タスクの詳細情報(KNAE01360-I,KNAE01361-W,KNAE01362-E)をサーバ用ログに出力するかどうかを指定する。

デバッグ実行の場合は出力されません。

  • true:出力する

  • false:出力しない

false

logger.message.command.MaxBackupIndex

コマンド用ログバックアップファイルの最大面数を指定する。

1~16

7

logger.message.command.MaxFileSize

コマンド用ログファイルサイズの最大値(単位:KB)を指定する。

4~2097151

1024

logger.TA.MaxFileSize

タスク用ログファイルサイズの最大値(単位:KB)を指定する。

4~2097151

10240

タスク管理

tasklist.autoarchive.taskRemainingPeriod

実行が終了したタスクをタスク一覧に保持する期間(単位:日)を指定する。

1~90

7

tasklist.autoarchive.executeTime

次の処理を実行する時刻を指定する。

  • タスクの自動アーカイブ

  • 履歴の自動削除

  • デバッグタスクの自動削除

この時刻に,データベースの無効領域の解放も実施されます。

00:00:00~23:59:59

04:00:00

tasklist.autoarchive.maxTasks

タスク一覧に保持するタスクおよびデバッグタスク一覧に保持するデバッグタスクの合計の最大数を指定する。

100~5000

5000

tasklist.autodelete.maxHistories

保持する履歴の最大数を指定する。

100~30000

30000

task.periodicalTaskArchive.enable

タスクの定期アーカイブ,履歴の定期削除を有効にするかどうかを指定する。

  • true:有効にする

  • false:無効にする

false

task.periodicalTaskArchive.period

タスクの定期アーカイブ,履歴の定期削除の実行間隔(単位:時間)を指定する。実行間隔はタスクの自動アーカイブの実行時刻を基準とする。

1/2/3/4/6/8/12/24

24

task.periodicalTaskArchive.taskCountThreshold

タスクの定期アーカイブ機能のタスク数のしきい値を指定する。タスク数が本プロパティ値のしきい値を超える場合,タスクのアーカイブを実行する。本プロパティ値はキー名tasklist.autoarchive.maxTasksの値より小さい必要がある。

0~5000

4000

task.periodicalTaskArchive.taskCountAfterArchive

タスクの定期アーカイブ機能の残タスク数を指定する。タスクの定期アーカイブ機能では,アーカイブ後に本プロパティ値のタスク件数になるようにタスクをアーカイブする。

本プロパティ値はキー名task.periodicalTaskArchive.taskCountThresholdの値以下である必要がある。

0~5000

3000

task.execute.skip.serverStart※10 JP1/AOサービスを再開した場合,開始予定日時を過ぎていたタスクの動作を指定する。
  • true:キャンセルとなります

  • false:即座にタスクが実行されます

false

部品のローカル実行

plugin.localMode

ローカル実行機能を使用するかどうかを指定する。

「true」を指定すると,部品の実行ユーザーは,Systemアカウントまたはrootユーザーになります。ただし,これらのユーザーではアクセスできないリソースを使用する場合は,正常に部品を実行できなくなることがあります。

  • true:有効にする

  • false:無効にする

false

サービス管理

packagemanager.maxServiceTemplates

JP1/AOで管理するサービステンプレート(作成またはインポートしたサービステンプレートの合計)の最大数を指定する。

1~3000

1000

packagemanager.maxServices

デバッグサービスを含む,作成するサービスの最大数を指定する。

1~3000

1000

JP1イベントの通知

notification.jp1event

通知機能としてJP1イベントを送信するかどうかを指定する。

  • true:送信する

  • false:送信しない

false

部品実行

plugin.threadPoolSize

通常のタスクに含まれる部品の同時実行数を指定する。

  • 10

  • 50

  • 100

10

繰り返し

foreach.max_value

繰り返し実行部品で同時実行できる最大数を指定する。

1~99

3

リモート接続ポート番号

ssh.port.number

操作対象機器のSSHポート番号を指定する。

0~65535

22

telnet.port.number

操作対象機器のTelnetポート番号を指定する。

0~65535

23

ターミナル接続

plugin.terminal.prompt.account

ユーザーIDの入力待ち状態であることを検知するための,正規表現パターンを1~1,024文字で指定する。操作対象の機器にTelnetで接続する場合,ターミナル接続部品は,標準出力および標準エラー出力が指定した正規表現パターンと合致したときに,ユーザーIDの入力待ち状態であると検知し,ユーザーIDを入力する。

正規表現パターンで使用できる文字列

login|Login Name|Username|UserName

plugin.terminal.prompt.password

パスワードの入力待ち状態であることを検知するための,正規表現パターンを1~1,024文字で指定する。操作対象の機器にTelnetで接続する場合,ターミナル接続部品は,標準出力および標準エラー出力が指定した正規表現パターンと合致したときに,パスワードの入力待ち状態であると検知し,パスワードを入力する。

正規表現パターンで使用できる文字列

password|Password|PassWord

telnet.connect.wait

操作対象機器にTelnet接続したあと,標準出力が返るまでの待ち時間(単位:秒)を指定する。

1~600

60

ssh.privateKeyFile

SSH接続で公開鍵認証を使用する場合に,秘密鍵ファイルの絶対パスを指定する。

0~255文字の文字列

" "(空文字)

リモートコマンド

plugin.remoteCommand.executionDirectory.wmi※2

操作対象機器のOSがWindowsの場合,コンテンツ部品を実行するための実行ディレクトリのパスを指定する。なお,実行ディレクトリは,作業用フォルダと同じドライブ配下に事前に作成し,必要に応じてパーミッションを変更する必要がある。少なくとも,部品を実行するユーザーのパーミッションを付与する必要がある。

コンテンツ部品の「実行モード」が「スクリプト」の場合,ここで指定した値と,スクリプトファイル名の合計の文字列長が140文字以下になるようにする必要がある。140文字を超える場合,スクリプトファイルの転送に失敗することがある。なお,スクリプトファイル名は90文字以内で指定するため,ここで指定する値は,50文字以内とすることをお勧めする。

0~128文字の文字列

" "(空文字)

plugin.remoteCommand.executionDirectory.ssh※3

操作対象機器のOSがUNIXの場合,コンテンツ部品を実行するための実行ディレクトリのパスを指定する。なお,実行ディレクトリは事前に作成し,必要に応じてパーミッションを変更する必要がある。少なくとも,部品を実行するユーザーのパーミッションを付与する必要がある。

0~128文字の文字列

" "(空文字)

plugin.remoteCommand.workDirectory.ssh※4

操作対象の機器のOSがUNIXの場合,ファイル転送部品またはコンテンツ部品を実行したときに使用する作業用フォルダ※5を指定する。絶対パス(1~128文字)で,フォルダまたはシンボリックリンクを入力する。なお,シンボリックリンクをパスの階層に含めることもできる。

半角英数字,および次の記号です。

「/」(パスの区切り文字として指定できる),「-」,「_」,「.」

/tmp/Hitachi_AO

plugin.wmi.win32.UACAdministratorsExec 操作対象機器のOSがWindowsで,UACが有効な場合にSystemアカウント以外のユーザーで部品を実行するための設定を有効にするかどうかを指定する。
  • true:有効にする

  • false:無効にする

false
plugin.wmi.win32.CreationFlags.CREATE_NO_WINDOW 操作対象の機器のOSがWindowsの場合,Systemアカウント以外のユーザーでプログレスバーを表示するようなコマンドを実行すると,正しく動作しない場合があるときに有効にする。
  • true:有効にする

  • false:無効にする

true

Webクライアント

plugin.http.connect.timeout

HTTP/HTTPS接続を確立するときのタイムアウト値(単位:秒)を指定する。0を指定した場合,タイムアウトしない。

0~3600

60

plugin.http.read.timeout

HTTP/HTTPS接続でデータを読み取るときのタイムアウト値(単位:秒)を指定する。0を指定した場合,タイムアウトしない。

0~86400

600

リモートホスト接続 plugin.adapter.timeout※10 排他処理のタイムアウト時間(単位:秒) 0~2147483647 2147483647

リモートホスト接続リトライ

ssh.connect.retry.times

操作対象機器へのSSH接続に失敗した場合のリトライ回数を指定する。

0~100

3

ssh.connect.retry.interval

操作対象機器へのSSH接続に失敗した場合のリトライ間隔(単位:秒)を指定する。

1~600

10

wmi.connect.retry.times

操作対象機器にWindows用の接続を行い,接続に失敗した場合のリトライ回数を指定する。

0~100

3

wmi.connect.retry.interval

操作対象機器にWindows用の接続を行い,接続に失敗した場合のリトライ間隔(単位:秒)を指定する。

1~600

10

telnet.connect.retry.times

操作対象機器へのTelnet接続に失敗した場合のリトライ回数を指定する。

0~100

3

telnet.connect.retry.interval

操作対象機器へのTelnet接続に失敗した場合のリトライ間隔(単位:秒)を指定する。

1~600

10

リモートファイル操作リトライ

plugin.remoteFileAccess.retry.times

コンテンツ部品とファイル転送部品が内部で実行するファイルを操作するコマンドのリトライ回数を指定する。なお,リトライの間隔は100ms固定である。

一時的なファイルアクセスのエラーが発生した場合でも,リトライを行うことで成功する場合がある。しかし,ファイルアクセスのエラーが回復しない場合は,部品の終了までに,リトライを行う時間分だけ余分に時間がかかる。このプロパティは,ディスクなどに問題がないにも関わらず,ファイルアクセスのエラーが発生する環境で設定する。

0~100

0

メール送信リトライ

mail.notify.retry.times

通知機能でメール送信に失敗した場合のリトライ回数を指定する。

0~100

3

mail.notify.retry.interval

通知機能でメール送信に失敗した場合のリトライ間隔(単位:秒)を指定する。

1~600

10

mail.plugin.retry.times

メール通知部品でメール送信に失敗した場合のリトライ回数を指定する。

0~100

3

mail.plugin.retry.interval

メール通知部品でメール送信に失敗した場合のリトライ間隔(単位:秒)を指定する。

1~600

10

監査ログ

logger.Audit.enable

監査ログを出力するかどうかを指定する。

  • 0:出力しない

  • 1:出力する

0

logger.Audit.path

監査ログの出力先パスを1~244バイトで指定する。

半角英数字,半角スペース,および次の記号です。

「!」,「#」,「$」,「&」,「(」,「)」,「+」,「,」,「-」,「.」,「;」,「=」,「@」,「[」,「]」,「?」,「_」,「`」,「{」,「}」,「~」

Windowsの場合

JP1/AOのインストール先フォルダ\logs※6

Linuxの場合

/var/opt/jp1ao/logs

logger.Audit.MaxBackupIndex

監査ログ用ログバックアップファイルの最大面数を指定する。

1~16

7

logger.Audit.MaxFileSize

監査ログ用ログファイルサイズの最大値(単位:KB)を指定する。

4~2097151

1024

logger.Audit.command.useLoginUserID※7

コマンド実行時の監査ログのサブジェクト識別情報に出力するユーザーIDを,JP1/AOのログインユーザーIDに切り替えるかどうかを指定する。

  • true:サブジェクト識別情報にJP1/AOのログインユーザーIDを出力する

  • false:サブジェクト識別情報にOSのユーザーIDを出力する

false

画面更新

client.events.refreshinterval

[Service Builder]画面の[コンポーネント]エリアの更新間隔(単位:秒)を指定する。

0~65535

5

サービスビルダー

client.editor.upload.maxfilesize

[Service Builder]画面から,次のファイルをアップロードする場合に,指定できるそれぞれのファイルサイズの最大値(単位:MB)を指定する。

  • コンポーネントアイコンファイル

  • 部品で実行するスクリプトファイル

  • 部品リソースファイル

  • サービスリソースファイル

  • 画面カスタムファイル

1~10

3

server.editor.step.perTemplate.maxnum※8

1サービステンプレートあたりの最大ステップ数を指定する。

320~40000 ※9

320

server.editor.step.perLayer.maxnum※8

1階層あたりの最大ステップ数を指定する。

80~10000 ※9

80

server.editor.publicProperty.perTemplate.maxnum

1サービステンプレートあたりの最大サービスプロパティ数を指定する。

100~2000

1000

server.editor.propertyGroup.perTemplate.maxnum

1サービステンプレートあたりの最大プロパティグループ数を指定する。

5~1000

500

client.editor.canvas.maxwidth※8

[フロー]エリアの操作領域の最大横幅サイズ(単位:px)を指定する。

見積もり式は,次のとおりです。

横幅サイズ(px) = (横1列に配置したいステップ数 + 1) × 90(px)

3600~10000

3600

client.editor.canvas.maxhigh※8

[フロー]エリアの操作領域の最大縦幅サイズ(単位:px)を指定する。

見積もり式は,次のとおりです。

縦幅サイズ(px) = 縦1列に配置したいステップ数 × 300(px)

2400~30000

2400

デバッグ

tasklist.debugger.autodelete.taskRemainingPeriod

実行が終了したデバッグタスクをデバッグタスク一覧に保持する期間(単位:日)を指定する。

1~90

7

client.debugger.tasklog.maxfilesize

[タスクログ]タブに表示するタスクログのサイズ(単位:KB)を指定する。

4~10240

1024

logger.debugger.TA.MaxFileSize

デバッグタスク用ログファイルサイズの最大値(単位:KB)を指定する。

4~2097151

10240

「長期実行中」のタスク

server.longRunning.check.interval

タスクの状態を「長期実行中」と判定するまでの実行時間(単位:分)を指定する。「0」を指定した場合,「長期実行中」の判定をしない。

0~20160

2880

server.longRunning.monitor.interval

「長期実行中」のタスクを監視する間隔(単位:秒)を指定する。

1~3600

60

部品の出力

plugin.stdoutSize.wmi

汎用コマンド実行部品またはコンテンツ部品で,接続対象ホストがWindowsの場合の標準出力と標準エラー出力の合計サイズの最大値(単位:KB)を指定する。出力が最大値を超えた場合,部品の実行がエラーとなる。

出力の改行数が65535以上となった場合,部品が実行中のままとなるため,65534以内となるようなサイズを指定する。

1~1024

100

plugin.stdoutSize.ssh

汎用コマンド実行部品またはコンテンツ部品で接続対象ホストがUNIXの場合,または,ターミナル接続部品またはターミナルコマンド実行部品で接続プロトコルがSSHの場合の標準出力と標準エラー出力の合計サイズの最大値(単位:KB)を指定する。出力が最大値を超えた場合,部品の実行がエラーとなる。

1~1024

100

plugin.stdoutSize.telnet

ターミナル接続部品またはターミナルコマンド実行部品で接続プロトコルがTelnetの場合の標準出力と標準エラー出力の合計サイズの最大値(単位:KB)を指定する。

1~1024

100

共通コンポーネントHTTP接続ポート番号

server.http.port

JP1/AOサーバが共通コンポーネントとHTTP通信する場合に使用するポート番号を指定する。

0~65535

22015

注※1

タスク用ログの出力しきい値は,サービス共有プロパティで設定できます。

注※2

実行ディレクトリは次の優先順位で決定します。

優先順位

設定値

1

部品に定義された実行ディレクトリの値

2

接続先プロパティファイル(接続先名.properties)のcommon.executionDirectoryで指定した値

3

plugin.remoteCommand.executionDirectory.wmiで指定した値

4

操作対象の機器の接続先のWindowsの環境変数%TEMP%の値

注※3

実行ディレクトリは次の優先順位で決定します。

優先順位

設定値

1

部品に定義された実行ディレクトリの値

2

接続先プロパティファイル(接続先名.properties)のcommon.executionDirectoryで指定した値

3

plugin.remoteCommand.executionDirectory.sshで指定した値

4

/tmp

注※4

このプロパティで指定したパスや親フォルダのパスを,ファイル転送部品の送信先フォルダや受信元フォルダに指定しないでください。指定した場合は,製品サポートの対象外となります。

注※5
  • 作業用フォルダには,接続ユーザーに対する読み込み権限,書き込み権限,および実行権限が必要となります。

  • ファイル転送部品またはコンテンツ部品を実行した際に,作業用フォルダのアクセス権を777(すべてのユーザーにアクセス権を設定)に変更します。作業用フォルダに指定したパスが存在しない場合,部品の実行時に作業用フォルダが作成されます。なお,フォルダの作成に失敗した場合,部品の実行は異常終了します。

注※6

出力するファイル名は「Audit[n].log」です。[n]には面数の整数値が入ります。

注※7

監査ログのサブジェクト識別情報に出力されるユーザーIDが切り替わるコマンドを次に示します。

  • deleteservicetemplateコマンド

  • importservicetemplateコマンド

  • listservicesコマンド

  • listtasksコマンド

  • stoptaskコマンド

  • submittaskコマンド

注※8

これらの定義は,JP1/AO 10-02以前との互換用プロパティです。

注※9

これらの定義は,次の条件すべてに合致する場合だけ編集してください。これらの条件に合致しない場合は,定義を編集する必要はありません。なお,定義を編集する場合は,サービステンプレートの複製および編集をする前に実施してください。

  • 10-02以前のJP1/AOで作成したサービステンプレートを編集する場合

  • 編集するサービステンプレートのステップの合計が320を超えている,または1階層あたりのステップ数が80を超えている場合

注※10

デフォルトではファイル中にキー名は存在しません。

定義例

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