jimasecret

〈このページの構成〉

機能
形式
実行権限
格納先ディレクトリ
引数
注意事項
戻り値
ログの出力
使用例

機能

指定されたシークレットを難読化してシークレット管理ファイルに登録するコマンドです。登録したシークレットは，JP1/IM - Agentのサービスが読み込んで利用します。

このコマンドで設定できるシークレットについては，マニュアル「JP1/Integrated Management 3 - Manager 導入・設計ガイド」の「9.5.7 シークレット難読化機能」を参照してください。

形式

シークレットを登録したキーを一覧表示する場合

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

重要: -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（JP1/IM - Exporterが提供するアドオンプログラム）の場合

Resource Discoveryのクライアントシークレットを登録するときのキー

Promitor.resource_discovery.env.AUTH_APPKEY

Scraperのクライアントシークレットのキーを登録するときのキー

Promitor.scraper.env.AUTH_APPKEY

-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

ページの先頭へ