Hitachi

JP1 Version 12 JP1/Performance Management リファレンス


jpcconf port define

〈このページの構成〉

形式

形式1

jpcconf port define     -key サービスキー
                        [-lhost 論理ホスト名]
                        [-inst インスタンス名]
                        [-only]
                        [-input 定義ファイル名]
                        [-noquery]

形式2

jpcconf port define     -key サービスキー
                        [-lhost 論理ホスト名]
                        [-inst インスタンス名]
                        -template 定義ファイル名
                        [-noquery]

機能

jpcconf port defineコマンドは,Performance Managementで使用するポート番号を設定するコマンドです。

ポート番号には固定ポート番号と優先ポート番号があり,サービスの種類によって,コマンドで指定できる内容が異なります。ポート番号の詳細については,「付録C ポート番号一覧」を参照してください。

なお,jpcconf port defineコマンドを実行すると,現在設定されているポート番号が表示されます。ポート番号を指定しないでリターンキーを押すと,表示されているポート番号が設定されます。

コマンドを実行できるホスト

実行権限

Windowsの場合

Administrators権限を持つユーザー(WindowsのUAC機能が有効な場合は管理者コンソールから実行)

UNIXの場合

rootユーザー権限を持つユーザー

格納先ディレクトリ

Windowsの場合

インストール先フォルダ\tools\

UNIXの場合

/opt/jp1pc/tools/

引数

-key サービスキー

ポート番号を操作するサービスのサービスキー名を指定します。指定できるサービスキーを次に示します。

  • all:すべてのPerformance Managementプログラムのサービスのポート番号を操作します。

  • Managerまたはmgr:PFM - Managerサービス(Status ServerサービスとAction Handlerサービスを除く),およびPFM - Web ConsoleとView Serverサービス間で使用するポート番号を操作します。

  • プロダクト名またはagtX:指定したPFM - AgentまたはPFM - RMサービス,およびName Serverサービスで使用するポート番号を操作します。

  • AHまたはact:Action HandlerサービスおよびName Serverサービスで使用するポート番号を操作します。

  • StatSvrまたはstat:Status ServerサービスおよびName Serverサービスで使用するポート番号を操作します。

    注※

    -onlyオプションを指定した場合,NameServerサービスのポート番号は操作されません。

プロダクト名」または「agtX」は,各PFM - AgentまたはPFM - RMのサービスキーを示します。PFM - AgentまたはPFM - RMのサービスのサービスキーについては,マニュアル「JP1/Performance Management 設計・構築ガイド」の付録の,命名規則について説明している個所を参照してください。

-lhost 論理ホスト名

論理環境が対象の場合,論理ホストのホスト名を指定します。

1〜32バイトの半角英数字で指定します。半角空白文字および"."は指定できません。

論理ホスト名に,"localhost",IPアドレス,"-"から始まるホスト名は指定できません。

-inst インスタンス名

特定のインスタンスのポート番号を操作したい場合は,インスタンス名を指定します。このオプションは,インスタンス環境を持つPFM - AgentまたはPFM - RMにだけ有効です。1〜32バイトの半角英数字で指定します。

-only

このオプションを指定すると,プロダクト名,Action Handler,または特定のインスタンスのポート番号の変更だけが有効になるため,ポート番号を変更しないサービスの再起動が不要になります。このオプションは,-keyオプションで「プロダクト名またはagtXか「AHまたはact」を指定している場合にだけ指定できます。これら以外のサービスキーを指定している場合に-onlyオプションを指定すると,KAVE05093-Eメッセージが出力され,処理が中止されます。

注※

ヘルスチェックエージェント(HCagt0)を指定している場合は,-onlyオプションは指定できません。

-noquery

このオプションを指定すると,コマンドの実行を中断する問い合わせメッセージが出力されなくなり,ユーザーの応答が不要になります。

このコマンドを非対話形式で実行するには,このオプションと-inputオプションを同時に指定します。

なお,コマンド実行時は次のように動作します。

  • 起動中のPerformance Managementサービスがない場合

    KAVE05143-Eメッセージが出力され,コマンドの実行が中断されます。サービスを停止してコマンドを再度実行してください。

  • -templateで指定したファイルと同名のファイルがある場合

    KAVE05399-Iメッセージが出力され,ファイルが更新されます。

-input 定義ファイル名

ポート番号を定義ファイルから読み込む場合に指定します。1〜250バイトで指定します。指定した定義ファイルの内容で,ポート番号が設定されます。

-inputオプションで指定した定義ファイルのサービス名ラベルに「auto」を指定した状態でコマンドを実行すると,次のようになります。

固定ポートがあるサービス:

固定ポート番号が設定されます。

優先ポートがあるサービス:

優先ポート番号が設定されます。ただし,優先ポート番号がすでに使用されている場合は,その時点で使用されていないポート番号が設定されます。

固定ポート番号および優先ポート番号の詳細については,「付録C.1 Performance Managementのポート番号」を参照してください。

指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。

このコマンドを非対話形式で実行するには,このオプションと-noqueryオプションを同時に指定します。

-template 定義ファイル名

ポート番号の設定値を定義ファイルに出力する場合に指定します。1〜245バイトで指定します。対象となるすべてのサービスのラベルが記載された定義ファイルが出力されます。なお,[コンポーネント名]セクションのラベルに対応する値は,設定されているポート番号または0になります。

指定したファイルパスに空白が含まれる場合は「"」で囲んで指定してください。

定義ファイルの形式(jpcconf port defineコマンド)

定義ファイルはテキスト形式のファイルです。次に示すセクションおよびラベルで構成されます。ラベルの設定値は,ラベル名の後ろの「=」に続けて指定します。不正なセクション名およびラベル名を指定した場合,該当するセクションおよびラベルは無視されます。

[Common Definitions]セクション

定義ファイルの基本情報を指定するセクションです。このセクションおよびこのセクション内のラベルは省略できません。

Definition File Versionラベル

定義ファイルのバージョンを指定するラベルです。固定で「0001」を指定してください。

[コンポーネント名]セクション

設定するポート番号を指定するセクションです。

コンポーネント名には,ポート番号を設定するサービスが属するコンポーネント名を指定します。このセクションは,コンポーネント名ごとに複数指定できます。

なお,同じ名称のセクションを複数指定した場合,最初に指定したセクションの設定が有効になります。

指定できる値は次のとおりです。

  • Common

    Name Server,Status Server,およびAction Handlerサービスで使用するポート番号を設定する場合に指定します。

  • Manager

    PFM - Managerの各サービスで使用するポート番号を設定する場合に指定します。

  • PFM - Agent,PFM - RMのプロダクト名

    PFM - AgentまたはPFM - RMで使用するポート番号を設定する場合に指定します。なお,プロダクト名については,マニュアル「JP1/Performance Management 設計・構築ガイド」の,Performance Managementの機能について説明している章を参照してください。

インスタンス名サブセクション

PFM - AgentまたはPFM - RMのインスタンス環境のポート番号を指定するサブセクションです。このサブセクションは,コンポーネント名にマルチインスタンスのPFM - AgentまたはPFM - RMを指定した場合だけ指定します。

なお,同じ名称のサブセクションをセクション配下に複数指定した場合,最初に指定したサブセクションの設定が有効になります。

サービス名ラベル

設定するポート番号を指定するラベルです。

なお,同じ名称のラベルをセクションまたはサブセクション配下に複数指定した場合,最初に指定したラベルの設定が有効になります。

  • ポート番号を固定しない状態(サービスが再起動されるたびに割り当てられる状態)にする場合は,値に「0」を指定します。ただし,固定の番号が割り当てられているポート番号には,「0」を指定しても固定のポート番号が割り当てられます。

  • Performance Managementで割り当てられるデフォルトのポート番号を使用する場合は,値に「auto」を指定します。ただし,固定の番号が割り当てられているポート番号には「auto」を指定できません。

  • ポート番号を指定する場合は,1024〜65535の範囲内でかつシステムで使用されていない値を指定してください。

  • ポート番号を変更しない場合は,値には何も指定しないでください。

1024〜65535に含まれない値や,autoを除く数値以外の文字列を含む値を指定した場合は,該当するサービスに対する処理がスキップされます。

[コンポーネント名]セクションとサービス名ラベルの指定で使用するコンポーネント名,サービス名,および設定値を次の表に示します。

コンポーネント名

サービス名

設定値

Common

Name Server

Name Serverのポート番号を指定する

Status Server

Status Serverのポート番号を指定する

Action Handler

Action Handlerのポート番号を指定する

Manager

Master Manager

Master Managerのポート番号を指定する

Master Store

Master Storeのポート番号を指定する

Correlator

Correlatorのポート番号を指定する

Trap Generator

Trap Generatorのポート番号を指定する

View Server

View Serverのポート番号を指定する

View

View Server(PFM - Web ConsoleとView Serverサービス間)のポート番号を指定する

PFM - AgentまたはPFM - RMのプロダクト名

Collector

PFM - Agent CollectorまたはRemote Monitor Collectorの使用するポート番号を指定する

Store

Agent StoreまたはRemote Monitor Storeの使用するポート番号を指定する

定義ファイルの記述例を次に示します。

[Common Definitions]
Definition File Version=0001
 
[Common]
Name Server=22285
Status Server=22350
[Manager]
Master Manager=auto
Master Store=auto
Correlator=auto
:
[Windows]
Collector=0
Store=0
:
[Oracle]
[[oracle1]]
Collector=0
Store=0

注意事項

戻り値

0

正常終了した。

1

引数の指定に誤りがある。

2

コマンドの実行権限がない。

4

指定されたサービスが停止されていない。

5

指定されたサービスキーがない。

6

定義ファイルの内容に誤りがある。

7

指定されたサービスキーが論理ホストに対応していない。

10

コマンドが実行中である。

11

ユーザーによって処理が中止された(問い合わせに対して「N」を返した場合)。

13

定義ファイルに指定した内容で設定できなかったため,設定がスキップされたサービスがある。

100

Performance Managementの環境が不正である。

101

ポート番号が取得できない。

102

指定されたインスタンスがない。

106

ポート番号がservicesファイルに登録されていない。

200

メモリーが不足している。

210

ディスク容量が不足している。

211

ファイルにアクセスできない。

222

通信処理でエラーが発生した(IPアドレスが取得できない)。

224

servicesファイルに設定できるポート番号がない。

230

内部コマンドの実行に失敗した。

255

予期しないエラーが発生した。

使用例

運用例1

すべてのPerformance Managementプログラムのサービスのポート番号を固定値にする場合のコマンド実行例を次に示します。

jpcconf port define -key all

運用例2

NameServerサービスのポート番号を操作しないで,PFM - Agent for Oracleのポート番号に固定値を設定する例を次に示します。

# jpcconf port define -key Oracle -only

非対話形式のコマンドの運用例

-noqueryオプション,-inputオプション,および-templateオプションを使用することで,Performance Managementからの問い合わせを抑止した状態でセットアップを実行できます。運用例を次に示します。

運用例3

PFM - Agent for Platform(Windows)とPFM - Agent for Oracleで設定が必要なポート番号の情報を,それぞれテンプレートとして定義ファイルAgentPort01.txtAgentPort02.txtに出力する例を次に示します。

# jpcconf port define -key Windows -template AgentPort01.txt
# jpcconf port define -key Oracle -template AgentPort02.txt

運用例4

PFM - Agent for Platform(Windows)とPFM - Agent for Oracleにポート番号を設定する例を次に示します。

なお,ここでは運用例1で出力したAgentPort01.txtAgentPort02.txtをあらかじめ編集しているものとします。

# jpcconf port define -key Windows -input AgentPort01.txt -noquery
# jpcconf port define -key Oracle -input AgentPort02.txt -noquery