jpcconf acc setup
- 〈このページの構成〉
形式
形式1
jpcconf acc setup -type {pfmhost|wmi|ssh} [-lhost 論理ホスト名] [-input 定義ファイル名] [-noquery]
形式2
jpcconf acc setup -type {pfmhost|wmi|ssh} -template 定義ファイル名 [-noquery]
機能
形式1
指定した共通アカウント情報を新規に作成したり更新したりします。
形式2
-templateオプションを指定することで,共通アカウント情報で設定するラベルがすべて入力されているテンプレートファイルを出力することもできます。
コマンドを実行できるホスト
-
PFM - Manager
-
PFM - Agent
-
PFM - RM
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
- UNIXの場合
-
rootユーザー権限を持つユーザー(uid=0のユーザー)
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pc/tools/
引数
-type {pfmhost|wmi|ssh}
作成する共通アカウント情報のタイプを指定します。それぞれのタイプの詳細を次に示します。
共通アカウント情報のタイプ |
説明 |
---|---|
pfmhost |
PFM - RMホストごとの,インスタンス環境用の共通アカウント情報です。 |
wmi |
WMIでリモート接続する場合の,監視対象用の共通アカウント情報です。 |
ssh |
SSHでリモート接続する場合の,監視対象用の共通アカウント情報です。 |
-lhost 論理ホスト名
このコマンドを実行するホストの論理ホスト名を指定します。1〜32バイトの半角英数字で指定します。指定を省略した場合,物理ホストが仮定されます。
-templateオプションを使用する場合は(形式2),このオプションは指定できません。
-input 定義ファイル名
共通アカウント情報の設定値を定義ファイルから読み込む場合に指定します。1〜250バイトで指定します。指定した定義ファイルの内容で,共通アカウント情報を自動的に作成または更新します。
指定するファイルパスに空白,または括弧「( )」が含まれる場合は" "で囲んで指定してください。
このオプションを指定しなかった場合,対話形式で実行されます。
-noquery
このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。非対話形式で実行したい場合に指定します。なお,コマンド実行時は次のように動作します。
-
すでに共通アカウント情報が設定されている場合
KAVE05478-Iメッセージが出力され,共通アカウント情報の設定が更新される。
-
-templateオプションで指定したファイルと同名のファイルが存在した場合
KAVE05399-Iメッセージが出力され,ファイルが更新される。
-template 定義ファイル名
定義ファイルのテンプレートを出力する場合に指定します。1〜245バイトで指定します。対象とする共通アカウント情報のタイプに合わせて,セクションおよびラベルが記載された定義ファイルが出力されます。なお,[Account Definitions]セクションのラベルに対応する値は,空白のままです。
出力した定義ファイルは,環境に応じて編集した上で,-inputオプション指定時の入力ファイルとして使用できます。
指定したファイルパスに空白または括弧「( )」が含まれる場合は" "で囲んで指定してください。
定義ファイルの形式(pfmhostおよびwmi)
定義ファイルはテキスト形式のファイルです。セクションとラベルで構成されます。ラベルの設定値は,ラベル名の後ろの「=」に続けて指定します。共通アカウント情報のタイプごとに,定義ファイルの形式が異なります。ここでは,pfmhostおよびwmiの定義ファイルの形式を示します。
- [Common Definitions]セクション
-
定義ファイルの基本情報を指定するセクションです。
- Definition Typeラベル
-
共通アカウント情報のタイプを設定するラベルです。共通アカウント情報のタイプをpfmhostにした場合は「pfmhost」を指定します。共通アカウント情報のタイプをwmiにした場合は「wmi」を指定します。
- [Account Definitions]セクション
-
共通アカウント情報に対する設定値を指定するセクションです。
- Userラベル
-
ユーザー名を1〜256バイトの半角文字で指定できます。ただし,タブは指定できません。このラベルは省略できません。
- Passwordラベル
-
パスワードを1〜256バイトの半角文字で指定できます。ただし,タブは指定できません。このラベルは省略できません。
- Domainラベル
-
ドメイン名を0〜256バイトの半角文字で指定できます。ただし,タブは指定できません。このラベルは省略できます。
pfmhostの定義ファイルの記述例
[Common Definitions] Definition Type=pfmhost [Account Definitions] User=Administrator Password=aaa Domain=bbb
wmiの定義ファイルの記述例
[Common Definitions] Definition Type=wmi [Account Definitions] User=Administrator Password=aaa Domain=bbb
定義ファイルの形式(ssh)
定義ファイルはテキスト形式のファイルです。セクションとラベルで構成されます。ラベルの設定値は,ラベル名の後ろの「=」に続けて指定します。
- [Common Definitions]セクション
-
定義ファイルの基本情報を指定するセクションです。
- Definition Typeラベル
-
共通アカウント情報のタイプを設定するラベルです。共通アカウント情報のタイプをsshにした場合は「ssh」を指定します。
- [Account Definitions]セクション
-
共通アカウント情報に対する設定値を指定するセクションです。
- Userラベル
-
ユーザー名を1〜256バイトの半角文字で指定できます。ただし,タブは指定できません。このラベルは省略できません。
- Private_Key_Fileラベル
-
SSH公開鍵方式で使用する秘密鍵ファイルの名前を絶対パスで指定します。1〜256バイトの半角文字が使用できます。
パスにスペースが含まれている場合でも," "で囲んで指定する必要はありません。ただし,タブは指定できません。
なお,このラベルは省略できません。
sshの定義ファイルの記述例
[Common Definitions] Definition Type=ssh [Account Definitions] User=root Private_Key_File=/opt/jp1pc/agt7/.ssh/agt7
注意事項
-
PFM - RM for PlatformおよびPFM - RM for Platformの同一装置内の前提プログラム(PFM - ManagerまたはPFM - Base)のバージョンが10-50以降である必要があります。
-
定義ファイルにパスワードなどの秘匿情報が含まれる場合,定義ファイルはセキュリティを確保した安全な場所に保存し,使用後は削除してください。また,定義ファイルをホスト間で転送したいときには,SFTP(SSHトンネル経由のFTP)など,盗聴のおそれがない安全な方法を使用することを推奨します。
-
このコマンドは,同一ホスト上の起動停止コマンドまたはほかのセットアップコマンドと同時に実行できません。
-
コマンドの実行をCtrl+Cキーやシグナルで中断した場合,特定の戻り値が返りません。そのため,コマンドをCtrl+Cキーやシグナルで中断した場合は戻り値を無視してください。
-
Remote Monitor Collectorサービスが起動中に共通アカウント情報を更新した場合,共通アカウント情報のタイプによって,更新内容が反映されるタイミングが異なります。
-
pfmhostの共通アカウント情報の更新内容をインスタンス環境へ反映するには,Remote Monitor Collectorサービスを再起動する必要があります。
-
wmiまたはsshの共通アカウント情報の更新内容は,更新後の次のパフォーマンス情報の収集時に反映されます。Remote Monitor Collectorサービスを再起動する必要はありません。
-
-
-inputオプションを指定した場合,定義ファイルに必要なラベルがないとき,または必要なラベルの値が不正なときは,コマンドの実行が中断されます。-noqueryオプションを指定して,バッチまたはスクリプトファイルなどで処理を自動化したい場合は,定義ファイルの内容が正しいことをあらかじめ確認してください。また,コマンドが正常終了したかどうかは,出力されるメッセージまたは戻り値で確認してください。
-
論理ホスト環境で形式1の設定をする場合,待機系では実行できません。
-
-typeオプションがsshの場合,Private_Key_Fileに指定した値のファイルが存在するかどうかをチェックします。ファイルが存在しない場合はKAVE05489-Wを表示して処理を続行します。
戻り値
0 |
正常終了した。 |
1 |
引数の指定に誤りがある。 |
2 |
コマンドの実行権限がない。 |
6 |
定義ファイルの内容に誤りがある。 |
10 |
コマンドが実行中である。 |
11 |
ユーザーによって処理が中止された。 |
26 |
指定された値が誤っている可能性がある。※ |
100 |
Performance Managementの環境が不正である。 |
102 |
指定された論理ホスト名がセットアップされていない。 |
200 |
メモリーが不足している。 |
210 |
ディスク容量が不足している。 |
211 |
ファイルまたはディレクトリにアクセスできない。 |
230 |
内部コマンドの実行に失敗した。 |
255 |
予期しないエラーが発生した。 |
使用例1
対話形式で,-inputオプションで定義ファイルを読み込んで,共通アカウント情報を作成または更新するときの実行例を次に示します。この例では,入力ファイルpfmhostTemplate.txtを読み込んでいます。User,Password,DomainにはpfmhostTemplate.txtの内容が表示されます。Passwordの値は入力時および再入力時にも表示されません。
jpcconf acc setup -type pfmhost -input pfmhostTemplate.txt KAVE05477-Q 共通アカウント情報が設定されています (type=pfmhost)。更新しますか? (Y/N) Y User : Administrator Password : Re-enter : Domain [] : bbb KAVE05473-I 共通アカウント情報の設定が完了しました (type=pfmhost)
使用例2
対話形式で,-templateオプションでテンプレートを出力する場合の実行例を次に示します。この例では,pfmhostTemplate.txtというテンプレートファイルを出力しています。
jpcconf acc setup -type pfmhost -template pfmhostTemplate.txt KAVE05146-Q 指定されたファイルが存在します。更新しますか? (Y/N) Y KAVE05481-I 入力定義ファイルのテンプレート出力が完了しました (type=pfmhost)
使用例3
対話形式で,pfmhostの共通アカウント情報を作成する場合の実行例を次に示します。Passwordの値は入力時および再入力時にも表示されません。
jpcconf acc setup -type pfmhost User : Administrator Password : Re-enter : Domain [] : bbb KAVE05473-I 共通アカウント情報の設定が完了しました (type=pfmhost)
使用例4
対話形式で,pfmhostの共通アカウント情報を更新する場合の実行例を次に示します。Passwordの値は入力時および再入力時にも表示されません。
jpcconf acc setup -type pfmhost KAVE05477-Q 共通アカウント情報が設定されています (type=pfmhost)。更新しますか? (Y/N) Y User [Administrator] : Password : Re-enter : Domain [bbb] : KAVE05473-I 共通アカウント情報の設定が完了しました (type=pfmhost)
使用例5
非対話形式で,-inputオプションでpfmhostTemplate.txtという定義ファイルを読み込んで共通アカウント情報を作成する場合の実行例を次に示します。この例では-noqueryオプションを指定しているので,すでに同じ名前の定義ファイルがある場合は自動的に更新されます。
jpcconf acc setup -type pfmhost -input pfmhostTemplate.txt -noquery KAVE05478-I共通アカウント情報を更新します (type=pfmhost) User : Administrator Password : Re-enter : Domain [] : bbb KAVE05473-I 共通アカウント情報の設定が完了しました (type=pfmhost)
使用例6
非対話形式で,-templateオプションでpfmhostTemplate.txtというテンプレートファイルを出力する場合の実行例を次に示します。この例では-noqueryオプションを指定しているので,すでに同じ名前のテンプレートファイルがある場合は自動的に更新されます。
jpcconf acc setup -type pfmhost -template pfmhostTemplate.txt -noquery KAVE05399-I 既に存在するファイルを更新します (file=C:\Program Files\Hitachi\jp1pc\tools\pfmhostTemplate.txt) KAVE05481-I 入力定義ファイルのテンプレート出力が完了しました (type=pfmhost)