jimasecret
機能
指定されたシークレットを難読化してシークレット管理ファイルに登録するコマンドです。登録したシークレットは，JP1/IM - Agentのサービスが読み込んで利用します。
このコマンドで設定できるシークレットについては，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「3.15.10 シークレット難読化機能」を参照してください。
形式
-
シークレットを登録したキーを一覧表示する場合
jimasecret -list
[-l 共有ディレクトリ]-
キーを指定してシークレットを追加または更新する場合
jimasecret -add
-key キー名
-s シークレット
[-l 共有ディレクトリ]-
キーを指定してシークレットを削除する場合
jimasecret -rm
-key キー名
[-l 共有ディレクトリ]
実行権限
Windowsの場合：Administrators権限（WindowsのUAC機能が有効な場合は管理者コンソールから実行）
Linuxの場合：スーパーユーザー権限
格納先ディレクトリ
- Windowsの場合
-
Agentパス\tools\
- Linuxの場合
-
/opt/jp1ima/tools/
引数
- -list
-
登録したシークレットのキーを一覧表示します。シークレットは表示しません。
-add，-rmオプションと同時に指定できません。
- -add
-
キーを指定して新しいシークレットを登録します。
すでに登録済みのキーを指定した場合は，シークレットを上書きします。このとき，上書きの確認はしません。
登録できるシークレットは1,000個までです。
このオプションを指定する場合は，-keyおよび-sオプションも必須で指定します。
-list，-rmオプションと同時に指定できません。
- -rm
-
キーを指定して登録済みのシークレットを削除します。
存在しないキーを指定した場合は，エラーとなります。
このオプションを指定する場合は，-keyオプションも必須で指定します。
-list，-addオプションと同時に指定できません。
- -key キー名
-
追加，変更，削除するシークレットのキー名を指定します。
指定できる文字は，ASCIIコードの0x20〜0x7eの文字です。
指定できる長さは，最大1,024文字です。
具体的なキーの書式を次に示します。
- ■接続先のマネージャーの情報
-
マネージャーホストへ接続するためのプロキシーパスワードのキー
immgr.proxy_user.認証ID
認証IDには，imagent設定ファイル（jpc_imagent.json）のimmgr.proxy_userに指定したユーザーIDを指定します。
- ■マネージャーホストへ接続するための初期シークレットのキー
immgr.initial_secret
- ■マネージャーホストへ接続するためのクライアントシークレットのキー
immgr.client_secret
- ■統合エージェント制御基盤
-
アクション実行で使用する実行ユーザーのパスワードを登録するためのキー
action.user.<ユーザー名>
ユーザー名にはimagent設定ファイル（jpc_imagent.json）のaction.usernameに指定したユーザーを指定します。
Windowsのみ有効です。Linuxの場合，設定しても無視されます。
- 重要
-
-keyに指定した値が正しい書式であるかのチェックは行われません。
- メモ
-
クライアントシークレットは，ユーザーが手動で削除する場合にだけ指定します。
- ■Blackbox exporterの場合
-
-
プロキシ認証のパスワードを登録するときのキー
Blackbox.モジュール名.proxy_user.認証ID
モジュール名には，Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）に指定したモジュール名を指定します。
認証IDには，Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）のproxy_userに指定したユーザーIDを指定します。
-
監視対象Webサーバのパスワードを登録するときのキー
Blackbox.モジュール名.basic_auth.認証ID
モジュール名には，Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）に指定したモジュール名を指定します。
認証IDには，Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）のbasic_auth.usernameに指定したユーザーIDを指定します。
-
監視対象WebサーバのBearerトークンを登録するときのキー
Blackbox.モジュール名.bearer_token
モジュール名には，Blackbox exporter設定ファイル（jpc_blackbox_exporter.yml）に指定したモジュール名を指定します。
-
- ■Primitorの場合
-
-
Resource Discoveryのクライアントシークレットを登録するときのキー
Promitor.resource_discovery.env.AUTH_APPKEY
-
Scraperのクライアントシークレットのキーを登録するときのキー
Promitor.scraper.env.AUTH_APPKEY
-
- ■OracleDB exporterの場合
-
Oracle Databaseに接続するためのパスワードを登録するキーには，次に示す2種類のキーがあります。
-
Oracle Databaseに接続するためのパスワードのキー（ユーザー名を指定する形式）
OracleDB.user.ユーザー名
・ユーザー名
環境変数DATA_SOURCE_NAMEに設定しているユーザー名を指定します。大文字小文字を合わせてください。
-
Oracle Databaseに接続するためのパスワードのキー（ホスト名，リスナーサービス名，ユーザー名を指定する形式）
OracleDB.host.ホスト名.listener.リスナーサービス名.user.ユーザー名
・ホスト名
環境変数DATA_SOURCE_NAMEのOracle Databaseサーバーのホスト名を指定します。大文字小文字を合わせてください。
・リスナーサービス名
環境変数DATA_SOURCE_NAMEのサービス名を指定します。大文字小文字を合わせてください。
・ユーザー名
環境変数DATA_SOURCE_NAMEに設定しているユーザー名を指定します。大文字小文字を合わせてください。
通常は，「ユーザー名を指定する形式」のキーを使用します。
同じユーザー名のユーザーが複数存在，かつ，異なるパスワードを設定して運用しているような環境の場合は，「サーバ名，リスナーサービス名，ユーザー名を指定する形式」のキーを使用して，Oracle Databaseホストやサービスごとにパスワードを設定する必要があります。
OracleDB exporterは，環境変数DATA_SOURCE_NAMEの値から，ホスト名，リスナーサービス名，ユーザー名の値を取得します。取得した値から「ユーザー名を指定する形式」のキー，および，「サーバ名，リスナーサービス名，ユーザー名を指定する形式」のキーを構成して，登録済みのパスワードを検索します。両方の形式でパスワードを取得できた場合は，「サーバ名，リスナーサービス名，ユーザー名を指定する形式」のキーを使用します。
-
- -s シークレット
-
追加または更新するシークレット（パスワード）を指定します。
指定できる文字は，ASCIIコードの0x20〜0x7eの文字です。
指定できる長さは，最大1,024文字です。
- -l 共有ディレクトリ
-
論理ホスト環境を対象にする場合は，論理ホストの共有ディレクトリを指定します。
相対パスまたは絶対パスで指定します。
指定できるパスの長さは63バイトまでです。
文字種のチェックは行われません。
注意事項
-keyに指定した値が正しい書式であるかのチェックは行いません。
戻り値
|
0 |
正常終了 |
|
1 |
異常終了（ユーザー起因のエラー） |
|
2 |
異常終了（その他のエラー） |
ログの出力
-
出力先
■Windowsの場合
Agentパス\logs\tools\
■Linuxの場合
/opt/jp1ima/logs/tools/
使用例
-
シークレットを登録する場合
> jimasecret -add -key Blackbox.http1.proxy_user.p-user01 -s password01
-
シークレットを削除する場合
> jimasecret -rm -key Blackbox.http1.proxy _user.p-user01
-
登録済みのキーを一覧表示する場合
> jimasecret -list Blackbox.http1.proxy_user.p-user01 Blackbox.http1.basic_auth.w-user01 immgr.proxy_user.user01