ページの先頭行へ戻る
Symfoware Server V12.1.x リファレンス
FUJITSU Software
第5章 PL/extJavaのコマンド > 5.1 pgx_jadmin
前

5.1 pgx_jadmin

名前

pgx_jadmin -- PL/extJavaの構築や運用操作

概要

pgx_jadmin init-domain --shareddir directory [--domainport port1,port2,port3]
                       --dbadminuser username
                      [--pgdata directory | -D directory] [--cluster-standbynode]
pgx_jadmin delete-domain [-y] [--force] [--cluster-standbynode]
pgx_jadmin list-domain
pgx_jadmin modify-domain-port --domainport port1,port2,port3 [--cluster-standbynode]
pgx_jadmin create-container --dbname database_name [--instanceport port1,port2]
                           [--dbport port] --dbuser username --dbpassword password
                           [--cluster-standbynode]
pgx_jadmin delete-container --dbname database_name [--cluster-standbynode]
pgx_jadmin list-container --dbname database_name
pgx_jadmin add-instance --dbname database_name
                        --instanceport port1,port2 [--cluster-standbynode]
pgx_jadmin delete-instance --dbname database_name [--cluster-standbynode]
pgx_jadmin modify-instance-port --instance name
                                --instanceport port1,port2 [--cluster-standbynode]
pgx_jadmin modify-container-db --dbname database_name [--dbport port]
                              [--dbuser username] [--dbpassword password]
pgx_jadmin list-jvm-options --dbname database_name
pgx_jadmin modify-jvm-options --dbname database_name [--heapsize size]
                             [--permsize size]
pgx_jadmin backup --backupdir directory
pgx_jadmin restore --backupdir directory [--cluster-standbynode]

説明

pgx_jadminは、Symfoware Server Java アプリケーションサーバでPL/extJavaを利用するためのコマンドです。pgx_jadminは、複数のサブコマンドから構成され、それぞれのサブコマンドがPL/extJavaの操作に対応しています。

init-domainサブコマンドは、PL/extJavaを利用するために、ドメインを作成します。ドメインは、Symfoware Serverのインストール後に1回だけ作成します。

delete-domainサブコマンドは、PL/extJavaを利用するためのドメインを削除します。

list-domainサブコマンドは、ドメインの情報を表示します。

modify-domain-portサブコマンドは、ドメイン管理用のポート番号を変更します。

create-containerサブコマンドは、ドメイン内にコンテナを作成します。コンテナを作成すると、コンテナ内にサーバインスタンス（JavaVM）が1個作成されます。インスタンス内のデータベース1個に対してコンテナを1個作成します。また、複数のデータベースでJava関数を利用する場合、それぞれのデータベースに対してコンテナを作成します。

delete-containerサブコマンドは、ドメイン内からコンテナを削除します。

list-containerサブコマンドは、コンテナの情報を表示します。

add-instanceサブコマンドは、コンテナにサーバインスタンス（JavaVM）を追加します。

delete-instanceサブコマンドは、コンテナ内のサーバインスタンス（JavaVM）を削除します。コンテナ内にサーバインスタンス（JavaVM）が複数作成されている場合、最後に追加したサーバインスタンス（JavaVM）を削除します。

modify-instance-portサブコマンドは、サーバインスタンス（JavaVM）の管理用ポート番号を変更します。

modify-container-dbサブコマンドは、コンテナのデータベース接続情報を変更します。

list-jvm-optionsサブコマンドは、コンテナのJavaVMのオプション情報を表示します。

modify-jvm-optionsサブコマンドは、コンテナのJavaVMオプションの設定値を変更します。

backupサブコマンドは、PL/extJavaをバックアップします。

restoreサブコマンドは、PL/extJavaをリストアします。

オプション

--backupdir directory

PL/extJavaのバックアップ格納ディレクトリを絶対パスで指定します。

Windowsディレクトリ名は64バイト以内で指定してください。

SolarisLinuxディレクトリ名は120バイト以内で指定してください。

ディレクトリ名には、以下の文字が使用できます。

  • 半角英数字

  • 半角空白

  • 半角アンダースコア “_”

  • 半角ハイフン “-”

  • 半角丸括弧 “( )”

下記のディレクトリを指定しないでください。

  • インスタンスのデータ格納先、バックアップ格納先およびドメインルートと同じディレクトリ

  • インスタンスのデータ格納先、バックアップ格納先およびドメインルート配下のディレクトリ

  • インスタンスのデータ格納先、バックアップ格納先およびドメインルートが、PL/extJavaのバックアップ格納ディレクトリの配下となるディレクトリ

--cluster-standbynode

本オプションは、クラスタ環境で待機ノードに対してコマンドを実行する場合に指定します。

-D directory
--pgdata directory

インスタンスのデータ格納先を絶対パスで指定します。省略した場合、環境変数(PGDATA)を参照します。

Windows--dbadminuser username

インスタンス管理者名を指定します。

ユーザー名は、20バイト以内で指定してください。

ドメインユーザを指定する場合、“ドメイン名\username”形式で指定してください。ドメイン名は、250バイト以内で指定してください。

ドメイン作成時に設定したインスタンス管理者は、ドメイン作成後に変更することができません。

SolarisLinux--dbadminuser username

インスタンス管理者名を指定します。インスタンス管理者の詳細については、“運用ガイド”の“PL/extJavaの導入と運用”の“ユーザー定義”を参照してください。

ユーザー名は、8バイト以内で指定してください。

ドメイン作成時に設定したインスタンス管理者は、ドメイン作成後に変更することができません。

--dbname database_name

コンテナに対応するデータベース名を、1バイト以上28バイト以内で指定します。データベース名には、以下の文字が使用できます。

  • 半角英数字

  • 半角アンダースコア “_”

先頭文字および最終文字には“_”を指定できません。すでに登録済みのデータベース名は、大文字・小文字の違いにかかわらず指定できません。例えば、“database001”のデータベース名が登録済みの場合、新規に“DATABASE001”のデータベース名でコンテナを作成することはできません。以下の名前のデータベース名は指定できません。

  • domain

  • default

  • server

  • resources

インスタンスに対するデータベース名は変更できません。データベース名を変更する場合、コンテナを再作成してください。

WindowsWindows OSの予約語を指定できません。

--dbpassword password

データベースに接続するユーザーのパスワードを指定します。インスタンスに登録しているユーザーのパスワードと一致させてください。

データベース接続情報を変更する場合は、--dbpasswordおよび--dbuserのいずれかのオプションを指定してください。

--dbport port

インスタンスのポート番号を指定します。ポート番号を省略した場合、インスタンスのデフォルト値の“26500”が設定されます。

--dbuser username

データベースに接続するためのユーザー名を指定します。事前に、インスタンス上にユーザーを登録してください。

データベース接続情報を変更する場合は、--dbuserおよび--dbpasswordのいずれかのオプションを指定してください。

--domainport port1,port2,port3

ドメイン管理用のポート番号を、カンマで区切って指定します。ポート番号は、3個指定する必要があります。ポート番号を省略した場合、デフォルトのポート番号が設定されます。ポート番号の詳細については、“運用ガイド”の“PL/extJavaの導入と運用”の“ポート番号の準備”を参照してください。modify-domain-portサブコマンドに指定する場合、変更しないポート番号は、init-domainサブコマンドで指定した順番を替えて指定できません。

--force

本オプションは、ドメイン内にコンテナが存在していても強制的にドメインを削除する場合に指定します。本オプションを指定しない場合、ドメイン内にコンテナが存在するとドメインの削除に失敗します。

--heapsize size

ヒープ領域サイズを指定します。単位はメガバイトです。ヒープ領域サイズは、64以上の値を指定してください。

JavaVMオプションの設定値を変更する場合は、--heapsizeおよび--permsizeのいずれかのオプションを指定してください。

--instance name

サーバインスタンス（JavaVM）名を指定します。コンテナ内に登録されたサーバインスタンス（JavaVM）名は、list-containerサブコマンドで確認することができます。

--instanceport port1,port2

サーバインスタンス（JavaVM）管理用のポート番号を、カンマで区切って指定します。ポート番号は、2個指定する必要があります。ポート番号を省略した場合、デフォルトのポート番号が設定されます。ポート番号の詳細については、“運用ガイド”の“PL/extJavaの導入と運用”の“ポート番号の準備”を参照してください。

modify-instance-portサブコマンドに指定する場合、変更しないポート番号は、create-containerサブコマンド、またはadd-instanceサブコマンドで指定した順番を替えて指定できません。

--permsize size

Perm領域サイズを指定します。単位はメガバイトです。Perm領域サイズは、64以上の値を指定してください。

JavaVMオプションの設定値を変更する場合は、--permsizeおよび--heapsizeのいずれかのオプションを指定してください。

--shareddir directory

ドメインの資源を格納するディレクトリ（ドメインルート）を絶対パスで指定します。

Windowsディレクトリ名には存在しないディレクトリを、64バイト以内で指定してください。

ただし、--cluster-standbynodeを指定した場合、ディレクトリ名には存在するディレクトリを指定してください。

ドメインルートの親ディレクトリには管理者権限を持つユーザーの書き込み権限があるディレクトリを指定してください

SolarisLinuxディレクトリ名には存在しないディレクトリを、255バイト以内で指定してください。

ドメインルートの親ディレクトリにはインスタンス管理者の書き込み権限があるディレクトリを指定してください

ディレクトリ名には、以下の文字が使用できます。

  • 半角英数字

  • 半角空白

  • 半角アンダースコア “_”

  • 半角ハイフン “-”

  • 半角丸括弧 “( )”

ドメインルートには、下記のディレクトリを指定しないでください。

  • インスタンスのデータ格納先と同じディレクトリ

  • インスタンスのデータ格納先配下のディレクトリ

  • インスタンスのデータ格納先が、ドメインルートの配下となるディレクトリ

-y

本オプションは、ドメインの削除を確認するメッセージを省略する場合に指定します。本オプションを指定しない場合、ドメインの削除を確認するメッセージが表示されます。

環境

PGDATA

インスタンスのデータ格納先を絶対パスで指定します。pgx_jadminコマンドにおいて、-Dオプションまたは、--pgdataを指定した場合、そちらが有効になります。

診断

0: 正常終了

0以外: 異常終了

注釈

このコマンドは、多重実行できません。

エスケープ文字の利用

コマンドのオプションまたはオペランドの値に以下の文字を利用する場合は、エスケープ文字として“\”を指定する必要があります。ただし、メタ文字以外については、modify-container-dbサブコマンドに--dbuserおよび--dbpasswordを指定する場合は、エスケープ文字を指定しないでください。

WindowsWindowsの場合

文字の種類

説明

文字

Javaエスケープ
シーケンス

Javaにおいてエスケープ文字
として利用される文字

\、"など

pgx_jadminコマンド
の特殊文字

サブコマンド内で、区切り文字や
エスケープ文字として利用され
る特殊文字

.-:=

SolarisLinuxLinuxおよびSolarisの場合

文字の種類

説明

文字

メタ文字

メタ文字として利用される文字

;&()|><*?[]~+-@!
"'\`${}^ (注)

Javaエスケープ
シーケンス

Javaにおいてエスケープ文字
として利用される文字

\、"など

pgx_jadminコマンド
の特殊文字

サブコマンド内で、区切り文字や
エスケープ文字として利用され
る特殊文字

.-:=

注) 利用しているシェルの種類により、メタ文字として扱われる文字が異なります。

インスタンスに接続するユーザーのパスワードを“pass\word!”に設定する場合

Windowspgx_jadmin create-container --dbname db01 --dbuser user1 --dbpassword pass\\word\!
Solarispgx_jadmin create-container --dbname db01 --dbuser user1 --dbpassword pass\\\\word\!
Linuxpgx_jadmin create-container --dbname db01 --dbuser user1 --dbpassword pass\\\\word\!
インスタンスの停止

以下のサブコマンドは、インスタンスの停止中にのみ実行できます。

  • init-domain

  • create-container

  • add-instance

  • delete-instance

  • modify-domain-port

  • modify-instance-port

  • modify-container-db

  • modify-jvm-options

  • delete-container

  • delete-domain

  • backup

  • restore

インスタンスの起動

以下のサブコマンドは、インスタンスの起動中にのみ実行できます。

  • list-jvm-options

コマンドの実行ユーザー

Windowsすべてのサブコマンドは、以下のユーザーで実行してください。

  • OS上の管理者ユーザー

SolarisLinuxinit-domainサブコマンド、delete-domainサブコマンド、backupサブコマンドおよびrestoreサブコマンドは、以下のユーザーで実行してください。

  • OS上のシステム管理者ユーザー

それ以外のサブコマンドは、以下のユーザーで実行してください。

  • インスタンス管理者

list-domainサブコマンドは上記どちらのユーザーでも実行できます。

Windowsドメインの作成

ドメインを作成する前に、Windowsサービスへインスタンスを登録してください。

ドメインの削除

Symfoware Serverをアンインストールする前にドメインを削除してください。ドメインを削除すると、ドメインルートディレクトリが削除されます。必要なディレクトリやファイルは、ドメインを削除する前に退避してください。

PL/extJavaのバックアップ格納ディレクトリ

PL/extJavaのバックアップ格納ディレクトリ内のファイルを更新、および削除しないでください。PL/extJavaを復旧できなくなる可能性があります。

PL/extJavaのバックアップ格納ディレクトリには、ほかのファイルを格納しないでください。

例

ドメインの作成

以下は、ドメイン管理用のポート番号、インスタンスのデータ格納先を省略した例です。

Windowspgx_jadmin init-domain --shareddir C:\database\domain --dbadminuser dbadmin1 
Solarispgx_jadmin init-domain --shareddir /database/domain --dbadminuser dbadmin1
Linuxpgx_jadmin init-domain --shareddir /database/domain --dbadminuser dbadmin1

以下は、ドメイン管理用のポート番号、インスタンスのデータ格納先を指定した例です。

Windowspgx_jadmin init-domain --shareddir C:\database\domain --dbadminuser dbadmin1
                       --domainport 26530,26521,26522 --pgdata C:\database\inst1
Solarispgx_jadmin init-domain --shareddir /database/domain --dbadminuser dbadmin1
                       --domainport 26530,26521,26522 --pgdata /database/inst1
Linuxpgx_jadmin init-domain --shareddir /database/domain --dbadminuser dbadmin1
                       --domainport 26530,26521,26522 --pgdata /database/inst1
ドメインの削除

以下は、ドメイン内にコンテナが存在しない場合の例です。

pgx_jadmin delete-domain

以下は、ドメイン内に存在するコンテナも強制的に削除する例です。

pgx_jadmin delete-domain --force
ドメイン情報の表示
ドメインの情報を表示します。
pgx_jadmin list-domain
list-domainの表示内容
domain status:  (1)
shareddir:      (2)
domainport:     (3)
dbadminuser:    (4)
datadir:        (5)
(1) ドメインの状態
    running        : 起動状態
    not running    : 停止状態
(2) ドメインの資源を格納するディレクトリ（ドメインルート）
(3) ドメイン管理用のポート番号（3個）
(4) インスタンス管理者
(5) インスタンスのデータ格納先
Windows表示例
domain status: running
shareddir: C:\database\domain
domainport: 26530,26521,26522
dbadminuser: dbadmin1
datadir: C:\database\inst1
SolarisLinux表示例
domain status: running
shareddir: /database/domain
domainport: 26530,26521,26522
dbadminuser: dbadmin1
datadir: /database/inst1
ドメイン管理用ポート番号の変更
ドメインの管理用ポート番号を変更します。
pgx_jadmin modify-domain-port --domainport 26600,26601,26602
コンテナの作成
以下は、インスタンスのポート番号と、サーバインスタンス（JavaVM）のポート番号を省略した例です。
pgx_jadmin create-container --dbname db01 --dbuser user1 --dbpassword password1
以下は、インスタンスのポート番号と、サーバインスタンス（JavaVM）のポート番号を指定した例です。
pgx_jadmin create-container --dbname db01 --dbuser user1 --dbpassword password1
                            --dbport 26011 --instanceport 26531,26532
コンテナの削除
コンテナを削除します。
pgx_jadmin delete-container --dbname db01
コンテナ情報の表示
コンテナ情報を表示します。
pgx_jadmin list-container --dbname db01
list-containerの表示内容
container status:  (1)
dbname:            (2)
instance:          (3) (4)
dbport:            (5)
dbuser:            (6)
(1) コンテナの状態
    running     : 起動状態（すべてのサーバインスタンス（JavaVM）が起動）
    error       : 異常状態（サーバインスタンス（JavaVM）でエラーが発生しています。）
    not running : 停止状態（すべてのサーバインスタンス（JavaVM）が停止）
(2) データベース名
(3) サーバインスタンス（JavaVM）名
(4) サーバインスタンス（JavaVM）管理用のポート番号（2個）
(5) インスタンスのポート番号
(6) インスタンスに接続するためのユーザー名
表示例
container status: running 
dbname: db01
instance: db01-1 26531,26532
instance: db01-2 26801,26802
dbport: 26011
dbuser: user1
サーバインスタンス（JavaVM）の追加
サーバインスタンス（JavaVM）を追加します。
pgx_jadmin add-instance --dbname db01 --instanceport 26801,26802
サーバインスタンス（JavaVM）の削除
サーバインスタンス（JavaVM）を削除します。
pgx_jadmin delete-instance --dbname db01
サーバインスタンス（JavaVM）管理用ポート番号の変更
サーバインスタンス（JavaVM）の管理用ポート番号を変更します。
pgx_jadmin modify-instance-port --instance db01-1 --instanceport 26701,26702
データベース接続情報の変更
データベース接続時のユーザー名およびパスワードを変更します。
pgx_jadmin modify-container-db --dbname db01 --dbuser user02 --dbpassword passwd2
コンテナのJavaVMオプション情報の表示
コンテナのJavaVMのオプションを表示します。
pgx_jadmin list-jvm-options --dbname db01
JavaVMオプション設定値の変更
JavaVMのヒープ領域サイズおよびPerm領域サイズを変更します。
pgx_jadmin modify-jvm-options --dbname db01 --heapsize 1024 --permsize 384
PL/extJavaのバックアップ
PL/extJavaをバックアップします。
Windowspgx_jadmin backup --backupdir D:\backup
Solarispgx_jadmin backup --backupdir /backup
Linuxpgx_jadmin backup --backupdir /backup
PL/extJavaのリストア
PL/extJavaをリストアします。
Windowspgx_jadmin restore --backupdir D:\backup
Solarispgx_jadmin restore --backupdir /backup
Linuxpgx_jadmin restore --backupdir /backup
前
Copyright 2013-2014 FUJITSU LIMITED