2.4.3 create-domain
Java EE Serverドメインの作成
書式
asadmin [asadmin-options] create-domain [--help] [--adminport adminport] [--instanceport instanceport] [--portbase portbase] [--template template-name] [--domaindir domaindir] [--savemasterpassword={false|true}] [--usemasterpassword={false|true}] [--domainproperties name=value[:name=value]...] [--keytooloptions name=value[:name=value]...] [--savelogin={false|true}] [--checkports={true|false}] [--nopassword={false|true}] domain-name
格納先
Application Serverインストールディレクトリー/javaee/glassfish/bin
機能
create-domainサブコマンドは、Java EE Serverドメインを作成します。
ドメインとは、Java EE標準仕様に準拠した、管理上の名前空間です。ドメインごとに構成を持っており、その構成はファイルに保存されます。
ドメインは一意の管理IDを持っており、Application Serverをインストールした場所にはドメインをいくつでも作成できます。個々のドメインは、その他のドメインとは独立して存在します。
構築したシステム上のasadminユーティリティーにアクセスできるユーザーは、ドメインを作成し、ユーザーが指定したディレクトリーに構成を保存することができます。デフォルトでは、ドメインの構成はドメインのデフォルトディレクトリーに作成されます。デフォルトディレクトリーを上書きして、構成をほかの場所に保存することができます。
このサブコマンドは、asadminユーティリティーの--userオプションで指定した、1人の管理ユーザーを持つドメインを作成します。
--userオプションが指定されていなくて、--nopasswordオプションがtrueに設定されている場合、デフォルトの管理ユーザーadminを使用します。
--nopasswordオプションがfalseに設定されている場合、ユーザー名が必要です。この場合、--userオプションでユーザー名を指定していないと、指定するように対話型で求められます。
新規ドメインで実行するアプリケーションに応じてドメインの適切なプロファイルを選択します。作成したドメインの開発者、クラスター、またはエンタープライズプロファイルを選択できます。
このサブコマンドはローカルモードだけサポートします。
実行権限
次に示す情報は、--domainpropertiesオプションだけに適用されます。
UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。
引数
- --help | -?
-
このサブコマンドのヘルプテキストを表示します。
- --adminport adminport
-
管理用のHTTPポートまたはHTTPSポートを指定します。このポートは、ユーザーがWebブラウザーでドメインを管理するときにURLに指定するポートです。例えば、http://localhost:4949のような形式で指定します。
--adminportオプションは、--portbaseオプションと同時に指定することはできません。
--adminportオプションは、--domainpropertiesオプションのdomain.adminPortプロパティーを上書きします。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:4848
-
- --instanceport instanceport
-
デプロイ時に、アプリケーションの実行が行えるよう、サービスを提供するドメインを指定します。
このHTTPポートは、Webブラウザーが接続のためにWebアプリケーションのコンテキストルートをどこで利用できるかを指定します。このポートは正の整数であり、ドメイン作成時に利用できるようになっている必要があります。
--instanceportオプションは、--portbaseオプションと同時に指定することはできません。
--instanceportオプションは、--domainpropertiesオプションのdomain.instancePortプロパティーを上書きします。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:8080
-
- --portbase portbase
-
ポート割当を開始する番号を指定します。
ドメインは、静的に割り当てられた一定数のポートを使用します。portbaseの値は、割り当てをどこから始めるかを決定します。ポートの値は次のように算出されます。
-
管理ポート: portbase + 48
-
HTTPリスナーポート: portbase + 80
-
HTTPSリスナーポート: portbase + 81
-
JMSポート: portbase + 76
-
IIOPリスナーポート: portbase + 37
-
セキュアIIOPリスナーポート: portbase + 38
-
相互認証ポートのあるセキュアIIOP: portbase + 39
-
JMXポート: portbase + 86
-
JPDAデバッガーポート: portbase + 9
-
OSGiモジュール管理用Felixシェルサービスポート: portbase + 66
--portbaseオプションが指定されているとき、このサブコマンドの出力内容には、使用されたすべてのポートのリストが含まれます。
--portbaseオプションは、--adminport、--instanceport、または--domainpropertiesオプションと同時に指定することはできません。
型:Integer
指定できる値を次に示します。
-
-8〜65449
デフォルト値:なし
-
- --template template-name
-
相対パスまたは絶対パスを含む、ドメイン構成テンプレートのファイル名を指定して、ドメイン作成時に使用します。
相対パスが指定された場合、このサブコマンドはApplication Serverインストールディレクトリー/javaee/glassfish/lib/templatesディレクトリーにパスを付加してファイルを検索します。絶対パスが指定された場合、サブコマンドは指定されたパスでファイルを特定します。
このオプションを使うことによって、さまざまなタイプのドメインの作成やドメイン構成ファイルが利用できるようになります。
jarファイルは、このオプションの入力ファイルで、ドメイン構成ファイルを含んでいます。
型:String
指定できる値を次に示します。
-
ドメイン構成のファイル名
デフォルト値:なし
-
- --domaindir domaindir
-
ドメインを作成するディレクトリーを指定します。指定した場合、ファイルシステム内でそのパスにアクセスできる必要があります。指定しない場合、ドメインはデフォルトのドメインディレクトリーApplication Serverインストールディレクトリー/javaee/glassfish/domainsに作成されます。
型:String
指定できる値を次に示します。
-
ドメインのディレクトリーパス
デフォルト値:Application Serverインストールディレクトリー/javaee/glassfish/domains
-
- --savemasterpassword={false|true}
-
このオプションが設定されている場合、マスターパスワードをファイルシステムに書き込むことを許可します。
マスターパスワードは、実際にはセキュアキーストアのパスワードです。ドメインは、ドメイン作成時に作成される自身の証明書を、構成内の安全な場所に保存するよう設計されています。この証明書は、ドメインのSSLサーバ証明書と呼ばれます。Webブラウザーが安全なチャネル(HTTPS)でドメインにアクセスすると、この証明書がドメインによって提示されます。マスターパスワードは、この証明書を含むストア(ファイル)を保護します。このファイルはkeystore.jksと呼ばれ、作成されたドメインの構成ディレクトリーに作成されます。しかし、もしこのオプションが選択された場合、マスターパスワードはドメインの構成内のディスクに保存されます。マスターパスワードはmaster-passwordというファイルに格納されますが、このファイルはJavaのJCEKSタイプのキーストアです。
--savemasterpasswordオプションはシステムブートの自動化に使用されます。マスターパスワードを保存しておくと、このkeystore.jksファイルからパスワードが抽出されるので、ドメインの開始時にマスターパスワードの入力を求められることはありません。マスターパスワードはstart-domainサブコマンドによって利用されるため、ドメイン作成時にはマスターパスワードを作成した方がよいでしょう。セキュリティー目的では、デフォルトの設定はfalseとすべきです。もし、ファイルシステムの権限が適切に設定されていない場合、マスターパスワードをディスクに保存していることは安全とは言えません。マスターパスワードが保存されている場合、start-domainはそのパスワードの入力を促しません。マスターパスワードはシステム環境のセキュリティーレベルに影響を与えます。
このオプションがtrueの場合、コマンドラインで指定した値に関係なく、--usemasterpasswordオプションもtrueになります。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --usemasterpassword={false|true}
-
システムに組み込まれているマスターパスワードまたはユーザー定義マスターパスワードでキーストアを暗号化するかどうかを指定します。
falseの場合、キーストアは、システムに組み込まれているwell-knownパスワードで暗号化されます。システムに組み込まれているパスワードでキーストアを暗号化する場合、セキュリティーの向上はありません。
trueの場合、このサブコマンドはパスワードファイルのAS_ADMIN_MASTERPASSWORDエントリーからマスターパスワードを取得するか、またはマスターパスワードの入力を促します。パスワードファイルは、asadminユーティリティーの--passwordfileオプションに指定されています。
--savemasterpasswordオプションがtrueの場合には、コマンドラインで指定された値に関係なく、このオプションもtrueとなります。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --domainproperties name=value[:name=value]...
-
オプションの名前と値のペアを設定します。作成するドメインのプロパティーのデフォルト値を上書きします。
指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。
--portbaseオプションは、--domainpropertiesオプションと同時に指定することはできません。
UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。
プロパティー名とvalueに指定できる値を次に示します。
domain.adminPort=value
このプロパティーは、管理するHTTPまたはHTTPSポートのポート番号を指定します。このポートはWebブラウザーでインスタンスを管理するために指定するURLのポートです(例:http://localhost:4949)。
domain.adminPortプロパティーは、--adminportオプションで上書きされます。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
domain.instancePort=value
このプロパティーは、HTTP要求をリッスンするのに使用するポートのポート番号を指定します。
domain.instancePortプロパティーは、--instanceportオプションで上書きされます。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
domain.jmxPort=value
このプロパティーは、JMXコネクターがリッスンするポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
http.ssl.port=value
このプロパティーは、HTTPS要求をリッスンするのに使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
java.debugger.port=value
このプロパティーは、Java Platform Debugger Architecture(JPDA)(http://java.sun.com/javase/technologies/core/toolsapis/jpda/)デバッガーへの接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
jms.port=value
このプロパティーは、JMSプロバイダーのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
orb.listener.port=value
このプロパティーは、IIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
orb.mutualauth.port=value
このプロパティーは、クライアント認証を持つセキュアなIIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
orb.ssl.port=value
このプロパティーは、セキュアなIIOP接続に使用するポートのポート番号を指定します。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
osgi.shell.Telnet.port=value
このプロパティーは、Apache Felix Remote Shell(http://felix.apache.org/site/apache-felix-remote-shell.html)への接続に使用するポートのポート番号を指定します。
このシェルはFelixシェルサービスを使用して、OSGiモジュール管理サブシステムと対話します。
--portbaseオプションは--domainpropertiesオプションと同時に使用はできません。
型:Integer
指定できる値を次に示します。
-
1〜65535
デフォルト値:なし
-
- --keytooloptions name=value[:name=value]...
-
自己署名証明書のキーツールオプションの名前と値のペアを指定します。証明書は、ドメインの作成中に生成されます。
指定形式は、name=valueです。複数指定する場合は、コロン(:)で区切ります。同じオプション名を複数指定した場合は、最後に指定したオプションの値が有効となります。
オプション名とvalueに指定できる値を次に示します。
CN=value
自己署名証明書に使用されるホストの共通名を指定します。このオプションの名前は、大文字小文字を区別しません。
型:String
デフォルト値:サブコマンドが実行されているホストの完全修飾名
- --savelogin={false|true}
-
このオプションがtrueに設定されている場合、管理ユーザー名とパスワードを保存します。
ユーザー名とパスワードは、ユーザーのホームディレクトリーの.asadminpassファイルに格納されています。ドメインはローカルだけで作成できます。そのため、--saveloginオプションの利用時には、.asadminpassに保存されているホスト名は常にlocalhostです。ユーザーがドメインの作成中にデフォルトの管理ポートを指定した場合、その後のasadminリモートコマンドで--user、 --passwordfile、--host、または--portを指定する必要はありません。これらの値は自動的に取得されます。
同じホスト上またはホームディレクトリーをNFSマウントしているホスト上に、同じの管理ポート番号を持つ複数ドメインを、同じユーザーが作成する場合であっても、サブコマンドはパスワードを上書きするかどうかを確認しません。パスワードは常に上書きされます。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- --checkports={true|false}
-
管理、HTTP、JMS、JMX、IIOPの各ポートが利用できることを確認するかどうかを指定します。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:true
-
- --nopassword={false|true}
-
管理ユーザーがパスワードを持つかどうかを指定します。
falseの場合、パスワードは、asadminパスワードファイルのAS_ADMIN_PASSWORDエントリーによって設定されます。asadminパスワードファイルは--passwordfileオプションで設定します。falseでAS_ADMIN_PASSWORDが設定されていない場合は、パスワードの入力が求められます。
trueの場合、パスワードのない管理ユーザーが作成されます。--userオプションでドメインのユーザー名の指定がなく、--nopasswordオプションがtrueに設定されている場合には、デフォルトのユーザー名であるadminが使われます。
型:Boolean
指定できる値を次に示します。
-
true
-
false
デフォルト値:false
-
- domain-name
-
作成するドメインの名称を指定します。
型:String
指定できる値を次に示します。
-
ドメイン名
ドメイン名は、次に示す条件を満たしている必要があります。
-
ASCII文字であること。
-
ドメインが作成されるホストのOSで有効な名称であること。
デフォルト値:なし
-
使用例
次の例では、ドメインを作成します。
asadmin create-domain --adminport 4848 domain4
戻り値
戻り値 |
説明 |
---|---|
0 |
サブコマンドの実行に成功しました。 |
1 |
サブコマンドの実行中にエラーが発生しました。 |