Hitachi Application Server V10 コマンドリファレンス（UNIX®用）

3021-3-419-30

前書き

対象製品

適用OS：Red Hat Enterprise Linux 5 Advanced Platform（AMD/Intel 64）、Red Hat Enterprise Linux 5（AMD/Intel 64）、Red Hat Enterprise Linux Server 6（64-bit x86_64）、Red Hat Enterprise Linux Server 7（64-bit x86_64）

P-9W43-5KA1 Hitachi Application Server 10-11

注　このマニュアルで「AIXの場合」と表記している個所については、この製品ではサポートしていません。

適用OSについては、上記以外にもご利用になれる場合があります。詳細はリリースノートでご確認ください。

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI、Cosminexus、HAモニタ、HiRDB、JP1、uCosminexus、Virtageは、株式会社日立製作所の商標または登録商標です。

AMDは、Advanced Micro Devices, Inc.の商標です。

IBM、AIXは、世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

IBM、POWERは、世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

IBM、WebSphereは、世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Intelは、アメリカ合衆国およびその他の国におけるIntel Corporationの商標です。

Internet Explorerは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Linuxは、Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

MicrosoftおよびExcelは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびHyper-Vは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびSQL Serverは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

MicrosoftおよびVisual C++は、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleとJavaは、Oracle Corporation 及びその子会社、関連会社の米国及びその他の国における登録商標です。

RC4は、米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

Red Hatは、米国およびその他の国でRed Hat, Inc. の登録商標もしくは商標です。

RSAおよびBSAFEは、米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

UNIXは、The Open Groupの米国ならびに他の国における登録商標です。

W3Cは、World Wide Web Consortiumの商標（多数の国において登録された）です。

Windowsは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Windows Serverは、米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名、製品名などは、それぞれの会社の商標もしくは登録商標です。

本製品は、米国EMC コーポレーションのRSA BSAFE®ソフトウェアを搭載しています。

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

発行

2017年9月 3021-3-419-30

著作権

Copyright (C) 2014, 2017, Hitachi, Ltd.

Copyright (C) 2013, Oracle and/or its affiliates. All rights reserved.

変更内容

変更内容(3021-3-419-30)

Hitachi Application Server 10-11

追加・変更内容

変更個所

リリースノートのマニュアル訂正を反映した。

−

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

マニュアルの目的

このマニュアルは、Hitachi Application Serverのシステム基盤の構築および運用で使用するコマンドについて説明したものです。このマニュアルを利用することで、ユーザーがHitachi Application Serverのシステム基盤に対して詳細な設計や設定ができることを目的とします。

対象読者

このマニュアルは次の方を対象読者としています。

システム構築者

前提知識を次に示します。

WindowsまたはUNIXの操作に関する知識

Application Serverの構築に関する知識

Java EE標準仕様に関する知識

システム構築で使用する周辺環境（データベース、ネットワーク、ジョブ管理など）に関する知識

関連マニュアルの表記

関連マニュアル、およびこのマニュアルで使用している関連マニュアル名の表記を次の表に示します。

Application Server関連

表記

正式名称

資料番号

ユーザーズガイド

Hitachi Application Server V10 ユーザーズガイド（UNIX®用）

3021-3-415

GUIリファレンス

Hitachi Application Server V10 GUIリファレンス（UNIX®用）

3021-3-417

コマンドリファレンス

Hitachi Application Server V10 コマンドリファレンス（UNIX®用）

3021-3-419

定義リファレンス

Hitachi Application Server V10 定義リファレンス（UNIX®用）

3021-3-421

メッセージリファレンス

Hitachi Application Server V10 メッセージリファレンス

3021-3-422

APIリファレンス

Hitachi Application Server V10 APIリファレンス

3021-3-423

HiRDB関連

表記

正式名称

資料番号

HiRDB システム導入・設計ガイド

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（UNIX®用）

3000-6-452

ノンストップデータベース HiRDB Version 9 システム導入・設計ガイド（Windows®用）

3020-6-452

HiRDB メッセージ

ノンストップデータベース HiRDB Version 9 メッセージ

3020-6-458

製品名と機能名の表記

このマニュアルでは、製品名と機能名を次のように表記しています。

表記

製品名と機能名

Application Server

Hitachi Application Server

Application Server - Base

Hitachi Application Server - Base

Application Server - Optional License for Java

Hitachi Application Server - Optional License for Java

Application Server for Developers

Hitachi Application Server for Developers

APV

IBM Advanced POWER Virtualization

DAS

Domain Administration Server

ドメイン管理サーバ

Developer's Kit for Java

Hitachi Developer's Kit for Java

Excel

Microsoft® Excel

Firefox

Firefox®

HiRDB

HiRDB Version 9

HiRDB Server Version 9

HiRDB/Single Server

HiRDB/Single Server Version 9

HWS

Hitachi Web Server

Web Server

Internet Explorer

Windows® Internet Explorer®

Java EE Server

Hitachi Java EE Server

JP1/AJS3

JP1 Version 10 JP1/Automatic Job Management System 3 - Agent

JP1 Version 10 JP1/Automatic Job Management System 3 - Manager

JP1 Version 10 JP1/Automatic Job Management System 3 - View

JP1/IM

JP1 Version 10 JP1/Integrated Management - Manager

JP1 Version 10 JP1/Integrated Management - View

Microsoft IIS

Microsoft IIS 7.5

Microsoft® Internet Information Services 7.5

Microsoft IIS 8.0

Microsoft® Internet Information Services 8.0

Microsoft IIS 8.5

Microsoft® Internet Information Services 8.5

Microsoft Visual C++

Microsoft® Visual C++®

Oracle

Oracle 11g

Oracle Database 11g

Oracle Database 11g R2

Oracle 12c

Oracle Database 12c

SQL Server

Microsoft® SQL Server

UNIX

AIX

AIX V6.1

AIX V7.1

Linux

Linux（AMD64 & Intel EM64T）

Red Hat Enterprise Linux® 5 Advanced Platform（AMD/Intel 64）

Red Hat Enterprise Linux® 5（AMD/Intel 64）

Red Hat Enterprise Linux® Server 6（64-bit x86_64）

Red Hat Enterprise Linux® Server 7（64-bit x86_64）

Virtage

Hitachi Virtage

VMware ESX

VMware vSphere® ESX

VMware vSphere ESXi

VMware vSphere® ESXi™

Windows

Windows Server 2008 R2

Microsoft® Windows Server® 2008 R2 Standard 日本語版

Microsoft® Windows Server® 2008 R2 Enterprise 日本語版

Microsoft® Windows Server® 2008 R2 Datacenter 日本語版

Windows Server 2012

Microsoft® Windows Server® 2012 Standard 日本語版

Microsoft® Windows Server® 2012 Datacenter 日本語版

Windows Server 2012 R2

Microsoft® Windows Server® 2012 R2 Standard 日本語版

Microsoft® Windows Server® 2012 R2 Datacenter 日本語版

Windows 7

Windows 7 x86

Microsoft® Windows® 7 Professional 日本語版(32ビット版)

Microsoft® Windows® 7 Enterprise 日本語版(32ビット版)

Microsoft® Windows® 7 Ultimate 日本語版(32ビット版)

Windows 7 x64

Microsoft® Windows® 7 Professional 日本語版(64ビット版)

Microsoft® Windows® 7 Enterprise 日本語版(64ビット版)

Microsoft® Windows® 7 Ultimate 日本語版(64ビット版)

Windows 8

Windows 8 x86

Windows® 8 Pro 日本語版(32ビット版)

Windows® 8 Enterprise 日本語版(32ビット版)

Windows 8 x64

Windows® 8 Pro 日本語版(64ビット版)

Windows® 8 Enterprise 日本語版(64ビット版)

Windows 8.1 x86

Windows® 8.1 Pro 日本語版(32ビット版)

Windows® 8.1 Enterprise 日本語版(32ビット版)

Windows 8.1 x64

Windows® 8.1 Pro 日本語版(64ビット版)

Windows® 8.1 Enterprise 日本語版(64ビット版)

Windows 10

Windows 10 x64

Windows® 10 Pro 日本語版(64ビット版)

Windows® 10 Enterprise 日本語版(64ビット版)

Windows Server Failover Cluster

Windows Server® Failover Cluster

クラス別統計

日立クラス別統計

パフォーマンストレーサ

Performance Tracer

パフォーマンストレーサー

Linuxに関しては、バージョンごとに次のように表記することがあります。

表記

OS名

Red Hat Enterprise Linux 5

Red Hat Enterprise Linux 5 Advanced Platform（AMD/Intel 64）

Red Hat Enterprise Linux® 5 Advanced Platform（AMD/Intel 64）

Red Hat Enterprise Linux 5（AMD/Intel 64）

Red Hat Enterprise Linux® 5（AMD/Intel 64）

Red Hat Enterprise Linux Server 6

Red Hat Enterprise Linux Server 6（64-bit x86_64）

Red Hat Enterprise Linux® Server 6（64-bit x86_64）

Red Hat Enterprise Linux Server 7

Red Hat Enterprise Linux Server 7（64-bit x86_64）

Red Hat Enterprise Linux® Server 7（64-bit x86_64）

英略語

このマニュアルで使用している英略語を次に示します。

英略語

英字での表記

ACC

Application Client Container

ACL

Access Control List

AES

Advanced Encryption Standard

API

Application Programming Interface

ASCII

American Standard Code for Information Interchange

BLOB

Binary Large Object

CA

Certificate Authority

CDI

Contexts and Dependency Injection

CGI

Common Gateway Interface

CMP

Container-Managed Persistence

CMT

Container-Managed Transaction

CopyGC

Copy Garbage Collection

CORBA

Common Object Request Broker Architecture

CPU

Central Processing Unit

CRL

Certificate Revocation List

CSR

Certificate Signing Request

CSV

Comma Separated Value

CVS

Concurrent Versions System

DBMS

Database Management System

DCOM

Distributed Component Object Model

DD

Deployment Descriptor

DDE

Dynamic Data Exchange

DER

Distinguished Encoding Rules

DES

Data Encryption Standard

DI

Dependency Injection

DLL

Dynamic Link Library

DMZ

Demilitarized Zone

DN

Distinguished Name

DNS

Domain Name System

DoS

Denial of Service

DSO

Dynamic Shared Object

DTD

Document Type Definition

EAR

Enterprise Archive

ear

EIS

Enterprise Information System

EJB

Enterprise JavaBeans™

EJB QL

EJB™ Query Language

EL

Expression Language

EUC

Extended UNIX Code

FQDN

Fully Qualified Domain Name

FullGC

Full Garbage Collection

G1GC

Garbage First Garbage Collection

GC

Garbage Collection

GMS

Group Management Service

GMT

Greenwich Mean Time

GUI

Graphical User Interface

HA

High Availability

HTML

Hyper Text Markup Language

HTTP

Hyper Text Transfer Protocol

HTTPS

Hyper Text Transfer Protocol Security

I/O

Input/Output

ID

Identifier

IDE

Integrated Development Environment

IEC

International Electrotechnical Commission

IIOP

Internet Inter-Orb Protocol

IIS

Internet Information Services

IMAP

Internet Message Access Protocol

IP

Internet Protocol

IPv6

Internet Protocol Version 6

ISO

International Organization for Standardization

J2EE

J2EE™

Java™ 2 Platform, Enterprise Edition

JAAS

Java™ Authentication and Authorization Service

JACC

Java™ Authorization Service Provider Contract for Containers

JAF

JavaBeans™ Activation Framework Specification

JAR

Java™ Archive

jar

JASPIC

Java™ Authentication Service Provider Interface for Containers

Java

Java™

Java EE

Java™ Platform, Enterprise Edition

Java EE RI

Java EE Reference Implementation

Java HotSpot Client VM

Java HotSpot™ Client Virtual Machine

Java Platform Debugger Architecture

Java™ Platform Debugger Architecture

JPDA

Java SE

Java™ Platform, Standard Edition

Java VM

Java™ Virtual Machine

JVM

JavaMail

JavaMail™

JAX-RPC

Java™ API for XML-based RPC

JAX-RS

Java™ API for RESTful Web Services

JAX-WS

Java™ API for XML-based Web Services

JAXB

Java™ Architecture for XML Binding

JAXP

Java™ API for XML Processing

JAXR

Java™ API for XML Registries

JCA

J2EE™ Connector Architecture

JDBC

Java™ Database Connectivity

JDBC™

JDK

Java™ Development Kit

JDK™

JIS

Japanese Industrial Standards

JMS

Java™ Message Service

JMX

Java™ Management Extensions

JNDI

Java Naming and Directory Interface™

JNI

Java™ Native Interface

JPA

Java™ Persistence API

JSF

JavaServer™ Faces

JavaServer™ Faces Reference Implementation (RI) Version: 1.1_01 FCS

JSON-P

Java™ API for JSON Processing

JSP

JavaServer Pages™

JSP™

JST

Japan Standard Time

JSTL

JavaServer Pages™ Standard Tag Library

JTA

Java™ Transaction API

JVMPI

Java™ Virtual Machine Profiler Interface

JVMTI

Java™ Virtual Machine Tool Interface

KVM

Kernel-based Virtual Machine

LAN

Local Area Network

LDAP

Lightweight Directory Access Protocol

MAC

Message Authentication Code

MIME

Multipurpose Internet Mail Extensions

MPM

Multi-Proccessing Module

OASIS

Organization for the Advancement of Structured Information Standards

OMG

Object Management Group

ORB

Object Request Broker

OS

Operating System

OTS

Object Transaction Service

QNAME

Qualified Name

REST

Representational State Transfer

RMI

Remote Method Invocation

RPC

Remote Procedure Call

RSA

Rivest, Shamir and Adleman

SAAJ

SOAP with Attachments API for Java™

SAX

Simple API for XML

SEI

Service Endpoint Interface

Servlet

Java™ Servlet

SHA

Secure Hash Algorithm

SMAP

Source Map

SMTP

Simple Mail Transfer Protocol

SOAP

Simple Object Access Protocol

SSH

Secure Shell

ssh

SSL

Secure Sockets Layer

StAX

Streaming API for XML

TCP

Transmission Control Protocol

TLD

Tag Library Descriptor

TLS

Transport Layer Security

UCS

Universal multi-octet coded Character Set

UDP

User Datagram Protocol

URI

Uniform Resource Identifier

URL

Uniform Resource Locator

URN

Uniform Resource Name

UTC

Coordinated Universal Time

UTF

UCS Transformation Format

UTF-8

8-bit UCS Transformation Format

VM

Virtual Machine

VTL

Velocity Template Language

W3C

World Wide Web Consortium

WAR

Web Archive

war

WBEM

Web-Based Enterprise Management

WSDL

Web Services Description Language

XML

Extensible Markup Language

KB（キロバイト）などの単位表記について

1KB（キロバイト）、1MB（メガバイト）、1GB（ギガバイト）、1TB（テラバイト）、1PB（ペタバイト）はそれぞれ1,024バイト、1,024²バイト、1,024³バイト、1,024⁴バイト、1,024⁵バイトです。

1　コマンドリファレンスについて

Application Serverのシステム基盤の構築および運用で使用するコマンドについて、コマンドの書式、機能などについて説明します。

1.1　コマンドの入力方法

コマンドの入力方法について説明します。

コマンドの入力形式

コマンドの入力形式を次に示します。

コマンド名 [オプション...]

各項目について説明します。なお、ここではコマンドプロンプトを「$」、コマンド名を「cmd」と表記します。

コマンド名

実行するコマンドのファイル名を指定します。

スペースを含むパスを指定してコマンドを実行する場合、パス全体をダブルクォーテーション（""）で囲む必要があります。

誤った指定例：$ /opt/program path/bin/cmd

正しい指定例：$ "/opt/program path/bin/cmd"

注：指定例に記載のパスは実際の製品で使用するパスとは異なります。

オプションの入力形式

オプションは、ハイフン（-）で始まる文字列です。オプションの入力形式には、オプション引数を指定しない形式と、1つのオプション引数を指定する形式があります。

オプション引数を指定しない形式

$ cmd -オプションフラグ

1つのオプション引数を指定する形式

$ cmd -オプションフラグスペースまたはタブオプション引数

（凡例）

オプションフラグ：1文字の半角英数字です。大文字と小文字が区別されます。

オプション引数：オプションフラグに対する引数です。

オプションの指定規則

オプションフラグは、1つのハイフン（-）にまとめて指定できません。

誤った指定例：$ cmd -abc

正しい指定例：$ cmd -a -b -c

オプション引数を必要とするオプションフラグのオプション引数は、省略できません。

オプションフラグとオプション引数の間には、スペースまたはタブが必要です。

誤った指定例：$ cmd -afile

正しい指定例：$ cmd -a file

同じオプションフラグは、複数指定できません。

誤った指定例：$ cmd -a 1 -a 2

オプション引数にスペースを含む場合、オプション引数全体を""で囲む必要があります。

誤った指定例：$ cmd -a file 1

正しい指定例：$ cmd -a "file 1"

1.2　コマンドリファレンスの見方

コマンドリファレンスを読むために必要な情報について説明しています。

記述形式

コマンドについて次の形式で説明します。各コマンドの説明では、次の項目のうち必要な項目についてだけ説明しています。また、次の項目以外に、各コマンドの固有情報を記載している場合があります。

書式

コマンドの入力形式を示します。

格納先

コマンドが格納されているパスを示します。

機能

コマンドの機能について説明します。

実行権限

コマンドの実行権限を示します。

前提条件

コマンドを実行する上で前提となる条件を示します。

引数

コマンドの引数およびオプションについて説明します。

オプションでは、そのオプションに対するオプション引数が必要な場合があります。

Java EEサーバで使用するコマンドのデフォルト値は、オプションに必要なオプション引数だけを省略した場合ではなく、オプション自体を指定しなかった場合の値を示します。

出力形式

コマンドの出力形式を示します。

使用例

コマンドの入力例、出力例などを示します。

戻り値

コマンドの戻り値について説明します。

注意事項

コマンドを実行する上での注意事項について説明します。

使用している記号

コマンドの文法では、次の表に示す記号を使用して記述しています。

記号

意味

|

横に並べられた複数の項目に対する項目間の区切りを示し、「または」を意味します。

（例）　A｜B

AまたはBを指定することを示します。

{ 　 }

この記号で囲まれている複数の項目のうちから1つを選択することを示します。項目が横に並べられ、記号|で区切られている場合は、そのうちの1つを選択します。

（例）　{A|B|C}

A、BまたはCのどれかを指定することを示します。

[ 　 ]

この記号で囲まれている項目は省略してもよいことを示します。複数の項目が横に並べて記述されている場合には、すべてを省略するか、記号{ }と同じくどれか1つを選択します。

（例1）　[A]

「何も指定しない」か「Aを指定する」ことを示します。

（例2）　[B|C]

「何も指定しない」か「BまたはCを指定する」ことを示します。

...

この記号の直前に示す項目を繰り返し、複数個指定できることを示します。

（例）　[プロパティー]...

プロパティーは複数個、繰り返して指定できます。

項目

斜体で表記されている項目は、該当する要素やファイルなどを指定したり、該当する要素が表示されたりすることを示します。

（例1）　プロパティー

プロパティーを記述します。またはプロパティーが表示されます。

（例2）　ファイル名

ファイル名を指定します。

使用している構文要素

コマンドの説明では、次の表に定義した構文要素を使用して記述しています。

構文要素

定義

英字

A〜Z　a〜z

英小文字

a〜z

英大文字

A〜Z

数字

0〜9

英数字

A〜Z　a〜z　0〜9

記号

! " # $ % & ' ( ) + , _ ・ . / : ; < = > @ [ ] ^ - { } ~ タブ スペース

注

すべて半角文字を使用します。

2　Java EEサーバで使用するコマンド

この章では、Java EEサーバで使用するコマンドの書式、機能などについて説明します。

2.1　Java EEサーバで使用するコマンドの一覧

Java EEサーバで使用するコマンドの一覧を次の表に示します。

Java EEサーバで使用するコマンド

コマンド名称

要約

概要説明

appclient

クライアントアプリケーションの起動

アプリケーションクライアントコンテナーを起動し、アプリケーションJARファイル内に通常パッケージされているクライアントアプリケーションを起動します。

asadmin

管理タスクの実行

Java EE Serverの管理タスクを実行します。

imqcmd list dst

物理格納先の一覧表示

メッセージブローカーの物理格納先を一覧表示します。

jspc

JSPファイルの事前コンパイル

コマンドラインでJSPファイルを事前にコンパイルできます。

schemagen

スキーマジェネレーターの起動

Javaソースファイルまたはクラスファイルに対してスキーマジェネレーターの処理を実行します。

wscompile

JavaインターフェースクラスからのWSDL生成、WSDLからサービスエンドポイントインターフェースやスタブなどのJavaクラスの生成

JAX-RPCのクライアントやサービスで使用するスタブ、タイ、シリアライザーおよびWSDLファイルを生成します。

wsdeploy

JAX-RPCのWebサービスとしてデプロイできるWARファイルの生成

JAX-RPCのWebサービスとしてデプロイできるWARファイルを生成します。

wsgen

JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトの生成

JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトを生成します。

wsimport

JAX-WSポータブルのアーティファクトの生成

JAX-WSポータブルのアーティファクトを生成します。

xjc

XML SchemaからJavaへバインディングするコンパイラー

コンパイル時に使用するバインドオプションの設定を基に、Javaソースファイルとjaxb.propertiesファイルを含んだパッケージの集合を作成します。

重要

コマンドの引数には、各コマンドで指定できる値を指定してください。それ以外の値が指定された場合、動作は保証されません。

コマンドが正常に終了しても、エラーが発生している場合があります。メッセージログやスタックトレースログを確認してください。

2.2　Java EEサーバで使用するコマンド

Java EEサーバで使用するコマンドの書式、機能などについて説明します。

2.2.1　appclient

クライアントアプリケーションの起動

書式

appclient
    [client_application_classfile | -client client_application_jar]
    [-mainclass main_class_name | -name display_name]
    [-xml glassfish-acc.xml file] [-textauth]
    [-targetserver host[:port][,host[:port]...]] [-user username]
    [-passwordfile password_file] [application-options]

appclient [jvm-options]
    [-mainclass main_class_name | -name display_name]
    [-xml client_config_xml_file] [-textauth]
    [-targetserver host[:port][,host[:port]...]] [-user username]
    [-passwordfile password_file]
    class-selector [application-options]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

appclientコマンドは、アプリケーションクライアントコンテナーを起動し、アプリケーションJARファイル内に通常パッケージされているクライアントアプリケーションを起動します。また、asadmin get-client-stubsコマンドを使用して、クライアントJARファイルを取得できます。

アプリケーションクライアントコンテナーとは、Java VM上で動く第1層アプリケーションクライアントのプログラムの実行に必要なJavaのクラス、ライブラリー、その他ファイルの集合です。アプリケーションクライアントコンテナーは、RMI-IIOPを使用してサーバと通信します。

-clientオプションまたは-jarオプションを使用して、アプリケーションのデプロイ後に取得したクライアントJARファイルをappclientコマンドの起動中に渡すことができます。

クライアントJARファイル名は「アプリケーション名Client.jar」となります。

EARファイルにアプリケーションクライアントが複数存在する場合は、-mainclassまたは-nameオプションを使用して、どのクライアントを起動するか指定する必要があります。

アプリケーションクライアントがスタンドアロンモジュールである場合、またはEARファイルに1つしか存在しない場合は、-mainclassオプションまたは-nameオプションを指定しなくても、アプリケーションクライアントコンテナーはクライアントを検索できます。

-mainclassオプションまたは-nameオプションに指定した値がクライアントの値と一致しない場合は、アプリケーションクライアントコンテナーはそのクライアントを起動を試みますが、警告メッセージが出力されます。その警告メッセージにはクライアントの実際のメインクラスと名称の値が表示されます。

絶対パス位置を指定してください。絶対パスを指定しない場合は、相対パスが使用されます。相対パスはコマンドを実行したディレクトリーからの相対パスとなります。

実行権限

スーパーユーザー

環境変数

appclientでPRFトレースを出力する場合には、次の環境変数の設定が必要です。

PRFSPOOL

ドメイン管理サーバによって設定される環境変数PRFSPOOLを設定してください。

環境変数PRFSPOOLは、次の形式で設定されます。

Java EEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名

client_application_classfileオプションには、ほかのユーザークラスによってクラスが決定し、クラスパスJVMオプションが使用されていない場合は、CLASSPATHが必要です。

-xmlオプションには、クライアント設定XMLファイル（glassfish-acc.xml）が必要です。

ファイル

アプリケーション名Client.jarを使用してクライアントアプリケーションを起動します。

-xmlオプションを使用する場合はクライアント設定XMLファイル（glassfish-acc.xml）が必要です。

引数

client_application_classfile

クライアントアプリケーションのクラスファイルのパスを指定します。相対パスを指定する場合は、現在のディレクトリーからの相対パスで記述します。

このクラスファイルには、アプリケーションクライアントコンテナーが呼び出すmain()メソッドが含まれている必要があります。

client_application_classfileを使用し、クラスがほかのユーザークラスによって決まる場合は、クラスパスを設定する必要があります。

型：String

指定できる値を次に示します。

クライアントアプリケーションのクラスファイルのパス

デフォルト値：なし

-client client_application_jar

クライアントJARファイルのパスを指定します。

型：String

指定できる値を次に示します。

クライアントJARファイルのパス

デフォルト値：なし

-mainclass main_class_name

MANIFEST.MFファイルのMain-Classエントリーに指定されているメインクライアントアプリケーションの完全クラス名を指定します。複数のクライアントアプリケーションに対して使用できます。

型：String

指定できる値を次に示します。

メインクライアントアプリケーションの完全クラス名

デフォルト値：

クライアントアプリケーションが複数存在する場合は、クライアントJARファイル内で指定されているクラス

-name display_name

クライアントアプリケーションの表示名を示します。複数のクライアントアプリケーションに対して使用できます。

型：String

指定できる値を次に示します。

クライアントアプリケーションの表示名

デフォルト値：

クライアントJARファイル内のapplication-client.xmlのdisplay-name属性に設定されている値

-xml glassfish-acc.xml file

クライアント設定XMLファイルのパスを示します。ドメイン、インスタンス、および名称（glassfish-acc.xml）をデフォルトのまま使用している場合、このオプションの指定は任意です。変更している場合は、この値の設定は必須です。

型：String

指定できる値を次に示します。

クライアント設定XMLファイルのパス

デフォルト値：

domain-dir/configディレクトリー内のglassfish-acc.xmlファイル

-textauth

認証が必要な場合に、テキスト形式の認証を指定します。

-targetserver host:port

ORBエンドポイントに対してサーバをコンマで区切ったリストを指定します。指定する各サーバにはホストが含まれます。各サーバのポートを指定することもできます。

サーバの指定からポートを省略した場合、デフォルトとして3700が使用されます。

型：String

指定できる値を次に示します。

コンマで区切られたサーバのホスト名およびポート

デフォルト値：なし

-user username

EJBコンポーネントなどのアプリケーションで保護されている特定のコンポーネントへのアクセス権限があるユーザーを指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

-passwordfile password_file

PASSWORD=appclient-passwordの形式でアプリケーションクライアントのパスワードを含むファイル名をフルパスで指定します。

セキュリティー上の理由から、環境変数として指定したパスワードはappclientコマンドでは読み取りません。

型：String

指定できる値を次に示します。

パスワードファイルのパス

デフォルト値：なし

jvm-options

クライアントアプリケーションにJVMオプションを設定できます。-clientと-jarを除く有効なJavaコマンドオプションを指定できます。JVMオプションとほかのappclientコマンドのオプションをclass-selectorの前に記述すれば、この2種類のオプションを組み合わせて使用できます。

class-selector

クライアントアプリケーションのクラスに使用する次のどちらかのクラスセレクターを指定します。

型：String

指定できる値を次に示します。

-jar jarファイル名

クライアントJARファイルの名称を指定します。クライアントJARファイルはdeployサブコマンドによってデプロイ時に作成されます。この値を指定すると、クライアントJARファイルのマニフェスト内のClass-Pathの設定が適用され、-classpathオプションの設定は無視されます。

クラス名

アプリケーションクライアントのメインクラスの完全修飾名を指定します。アプリケーションクライアントコンテナーはこのクラスのメインメソッドを呼び出し、クライアントを起動します。

デフォルト値：なし

application-options

クライアントアプリケーションの引数を指定します。

型：String

指定できる値を次に示します。

クライアントアプリケーションの引数

デフォルト値：なし

使用例

次の例では、myclientapp.jarという名称のクライアントアプリケーションJARファイルを起動します。

glassfish-acc.xmlはクライアント設定XMLファイルの名称です。scottとsampleはアプリケーションへ渡される引数です。glassfish-acc.xmlとmyclientapp.jarがカレントディレクトリーにない場合は、絶対パスでファイルの場所を指定します。絶対パスを指定しない場合は、相対パスが使われます。相対パスは、コマンドを実行しているディレクトリーからの相対パスとなります。

appclient -xml glassfish-acc.xml -jar myclientapp.jar scott sample

2.2.2　asadmin

管理タスクの実行

書式

asadmin [--host host] [--port port] [--user admin-user]
    [--passwordfile filename] [--terse={true|false}]
    [--secure={false|true}] [--echo={true|false}]
    [--interactive={true|false}] [--detach={true|false}]
    {--help|subcommand [options] [operands]}

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

asadminユーティリティーコマンドを使用して、Java EE Serverの管理タスクを実行します。

asadminユーティリティーコマンドには次のオプションがあります：

asadminオプション

asadminユーティリティーコマンドの動作を制御しますが、サブコマンドの動作は制御しません。asadminオプションはサブコマンドの前後に指定できますが、サブコマンドのあとにasadminオプションを指定することは推奨しません。また、asadminオプションはサブコマンドの前または後ろのどちらか一方に統一して指定しなければなりません。サブコマンドの前後ばらばらにasadminオプションを指定すると、エラーが発生します。

サブコマンドオプション

サブコマンドの動作を制御しますが、asadminユーティリティーコマンドの動作は制御しません。サブコマンドオプションはサブコマンドの後ろに指定します。

asadminオプションと一部のサブコマンドオプションには長形式と短形式があります。

長形式の場合

2つのハイフン（--）の後にオプション文字列が続きます。

短形式の場合

1つのハイフン（-）の後に単一文字が続きます。

Booleanオプション（機能の有効・無効を切り替えるオプション）を除く、ほとんどのオプションでは引数値が必要となります。

オペランドにはサブコマンドが処理する項目を指定します。オペランドはサブコマンドオプションの引数値に続いて指定し、スペース、タブ、または2つのハイフン（--）で区切ります。asadminユーティリティーはサブコマンドオプションやその値に続く文字列をオペランドとして処理します。

asadminサブコマンドには、サーバ間の通信またはコマンド処理の時間に対して、タイムアウトが設定されています。すべてのサブコマンドに共通のタイムアウトとしては「リードタイムアウト」および「リクエストタイムアウト」があります。

asadminプロセスに適用するリードタイムアウトの値は、環境変数AS_ADMIN_READTIMEOUTに指定できます。リクエストタイムアウトの値は、asadminユーティリティーのsetサブコマンドおよびgetサブコマンドの次のプロパティーで設定および確認できます。

configs.config.name.network-config.protocols.protocol.admin-listener.http.request-timeout-seconds

configs.config.name.network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds

コロン（:）を区切り文字として使用するオプションでは、シングルクォーテーション（'）やダブルクォーテーション（"）の前に円記号付きのエスケープ文字（¥）が必要です。

asadminユーティリティーでは、コロン（:）を区切り文字として使用するオプションがあります。コロン（:）がJava VMのプロパティーまたはオプションの一部である場合は、円記号付きのエスケープ文字（¥）が必要です。円記号付きのエスケープ文字（¥）の代わりに、ダブルクォーテーション（"）やシングルクォーテーション（'）を使用できます。これら2種類の文字での円記号（¥）の扱いを次に示します。

ダブルクォーテーション（"）で囲まれている場合、円記号（¥）は特殊文字として扱われます。

シングルクォーテーション（'）で囲まれている場合、円記号（¥）は特殊文字として扱われません。

実行権限

スーパーユーザー

前提条件

ローカルモードの場合、サブコマンドを実行してインストールディレクトリーやドメインディレクトリーにアクセスするには、ユーザーはそのドメインのホストマシンにログインする必要があります。

環境変数

次に示す環境変数を使って、asadminオプションのデフォルト値を変更できます。

AS_ADMIN_TERSE

AS_ADMIN_ECHO

AS_ADMIN_INTERACTIVE

AS_ADMIN_HOST

AS_ADMIN_PORT

AS_ADMIN_SECURE

AS_ADMIN_USER

AS_ADMIN_PASSWORDFILE

AS_ADMIN_HELP

AS_ADMIN_READTIMEOUT

ファイル

--passwordfileオプションにはパスワードエントリーを含んだファイルが必要です。

引数

--help | -?

asadminユーティリティーのヘルプテキストを表示します。

--host host | -H host

ドメイン管理サーバが起動しているマシンの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン管理サーバが起動しているマシン名

デフォルト値：localhost

--port port | -p port

管理用HTTPポートまたはHTTPSポートを指定します。

型：String

指定できる値を次に示します。

管理用HTTPポートまたはHTTPSポート

デフォルト値：4848

--user admin-user | -u admin-user

ドメイン管理サーバの権限を持つ管理ユーザーのユーザー名を示します。loginサブコマンドを使用してドメイン認証が完了している場合は、ドメイン上の後続のオペレーションに対して--userオプションを指定する必要はありません。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

--passwordfile filename | -W filename

特定の形式のパスワードエントリーを含んでいるファイルの名称をフルパスで指定します。これらのパスワードエントリーは平文でパスワードファイルに格納されています。セキュリティーに関する追加設定をする場合は、create-password-aliasサブコマンドを使用して、リモートサブコマンドが使用するパスワードのエイリアスを作成します。エイリアス作成済みのパスワードは暗号化されて格納されます。

パスワードに対しエイリアスが存在する場合は、次に示すように、そのパスワードエントリーにエイリアスを指定します。

AS_ADMIN_password-name=${ALIAS=password-alias-name}

型：String

指定できる値を次に示します。

パスワードファイル名のフルパス

デフォルト値：なし

--terse={true|false} | -t={true|false}

trueを設定した場合、簡潔で、スクリプトでの利用に最適化した形式のデータを出力します。この形式で出力したデータは、ユーザーが参照するには適していません。通常、説明文と詳細なステータスメッセージはこの出力データから省略されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--secure={true|false} | -s={true|false}

trueを設定した場合、ドメイン管理サーバとの通信でSSL/TLSを使用します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--echo={true|false} | -e={true|false}

trueを設定した場合、標準出力時にコマンドライン文を出力します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--interactive={true|false} | -I={true|false}

必要なオプションだけをプロンプト表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：

asadminユーティリティーをコンソール画面から起動している場合：true

asadminユーティリティーをスクリプト内から起動している場合：false

--detach={true|false}

trueを設定した場合、指定したasadminサブコマンドをバックグラウンドでデタッチおよび実行します。この処理はデタッチモードで行われます。--detachオプションは長時間実行のサブコマンドを使用する場合に活用できます。また、1つのコンソールまたはスクリプトから複数の独立したサブコマンドを実行できます。--detachオプションはサブコマンドの前に指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

使用例

次の例では、ローカルホストにデプロイされているすべてのアプリケーションを表示します。

asadmin list-applications

関連項目

2.11.11　setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧

2.2.3　imqcmd list dst

物理格納先の一覧表示

形式

imqcmd list dst -b hostName:portNumber
    [-t destType][-tmp]

格納先

Application Serverインストールディレクトリー/javaee/mq/bin

機能

imqcmd list dstサブコマンドは、指定した種類の物理格納先を一覧表示します。

引数

-b hostName:portNumber

メッセージブローカーのホスト名とポート番号を指定します。

リテラル表記のIPv4またはIPv6アドレスをホスト名として利用できます。リテラル表記のIPv6アドレスを利用する場合、その形式はRFC2732に準拠している必要があります。

型：String

指定できる値を次に示します。

コロンで区切られたホスト名およびポート番号

デフォルト値：localhost:7676

-t destType

物理格納先の種類を指定します。

型：String

指定できる値を次に示します。

t

トピックの物理格納先を指定します。

q

キューの物理格納先を指定します。

デフォルト値：なし

-tmp

一時物理格納先も一覧表示します。

使用例

次の例では、ホスト名：myHostかつポート番号：4545で稼働しているメッセージブローカーのすべての物理格納先を一覧表示します。

imqcmd list dst -b myHost:4545

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.2.4　jspc

JSPファイルの事前コンパイル

書式

jspc OPTION [--] jsp_files

    OPTION:
    [-webapp dir]
    [-help]
    [-v]
    [-d dir]
    [-l]
    [-s]
    [-p name]
    [-c name]
    [-mapped]
    [-die[#]]
    [-uribase dir]
    [-uriroot dir]
    [-compile]
    [-genclass]
    [-webinc file]
    [-webxml file]
    [-classpath path]
    [-xpoweredBy]
    [-trimSpaces]
    [-smap]
    [-dumpsmap]
    [-validate]
    [-compilerSourceVM jdk_release]
    [-compilerTargetVM jdk_release]
    [-ignoreJspFragmentErrors]
    [-disablePooling]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

jspcコマンドは、コマンドラインでJSPファイルを事前にコンパイルできます。

JSPファイルは実行時に自動的にコンパイルされます。

実行権限

スーパーユーザー

ファイル

このツールは.jsp形式を入力にして、サーブレットを生成します。

引数

jsp files

JSPページとして解析するファイルを指定します。

型：String

指定できる値を次に示します。

JSPページとして解析するファイル名

デフォルト値：なし

-webapp dir

Webアプリケーションが含まれるディレクトリーを指定します。指定したディレクトリー内のJSPページを再帰的に処理します。

型：String

指定できる値を次に示します。

Webアプリケーションが含まれるディレクトリー

デフォルト値：なし

-help

このコマンドのヘルプテキストを表示します。

-v

詳細情報を表示します。

-d dir

出力ディレクトリーを指定します。

型：String

指定できる値を次に示します。

出力ディレクトリー

デフォルト値：-Djava.io.tmpdir

-l

処理に失敗したJSPページの名称を出力します。

-s

処理に成功したJSPページの名称を出力します。

-p name

対象パッケージの名称を指定します。

型：String

指定できる値を次に示します。

パッケージ名

デフォルト値：org.apache.jsp

-c name

対象クラスの名称を指定します。最初のJSPページにだけ適用されます。

型：String

指定できる値を次に示します。

対象クラスの名称

デフォルト値：なし

-mapped

JSP中の1行ごとにwrite()コールを生成します。

-die[#]

致命的なエラー発生時にエラーリターンコード（#）を生成します。

デフォルト値：1

-uribase dir

コンパイル時に相対URI参照の基準となるURI（ディレクトリー）を示します。

型：String

指定できる値を次に示します。

ディレクトリー名称

デフォルト値：/

-uriroot dir

Webアプリケーションを含んでいるディレクトリーを指定します。指定したディレクトリー内のJSPページを再帰的に処理します。

型：String

指定できる値を次に示します。

ディレクトリー名

デフォルト値：なし

-compile

生成したサーブレットをコンパイルします。

-genclass

生成したサーブレットをコンパイルします。

-webinc file

ファイル内に部分的なサーブレットマッピングを作成します。

型：String

指定できる値を次に示します。

パスを含むファイル名

デフォルト値：なし

-webxml file

ファイル内に完全なweb.xmlを作成します。

型：String

指定できる値を次に示します。

Webアプリケーション名

デフォルト値：なし

-classpath path

java.class.pathシステムプロパティーにクラスパスを追加します。

型：String

指定できる値を次に示します。

クラスパス

デフォルト値：なし

-xpoweredBy

X-Powered-Byレスポンスヘッダーを追加します。

-trimSpaces

アクションや指示子の間のテンプレートテキストからスペースを削除します。

-smap

JSR45デバッグのSMAP情報を生成します。

-dumpsmap

JSR45デバッグのSMAP情報をファイル内にダンプします。

-validate

スキーマやDTDを使用して.tldファイルおよびweb.xmlファイルの妥当性をチェックします。

-compilerSourceVM jdk_release

指定したJDKリリースとソース互換性を持たせます。

型：float

指定できる値を次に示します。

1.5または5

1.6または6

1.7または7

1.8または8

デフォルト値：1.5

-compilerTargetVM jdk_release

指定したVMバージョンのクラスファイルを生成します。

型：float

指定できる値を次に示します。

1.5または5

1.6または6

1.7または7

1.8または8

デフォルト値：1.5

-ignoreJspFragmentErrors

JSPフラグメントのコンパイルエラーを無視します。

-disablePooling

カスタムタグプーリング機能を無効にします。

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.5　schemagen

スキーマジェネレーターの起動

書式

schemagen [OPTION]... <java files>

    OPTION:
    [-d path]
    [-cp path]
    [-classpath path]
    [-episode file]
    [-version]
    [-help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

schemagenコマンドは、Javaソースファイルまたはクラスファイルに対してスキーマジェネレーターの処理を実行します。

現在のスキーマジェネレーターはJavaクラスで参照されている名称空間ごとにスキーマ定義ファイルを作成します。

実行権限

スーパーユーザー

環境変数

Javaソースおよびクラスファイルがほかのクラスを参照する場合、システムのCLASSPATH環境変数でそれらのクラスにアクセスできるか、-classpathオプションまたは-cpオプションを使用してそれらのクラスを指定する必要があります。それ以外の場合、スキーマの作成中にエラーが発生します。

ファイル

Javaソースファイルまたはクラスファイルをこのコマンドで指定します。

スキーマ定義ファイルはこのコマンドによって出力されます。

引数

-d path

プロセッサおよびjavacコマンドで生成したクラスファイルの出力先ディレクトリーを指定します。

型：String

指定できる値を次に示します。

生成されたクラスファイルの出力先ディレクトリー

デフォルト値：なし

-cp path | -classpath path

ユーザー指定ファイルの場所を指定します。

型：String

指定できる値を次に示します。

ユーザー指定ファイルのパス

デフォルト値：なし

-episode file

JAXBカスタマイズファイルであるエピソードファイルを生成します。

型：String

指定できる値を次に示します。

生成するエピソードファイル名

デフォルト値：なし

-version

バージョン情報を表示します。

-help

このコマンドのヘルプテキストを表示します。

使用例

次の例では、Foo.java、Bar.javaに対してスキーマジェネレーターの処理を実行します。

schemagen Foo.java Bar.java

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.6　wscompile

JavaインターフェースクラスからのWSDL生成、WSDLからサービスエンドポイントインターフェースやスタブなどのJavaクラスの生成

書式

wscompile [OPTION] configuration_file

    OPTION:
    [-classpath path]
    [-cp path]
    [-d directory]
    [-define servicename]
    [-f:features]
    [-features:features]
    [-g]
    [-gen]
    [-gen:client]
    [-gen:server]
    [-help]
    [-httpproxy:host:port]
    [-import]
    [-keep]
    [-model file]
    [-nd directory]
    [-O]
    [-s directory]
    [-verbose]
    [-version]
    [-mapping file]
    [-security file]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

wscompileコマンドは、JAX-RPCのクライアントやサービスで使用するスタブ、タイ、シリアライザーおよびWSDLファイルを生成します。このツールは設定ファイルを読み込みます。設定ファイルにはWSDLファイル、モデルファイル、またはコンパイル済みのサービスエンドポイントインターフェースのどれかを指定します。

実行権限

スーパーユーザー

ファイル

このツールは設定ファイルを読み込みます。設定ファイルにはWSDLファイル、モデルファイル、またはコンパイル済みのサービスエンドポイントインターフェースのどれかを指定します。

引数

-classpath path | -cp path

入力クラスファイルの場所を指定します。

型：String

指定できる値を次に示します。

入力クラスファイルのパス

デフォルト値：なし

-d directory

生成した出力ファイルの場所を指定します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：なし

-define servicename

サービスを定義します。

型：String

指定できる値を次に示します。

サービス名

デフォルト値：なし

-f:features | -features:features

指定した機能を有効にします。

型：String

指定できる値を次に示します。

datahandleronly

documentliteral

rpcliteral

explicitcontext

infix:<name>

infix=<name>

jaxbenumtype

nodatabinding

nonencodedtypes

nomultirefs

norpcstructures

novalidation

resolveidref

searchschema

serializeinterfaces

strict

useonewayoperations

wsi

unwrap

donotoverride

donotunwrap

デフォルト値：なし

-g

デバッグ情報を生成します。

-gen

クライアントのアーティファクト （スタブなど） を生成します。

-gen:client

クライアントのアーティファクト （スタブなど） を生成します。

-gen:server

クライアントのアーティファクト （タイなど） を生成します。

-help

ヘルプテキストを表示します。

-httpproxy:host:port

HTTPプロキシーサーバを指定します。

hostには、プロキシーサーバのホスト名を指定します。

portには、プロキシーサーバのポート番号を指定します。

ポート番号の型：Integer

ポート番号に指定できる値を次に示します。

1〜65535

ポート番号のデフォルト値：8080

-import

インターフェースと値タイプだけを生成します。

-keep

生成したファイルを保持します。

-model file

指定したファイルに内部モデルを書き込みます。

型：String

指定できる値を次に示します。

ファイル名

デフォルト値：なし

-nd directory

生成したファイル（クラスファイル以外）の格納場所を指定します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：なし

-O

生成したコードを最適化します。

-s directory

生成したソースファイルの場所を指定します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：なし

-verbose

コンパイラーの動作に関するメッセージを出力します。

-version

バージョン情報を出力します。

-mapping file

指定したファイルにJSR-109マッピングファイルを書き込みます。

型：String

指定できる値を次に示します。

ファイル名

デフォルト値：なし

-security file

セキュリティー設定のファイルを表示します。

型：String

指定できる値を次に示します。

ファイル名

デフォルト値：なし

使用例

wscompile -gen -f:infix:Name -d generated config.xml

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.7　wsdeploy

JAX-RPCのWebサービスとしてデプロイできるWARファイルの生成

書式

wsdeploy [OPTION] war file

    OPTION:
    [-classpath path]
    [-keep]
    [-o output war file]
    [-tmpdir directory]
    [-verbose]
    [-version]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

wsdeployコマンドはWARファイルを入力し、JAX-RPCのWebサービスとしてデプロイできるWARファイルを生成します。

実行権限

スーパーユーザー

ファイル

wsdeployコマンドはWARファイルを入力し、デプロイできるWARファイルを生成します。

引数

-classpath path

入力クラスファイルのパスを指定します。

型：String

指定できる値を次に示します。

クラスファイルのパス

デフォルト値：なし

-keep

一時ファイルを保存します。

-o output war file

生成したWARファイルの場所を指定します。

型：String

指定できる値を次に示します。

WARファイルのパス

デフォルト値：なし

-tmpdir directory

使用する一時ディレクトリーを指定します。

型：String

指定できる値を次に示します。

パスを含む一時ディレクトリー名

デフォルト値：なし

-verbose

コンパイラーの動作に関するメッセージを出力します。

-version

バージョン情報を出力します。

使用例

wsdeploy -o target.war myapp.war

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.8　wsgen

JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトの生成

書式

wsgen [OPTION]... <SEI>

    OPTION:
    [-classpath path]
    [-cp path]
    [-d directory]
    [-extension]
    [-help]
    [-keep]
    [-r directory]
    [-s directory]
    [-encoding encoding]
    [-verbose]
    [-version]
    [--fullversion]
    [-wsdl[:protocol]]
    [-servicename name]
    [-portname name]
    [-inlineSchemas]
    [-x path]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

wsgenコマンドは、JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトを生成します。このコマンドはWebサービスのエンドポイントクラスを読み込み、Webサービスのデプロイや呼び出しに必要なすべてのアーティファクトを生成します。

実行権限

スーパーユーザー

ファイル

このコマンドはWebサービスのエンドポイントクラスを読み込み、JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトを生成します

引数

-classpath path | -cp path

入力クラスファイルの場所を指定します。

型：String

指定できる値を次に示します。

入力クラスファイルのパス

デフォルト値：なし

-d directory

生成した出力ファイルの格納場所を指定します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：なし

-extension

ベンダー拡張（仕様に指定されていない機能）を許可します。拡張を使用すると、アプリケーションの移植性が失われたり、ほかの実装との相互運用ができなくなったりすることがあります。

-help

ヘルプテキストを表示します。

-keep

生成したファイルを保持します。

-r directory

生成したリソースファイル（WSDLなど）の格納場所を指定します。

常に-wsdlオプションと組み合わせて使用します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：なし

-s directory

生成したソースファイルの格納場所を指定します。

型：String

指定できる値を次に示します。

出力先ディレクトリーのパス

デフォルト値：作業中のディレクトリー

-encoding encoding

作成したソースの文字エンコード（EUC-JP、UTF-8など）を設定します。-encodingオプションを指定しない場合、プラットフォームのデフォルトの文字エンコードが使用されます。

型：String

指定できる値を次に示します。

UTF-8

EUC-JP

デフォルト値：なし

-verbose

コンパイラーの動作に関するメッセージを出力します。

-version

バージョン情報を出力します。

-fullversion

フルバージョンの情報を出力します。

-wsdl[:protocol]

WSDLファイルを生成する場合はこのオプションを必ず指定します。このオプションの指定がない場合はWSDLファイルを生成しません。

通常の場合、wsgenコマンドは開発者がエンドポイントのデプロイ前にWSDLを参照する場合にだけ使用されます。

protocolにはwsdl:bindingに使用するプロトコルを指定します。

protocolにXsoap1.2を指定する場合は-extensionオプションの指定も必要です。

型：String

指定できる値を次に示します。

soap1.1

Xsoap1.2

デフォルト値：soap1.1

-servicename name

WSDL内に生成される特定のwsdl:service名を指定します。

指定例：-servicename "{http://mynamespace/}MyService"

常に-wsdlオプションと組み合わせて使用します。

型：String

指定できる値を次に示します。

サービス名

デフォルト値：なし

-portname name

WSDL内に生成される特定のwsdl:port名を指定します。

型：String

指定できる値を次に示します。

ポート名

デフォルト値：なし

例：-portname "{http://mynamespace/}MyPort"

常に-wsdlオプションと組み合わせて使用します。

-inlineSchemas

生成したWSDLにスキーマを埋め込みます。

-wsdlオプションと組み合わせて使用する必要があります。

-x path

使用する外部WebサービスのメタデータXML記述子を指定します。

記述子ファイルが複数存在する場合は、各識別子ファイルの前にこのオプションを指定する必要があります。

型：String

指定できる値を次に示します。

メタデータXML記述子ファイルのパス

デフォルト値：なし

使用例

次の例では、stockという名称のディレクトリー内に@WebServiceで注釈付けされたStockServiceに必要なラッパークラスを生成します。

wsgen -d stock -cp myclasspath stock.StockService

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.9　wsimport

JAX-WSポータブルのアーティファクトの生成

書式

wsimport [OPTION]... <WSDL>

    OPTION:
    [-d directory]
    [-b path]
    [-B jaxbOption]
    [-catalog catalogfile]
    [-extension]
    [-help]
    [-httpproxy:host:port]
    [-keep]
    [-p pkg]
    [-s directory]
    [-encoding encoding]
    [-verbose]
    [-version]
    [-fullversion]
    [-clientjar jarfile]
    [-wsdllocation location]
    [-target version]
    [-quiet]
    [-XadditionalHeaders]
    [-Xauthfile authfile]
    [-Xdebug]
    [-XdisableAuthenticator]
    [-Xno-addressing-databinding]
    [-Xnocompile]
    [-XdisableSSLHostnameVerification]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

wsimportコマンドは次に示すJAX-WSポータブルのアーティファクトを生成します。

サービスエンドポイントインターフェース（SEI）

サービス

wsdl:faultからマッピングする例外クラス（存在する場合）

応答wsdl:messageから派生する非同期応答Bean（存在する場合）

JAXBが生成する値タイプ（スキーマ型からマッピングするJavaクラス）

これらのアーティファクトは、WSDLドキュメント、スキーマ定義ファイル、およびデプロイするエンドポイントの実装とともにWARファイル内にパッケージ化されます。

実行権限

スーパーユーザー

ファイル

このコマンドはWSDLファイルを入力とします。

このコマンドはJAX-WSポータブルのアーティファクトを生成します。

-bオプションを指定している場合は、このコマンドはバインディングファイルまたはスキーマ定義ファイルを入力とします。

引数

-d directory

生成される出力ファイルの格納場所を指定します。

型：String

指定できる値を次に示します。

ディレクトリー名

デフォルト値：なし

-b path

外部のJAX-WSバインディングファイルまたはJAXBバインディングファイル、もしくは追加のスキーマ定義ファイルを指定します。複数のファイルを指定する場合は、ファイル（<file>）ごとに-bオプションで指定する必要があります。

型：String

指定できる値を次に示します。

バインディングファイルのパス

デフォルト値：なし

-B jaxbOption

このオプションをJAXBスキーマコンパイラーに渡します。

型：String

指定できる値を次に示します。

JAXBオプション名

デフォルト値：なし

-catalog catalogfile

外部エンティティー参照を解決するためのカタログファイルのパスを指定します。TR9401、XCatalog、OASIS XML Catalogの形式をサポートしています。

型：String

指定できる値を次に示します。

カタログファイルのパス

デフォルト値：なし

-extension

ベンダー拡張（仕様に規定されていない機能）を許可します。拡張を使用すると、アプリケーションの移植性が失われたり、ほかの実装との相互運用ができなくなったりすることがあります。

-help

ヘルプテキストを表示します。

-httpproxy:host:port

HTTPプロキシーサーバを指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：portのデフォルトは8080

-keep

作成したソースファイル、またはファイルを保持します。

-sオプションを設定している場合に有効になります。

-p pkg

パッケージを指定します。このコマンドラインオプション経由で対象パッケージを指定した場合、パッケージ名に対するwsdl/スキーマカスタムバインディングや、仕様で規定されているデフォルトのパッケージ名アルゴリズムよりも優先されます。

型：String

指定できる値を次に示します。

対象パッケージ名

デフォルト値：JAXB 2.1で規定されたマッピングをパッケージするWSDL/スキーマ対象の名称空間

-s directory

生成されるソースコードの格納場所を指定します。

このオプションを指定した場合、-keepオプションは有効になります。

型：String

指定できる値を次に示します。

出力先ディレクトリーパス

デフォルト値：作業中のディレクトリー

-encoding encoding

作成したソースの文字エンコード（EUC-JP、UTF-8など）を設定します。-encodingオプションを指定しない場合、プラットフォームのデフォルトの文字エンコードが使用されます。

型：String

指定できる値を次に示します。

UTF-8

EUC-JP

デフォルト値：プラットフォームのデフォルトの文字エンコード

-verbose

コンパイラーが実行している処理に関するメッセージを出力します。

-version

バージョン情報を出力します。

-fullversion

フルバージョンの情報を出力します。

-clientjar jarfile

Webサービスを起動するのに必要なWSDLメタデータに加えて、生成したアーティファクトのJARファイルを作成します。

型：String

指定できる値を次に示します。

生成するJARファイル名

デフォルト値：なし

-wsdllocation location

@WebServiceClient.wsdlLocationの値を指定します。

型：String

指定できる値を次に示します。

@WebServiceClient.wsdlLocationの値

デフォルト値：wsdl属性に渡されるWSDLのURL

-target version

指定したJAX-WSバージョンの仕様に従ってコードを生成します。例えば、-targetオプションのパラメーターに2.0を指定した場合は、JAX-WS 2.0仕様でコードを生成します。

型：String

指定できる値を次に示します。

最新のJAX-WSバージョンまで

デフォルト値：2.2

-quiet

wsimport出力を抑止します。

-XadditionalHeaders

要求メッセージまたは応答メッセージにバインドされないヘッダーをJavaメソッドのパラメーターにマッピングします。

-Xauthfile authfile

認証情報を伝達するファイルを次の形式で指定します。

http://ユーザー名:パスワード@example.org/stock?wsdl

複数のURLパターンと一致させる場合は、アスタリスク（*）を使用します。

型：String

指定できる値を次に示します。

認証情報を伝達するファイルのURL

デフォルト値：$HOME/.metro/auth

-Xdebug

デバッグ情報を出力します。

-XdisableAuthenticator

JAX-WS RIが使用するオーセンティケーターを無効にします。

このオプションが設定されている場合、-Xauthfileオプションは無視されます。

-Xno-addressing-databinding

W3C EndpointReference型のJavaへのバインディングを有効にします。

-Xnocompile

生成したJavaファイルをコンパイルしません。

-XdisableSSLHostnameVerification

wsdlのフェッチ中にSSLのホスト名を検証しません。

使用例

wsimport -p stockquote http://stockquote.xyz/quote?wsdl

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.2.10　xjc

XML SchemaからJavaへバインディングするコンパイラー

書式

xjc [OPTION]... <schema file/URL/dir/jar> [-b <binding>...]

    OPTION:
    [-nv]
    [-extension]
    [-d dir]
    [-p pkg]
    [-httpproxy proxy]
    [-httpproxyfile file]
    [-classpath arg]
    [-catalog file]
    [-readOnly]
    [-npa]
    [-no-header]
    [-target 2.0|2.1]
    [-encoding encoding]
    [-enableIntrospection]
    [-disableXmlSecurity]
    [-contentForWildcard]
    [-xmlschema]
    [-verbose]
    [-quiet]
    [-help]
    [-version]
    [-Xinject-code]
    [-Xlocator]
    [-Xsync-methods]
    [-mark-generated]
    [-episode file]
    [-Xpropertyaccessors]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

xjcコマンドは、コンパイル時に使用するバインドオプションの設定を基に、Javaソースファイルとjaxb.propertiesファイルを含んだパッケージの集合を作成します。

パッケージを生成したときに、jaxb.propertiesファイルはコンパイル済みのソースコードとともに保持されていて、クライアントアプリケーションの実行時に利用できる状態である必要があります。

実行権限

スーパーユーザー

ファイル

xjcコマンドの入力として渡されるxsdスキーマ定義ファイルが必要です。xjcコマンドはJavaコンテンツクラスを作成します。

xjcコマンドはJavaソースファイルとjaxb.propertiesファイルを含んだパッケージの集合を作成します。

引数

-nv

スキーマの妥当性検査のレベルを変更します。このオプションを指定すると、厳密性の低い妥当性検査が実施されます。

-extension

JAXB仕様で規定されていない機能のベンダー拡張を許可する場合に指定します。

-d dir

Javaコンテンツクラスを代替出力ディレクトリーに作成します。

このオプションを指定する場合は、代替出力ディレクトリーが事前に作成されている必要があります。XJCスキーマコンパイラーはこのディレクトリーを作成しません。

型：String

指定できる値を次に示します。

出力先ディレクトリー名

デフォルト値：なし

-p pkg

パッケージを指定します。-pオプションでパッケージを指定した場合、パッケージ名に対するカスタムバインディングや、仕様で規定されているデフォルトのパッケージ名アルゴリズムよりも優先されます。

型：String

指定できる値を次に示します。

パッケージ名

デフォルト値：なし

-httpproxy proxy

HTTP/HTTPSプロキシーを指定します。

書式は次のとおりです：

[user[:password]@]proxyHost[:proxyPort]

型：Integer

指定できる値を次に示します。

HTTP/HTTPSプロキシー

デフォルト値：なし

-httpproxyfile file

HTTP/HTTPSプロキシーのファイルパスを指定します。ファイル内の<proxy>パラメーターを使用して、パスワードを保護できます。

書式は次のとおりです：

[user[:password]@]proxyHost[:proxyPort]

型：String

指定できる値を次に示します。

HTTP/HTTPSプロキシーのファイルパス

デフォルト値：なし

-classpath arg

<jxb:javaType>や<xjc:superClass>のカスタマイズで使用されるクライアントアプリケーションのクラスファイルの場所を指定します。

型：String

指定できる値を次に示します。

クラスパス

デフォルト値：なし

-catalog file

外部エンティティー参照を解決するカタログファイルのパスを指定します。TR9401、XCatalogおよびOASIS XML Catalogの形式をサポートします。

型：String

指定できる値を次に示します。

カタログファイルのパス

デフォルト値：なし

-readOnly

このオプションを指定すると、XJCスキーマコンパイラーは生成されたJavaソースを強制的に読み取り専用とします。

-npa

**/package-info.javaにパッケージレベルの注釈を作成することを抑止します。

このオプションを指定して生成されたコードでは、生成済みのほかのクラスにこれらの注釈が取り込まれます。

-no-header

注釈やタイムスタンプを含むファイルヘッダーコメントの生成を抑止します。

このオプションを指定すると、生成されたコードの差分が取りやすくなります。

-target 2.0|2.1

JAXB 2.1またはJAXB 2.2の機能に依存するコードを生成しないようにします。このオプションを指定すると、生成されたコードがJAXB 2.0ランタイム（JavaSE 6など）で実行できるようになります。

型：Integer

指定できる値を次に示します。

JAXBのバージョン番号

デフォルト値：なし

-encoding encoding

作成したソースファイルの文字エンコードを指定します。

型：String

指定できる値を次に示します。

JDKがサポートする文字エンコード

デフォルト値：OSのデフォルトの文字エンコード

-enableIntrospection

Boolean getters/settersを正しく生成して、Introspection APIを有効にします。

-disableXmlSecurity

XMLドキュメントの解析時にXMLのセキュリティー機能を無効にします。

-contentForWildcard

複数のxs:any派生要素を持つタイプのコンテンツプロパティーを生成します。

-xmlschema

入力スキーマをW3C XML Schemaとして処理します。このオプションを指定しない場合も、入力スキーマはW3C XML Schemaとして処理されます。

-verbose

エラー発生時に詳細な情報メッセージを出力したり、スタックトレースを表示したりします。

-quiet

進捗情報や警告などのコンパイラーによる出力を抑止します。

-help

コマンドラインオプションの概要を表示します。

-version

コンパイラーのバージョン情報を表示します。

-Xinject-code

指定したJavaコードのフラグメントを生成したコードに埋め込みます。

-Xlocator

このオプションを指定すると、生成したJavaコードに、基のXMLのSAXのLocator情報を出力します。

-Xsync-methods

このオプションを指定すると、生成したメソッドのシグニチャーすべてにsynchronizedキーワードが含まれます。

-mark-generated

このオプションを指定すると、生成したコードに注釈（@Generated [http://java.sun.com/javaee/5/docs/api/jaxb-2-0-overview? javax/annotation/Generated.html]）を付与します。

-episode file

コンパイル時にエピソードファイルを生成します。このエピソードファイルに依存するほかのスキーマ定義ファイルのコンパイル後、エピソードファイルをコンパイル時に生成されたクラスに依存させることができます。作成したエピソードファイルはベンダー拡張を含んだJAXBカスタマイズファイルとなります。

型：String

指定できる値を次に示します。

生成するエピソードファイル名

デフォルト値：なし

-Xpropertyaccessors

生成したクラスの@XmlAccessorTypeに、XmlAccessType.FIELDの代わりにXmlAccessType PROPERTYを付与します。

schema file/URL/dir

コンパイル対象のスキーマ定義ファイルを1つ以上指定します。ディレクトリーを指定した場合、xjcはそのディレクトリーを走査し、検出したスキーマ定義ファイルすべてをコンパイルします。

型：String

指定できる値を次に示します。

スキーマ定義ファイルまたはディレクトリーのパス

デフォルト値：なし

-b <binding>

処理する外部バインディングファイルを指定します。

バインディングファイルごとに-bオプションを指定します。複数のスキーマのカスタマイズを1つのバインディングファイルに含めたり、複数のバインディングファイルに分割したりできます。コマンドラインに指定するスキーマ定義ファイルとバインディングファイルの順番は任意です。

型：String

指定できる値を次に示します。

外部バインディングファイル名

デフォルト値：なし

使用例

例1：1つのバインディングファイル（bindings123.xjb）を使用して、schema1.xsd、schema2.xsd、schema3.xsdからJavaクラスを生成する場合

xjc schema1.xsd schema2.xsd schema3.xsd -b
bindings123.xjb

例2：複数のバインディングファイル（bindings1.xjb、bindings2.xjb、bindings3.xjb）を使用して、schema1.xsd、schema2.xsd、schema3.xsdからJavaクラスを生成する場合

xjc schema1.xsd schema2.xsd schema3.xsd -b
bindings1.xjb -b bindings2.xjb -b bindings3.xjb

戻り値

戻り値

説明

0

コマンドの実行に成功しました。

1

コマンドの実行中にエラーが発生しました。

2.3　Java EEサーバで使用するasadminコマンドのサブコマンド一覧

Java EEサーバで使用するasadminコマンドのサブコマンド一覧を次の表に示します。

ドメインの管理で使用するコマンド

コマンド名称

要約

概要説明

backup-domain

ドメインのバックアップ

名前付きドメイン内のファイルをバックアップします。

change-admin-password

管理ユーザーパスワードの変更

管理ユーザーのパスワードを変更します。

create-domain

Java EE Serverドメインの作成

Java EE Serverドメインを作成します。

delete-domain

ドメインの削除

指定したドメインを削除します。

list-backups

ドメインバックアップの一覧表示

ドメインバックアップに関する情報を一覧表示します。

list-domains

ドメインディレクトリー内のドメインの一覧表示

指定したドメインディレクトリー内のドメインを一覧表示します。

restart-domain

ドメイン管理サーバの再起動

指定したドメインのドメイン管理サーバを停止した後、再起動します。

restore-domain

バックアップからのファイルの復元

バックアップディレクトリーからドメイン内にファイルを復元します。

start-domain

ドメイン管理サーバの起動

指定したドメインのドメイン管理サーバを起動します。

stop-domain

ドメイン管理サーバの停止

指定したドメインのドメイン管理サーバを停止します。

ノードの管理で使用するコマンド

コマンド名称

要約

概要説明

create-node-config

リモート通信が有効化されていないノードの作成

リモート通信が有効化されていないノードを作成します。

create-node-ssh

SSHが有効なノードの作成

SSHを介した通信が有効なノードを作成します。

delete-node-config

リモート通信が無効なノードの削除

ドメインからリモート通信が無効なノードを削除します。

delete-node-ssh

SSH通信が有効なノードの削除

ドメインからのSSH通信が有効なノードを削除します。

list-nodes

Java EE Serverノードの一覧表示

ドメイン内のすべてのJava EE Serverノードを一覧表示します。

list-nodes-config

リモート通信をサポートしないドメイン内のJava EE Serverノードの一覧表示

リモート通信をサポートしない、ドメイン内のすべてのJava EE Serverノードを一覧表示します。

list-nodes-ssh

SSH経由の通信をサポートするドメイン内のJava EE Serverノードの一覧表示

SSH経由の通信をサポートするドメイン内すべてのJava EE Serverノードを一覧表示します。

ping-node-ssh

SSH通信によるノード使用のテスト

SSH経由で、ノードが表すホスト上でasadminユーティリティーコマンドを実行できるかどうかをテストします。

setup-ssh

SSHキーのセットアップ

指定したホストにSSHキーをセットアップします。

update-node-config

ノード構成データの更新

ノードの構成データを更新します。ノードを更新するために、SSHを設定する必要がありません。

update-node-ssh

SSHを使ったノード構成データの更新

ノードの構成データを更新します。ノードを更新するために、ドメイン管理サーバが稼働しているマシンおよびノードが存在するマシンで、SSHを設定する必要があります。

サーバの管理で使用するコマンド

コマンド名称

要約

概要説明

cleanup-prf

PRF環境のクリーンアップ

サブコマンドを実行したホスト上に構築されているPRFを停止して、PRF環境を削除（クリーンアップ）します。

cleanup-webserver

Webサーバ環境のクリーンアップ

サブコマンドを実行したホスト上に構築されているWebサーバを停止して、Webサーバ環境を削除（クリーンアップ）します。

copy-config

既存の名前付き構成をコピーして、別の構成を作成

既存の構成をコピーしてドメイン管理サーバに構成を作成します。

create-cluster

Java EE Serverクラスターの作成

Java EE Serverクラスターを作成します。

create-instance

サーバインスタンスの作成

サーバインスタンスを作成します。

create-prf

PRFの構築

ドメインにPRFを構築します。

create-webserver

Webサーバの構築

ドメインにWebサーバを構築します。

delete-cluster

Java EE Serverクラスターの削除

Java EE Serverクラスターを削除します。

delete-config

名前付き既存構成の削除

ドメイン管理サーバの構成から既存の名前付き構成を削除します。

delete-instance

サーバインスタンスの削除

サーバインスタンスを削除します。

delete-prf

PRFの削除

指定したPRFをドメインから削除します。

delete-webserver

Webサーバの削除

Webサーバをドメインから削除します。

export-sync-bundle

クラスターまたはスタンドアロンサーバインスタンスの構成データのアーカイブファイルへのエクスポート

クラスターまたはスタンドアロンサーバインスタンスの構成データをアーカイブファイルにエクスポートします。

get-health

クラスターの状態表示

クラスターの状態に関する情報を取得し、表示します。

import-sync-bundle

クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データのインポート

export-sync-bundleサブコマンドで作成されたアーカイブファイルから、クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データをインポートします。

list-clusters

ドメイン内の既存クラスターの一覧表示

ドメイン内の既存のクラスターを一覧表示します。

list-instances

サーバインスタンスの一覧表示

ドメイン内のサーバインスタンスを一覧表示します。

list-prfs

PRFの一覧表示

ドメイン内のPRFを一覧表示します。

list-webservers

Webサーバの一覧表示

ドメインに構築されたWebサーバを一覧表示します。

start-cluster

クラスターの起動

クラスター内でまだ実行されていないすべてのサーバインスタンスを起動します。

start-instance

サーバインスタンスの起動

サーバインスタンスを起動します。

start-prf

PRFの起動

指定したPRFを起動します。

start-servers

サーバの一括起動

ドメイン内の各種サーバを一括で起動します。

start-webserver

Webサーバの起動

指定したWebサーバを起動します。

stop-cluster

Java EE Serverのクラスターの停止

クラスター内で実行されているすべてのサーバインスタンスを停止することによって、そのクラスターを停止します。

stop-instance

実行中のサーバインスタンスの停止

実行中のサーバインスタンスを停止します。

stop-prf

PRFの停止

指定したPRFを停止します。

stop-servers

サーバの一括停止

ドメイン内の各種サーバを一括で停止します。

stop-webserver

Webサーバの停止

指定したWebサーバを停止します。

validate-multicast

マルチキャストトランスポートの検証

クラスターに対してマルチキャストトランスポートが使用できるかどうかを検証します。

サーバ間関連設定で使用するコマンド

コマンド名称

要約

概要説明

create-relation

サーバ間関連を作成

サーバ間の関連を作成します。

delete-relation

サーバ間関連を削除

サーバ間の関連をドメインから削除します。

list-relations

サーバ間関連を一覧表示

サーバ間の関連を一覧表示します。

アプリケーション管理で使用するコマンド

コマンド名称

要約

概要説明

create-application-ref

アプリケーション参照の作成

クラスターまたはクラスター構成ではないサーバインスタンスから、すでにデプロイされているアプリケーションへの参照を作成します。

delete-application-ref

アプリケーション参照の削除

クラスターまたはクラスター構成ではないサーバインスタンスからアプリケーション参照を削除します。

deploy

コンポーネントのデプロイ

アプリケーションをサーバにデプロイします。

disable

コンポーネントの無効化

指定したデプロイ済みコンポーネントをただちに無効にします。

enable

コンポーネントの有効化

指定したデプロイ済みコンポーネントを有効にします。

get-client-stubs

クライアントスタブのJARファイルの取得

クライアントスタブJARファイルを、サーバマシンからローカルディレクトリーに取得します。

list-application-refs

既存のアプリケーション参照の一覧表示

クラスターまたはクラスター構成ではないサーバインスタンスにあるすべてのアプリケーション参照を一覧表示します。

list-applications

デプロイ済みアプリケーションの一覧表示

デプロイ済みのJava EEアプリケーションと各アプリケーションの種類を一覧表示します。

list-containers

アプリケーションコンテナーの一覧表示

アプリケーションコンテナーのリストを一覧表示します。

list-modules

Java EE Serverモジュールの一覧表示

Java EE Serverからアクセス可能なモジュールの一覧を表示します。

list-sub-components

デプロイされたモジュール内またはデプロイされたアプリケーションモジュール内のEJBまたはサーブレットのコンポーネントの一覧表示

デプロイされたモジュール内、またはデプロイされたアプリケーションのモジュール内のEJBまたはサーブレットのコンポーネントを一覧表示します。

list-timers

サーバインスタンスが所有する永続タイマーの一覧表示

指定したサーバインスタンスまたはサーバインスタンスのクラスターが所有する永続タイマーを一覧表示します。

list-web-context-param

デプロイされたWebアプリケーションまたはモジュールのServletContext初期化パラメーターの一覧表示

デプロイされたWebアプリケーションまたはモジュールのServletContext初期化パラメーターを一覧表示します。

list-web-env-entry

デプロイされたWebアプリケーションまたはモジュールの環境エントリーの一覧表示

デプロイされたWebアプリケーションまたはモジュールの環境エントリーを一覧表示します。

redeploy

コンポーネントのリデプロイ

デプロイ済みまたは既存のコンポーネント（エンタープライズアプリケーション、Webアプリケーション、EJBモジュール、リソースアダプターアーカイブ、またはアプリケーションクライアントのモジュール）をリデプロイします。

set-web-context-param

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定

デプロイ済みのWebアプリケーションまたはモジュールのServletContext初期化パラメーターを設定します。

set-web-env-entry

Webアプリケーションまたはモジュールの環境エントリーの設定

デプロイ済みのWebアプリケーションまたはモジュールの環境エントリーを設定します。

show-component-status

デプロイ済みのコンポーネントの状態の表示

デプロイ済みのコンポーネントの状態を取得します。

undeploy

デプロイ済みのコンポーネントの削除

デプロイ済みのコンポーネント（アプリケーションまたはモジュール）をアンインストールして、リポジトリーから削除します。

unset-web-context-param

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定の解除

デプロイ済みのWebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定を解除します。

unset-web-env-entry

Webアプリケーションまたはモジュールの環境エントリーの設定の解除

デプロイ済みのWebアプリケーションまたはモジュールの環境エントリーの設定を解除します。

セキュリティー管理で使用するコマンド

コマンド名称

要約

概要説明

change-master-password

マスターパスワードの変更

マスターパスワードを変更します。

create-auth-realm

名前付き認証レルムの追加

名前付き認証レルムを追加します。

create-file-user

ファイルユーザーの作成

キーファイルのエントリーを作成します。

create-jacc-provider

任意の認証モジュールで使用できるJACCプロバイダーの作成

JSR-115準拠のJACCプロバイダーを作成します。

create-password-alias

パスワードエイリアスの作成

パスワードに対するエイリアスを作成します。

delete-auth-realm

名前付きの認証レルムの削除

名前付き認証 レルムを削除します。

delete-file-user

ファイルユーザーの削除

指定したユーザー名に対するキーファイルのエントリーを削除します。

delete-jacc-provider

JACCプロバイダーの削除

ドメインに定義されたJACCプロバイダーを削除します。

delete-password-alias

パスワードエイリアスの削除

パスワードエイリアスを削除します。

disable-secure-admin

secure admin機能の無効化

secure admin機能を無効にします。

enable-secure-admin

secure admin機能の有効化

secure admin機能を有効にします。

list-auth-realms

認証レルムの一覧表示

認証レルムを一覧表示します。

list-file-groups

ファイルグループの一覧表示

ファイルレルム認証によってサポートされるファイルユーザーとグループを一覧表示します。

list-file-users

ファイルユーザーの一覧表示

ファイルレルム認証でサポートされるファイルユーザーの一覧を表示します。

list-jacc-providers

JACCプロバイダーの一覧表示

ドメインに定義されたJACCプロバイダーを一覧表示します。

list-password-aliases

パスワードエイリアスの一覧表示

すべてのパスワードエイリアスを一覧表示します。

list-supported-cipher-suites

Java EE Serverで利用できる暗号化方式群の一覧表示

指定したJava EE Serverで利用できる暗号化方式群を一覧表示します。

update-file-user

現在のファイルユーザーの更新

キーファイル内の既存のエントリーを更新します。

update-password-alias

パスワードエイリアスの更新

指定したターゲットでパスワードエイリアスIDを更新します。

ログ管理で使用するコマンド

コマンド名称

要約

概要説明

collect-local-snapshot

ドメイン管理サーバ非稼働時のシステム情報の収集

Application Serverを構成する製品のシステム情報を収集します。ドメイン管理サーバが稼働していない状態でも実行できます。

collect-snapshot

ドメイン管理サーバ稼働時のシステム情報の収集

Application Serverを構成する製品のシステム情報を収集します。ドメイン管理サーバが稼働しているときだけ実行できます。

list-log-attributes

ログ属性の一覧表示

指定したJava EE Serverドメインまたはドメイン内の対象に現在定義されているログ属性を一覧表示します。

set-log-attributes

1つ以上のロガーのロギング属性の設定

1つ以上のロガーのロギング属性を設定します。

パラメーター設定で使用するコマンド

コマンド名称

要約

概要説明

create-jvm-options

Java VMオプションの作成

Java EE Server起動時にJava VMに渡されるコマンドラインの各オプションを作成します。

create-system-properties

構成のほかの部分から参照できるシステムプロパティーの追加

サーバの各所から参照できる各システムプロパティーを追加または更新します。

delete-jvm-options

Java VMオプションの削除

Java VMのコマンドラインオプションを削除します。

delete-system-property

システムプロパティー（ドメイン／構成／クラスター／サーバインスタンス）の削除

システムプロパティー（ドメイン、構成、クラスターまたはサーバインスタンス）を削除します。

get

構成属性値の取得

ドット表記名を使用してJava EE Serverの構成属性値を取得します。

list

構成属性値の一覧表示

Java EE Serverの構成属性値を一覧表示します。

list-configs

ドメイン管理サーバの構成中の、名前付き構成の一覧表示

ドメイン管理サーバの構成中の名前付き構成を一覧表示します。

list-jvm-options

Java VMオプションの一覧表示

Java EE Server起動時にJava VMに渡されるコマンドラインオプションを一覧表示します。

list-system-properties

ドメイン、構成、クラスターまたはサーバインスタンスのシステムプロパティーの一覧表示

システムプロパティー（ドメイン、構成、クラスターまたはサーバインスタンス）を一覧表示します。

set

構成属性値の設定

1つ以上の構成属性値を変更します。

システム管理で使用するコマンド

コマンド名称

要約

概要説明

add-library

1つ以上のライブラリーのアーカイブをJava EE Serverに追加

1つ以上のライブラリーのアーカイブをJava EE Serverに追加します。

create-profiler

プロファイラー要素の作成

プロファイラー要素を作成します。

delete-profiler

プロファイラー要素の削除

Java構成のプロファイラー要素を削除します。

list-commands

使用できるコマンドの一覧表示

asadminコマンドのサブコマンドを一覧表示します。

list-libraries

ライブラリーのアーカイブの一覧表示

Java EE Serverのライブラリーのアーカイブを一覧表示します。

login

ドメインへのログイン

特定のドメインにログインできる状態にして、ドメイン管理を簡略化します。

remove-library

1つ以上のライブラリーJARファイルのJava EE Serverからの除去

1つ以上のライブラリーJARファイルをJava EE Serverから除去します。

version

Java EE Serverのバージョン情報の表示

Java EE Serverのバージョン情報を表示します。

インターネット接続管理で使用するコマンド

コマンド名称

要約

概要説明

create-protocol

新規プロトコルの追加

プロトコルを作成します。

create-ssl

セキュア通信の構成

選択したHTTPリスナー、IIOPリスナーまたはIIOPサービスにSSL要素を作成して、それらのリスナーまたはサービスでセキュア通信を有効にするように構成します。

delete-protocol

プロトコルの削除

指定したプロトコルを削除します。

delete-ssl

SSL設定の削除

選択したHTTPリスナー、IIOPリスナーまたはIIOPサービスのSSL要素を削除します。

list-network-listeners

ネットワークリスナーの一覧表示

既存のネットワークリスナーを一覧表示します。

list-protocols

プロトコルの一覧表示

既存のプロトコルを一覧表示します。

list-transports

トランスポートの一覧表示

既存のトランスポートを一覧表示します。

list-virtual-servers

仮想サーバの一覧表示

既存の仮想サーバを一覧表示します。

ORB管理機能で使用するコマンド

コマンド名称

要約

概要説明

create-iiop-listener

IIOPリスナーの追加

IIOPリスナーを作成します。

delete-iiop-listener

IIOPリスナーの削除

指定したIIOPリスナーを削除します。

list-iiop-listeners

IIOPリスナーの一覧表示

既存のIIOPリスナーを一覧表示します。

リソース管理で使用するコマンド

コマンド名称

要約

概要説明

add-resources

XMLファイルに指定されたリソースの追加

指定したXMLファイル内で指名されているリソースを追加します。

create-resource-ref

リソースへの参照の作成

クラスターまたはクラスター化されていないサーバインスタンスから前に作成されたリソースへの参照を作成します。

delete-resource-ref

リソース参照の削除

クラスターまたはクラスター化されていないサーバインスタンスから、リソース参照を削除します。

list-resource-refs

リソース参照の一覧表示

クラスターまたはクラスター化されていないサーバインスタンス内のリソース参照を一覧表示します。

データベースコネクション管理で使用するコマンド

コマンド名称

要約

概要説明

create-jdbc-connection-pool

JDBCコネクションプールの登録

指定したJDBCコネクションプール名を持つJDBCソフトウェアを新規登録します。

create-jdbc-resource

JDBCリソースの作成

JDBCリソースを新規に作成します。

delete-jdbc-connection-pool

JDBCコネクションプールの削除

JDBCコネクションプールを削除します。

delete-jdbc-resource

JNDI名を持つJDBCリソースの削除

JNDI名を指定したJDBCリソースを削除します。

list-jdbc-connection-pools

JDBCコネクションプールの一覧表示

現在のJDBCコネクションプールを一覧表示します。

list-jdbc-resources

JDBCリソースの一覧表示

既存のJDBCリソースを一覧表示します。

JavaMailサービス管理で使用するコマンド

コマンド名称

要約

概要説明

create-javamail-resource

JavaMailセッションリソースの作成

JavaMailセッションリソースを作成します。

delete-javamail-resource

JavaMailセッションリソースの削除

指定したJavaMailセッションリソースを削除します。

list-javamail-resources

JavaMailセッションリソースの一覧表示

既存のJavaMailセッションリソースを一覧表示します。

JNDIサービス管理で使用するコマンド

コマンド名称

要約

概要説明

create-custom-resource

カスタムリソースの作成

カスタムリソースを作成します。

create-jndi-resource

JNDIリソースの登録

JNDI リソースを登録します。

delete-custom-resource

カスタムリソースの削除

カスタムリソースを削除します。

delete-jndi-resource

JNDIリソースの削除

指定した JNDIリソースを削除します。

list-custom-resources

カスタムリソースの取得

カスタムリソースを一覧表示します。

list-jndi-resources

JNDIリソースの一覧表示

既存のすべてのJNDIリソースを一覧表示します。

JMS管理で使用するコマンド

コマンド名称

要約

概要説明

create-jms-host

JMSホストの作成

JMSサービス内にJMSホストを作成します。

create-jms-resource

JMSリソースの作成

JMSコネクションファクトリーリソースまたはJMS Destinationリソースを作成します。

create-jmsdest

JMSの物理送信先の作成

JMSの物理送信先を作成します。

delete-jms-host

JMSホストの削除

JMSホストを削除します。

delete-jms-resource

JMSリソースの削除

JMSコネクションファクトリーリソースまたはJMS Destinationリソースを削除します。

delete-jmsdest

JMS物理送信先の削除

JMS物理送信先を削除します。

flush-jmsdest

JMS送信先内のメッセージの削除

サーバのJMS構成にある物理送信先からメッセージを削除します。

list-jms-hosts

JMSホストの一覧表示

JMSサービスの既存のJMSホストを一覧表示します。

list-jms-resources

JMSリソースの一覧表示

既存のJMSリソース（送信先とコネクションファクトリーリソース）を一覧表示します。

list-jmsdest

JMS物理送信先の一覧表示

JMS物理送信先を一覧表示します。

EIS接続管理で使用するコマンド

コマンド名称

要約

概要説明

create-admin-object

管理対象オブジェクトの作成

指定したJNDI名で管理対象オブジェクト、およびリソースアダプターのインターフェース定義を作成します。

create-connector-connection-pool

コネクションプールの追加

エンタープライズ情報システム（EIS）への接続のプールを定義します。

create-connector-resource

コネクターリソースの登録

指定したJNDI名でコネクターリソースを登録します。

create-connector-security-map

コネクターコネクションプールのセキュリティーマップの作成

指定したコネクターコネクションプールのセキュリティーマップを作成します。

create-connector-work-security-map

リソースアダプターのワークセキュリティーマップの作成

リソースアダプターEISプリンシパルまたはEISユーザーグループによってサブミットされたワークの呼び出し側識別を、Java EE Serverセキュリティードメインの対応するプリンシパルまたはユーザーグループにマップします。

create-resource-adapter-config

リソースアダプターアーカイブ構成情報の作成

リソースアダプターアーカイブ構成情報を作成します。

delete-admin-object

管理対象オブジェクトの削除

指定したJNDI名の管理対象オブジェクトを削除します。

delete-connector-connection-pool

コネクターコネクションプールの削除

指定したコネクターコネクションプールを削除します。

delete-connector-resource

コネクターリソースの削除

指定したJNDI名のコネクターリソースを削除します。

delete-connector-security-map

コネクターコネクションプールのセキュリティーマップの削除

指定したコネクターコネクションプールのセキュリティーマップを削除します。

delete-connector-work-security-map

リソースアダプターのワークセキュリティーマップの削除

指定したリソースアダプターに関連づけられているワークセキュリティーマップを削除します。

delete-resource-adapter-config

リソースアダプターアーカイブ構成情報の削除

リソースアダプターアーカイブの構成情報を削除します。

flush-connection-pool

コネクションプールで確立されたコネクションの再初期化

JDBCコネクションプールまたはコネクターコネクションプールを初期状態にリセットします。

list-admin-objects

管理された全オブジェクトの取得

管理された全オブジェクトの一覧を表示します。

list-connector-connection-pools

コネクターコネクションプールの一覧表示

作成されたコネクターコネクションプールを一覧表示します。

list-connector-resources

コネクターリソースの一覧表示

すべてのコネクターリソースを一覧表示します。

list-connector-security-maps

コネクターコネクションプールに属するセキュリティーマップの一覧表示

指定されたコネクターコネクションプールに属するセキュリティーマップを一覧表示します。

list-connector-work-security-maps

リソースアダプターに属するワークセキュリティーマップの一覧表示

指定されたリソースアダプターに属するワークセキュリティーマップを一覧表示します。

list-resource-adapter-configs

リソースアダプターアーカイブ構成の名称の一覧表示

リソースアダプターアーカイブに対するdomain.xmlの構成情報を一覧表示します。

ping-connection-pool

JDBCまたはコネクターコネクションプールの検証

既存のJDBCまたはコネクターコネクションプールが使用できるかどうかをテストします。

update-connector-security-map

コネクターコネクションプールのセキュリティーマップの変更

指定したコネクターコネクションプールのセキュリティーマップを変更します。

update-connector-work-security-map

リソースアダプターのワークセキュリティーマップの変更

指定したリソースアダプターのセキュリティーマップを変更します。

スレッドプール管理で使用するコマンド

コマンド名称

要約

概要説明

create-threadpool

スレッドプールの追加

指定名でスレッドプールを作成します。

delete-threadpool

スレッドプールの削除

指定したIDのスレッドプールを削除します。

list-threadpools

スレッドプールの一覧表示

Java EE Serverのスレッドプールを一覧表示します。

トランザクション管理で使用するコマンド

コマンド名称

要約

概要説明

recover-transactions

実行待ちトランザクションの手動での回復

サーバ障害後にトランザクションを回復します。

バッチジョブ管理で使用するコマンド

コマンド名称

要約

概要説明

list-batch-job-executions

バッチジョブ実行の一覧表示

バッチジョブ実行と実行の詳細情報を一覧表示します。

list-batch-job-steps

バッチジョブの実行ステップの一覧表示

特定のバッチジョブの実行ステップを一覧表示します。

list-batch-jobs

バッチジョブの一覧表示

バッチジョブとジョブの詳細を一覧表示します。

list-batch-runtime-configuration

バッチ実行時の構成の表示

バッチ実行時の構成を表示します。

set-batch-runtime-configuration

バッチランタイムの設定

バッチランタイムを設定します。

並行リソース管理で使用するコマンド

コマンド名称

要約

概要説明

create-context-service

コンテキストサービスのリソースの作成

コンテキストサービスのリソースを作成します。

create-managed-executor-service

ManagedExecutorServiceリソースの作成

ManagedExecutorServiceリソースを作成します。

create-managed-scheduled-executor-service

ManagedScheduledExecutorServiceリソースの作成

ManagedScheduledExecutorServiceリソースを作成します。

create-managed-thread-factory

ManagedThreadFactoryリソースの作成

ManagedThreadFactoryリソースを作成します。

delete-context-service

コンテキストサービスのリソースの削除

指定したJNDI名のコンテキストサービスのリソースを削除します。

delete-managed-executor-service

ManagedExecutorServiceリソースの削除

指定したJNDI名のManagedExecutorServiceリソースを削除します。

delete-managed-scheduled-executor-service

ManagedScheduledExecutorServiceリソースの削除

指定したJNDI名のManagedScheduledExecutorServiceリソースを削除します。

delete-managed-thread-factory

ManagedThreadFactoryリソースの削除

指定したJNDI名のManagedThreadFactoryリソースを削除します。

list-context-services

コンテキストサービスのリソースの一覧表示

コンテキストサービスのリソースを一覧表示します。

list-managed-executor-services

ManagedExecutorServiceリソースの一覧表示

ManagedExecutorServiceリソースを一覧表示します。

list-managed-scheduled-executor-services

ManagedScheduledExecutorServiceリソースの一覧表示

ManagedScheduledExecutorServiceリソースを一覧表示します。

list-managed-thread-factories

ManagedThreadFactoryリソースの一覧表示

ManagedThreadFactoryリソースを一覧表示します。

メッセージセキュリティープロバイダーの管理で使用するコマンド

コマンド名称

要約

概要説明

create-message-security-provider

メッセージセキュリティープロバイダーの作成

メッセージセキュリティープロバイダーを作成します。

delete-message-security-provider

メッセージセキュリティープロバイダーの削除

メッセージセキュリティープロバイダーを削除します。

list-message-security-providers

メッセージレイヤーのメッセージセキュリティープロバイダーの一覧表示

指定したメッセージレイヤー（domain.xmlのmessage-security-config要素）のすべてのメッセージセキュリティープロバイダー（provider-config子要素）を一覧表示します。

イベント検知時コマンド実行で使用するコマンド

コマンド名称

要約

概要説明

create-event-hook

イベント検知時コマンドの登録

ドメイン管理サーバでイベントが発生したときに、自動で実行されるイベント検知時コマンドを登録します。

delete-event-hook

イベント検知時コマンドの登録解除

イベント検知時コマンドの登録を解除します。

list-event-hooks

イベント検知時コマンドの一覧表示

登録されているイベント検知時コマンドを一覧表示します。

重要

コマンドの引数には、各コマンドで指定できる値を指定してください。それ以外の値が指定された場合、動作は保証されません。

コマンドが正常に終了しても、エラーが発生している場合があります。メッセージログやスタックトレースログを確認してください。

2.4　ドメインの管理で使用するコマンド

ドメインの管理で使用するコマンドの書式、機能などについて説明します。

2.4.1　backup-domain

ドメインのバックアップ

書式

asadmin [asadmin-options] backup-domain [--help]
    [--long[={false|true}]] [--description description-text]
    [--domaindir domain-root-dir] [--backupdir backup-directory]
    [domain_name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

backup-domainサブコマンドは、名前付きドメイン内のファイルをバックアップします。

このサブコマンドはローカルモードだけサポートします。

前提条件

バックアップするドメインは、停止する必要があります。

ファイル

backup-domainサブコマンドを実行すると、バックアップ対象ドメインのすべてのファイルを含むZIPアーカイブファイルが、--backupdirオプションで指定したディレクトリーに作成されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long[={false|true}] | -l

バックアップ操作の詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

詳細情報を出力する

false

詳細情報を出力しない

デフォルト値：false

--description description-text

バックアップファイルに設定する説明文を指定します。説明文は、バックアップファイルに関する情報の一部として表示されます。

型：String

指定できる値を次に示します。

バックアップについて説明するテキスト

デフォルト値：次に示す形式

「user-nameが、YYYY_MM_DDに作成したdomain-nameのバックアップ」

--domaindir domain-root-dir

ドメインルートディレクトリー（バックアップするドメインの親ディレクトリー）を指定します。

型：String

指定できる値を次に示します。

ドメインのディレクトリーパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--backupdir backup-directory

バックアップファイルの保存先のディレクトリーを指定します。

型：String

指定できる値を次に示します。

バックアップファイルが格納されるディレクトリーのパス

デフォルト値：domain-dir/backups

domain_name

バックアップするドメインの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：なし

使用例

次の例では、デフォルトのdomain1のバックアップを行い、バックアップファイルを/net/backups.example.com/glassfishに格納します。

asadmin backup-domain --backupdir /net/backups.example.com/glassfish domain1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.2　change-admin-password

管理ユーザーパスワードの変更

書式

asadmin [asadmin-options] change-admin-password [--help]
    [--domaindir domain-root-dir [--domain_name domain-name]]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

change-admin-passwordサブコマンドは、管理ユーザーのパスワードを変更します。このサブコマンドでは、古いパスワードと新しいパスワードの入力、および新しいパスワードの確認が対話型で求められます。新しいパスワードは8文字以上必要です。

次の場合、このサブコマンドはエラーになります。

パスワードを指定していない匿名ユーザーの場合。

空白のパスワードを指定した場合（secure admin機能が有効な場合）。

Java EE Serverに対して複数の管理ユーザーが設定されている場合、特定の管理ユーザーのパスワードを変更するには、asadminコマンドに--userオプションを指定して実行する必要があります。

このサブコマンドはローカルモードとリモートモードをサポートします。

前提条件

Java EE Serverに、2人以上の管理ユーザーが設定されている場合、--userオプションを指定してasadminコマンドを実行し、特定のユーザーのパスワードを変更する必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--domaindir domain-root-dir

--domain_nameオプションで指定したドメインの親ディレクトリーを指定します。このオプションを指定すると、change-admin-passwordサブコマンドはローカルモードで動作します。

型：String

指定できる値を次に示します。

ドメインディレクトリーのパス

デフォルト値：なし

--domain_name domain-name

管理ユーザーのドメインを指定します。--domaindirオプションで指定したディレクトリーにドメインが1つだけの場合、このオプションは不要です。

型：String

指定できる値を次に示します。

ドメイン名のパス

デフォルト値：なし

使用例

次の例では、シングルモードで1人の管理ユーザーのパスワードを変更します。

asadmin --user admin change-admin-password

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

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

サブコマンドの実行中にエラーが発生しました。

2.4.4　delete-domain

ドメインの削除

書式

asadmin [asadmin-options] delete-domain [--help]
    [--domaindir domaindir] domain-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-domainサブコマンドは、指定したドメインを削除します。ドメインはすでに存在し、停止している必要があります。

このサブコマンドはローカルモードだけサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--domaindir domaindir

削除対象ドメインが位置するディレクトリーを指定します。

型：String

指定できる値を次に示します。

ドメインが位置するディレクトリー名

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

domain-name

ドメインの固有の名称を指定します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：なし

使用例

次の例では、デフォルトのドメインディレクトリーからmydomain4という名称のドメインを削除します。

asadmin delete-domain mydomain4

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.5　list-backups

ドメインバックアップの一覧表示

書式

asadmin [asadmin-options] list-backups [--help]
    [--long[={false|true}]]
    [--domaindir domain-root-dir]
    [--backupdir backup-directory]
    [domain-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-backupsサブコマンドは、ドメインバックアップに関する情報を表示します。

このサブコマンドはローカルモードだけサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true} | -l={false|true}

バックアップごとの詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--domaindir domain-root-dir

ドメインルートディレクトリーおよびコマンドを実行するドメインの親ディレクトリーを指定します。

型：String

指定できる値を次に示します。

ディレクトリー名

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--backupdir backup-directory

バックアップファイルが格納されているディレクトリーを指定します。

型：String

指定できる値を次に示します。

ディレクトリー名

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains/domain-dir/backups（ドメインがデフォルトの場所にない場合はdomain-dir/backups）

domain-name

バックアップを一覧表示するドメインを指定します。

Java EE Serverドメインが1つだけの場合は省略できます。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：なし

使用例

次の例では、/net/backups.example.com/glassfishディレクトリーに格納されているデフォルトのドメインdomain1のバックアップを一覧表示します。

asadmin list-backups --backupdir /net/backups.example.com/glassfish domain1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.6　list-domains

ドメインディレクトリー内のドメインの一覧表示

書式

asadmin [asadmin-options] list-domains [--help]
    [--domaindir domaindir]
    [--long={false|true}]
    [--header={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-domainsサブコマンドは、指定したドメインディレクトリーにあるドメインを一覧表示します。ドメインディレクトリーが指定されていない場合、デフォルトのディレクトリーにあるドメインが一覧表示されます。

このサブコマンドはローカルモードだけサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--domaindir domaindir

一覧表示されるドメインディレクトリーを指定します。指定した場合、ファイルシステムでパスにアクセスできることが必要です。指定されていない場合、デフォルトのApplication Serverインストールディレクトリー/javaee/glassfish/domainsドメインルートディレクトリーのドメインが一覧表示されます。

型：String

指定できる値を次に示します。

ディレクトリー名

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--long={false|true} | -l={false|true}

一覧表示されたドメイン管理サーバに関する詳細情報（ホスト名とポート番号を含む）が表示されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--header={false|true} | -h={false|true}

--long オプションを使用したときにヘッダーを表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

使用例

次の例では、デフォルトのディレクトリーのドメインを一覧表示します。

asadmin list-domains

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.7　restart-domain

ドメイン管理サーバの再起動

書式

asadmin [asadmin-options] restart-domain [--help]
    [--debug={true|false}]
    [--domaindir domaindir]
    [--force={true|false}] [--kill={false|true}]
    [domain-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

restart-domainサブコマンドは、指定したドメインのドメイン管理サーバを停止した後、再起動します。

ドメインが指定されていない場合、デフォルトのドメインが使用されます。domainsディレクトリーにドメインが複数ある場合、domain-nameを指定する必要があります。ドメイン管理サーバが稼働していない場合、このサブコマンドはドメイン管理サーバの起動を試みます。

このサブコマンドはローカルモードとリモートモードをサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--debug={true|false}

Java Platform Debugger Architecture（JPDA）デバッグを有効にしてドメインを再起動するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

JPDAデバッグを有効にしてドメインを再起動し、JPDAデバッグのポート番号を表示します。

false

JPDAデバッグを無効にしてドメインを再起動します。

デフォルト値：再起動するドメインに対するこのオプションの現在の設定

--domaindir domaindir

再起動するドメインのディレクトリーを含むルートディレクトリーを指定します。

型：String

指定できる値を次に示します。

ドメインルートディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--force={true|false}

ドメインを再起動する直前に、ドメインを強制停止するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ドメインはただちに強制停止されます。

false

ドメインに関連づけられているすべてのスレッドが終了するまで待機してから、ドメインを停止します。

デフォルト値：true

--kill={false|true}

ドメインプロセスを停止するOSの機能を使用して、ドメインを再起動する前に強制終了するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

false

ドメインを強制終了しません。Javaプラットフォームの機能を使用してドメインプロセスを停止します。

true

ドメインを強制終了します。OSの機能を使用してドメインプロセスを停止します。

デフォルト値：false

domain-name

再起動するドメインの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：インストール時に指定した名称で、通常はdomain1

使用例

次の例では、デフォルトのdomainsディレクトリー内のmydomain4を再起動します。

asadmin restart-domain mydomain4

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.8　restore-domain

バックアップからのファイルの復元

書式

asadmin [asadmin-options] restore-domain [--help]
    [--long[={false|true}]] [--filename backup-filename]
    [--domaindir domain-root-dir] [--backupdir backup-directory]
    [--force[={false|true}]] [domain-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

restore-domainサブコマンドは、バックアップディレクトリーからドメイン内にファイルを復元します。

このサブコマンドはローカルモードだけサポートします。

なお、異なるOSでバックアップしたバックアップファイルは復元できません。

前提条件

ドメインを停止する必要があります。

ファイル

指定されたドメインのディレクトリー内のファイルおよびサブディレクトリー

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long[={false|true}] | -l

復元操作の詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--filename backup-filename

復元に使用するバックアップファイルの名称を指定します。

型：String

指定できる値を次に示します。

ファイル名

デフォルト値：なし

--domaindir domain-root-dir

ドメインルートディレクトリー（復元するドメインの親ディレクトリー）を指定します。

型：String

指定できる値を次に示します。

ディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--backupdir backup-directory

バックアップファイルが格納されているディレクトリーを指定します。

型：String

指定できる値を次に示します。

ディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains/domain-dir/backups ドメインがデフォルトの場所にない場合は、ロケーションはdomain-dir/backupsです。

--force[={false|true}]

復元するドメインの名称がバックアップファイルに格納されているドメインの名称と一致しなくても復元操作を継続できるようにします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

domain-name

復元するドメインの名称を指定します。

Java EE Serverにドメインが1つだけの場合、このdomain-nameは省略できます。

指定したドメイン名とバックアップファイルに格納されているドメイン名が一致していない場合、--forceオプションを指定していないとエラーが発生します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：Java EE Serverで有効な単一のドメイン

使用例

次の例では、指定されたバックアップディレクトリーに格納されている最新バックアップから、デフォルトドメインのdomain1のファイルを復元します。

asadmin restore-domain --backupdir /net/backups.example.com/glassfish domain1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.9　start-domain

ドメイン管理サーバの起動

書式

asadmin [asadmin-options] start-domain
    [--help] [--debug={true|false}] [--domaindir domain-dir]
    [--dry-run={true|false}] [--upgrade={true|false}]
    [--verbose={true|false}] [--watchdog={true|false}] [domain-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-domainサブコマンドは、指定したドメインのドメイン管理サーバを起動します。ドメインを指定しない場合、デフォルトのドメインが使用されます。domainsディレクトリーにドメインが複数ある場合、domain-nameを指定する必要があります。

このサブコマンドはローカルモードだけサポートします。

start-domainサブコマンドは、管理ユーザーにパスワードが設定されていない場合、新たな管理ユーザーパスワードの入力を促すプロンプトを表示します。また、セキュア管理が有効な場合、管理ユーザーパスワードを必ず指定してください。空白の場合、start-domainサブコマンドは失敗します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

{--debug|-d}={true|false}

Java Platform Debugger Architecture（JPDA）デバッグを有効にしてドメインを起動するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

JPDAデバッグを有効にしてインスタンスを起動し、JPDAデバッグのポート番号を表示します。

false

JPDAデバッグを無効にしてインスタンスを起動します。

デフォルト値：false

--domaindir domain-dir

再起動するドメインのディレクトリーを含むルートディレクトリーを指定します。指定した場合、このパスはファイルシステム内でアクセスできなければなりません。

型：String

指定できる値を次に示します。

ドメインルートディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

{--dry-run|-n}={true|false}

ドメインの実際の起動を抑止します。代わりに、start-domainサブコマンドは、ドメインを起動するために使用されるJavaコマンド全体をすべてのオプションを含めて表示します。このサブコマンドを見直すと、JVMオプションを確認する場合や起動に関する問題をトラブルシューティングする場合に役立ちます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--upgrade={true|false}

Hitachi Application Serverの上書きインストールでバージョンまたはリビジョンが上がった場合に、ドメイン管理サーバの設定をアップグレードするために使用します。

型：Boolean

指定できる値を次に示します。

true

ドメインが起動されると、Hitachi Application Serverの現在のリリースに合うように設定が変更され、ドメイン管理サーバのプロセスが停止します。

false

ドメイン管理サーバの設定は更新されません。

デフォルト値：false

{--verbose|-v}={true|false}

ドメインに関する詳細情報を、サブコマンドを実行するコンソール画面に表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ドメインに関する詳細なメッセージおよびログメッセージが、このサブコマンドを実行するコンソール画面に表示されます。別のコンソール画面からrestart-domainサブコマンドを実行してドメインをあとで再起動する場合は、メッセージは元のコンソール画面に引き続き表示されます。コンソール画面で［CTRL］＋［C］を入力すると、Java EE Serverのプロセスを強制終了できます。コンソール画面で次のキーの組み合わせを入力すると、Java EE Serverのプロセスを強制終了したりサーバのスレッドダンプを取得したりできます。

［CTRL］＋［¥］

false

詳細情報は表示されません。

デフォルト値：false

{--watchdog|-w}={true|false}

ドメインに関する限定された情報を、このサブコマンドを実行するコンソール画面に表示するかどうかを指定します。

--watchdogオプションは--verboseオプションと似ていますが、詳細なメッセージおよびログメッセージを表示しません。このオプションは、asadminユーティリティーをバックグラウンドで実行する場合やコンソールを取り付けずに実行する場合に役立ちます。

型：Boolean

指定できる値を次に示します。

true

限定された情報がコンソールに表示されます。

false

限定された情報はコンソールに表示されません。

デフォルト値：false

domain-name

起動するドメインの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：なし

使用例

次の例では、デフォルトのdomainsディレクトリーのmydomain4を起動します。

asadmin start-domain mydomain4

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.4.10　stop-domain

ドメイン管理サーバの停止

書式

asadmin [asadmin-options] stop-domain [--help]
    [--domaindir domaindir]
    [--kill={false|true}] [domain-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-domainサブコマンドは、指定したドメインのドメイン管理サーバを停止します。ドメインディレクトリーが指定されていない場合、デフォルトのdomainsディレクトリーにあるドメインが停止されます。domainsディレクトリーにドメインが複数ある場合、domain-nameを指定する必要があります。

このサブコマンドはローカルモードとリモートモードをサポートします。

ホスト名を指定した場合、このサブコマンドはリモートモードでの操作を仮定するため、リモートサーバに対して正しく認証する必要があります。ローカルモードでは、サーバを起動したユーザーと同じユーザーでこのサブコマンドを実行する限り、通常サーバに対する認証は必要ありません。

サーバ停止時に、標準エラーおよびlogger.logファイルにKDKD45000-Eのメッセージを出力することがありますが、終了処理に影響はありません。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--domaindir={true|false}

停止するドメインのディレクトリーを指定します。指定した場合、このパスはファイルシステム内でアクセスできなければなりません。指定しない場合、デフォルトのApplication Serverインストールディレクトリー/javaee/glassfish/domainsディレクトリーにあるドメインは停止します。

型：String

指定できる値を次に示します。

ドメインルートディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--kill={false|true}

ドメインプロセスを停止するOSの機能を使用して、ドメインを強制終了するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

false

ドメインを強制終了しません。Javaプラットフォームの機能を使用してドメインプロセスを停止します。

true

ドメインを強制終了します。OSの機能を使用してドメインプロセスを停止します。

デフォルト値：false

domain-name

停止するドメインの名称を指定します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：domain1

使用例

次の例では、デフォルトのdomainsディレクトリー内のsampleDomainという名称のドメインを停止します。

asadmin stop-domain sampleDomain

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5　ノードの管理で使用するコマンド

ノードの管理で使用するコマンドの書式、機能などについて説明します。

2.5.1　create-node-config

リモート通信が有効化されていないノードの作成

書式

asadmin [asadmin-options] create-node-config [--help]
    [--nodehost node-host] [--installdir as-install-parent]
    [--nodedir node-dir] node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-node-configサブコマンドは、リモート通信が有効化されていないノードを作成します。

このサブコマンドでノードを作成する場合、SSHが設定されている必要がありません。

ノードはApplication Serverがインストールされたホストを表します。

サーバインスタンスが存在するホストすべてに対してノードが存在する必要があります。

リモート通信が有効化されていないノードのインスタンスの管理は、すべてそのノードが表すホスト上で行われる必要があります。

リモートホストのドメイン管理サーバはノードにアクセスできません。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

サーバインスタンスがある、すべてのホストにノードが存在する必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--nodehost node-host

ノードが表すホスト名を指定します。このオプションが省略されると、ノードに対するホストが指定されないことになります。

型：String

指定できる値を次に示します。

ホスト名

デフォルト値：なし

--installdir as-install-parent

Application Serverインストールディレクトリー/javaeeの絶対パスを指定します。このオプションが省略されると、ノードに対してApplication Serverインストールディレクトリー/javaeeが指定されないことになります。

型：String

指定できる値を次に示します。

Application Serverインストールディレクトリー/javaeeの絶対パス

デフォルト値：なし

--nodedir node-dir

ノードに作成されたサーバインスタンスを含むディレクトリーのパスを指定します。相対パスが指定されると、パスはインストール時のディレクトリーからの相対になります。このオプションが省略されると、ノードに対してインスタンスのディレクトリーが指定されないことになります。

型：String

指定できる値を次に示します。

ノードが存在するディレクトリーのファイルパス

デフォルト値：なし

node-name

ノード名を指定します。

型：String

指定できる値を次に示します。

ノード名

名称は、次の条件を満たす必要があります。

ASCII文字だけで構成する。

文字、数字、またはアンダースコアで開始する必要があります。

次の文字だけを使用すること。

小文字

大文字

数字

ハイフン

ピリオド

アンダースコア

マシン内で一意である必要があり、同一マシン上に作成されている別のノード名、クラスター名、指定されたJavaEEサーバの構成名、またはサーバインスタンスの名称と重複できません。

domain、server、またはJava EE Serverが予約したその他のキーワードは使用できません。

デフォルト値：なし

使用例

次の例では、ノードを作成します。

asadmin create-node-config --nodehost sj03.example.com sj03

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.2　create-node-ssh

SSHが有効なノードの作成

書式

asadmin [asadmin-options] create-node-ssh [--help]
    --nodehost node-host [--installdir as-install-parent]
    [--nodedir node-dir] [--sshport ssh-port] [--sshuser ssh-user]
    [--sshkeyfile ssh-keyfile] [--force={false|true}]
    node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-node-sshサブコマンドは、SSHを介した通信が有効なノードを作成します。

ノードとは、Application Serverがインストールされたホストのことを示します。ノードは、サーバインスタンスが常駐するホストごとに必要です。

ドメイン管理サーバは、SSHコネクター経由でSSHノードのホストと通信して、ノードに常駐するサーバインスタンスを管理します。しかし、ドメイン管理サーバは、すべてのasadminサブコマンドをローカルで実行できるため、SSHコネクターを使用しないでドメイン管理サーバが稼働するホストと通信します。

このサブコマンドは、リモートモードだけサポートします。

SSH経由でホストと通信できない場合でも、ドメイン管理サーバの設定内にノードを強制的に作成するには、--forceオプションにtrueを設定します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ノードは、サーバインスタンスが常駐するホストごとに必要です。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--nodehost node-host

ノードが示すホストの名前を指定します。ホスト名は、必ず指定してください。指定しない場合は、エラーが発生します。

型：String

指定できる値を次に示します。

ノードのホスト名

デフォルト値：なし

--installdir as-install-parent

Application Serverインストールディレクトリー/javaeeの絶対パスを指定します。

型：String

指定できる値を次に示します。

Application Serverインストールディレクトリー/javaeeの絶対パス

デフォルト値：ドメイン管理サーバのApplication Serverインストールディレクトリー/javaeeディレクトリー。

--nodedir node-dir

ノードに作成されたサーバインスタンスを格納するディレクトリーへのパスを指定します。相対パスを指定した場合、パスはインストール時のディレクトリーからの相対になります。

型：String

指定できる値を次に示します。

サーバインスタンスを格納するディレクトリーへのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/nodes

--sshport ssh-port

このノードのホストへのSSHコネクションに使用するポートを指定します。--nodehostオプションにlocalhost-domainが設定されている場合、--sshportオプションは無視されます。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：22

--sshuser ssh-user

SSH経由でホストに接続するプロセスを実行する、このノードのホスト上のユーザーを指定します。このユーザーのSSH秘密鍵ファイルをドメイン管理サーバが確実に読み込めるようにするには、ドメイン管理サーバのプロセスを実行中のユーザーを指定します。--nodehostオプションにlocalhostドメインが設定されている場合、--sshuserオプションは無視されます。

型：String

指定できる値を次に示します。

sshuser名

デフォルト値：ドメイン管理サーバのプロセスを稼働中のユーザー

--sshkeyfile ssh-keyfile

--sshuserオプションに指定されたユーザーのSSH秘密鍵ファイルへの絶対パスを指定します。このファイルは、ノードのホスト上にあるSSH化されたデーモンへの認証に使用されます。

型：String

指定できる値を次に示します。

ユーザーのSSH秘密鍵ファイルへのパス

デフォルト値：このサブコマンドを実行しているホストにあるユーザーの.sshディレクトリー内のキーファイル。

ユーザーの.sshディレクトリーに複数のキーファイルがある場合、このサブコマンドは次の優先順序で使用します。

id_rsa

id_dsa

identity

--force={false|true}

ノードのパラメーターの検証に失敗した場合でも、ノードがドメイン管理サーバの設定に作成されるかどうかを指定します。

ノードのパラメーターを検証するには、ドメイン管理サーバは、SSH経由でノードのホストと通信できる必要があります。

型：Boolean

指定できる値を次に示します。

true

ノードのパラメーターの検証に失敗した場合でも、ノードは作成されます。

false

ノードのパラメーターの検証に失敗した場合、ノードは作成されません。

デフォルト値：false

node-name

ノード名を指定します。

型：String

指定できる値を次に示します。

ノード名

名称は、次の条件を満たす必要があります。

ASCII文字だけで構成する。

文字、数字、またはアンダースコアで開始する必要があります。

次の文字だけを使用すること。

小文字

大文字

数字

ハイフン

ピリオド

アンダースコア

マシン内で一意である必要があり、同一マシン上に作成されている別のノード名、クラスター名、指定されたJavaEEサーバの構成名、またはサーバインスタンスの名称と重複できません。

domain、server、またはJava EE Serverが予約したその他のキーワードは使用できません。

デフォルト値：なし

使用例

次の例では、ノードを作成します。

asadmin create-node-ssh --nodehost adc.example.com --installdir /export/glassfish3 adc

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.3　delete-node-config

リモート通信が無効なノードの削除

書式

asadmin [asadmin-options] delete-node-config [--help]
    node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-node-configサブコマンドは、ドメインからリモート通信が無効なノードを削除します。このサブコマンドでは、SSHを構成する必要がありません。削除するノードにサーバインスタンスが存在する場合、サブコマンドの実行に失敗します。このサブコマンドを実行する前に、ノードに存在するサーバインスタンスを削除してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

node-name

ノード名を指定します。

ノードはSSH上での通信が無効である必要があります。該当しない場合は、エラーが発生します。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：なし

使用例

次の例では、リモート通信が無効なノードsj03を削除します。

asadmin delete-node-config sj03

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.4　delete-node-ssh

SSH通信が有効なノードの削除

書式

asadmin [asadmin-options] delete-node-ssh [--help]
    node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-node-sshサブコマンドは、ドメインからのSSH通信が有効なノードを削除します。このサブコマンドでは、SSHを構成する必要がありません。

このサブコマンドは、SSH経由での通信が有効なノードだけを削除できます。

削除するノードにサーバインスタンスが存在する場合、サブコマンドの実行に失敗します。このサブコマンドを実行する前に、ノードに存在するサーバインスタンスを削除してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

node-name

ノード名を指定します。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：なし

使用例

次の例では、SSH上の通信が有効なノードeg1を削除します。

asadmin delete-node-ssh eg1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.5　list-nodes

Java EE Serverノードの一覧表示

書式

asadmin [asadmin-options] list-nodes [--help]
    [--long={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-nodesサブコマンドはドメインにあるすべてのJava EE Serverノードを一覧表示します。

デフォルトでは、このサブコマンドは一覧表示された各ノードの次の情報を表示します。

ノード名

次のノードタイプのどれか1つ

CONFIG：リモート通信をサポートしないノード

SSH：SSH経由の通信をサポートするノード

ノードが表すホストの名称

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true} | -l={false|true}

ノードを長形式で一覧表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ノードを長形式で一覧表示します。

false

ノードを短形式で一覧表示します。

デフォルト値：false

使用例

次の例では、Java EE Serverノードを長形式で一覧表示します。

asadmin list-nodes --long=true

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.6　list-nodes-config

リモート通信をサポートしないドメイン内のJava EE Serverノードの一覧表示

書式

asadmin [asadmin-options] list-nodes-config [--help]
    [--long={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-nodes-configサブコマンドは、リモート通信をサポートしない、ドメイン内すべてのJava EE Serverノードを一覧表示します。

デフォルトでは、一覧表示される各ノードについて次の情報が表示されます。

ノード名

ノードのタイプ（CONFIG）

ノードが表すホストの名称

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true} | -l={false|true}

ノードを長形式で一覧表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ノードを長形式で一覧表示します。

false

ノードを短形式で一覧表示します。

デフォルト値：false

使用例

次の例では、ドメインにあるリモート通信をサポートしないJava EE Serverノードを長形式で一覧表示します。

asadmin list-nodes-config --long=true

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.7　list-nodes-ssh

SSH経由の通信をサポートするドメイン内のJava EE Serverノードの一覧表示

書式

asadmin [asadmin-options] list-nodes-ssh [--help]
    [--long={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-nodes-sshサブコマンドは、SSH経由の通信をサポートするドメイン内すべてのJava EE Serverノードを一覧表示します。

デフォルトでは、一覧表示される各ノードについて次の情報が表示されます。

ノード名

ノードのタイプ（SSH）

ノードが表すホストの名称

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true} | -l={false|true}

ノードを長形式で一覧表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ノードを長形式で一覧表示します。

false

ノードを短形式で一覧表示します。

デフォルト値：false

使用例

次の例では、SSH経由の通信をサポートするドメイン内すべてのJava EE Serverノードの名称、タイプ、およびホストを表示します。

asadmin list-nodes-ssh

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.8　ping-node-ssh

SSH通信によるノード使用のテスト

書式

asadmin [asadmin-options] ping-node-ssh [--help]
    [--validate={false|true}] node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

ping-node-sshサブコマンドは、SSH経由で、ノードが表すホスト上でasadminユーティリティーコマンドを実行できるかどうかをテストします。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ドメイン管理サーバが稼働しているマシンと、ノードが存在するマシンにSSHが設定されている必要があります。

ノードでSSH経由の通信が有効になっている必要があります。それ以外の場合は、エラーが発生します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--validate={false|true}

サブコマンドがノードを検証するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ノードを検証します。

false

ノードを検証しません。

デフォルト値：false

node_name

テストするノードの名称を指定します。

型：String

指定できる値を次に示します。

ノードの名称

デフォルト値：なし

使用例

次の例では、SSH経由の通信が有効化されているノードsj03-nodeが使用できるかどうかをテストします。

asadmin ping-node-ssh sj03-node

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.9　setup-ssh

SSHキーのセットアップ

書式

asadmin [asadmin-options] setup-ssh [--help]
    [--sshport ssh-port] [--sshuser ssh-user]
    [--sshkeyfile ssh-keyfile] [--sshpublickeyfile ssh-public-keyfile]
    [--generatekey={false|true}] host-list

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

setup-sshサブコマンドは、指定されたホストにSSHキーをセットアップします。このキーによって、Java EE Serverは、リモートホストへのユーザーのSSHログイン時の認証に、公開鍵認証を使用できるようになります。

SSHによって、複数ホストにおよぶJava EE Serverクラスターが一括管理できるようになります。

SSHは、ドメイン管理サーバおよびリモートホスト間で交換されるデータの機密性および安全性をもたらします。

公開鍵認証では、次のキーから構成されるSSHキーペアを使用します。

ドメイン管理サーバホストの安全な場所に格納されていて、パスフレーズで保護されている可能性のある秘密鍵

ドメイン管理サーバが通信するすべてのリモートホストに格納されている公開鍵

setup-sshサブコマンドは、ドメイン管理サーバからの設定情報を要求しません。また、ドメイン管理サーバの設定を修正しません。

このサブコマンドはローカルモードだけサポートします。

前提条件

sshクライアントは、ドメイン管理サーバホストにインストールされ、ドメイン管理サーバユーザーのパス経由でアクセスできる必要があります。

sshdデーモンは、SSHキーがセットアップされるすべてのホストにインストールされ、常駐している必要があります。

ssh-keygenユーティリティーは、デフォルトの場所またはドメイン管理サーバユーザーのパスに定義された場所にあるドメイン管理サーバホストにインストールされている必要があります。

--sshuserに指定されたユーザーは、SSHキーがセットアップされるすべてのホストに対してSSH経由でログインできる必要があります。

ファイル

ドメイン管理サーバホストおよびリモートホスト両方のuser-home/.ssh/にある次に示すファイルが参照されます。

authorized_keys

id_rsa

id_rsa.pub

id_dsa

id_dsa.pub

identity

identity.pub

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--sshport ssh-port

SSHをセットアップ中のホストへのSSHコネクションに使用するポートを指定します。

型：Integer

指定できる値を次に示します。

1-65535

デフォルト値：22

--sshuser ssh-user

リモートホスト上のSSHユーザーを指定します。このSSHユーザーは、リモートホスト上でSSHをセットアップするプロセスを実行します。

ドメイン管理サーバがこのユーザーのSSH秘密鍵ファイルを読めるようにするには、ドメイン管理サーバのプロセスを実行中のユーザーを指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：コマンドを実行中のユーザー

--sshkeyfile ssh-keyfile

--sshuserオプションで指定したユーザーのSSH秘密鍵ファイルへの絶対パスを指定します。このファイルは、ホスト上のsshdデーモンへの認証に使用されます。このサブコマンドを実行中のユーザーは、キーファイルへのパスにアクセスしてキーファイルを読める必要があります。

型：String

指定できる値を次に示します。

ユーザーのSSH秘密鍵ファイルへのパス

デフォルト値：サブコマンドを実行しているホストにあるユーザーの.sshディレクトリー内のキーファイル。

ユーザーの.sshディレクトリーに複数のキーファイルがある場合、サブコマンドは次の優先順序で使用します。

id_rsa

id_dsa

identity

--sshpublickeyfile ssh-public-keyfile

--sshuserオプションで指定したユーザーのSSH公開鍵ファイルへの絶対パスを指定します。公開鍵ファイルの内容は、SSHをセットアップ中の各ホスト上にあるユーザーの.ssh/authorized_keysファイルに追加されます。

.ssh/authorized_keysファイルがホスト上に存在しない場合は、サブコマンドがファイルを作成します。このサブコマンドを実行中のユーザーはキーファイルへのパスにアクセスしてキーファイルを読める必要があります。

型：String

指定できる値を次に示します。

ユーザーのSSH公開鍵ファイルへのパス

デフォルト値：サブコマンドを実行しているホストにあるユーザーの.sshディレクトリー内のキーファイル。

ユーザーの.sshディレクトリーに複数のキーファイルがある場合、サブコマンドは次の優先順序で使用します。

id_rsa.pub

id_dsa.pub

identity.pub

--generatekey={false|true}

ユーザープロンプトなしでSSHキーファイルを作成するかどうかを指定します。

型：Boolean

次の値が有効です。

true

ユーザープロンプトなしでSSHキーファイルを作成します。

false

動作は、SSHキーファイルの有無によって決まります。

SSHキーファイルが存在する場合、ファイルを作成しません。

SSHキーファイルが存在しない場合、動作は、asadminユーティリティーの--interactiveオプションの値によって決まります。

--interactiveオプションがtrueの場合、ユーザーにファイルを作成するよう促します。

--interactiveオプションがfalseの場合、このサブコマンドは失敗します。

デフォルト値：false

host-list

SSHキーをセットアップするホストの名称がスペースで区切られたリストを作成します。

型：String

指定できる値を次に示します。

リモートホスト名

デフォルト値：なし

使用例

次の例では、ホストsj03およびsj04上で、ユーザーgfuserのSSHキーをセットアップします。キーファイルは作成されませんが、サブコマンドが実行中のホストにあるユーザーの.sshディレクトリーからコピーされます。

asadmin setup-ssh sj03 sj04

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.10　update-node-config

ノード構成データの更新

書式

asadmin [asadmin-options] update-node-config [--help]
    [--nodehost node-host] [--installdir as-install-parent]
    [--nodedir node-dir] node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-node-configサブコマンドは、ノードの構成データを更新します。このサブコマンドは、ノードがリモート通信に対して有効になっているかどうかに関係なく、任意のノードを更新できます。リモート通信のために有効化されたノードを更新した場合、更新後のノードはリモート通信に対して無効になります。

このサブコマンドでは、ノードを更新するために、SSHを設定する必要がありません。ドメイン管理サーバにアクセスできる任意のマシンから、このサブコマンドを実行できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ノードが存在している必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--nodehost node-host

ノードの更新後にノードが表すホストの名称を指定します。

型：String

指定できる値を次に示します。

ホスト名

デフォルト値：なし

--installdir as-install-parent

Application Serverインストールディレクトリー/javaeeの絶対パスを指定します。

型：String

指定できる値を次に示します。

Application Serverインストールディレクトリー/javaeeの絶対パス

デフォルト値：なし

--nodedir node-dir

ノード上に作成されるサーバインスタンスを入れるディレクトリーのパスを指定します。相対パスを指定する場合、パスはApplication Serverインストールディレクトリー/javaee/glassfishディレクトリーからの相対パスであり、Application Serverインストールディレクトリー/javaee/glassfishはホスト上のApplication Serverのインストールディレクトリーです。

型：String

指定できる値を次に示します。

ノードのサーバインスタンスを含むディレクトリーへのパス

デフォルト値：なし

node-name

更新するノードの名称を指定します。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：なし

使用例

次の例では、ノードsj04が表すホストをhsj04に更新します。

asadmin update-node-config --nodehost hsj04 sj04

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.5.11　update-node-ssh

SSHを使ったノード構成データの更新

書式

asadmin [asadmin-options] update-node-ssh [--help]
    [--nodehost node-host] [--installdir as-install-parent]
    [--nodedir node-dir] [--sshport ssh-port]
    [--sshuser ssh-user] [--sshkeyfile ssh-keyfile]
    [--force={false|true}] node-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-node-sshサブコマンドは、ノードの構成データを更新します。

このサブコマンドでは、ドメイン管理サーバが稼働しているマシンおよびノードが存在するマシンで、SSHを設定する必要があります。

ドメイン管理サーバにアクセスできる任意のマシンから、このサブコマンドを実行できます。

このサブコマンドは、ノードがリモート通信に対して有効になっているかどうかに関係なく、任意のノードを更新できます。

ノードがリモート通信に対して有効になっていない場合、このサブコマンドはノードのSSH通信を有効にし、そのほかの指定された構成データを更新します。ノードのSSH通信を有効にするためにこのサブコマンドを実行する場合、--sshport、--sshuserおよび--sshkeyfileが省略されたときには、デフォルト値が適用されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバが稼働しているホストおよびノードが表すホストでSSHが設定されている必要があります。

更新するホストが存在している必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--nodehost node-host

ノードの更新後にノードが表すホストの名称を指定します。

型：String

指定できる値を次に示します。

ホスト名

デフォルト値：なし

--installdir as-install-parent

Application Serverインストールディレクトリー/javaeeの絶対パスを指定します。

型：String

指定できる値を次に示します。

Application Serverインストールディレクトリー/javaeeの絶対パス

デフォルト値：なし

--nodedir node-dir

ノード上に作成されるサーバインスタンスを含むディレクトリーのパスを指定します。相対パスを指定する場合、パスはApplication Serverインストールディレクトリー/javaee/glassfishディレクトリーからの相対パスであり、Application Serverインストールディレクトリー/javaee/glassfishはホスト上のApplication Serverのインストールディレクトリーです。

型：String

指定できる値を次に示します。

ノードのサーバインスタンスを含むディレクトリーへのパス

デフォルト値：なし

--sshport ssh-port

このノードのホストに対するSSH接続に使用するポートを指定します。

デフォルトは、このサブコマンドをノードのSSH通信を有効にするために実行するかどうかによって異なります。

ノードがSSH経由の通信に対してすでに有効になっている場合、デフォルトではポートは変更されません。

ノードのSSH通信を有効にするためにこのサブコマンドを実行する場合、デフォルトポートは22です。--nodehostオプションをlocalhostに設定した場合、--sshportオプションは無視されます。

型：Integer

指定できる値を次に示します。

1-65535

デフォルト値：22

--sshuser ssh-user

SSH経由でホストに接続する処理を実行するためのこのノードのホスト上のユーザーを指定します。

デフォルトは、このサブコマンドをノードのSSH通信を有効にするために実行するかどうかによって異なります。

ノードがSSH経由の通信に対してすでに有効になっている場合、デフォルトではユーザーは変更されません。

ノードのSSH通信を有効にするためにこのサブコマンドを実行する場合、デフォルトはドメイン管理サーバのプロセスを実行するユーザーです。--nodehostオプションをlocalhostに設定した場合、--sshuserオプションは無視されます。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：ドメイン管理サーバのプロセスを実行しているユーザー

--sshkeyfile ssh-keyfile

--sshuserオプションで指定するユーザーのSSH秘密鍵ファイルの絶対パスを指定します。このファイルはノードのホスト上のsshdデーモンに対する認証に使用されます。

SSH秘密鍵ファイルがパスフレーズで保護されている場合、パスワードファイルにAS_ADMIN_SSHKEYPASSPHRASEエントリーを含める必要があります。鍵ファイルは、ドメイン管理サーバから到達できるパスにあり、ドメイン管理サーバが読み取りできる必要があります。

デフォルトは、このサブコマンドをノードのSSH通信を有効にするために実行するかどうかによって異なります。

ノードがSSH経由の通信に対してすでに有効になっている場合、デフォルトでは鍵ファイルは変更されません。

ノードのSSH通信を有効にするためにこのサブコマンドを実行する場合、デフォルトはユーザーの.sshディレクトリーにある鍵ファイルです。複数の鍵ファイルが見つかった場合、サブコマンドはid_rsa、id_dsa、identityの順序で使用します。

型：String

指定できる値を次に示します。

ユーザーのSSH秘密鍵ファイルを含むディレクトリーへのパス

デフォルト値：SSH通信を有効にするためにこのサブコマンドを実行する場合、ユーザーの.sshディレクトリーにある鍵ファイル

--force={false|true}

ノードのパラメーターの検証に失敗した場合でも、ノードを更新するかどうかを指定します。ノードのパラメーターを検証するには、ドメイン管理サーバがSSH経由でノードのホストにアクセスできる必要があります。

型：Boolean

指定できる値を次に示します。

false

ノードのパラメーターの検証に失敗した場合、ノードは更新されません。

true

ノードのパラメーターの検証に失敗した場合でも、ノードが更新されます。

デフォルト値：false

node-name

更新するノードの名称を指定します。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：なし

使用例

次の例では、ノードlsshが表すホストをsj04に更新します。

asadmin update-node-ssh --nodehost sj04 lssh

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6　サーバの管理で使用するコマンド

サーバの管理で使用するコマンドの書式、機能などについて説明します。

2.6.1　cleanup-prf

PRF環境のクリーンアップ

書式

asadmin [asadmin-options] cleanup-prf [--nodedir node-dir]
    [--node node-name] prf-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

cleanup-prfサブコマンドは、サブコマンドを実行したホスト上に構築されているPRFを停止し、PRF環境を削除（クリーンアップ）します。ドメインのPRF情報は削除しません。

このコマンドは、ドメイン管理サーバの停止によってドメインを再作成したために、リモートのノード上にPRF環境が残っている場合など、ドメイン管理サーバで管理されていないPRFに対して使用してください。

このコマンドはローカルモードだけサポートします。

実行権限

一般ユーザー

前提条件

対象のノード上のPRFがドメイン管理サーバで管理されていないこと。

引数

--nodedir node-dir

PRFが構築されているノードディレクトリーを指定します。

型：String

指定できる値を次に示します。

存在するノードディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/nodes

--node node-name

PRFが構築されているノード名を指定します。

型：String

指定できる値を次に示します。

存在するノード名

デフォルト値：なし

--nodedirで指定したディレクトリーに存在するノードディレクトリーが1つだけの場合は、このオプションを省略できます。

prf-name

削除するPRFのサーバ名を指定します。

型：String

指定できる値を次に示します。

存在するPRFのサーバ名

デフォルト値：なし（必須）

使用例

/temp/nodesに構築したlocalhost-domain1のノードに属するPRF1という名称のPRFを削除する場合

asadmin cleanup-prf --nodedir /temp/nodes --node localhost-domain1 PRF1

戻り値

戻り値

説明

0

正常終了

1

異常終了

注意事項

stop-prfサブコマンドでPRFを停止できる環境では、このコマンドを使用しないでください。使用した場合、ドメイン管理サーバがPRFの障害として検知する場合があります。

ドメイン管理サーバからPRFを削除できる場合は、このコマンドを使用しないでください。使用してドメインにPRFの情報が残ったときは、delete-prfサブコマンドの--forceオプションを指定して削除します。また、ドメインにPRFの情報が残った状態でstart-prfを実行すると、ノード上にPRFの情報が作成されることがあります。

2.6.2　cleanup-webserver

Webサーバ環境のクリーンアップ

書式

asadmin [asadmin-options] cleanup-webserver [--graceful={false|true}]
    [--nodedir node-dir] [--node node-name] webserver-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

cleanup-webserverサブコマンドは、サブコマンドを実行したホスト上に構築されているWebサーバを停止し、Webサーバ環境を削除（クリーンアップ）します。ドメインのWebサーバ情報は削除しません。

このコマンドは、ドメイン管理サーバの停止によってドメインを再作成したために、リモートのノード上にWebサーバ環境が残っている場合など、ドメイン管理サーバで管理されていないWebサーバに対して使用してください。

このコマンドはローカルモードだけサポートします。

実行権限

一般ユーザー

前提条件

対象のノード上のWebサーバがドメイン管理サーバで管理されていないこと。

引数

--graceful={false|true}

Webサーバを計画停止するかどうかを指定します。プロセスが停止済みの場合、この指定は無視されます。

型：Boolean

指定できる値を次に示します。

true

計画停止します。

false

通常停止します。

デフォルト値：true

--nodedir node-dir

Webサーバが構築されているノードディレクトリーを指定します。

型：String

指定できる値を次に示します。

存在するノードディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/nodes

--node node-name

Webサーバが構築されているノード名を指定します。

型：String

指定できる値を次に示します。

存在するノード名

デフォルト値：なし

--nodedirで指定したディレクトリーに存在するノードディレクトリーが1つだけの場合は、このオプションを省略できます。

webserver-name

削除するWebサーバのサーバ名を指定します。

型：String

指定できる値を次に示します。

存在するWebサーバのサーバ名

デフォルト値：なし（必須）

使用例

Web1という名称のWebサーバをクリーンアップする場合

asadmin cleanup-webserver --nodedir /temp/nodes --node localhost-domain1 Web1

/temp/nodesに構築したlocalhost-domain1のノードに属するWeb1という名称のWebサーバをクリーンアップする場合

asadmin cleanup-webserver --nodedir /temp/nodes --node localhost-domain1 Web1

Web1という名称のWebサーバを計画停止してからクリーンアップする場合

asadmin cleanup-webserver --graceful true --nodedir /temp/nodes
--node localhost-domain1 Web1

戻り値

戻り値

説明

0

正常終了

1

異常終了

注意事項

stop-webserverサブコマンドでWebサーバを停止できる環境では、このコマンドを使用しないでください。使用した場合、ドメイン管理サーバがWebサーバの障害として検知する場合があります。

ドメイン管理サーバからWebサーバを削除できる場合は、このコマンドを使用しないでください。使用してドメインにWebサーバの情報が残ったときは、delete-webserverサブコマンドの--forceオプションを指定して削除します。また、ドメインにWebサーバの情報が残った状態でstart-webserverを実行すると、ノード上にWebサーバの情報が作成されることがあります。

2.6.3　copy-config

既存の名前付き構成をコピーして、別の構成を作成

書式

asadmin [asadmin-options] copy-config [--help]
    [--systemproperties name=value[:name=value]...]
    source-configuration-name destination-configuration-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

copy-configサブコマンドは、既存の構成をコピーしてドメイン管理サーバの構成に名前付き構成を作成します。新しい構成は、--systempropertiesオプションで指定したプロパティー以外、コピーした構成と同じです。スタンドアロンのサーバインスタンスまたはスタンドアロンのクラスターの作成時にはdefault-config構成がコピーされます。

このサブコマンドはリモートモードだけサポートします。

前提条件

構成をコピーするドメイン管理サーバは、稼働中である必要があります。

copy-configサブコマンドを実行する前に、コピー元の構成が存在している必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--systemproperties name=value[:name=value]...

--systempropertiesオプションで任意の属性名と値のペアを指定できます。ここで設定したプロパティーは構成の中のポート設定を上書きします。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

プロパティー名とvalueに指定できる値を次に示します。

ASADMIN_LISTENER_PORT=value

このプロパティーは、ドメイン管理サーバがインスタンスを管理する際に接続するHTTPまたはHTTPSポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_LISTENER_PORT=value

このプロパティーは、HTTP要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_SSL_LISTENER_PORT=value

このプロパティーは、HTTPS要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_LISTENER_PORT=value

このプロパティーは、IIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_LISTENER_PORT=value

このプロパティーは、セキュアなIIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_MUTUALAUTH_PORT=value

このプロパティーは、クライアント認証を持つセキュアなIIOP接続に使用するポートのポート番号を指定します。

型：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_PROVIDER_PORT=value

このプロパティーは、JMSプロバイダーのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

JMX_SYSTEM_CONNECTOR_PORT=value

このプロパティーは、JMXコネクターがリッスンするポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

source-configuration-name

コピーする構成の名称を表示します。

型：String

指定できる値を次に示します。

コピー元構成の名称

デフォルト値：なし

destination-configuration-name

コピー元の構成をコピーして作成する構成の名称を表示します。

型：String

指定できる値を次に示します。

作成される構成の名称

destination-configuration-nameの値は、次に示す条件を満たしている必要があります。

ASCII文字だけで構成されていること。

文字、数字、またはアンダースコアで開始されていること。

次の文字だけを使用すること。

小文字

大文字

数字

ハイフン

ピリオド

アンダースコア

ドメイン内で一意である必要があり、ほかの構成名、クラスター名、サーバインスタンスの名称、または別のノード名と重複できません。

domain、server、またはJava EE Serverが予約したその他のキーワードは使用できません。

デフォルト値：なし

使用例

次の例では、デフォルトの構成をコピーして、名前付きの構成clusterpresets-configを作成します。

asadmin copy-config default-config clusterpresets-config

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.4　create-cluster

Java EE Serverクラスターの作成

書式

asadmin [asadmin-options] create-cluster [--help]
    [--config config-name]
    [--systemproperties name=value[:name=value]...]
    [--properties name=value[:name=value]...]
    [--gmsenabled={true|false}] [--multicastport multicast-port]
    [--multicastaddress multicast-address]
    [--bindaddress bind-address] cluster-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-clusterサブコマンドは、Java EE Serverクラスターを作成します。

クラスターは、そのクラスターに追加するすべてのインスタンスの構成を定義する名前付き構成への参照を必要とします。

クラスターの構成がほかのクラスターやスタンドアロンのサーバインスタンスと共有されていないため、作成されるクラスターはスタンドアロンのクラスターです。

このサブコマンドはリモートモードだけサポートします。

実行権限

次に示す情報は、--systempropertiesオプションだけに適用されます。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--config config-name

クラスターが参照する名前付き構成を指定します。--configオプションを指定して、共有クラスターを作成します。このオプションを省略した場合、スタンドアロンのクラスターが作成されます。

型：String

指定できる値を次に示します。

構成名

デフォルト値：なし

--systemproperties name=value[:name=value]...

--systempropertiesオプションで任意の属性名と値のペアを指定できます。ここで設定したプロパティーはdefault-config構成の中の設定を上書きします。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

プロパティー名とvalueに指定できる値を次に示します。

ASADMIN_LISTENER_PORT=value

このプロパティーは、ドメイン管理サーバがインスタンスを管理する際に接続するHTTPまたはHTTPSポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_LISTENER_PORT=value

このプロパティーは、HTTP要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_SSL_LISTENER_PORT=value

このプロパティーは、HTTPS要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_LISTENER_PORT=value

このプロパティーは、IIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_LISTENER_PORT=value

このプロパティーは、セキュアなIIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_MUTUALAUTH_PORT=value

このプロパティーは、クライアント認証を持つセキュアなIIOP接続に使用するポートのポート番号を指定します。

型：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_PROVIDER_PORT=value

このプロパティーは、JMSプロバイダーのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

JMX_SYSTEM_CONNECTOR_PORT=value

このプロパティーは、JMXコネクターがリッスンするポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

--properties name=value[:name=value]...

クラスターのプロパティーを定義します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

プロパティー名とvalueに指定できる値を次に示します。

GMS_DISCOVERY_URI_LIST=value

クラスターを検出するために使用されるクラスター内のサーバインスタンスの場所を一覧表示します。このプロパティーは、メッセージをブロードキャストするためにグループ管理サービスでマルチキャストを使用しない場合にだけ必要です。

型：String

指定できる値を次に示します。

Uniform Resource Identifier（URI）のコンマ区切りリスト。各URIはサーバインスタンスまたはドメイン管理サーバを特定する必要があります。複数のサーバインスタンスが同じホストで実行されている場合は、この形式が必須です。

リスト内の各URIの形式は次のとおりです。

scheme://host-name-or -IP-address:port

schemeはURIのスキームで、tcpです。

host-name-or -IP-addressはインスタンスが実行されているホストのホスト名またはIPアドレスです。

portはインスタンスがグループ管理サービスからのメッセージをリッスンするポートのポート番号です。システムプロパティーGMS_LISTENER_PORT-cluster-nameをインスタンスに対して設定する必要があります。

ドメイン管理サーバまたはインスタンスが稼働しているホストのIPアドレスまたはホスト名のコンマ区切りリスト。リストには、IPアドレスとホスト名を混在させることができます。この形式は、クラスター化された1つのインスタンスが各ホストで実行されている場合にだけ使用できます。GMS_LISTENER_PORTプロパティーの値は、ドメイン内の各クラスターで一意である必要があります。

キーワードgenerate。この形式は、クラスター内の1つのインスタンスが各ホストで実行されていてドメイン管理サーバが別のホストで稼働している場合にだけ使用できます。同じホスト上の複数のインスタンスは、同じクラスターのメンバーにできません。GMS_LISTENER_PORTプロパティーの値は、ドメイン内の各クラスターで一意である必要があります。

デフォルト値：なし

GMS_LISTENER_PORT=value

クラスターがグループ管理サービスからのメッセージをリッスンするポートのポート番号を指定します。

デフォルト値はGMS_LISTENER_PORT-cluster-nameシステムプロパティーへの参照です。デフォルトでは、このシステムプロパティーは設定されていません。この状況では、グループ管理サービスはGMS_TCPSTARTPORTプロパティーおよびGMS_TCPENDPORTプロパティーで定義された範囲から空きポートを選びます。デフォルトでは、範囲は9090〜9200です。

メッセージをブロードキャストするためにグループ管理サービスでマルチキャストを使用しない場合、GMS_LISTENER_PORTプロパティーは、クラスター内のすべてのサーバインスタンスに対して有効なポート番号を指定する必要があります。

この要件を満たすデフォルト値を使用するには、システムプロパティーを使用してインスタンスごとに個別にポート番号を設定します。

例えば、create-system-propertiesサブコマンドを使用して、GMS_LISTENER_PORT-cluster-nameシステムプロパティーをドメイン管理サーバに対して作成します。次に、クラスター内の各インスタンスについて、GMS_LISTENER_PORT-cluster-nameシステムプロパティーを、そのインスタンスがグループ管理サービスからのメッセージをリッスンするポート番号に設定します。クラスターのGMS_LISTENER_PORTプロパティーのデフォルト値は、このシステムプロパティーを参照します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

GMS_LOOPBACK=value

インスタンスがクラスターにブロードキャストしたアプリケーションレベルのメッセージを、そのインスタンスが自身から受信できるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

インスタンスは自身からメッセージを受信できます。インスタンスがクラスター内の唯一のインスタンスである場合に、インスタンスをテストするときに、この設定を使用します。

false

インスタンスは自身からメッセージを受信できません。

デフォルト値：false

GMS_MULTICAST_TIME_TO_LIVE=value

次のタイプのイベントのマルチキャストメッセージを反復処理または伝送する最大数を指定します。この数を超えるとメッセージは破棄されます。

グループの検出

メンバーのハートビート

メンバーシップの変更

ドメイン管理サーバおよびクラスター化されたインスタンスがデプロイされているネットワークの構成に一致させるには、この値をできる限り小さく設定します。システムに設定できる最小値を判定するには、validate-multicastサブコマンドを使用します。値に0を指定すると、マルチキャストメッセージはブロードキャスト元のホストから送信されません。

値に1を指定すると、スイッチまたはルーターで接続された同じサブネット上のホスト間でメッセージがブロードキャストされなくなる場合があります。

デフォルト値の4を指定すると、ホストがスイッチまたはルーターで接続されているネットワークのすべてのクラスター構成のインスタンスにメッセージが正常にブロードキャストされます。

型：Integer

指定できる値を次に示します。

0〜255

デフォルト値：4

GMS_TCPENDPORT=value

GMS_LISTENER_PORT-cluster-nameシステムプロパティーが設定されていない場合に、グループ管理サービスが空きポートを選択する範囲の最大のポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：9200

GMS_TCPSTARTPORT=value

GMS_LISTENER_PORT-cluster-nameシステムプロパティーが設定されていない場合に、グループ管理サービスが空きポートを選択する範囲の最小のポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：9090

--gmsenabled={true|false}

グループ管理サービスがクラスターに有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

グループ管理サービスはクラスターに有効です。グループ管理サービスがクラスターに有効な場合、クラスターおよびドメイン管理サーバで、グループ管理サービスは各サーバインスタンスを始動します。ドメイン管理サーバは、このオプションがTrueに設定されている各クラスターに関与します。

false

グループ管理サービスはクラスターに無効です。

デフォルト値：true

--multicastaddress multicast-address

グループ管理サービスがグループイベントをリッスンするアドレスを指定します。

型：String

指定できる値を次に示します。

224.0.0.0〜239.255.255.255

デフォルト値：228.9.XX.YY

ただし、XXおよびYYは、0〜255の範囲で自動生成される独立した値

--multicastport multicast-port

グループ管理サービスがグループイベントをリッスンする通信ポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

2048〜49151

デフォルト値：指定範囲内で自動生成される値

--bindaddress bind-address

グループ管理サービスがバインドするネットワークインターフェースのIPアドレスを指定します。

型：String

デフォルト値：すべてのパブリックネットワークインターフェースのIPアドレス

cluster-name

クラスター名を指定します。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

使用例

次の例では、クラスターを作成します。

asadmin create-cluster
--systemproperties IIOP_SSL_LISTENER_PORT=1169
ltscluster

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.5　create-instance

サーバインスタンスの作成

書式

asadmin [asadmin-options] create-instance [--help] --node node-name
    [--config config-name | --cluster cluster-name]
    [--portbase=port-number] [--checkports={true|false}]
    [--systemproperties name=value[:name=value]...]
    [--prf prf-name] instance-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-instanceサブコマンドはサーバインスタンスを作成します。

このサブコマンドは、ドメイン管理サーバが動作中のホストや、インスタンスが存在する--nodeオプションで指定されたホストに、SSHが配置されている必要があります。

サーバインスタンスは、Java EE Serverが動作している1つのノード上の1つのJava VMです。

ノードは、サーバインスタンスが存在するホストを定義します。Java VMは、Java EEとの互換性が必要です。

このサブコマンドはリモートモードだけサポートします。

インスタンスが、ローカルホストを表すタイプCONFIGのノードに存在している場合、SSHは必要ありません。

タイプCONFIGのノードは、SSHのリモート通信に対して有効化されていません。

実行権限

次に示す情報は、--systempropertiesオプションだけに適用されます。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--node node-name

インスタンスが作成される対象のホストを定義するノード名を指定します。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：localhost-domain

--config config-name

インスタンスから参照される名前付き構成を指定します。名前がdefault-configまたはserver-configではない構成が必要です。

型：String

指定できる値を次に示します。

構成名

デフォルト値：なし

--cluster cluster-name

インスタンスが構成を継承する元のクラスターを指定します。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

--portbase=port-number

ポート割当を開始する番号を確認します。

型：Integer

指定できる値を次に示します。

-8〜65449

デフォルト値：なし

--checkports={true|false}

管理、HTTP、JMS、JMX、IIOPの各ポートが利用できることを確認するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--systemproperties name=value[:name=value]...

--systempropertiesオプションで任意の属性名と値のペアを指定できます。ここで設定したプロパティーは構成の中のポート設定を上書きします。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

プロパティー名とvalueに指定できる値を次に示します。

ASADMIN_LISTENER_PORT=value

このプロパティーは、ドメイン管理サーバがインスタンスを管理する際に接続するHTTPまたはHTTPSポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_LISTENER_PORT=value

このプロパティーは、HTTP要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

HTTP_SSL_LISTENER_PORT=value

このプロパティーは、HTTPS要求をリッスンするのに使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_LISTENER_PORT=value

このプロパティーは、IIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_LISTENER_PORT=value

このプロパティーは、セキュアなIIOP接続に使用するポートのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

IIOP_SSL_MUTUALAUTH_PORT=value

このプロパティーは、クライアント認証を持つセキュアなIIOP接続に使用するポートのポート番号を指定します。

型：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_PROVIDER_PORT=value

このプロパティーは、JMSプロバイダーのポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

JMX_SYSTEM_CONNECTOR_PORT=value

このプロパティーは、JMXコネクターがリッスンするポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

同じホスト上で2つのクラスター構成のインスタンスがある場合、プリデファインドポートの設定は上書きされます。この状況では、1つのインスタンスのポート設定が優先される必要があります。両方のインスタンスで同じ構成を共有するからです。

--prf prf-name

Java EEサーバが使用するPRFのサーバ名を指定します。--nodeオプションに指定したノードに存在するPRFを指定してください。

型：String

指定できる値を次に示します。

PRFのサーバ名

デフォルト値：なし

instance-name

作成するインスタンスの名称を指定します。

型：String

指定できる値を次に示します。

インスタンス名

デフォルト値：なし

使用例

次の例では、サーバインスタンスを作成します。

asadmin create-instance --node localhost-domain1 pmdsainst

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.6　create-prf

PRFの構築

書式

asadmin [asadmin-options] create-prf --node node-name
    [--properties name=value[:name=value]...]
    [--template prf-templatedir] prf-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-prfサブコマンドは、ドメインにPRFを構築します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

ノードを作成済みであること。

ファイル

PRFのサーバテンプレート（オプション指定可能）

ドメインルートディレクトリー/ドメイン名/server_templates/prf

引数

--node node-name

PRFを構築するノードを指定します。

型：String

指定できる値を次に示します。

ドメインに存在するノード名

デフォルト値：なし（必須）

--properties name=value[:name=value]...

PRFの標準プロパティーまたは拡張プロパティーを、プロパティー名と値のペアで指定します。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

name

型：String

指定できる値を次に示します。

PRFの標準プロパティーまたは拡張プロパティー(ex_から始まるプロパティー)。

value

指定できる値を次に示します。

nameに指定したプロパティーの指定範囲に従います。

デフォルト値：このオプションで指定していない標準プロパティーについては、PRFのデフォルトコンフィグ（コンフィグ名default-prf-config）の値が適用されます。

--template prf-templatedir

PRFのサーバテンプレートが格納されているディレクトリーパスを、絶対パスで指定します。

型：String

デフォルト値：hitachi-prf-configs.hitachi-prf-config.default-prf-config.hitachi-manage-info.template-path属性に設定されているパスが適用されます。

上記属性のデフォルト値を示します。

ドメインルートディレクトリー/ドメイン名/server_templates/prf

prf-name

新規に構築するPRFサーバの名称を指定します。

型：String

指定できる値を次に示します。

31文字以内のASCII文字であること。

名称は次の文字で構成すること。

英小文字<a〜z>

英大文字<A〜Z>

数字<0〜9>

アンダースコア<_>

先頭文字は英大文字または英小文字を使用すること。ただし、次の文字列は大文字、小文字ともに先頭に使用できません。

TSC

CTM

ドメインに存在する次の名称は指定できません。

ノード名

JavaEEサーバ名

Webサーバ名

PRFのサーバ名

クラスター名

サーバ間関連名

JavaEEサーバの構成名

次に示す名称はシステムで使用済みまたは予約語のため指定できません。

domain

server

default

server-config

default-config

default-webserver-config

default-prf-config

javaee

webserver

prf

cluster

redirect

prf-relation

HJES_で始まる名称

構築済みWebサーバ名-config

構築済みPRF名-config

デフォルト値：なし（必須）

使用例

PRF1という名称のPRFを構築する場合

asadmin create-prf --node localhost-domain1 PRF1

標準プロパティーを指定してPRFを構築する場合

asadmin create-prf --node localhost-domain1 --properties trace-file-size=65536
PRF1

サーバテンプレートのディレクトリーを指定してPRFを構築する場合

asadmin create-prf --node localhost-domain1 --template C:¥temp¥PRF1 PRF1

戻り値

戻り値

説明

0

正常終了

1

異常終了

注意事項

構築先ノードのホストに、ほかのドメインがPRFを構築済みの場合、そのPRFと同じ名称のPRFを構築しないでください。

2.6.7　create-webserver

Webサーバの構築

書式

asadmin [asadmin-options] create-webserver --node node-name
    [--properties name=value[:name=value]...]
    [--template webserver-templatedir]
    [--prf prf-name] webserver-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-webserverサブコマンドは、ドメインにWebサーバを構築します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

ノードを作成済みであること。

ファイル

Webサーバのサーバテンプレート（オプション指定可能）

ドメインルートディレクトリー/ドメイン名/server_templates/webserver

引数

--node node-name

Webサーバを構築するノードを指定します。

型：String

指定できる値を次に示します。

ドメインに存在するノード名

デフォルト値：なし（必須）

--properties name=value[:name=value]...

Webサーバの標準プロパティーまたは拡張プロパティーを、プロパティー名と値のペアで指定します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

name

型：String

指定できる値を次に示します。

Webサーバの標準プロパティーまたは拡張プロパティー（ex_から始まるプロパティー）。

デフォルト値：このオプションで指定していない標準プロパティーについては、Webサーバのデフォルトコンフィグ（コンフィグ名default-webserver-config）の値が適用されます。

value

指定できる値を次に示します。

nameに指定したプロパティーの指定範囲に従います。

--template webserver-templatedir

Webサーバのサーバテンプレートが格納されているディレクトリーパスを絶対パスで指定します。

型：String

デフォルト値：hitachi-webserver-configs.hitachi-webserver-config.default-webserver-config.hitachi-manage-info.template-path属性に設定されているパスが適用されます。この属性のデフォルト値は次のパスです。

ドメインルートディレクトリー/ドメイン名/server_templates/webserver

--prf prf-name

Webサーバが使用するPRFのサーバ名を指定します。

型：String

指定できる値を次に示します。

--nodeに指定したノードに存在するPRF

デフォルト値：なし（指定しない）

webserver-name

新規に構築するWebサーバの名称を指定します。

型：String

指定できる値を次に示します。

128文字以内のASCII文字であること。

名称は次の文字で構成すること。

英小文字<a〜z>

英大文字<A〜Z>

数字<0〜9>

ハイフン<->

アンダースコア<_>

先頭文字は英大文字または英小文字を使用すること。

ドメインに存在する次の名称は指定できません。

ノード名

JavaEEサーバ名

Webサーバ名

PRFのサーバ名

クラスター名

サーバ間関連名

JavaEEサーバの構成名

次に示す名称はシステムで使用済みまたは予約語のため指定できません。

domain

server

default

server-config

default-config

default-webserver-config

default-prf-config

javaee

webserver

prf

cluster

redirect

prf-relation

HJES_で始まる名称

構築済みWebサーバ名-config

構築済みPRF名-config

デフォルト値：なし（必須）

使用例

サーバ名Web1、関連するPRFPRF1のWebサーバを構築する場合

asadmin create-webserver --node localhost-domain1 --prf PRF1 Web1

デフォルトから変更したい標準プロパティーを指定してWebサーバを構築する場合

asadmin create-webserver --node localhost-domain1 --properties
 listen-port=88:server-name=www.webserver.com --prf PRF1 Web1

サーバテンプレートを指定してWebサーバを構築する場合

asadmin create-webserver --node localhost-domain1 --template /user_template/Web1
 --prf PRF1 Web1

戻り値

戻り値

説明

0

正常終了

1

異常終了

注意事項

構築先ノードのホストに、ほかのドメインがWebサーバを構築済みの場合、そのWebサーバと同じ名称のWebサーバを構築しないでください。

2.6.8　delete-cluster

Java EE Serverクラスターの削除

書式

asadmin [asadmin-options] delete-cluster [--help] cluster-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-clusterサブコマンドは、Java EE Serverクラスターを削除します。クラスターは、サーバインスタンスがクラスターに含まれていない場合にだけ削除できます。削除しようとするクラスターにインスタンスが含まれている場合は、クラスターを削除する前に、インスタンスを停止して削除してください。

クラスターの名前付き構成が自動的に生成された場合、かつ、ほかのクラスターまたはクラスター構成ではないサーバインスタンスがその構成を参照していない場合、クラスター削除時に構成も削除されます。

クラスターの構成が自動的に生成された場合、構成名はcluster-name-configになります。クラスターの名称はcluster-nameに指定します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

cluster-name

クラスターの名称を指定します。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

使用例

次の例では、Java EE Serverクラスターのadcclusterを削除します。

asadmin delete-cluster adccluster

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.9　delete-config

名前付き既存構成の削除

書式

asadmin [asadmin-options] delete-config [--help] configuration-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-configサブコマンドは、ドメイン管理サーバの構成から既存の名前付き構成を削除します。構成は、サーバインスタンスまたはクラスターから参照されていない場合にだけ削除できます。スタンドアロン構成は、その構成を参照するインスタンスまたはクラスターが削除されると自動的に削除されます。スタンドアロン構成を作成するためにコピーされるdefault-config構成は削除できません。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

configuration-name

構成の名称を指定します。

型：String

指定できる値を次に示します。

構成名

デフォルト値：なし

使用例

次の例では、名前付きの構成pmdconfigを削除します。

asadmin delete-config pmdconfig

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.10　delete-instance

サーバインスタンスの削除

書式

asadmin [asadmin-options] delete-instance [--help] instance-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-instanceサブコマンドは、サーバインスタンスを削除します。このサブコマンドの実行には、SSHが次に示すどちらかのホスト上で構成されている必要があります。

ドメイン管理サーバが動作しているホスト。

インスタンスが存在するcreate-instanceコマンドの--nodeオプションで指定されたホスト。

ただし、削除対象となるインスタンスがconfigタイプのノード上に構築されている場合、SSHの設定は不要です。

ドメイン管理サーバにアクセスできるどのホストからでも、このサブコマンドは実行できます。

サブコマンドでは任意の サーバインスタンスを削除できます。 インスタンスが作成された方法は関係ありません。

削除するインスタンスは、動作していないことが必要です。インスタンスが動作している場合は、エラーが発生します。

このサブコマンドでは、次の処理でインスタンスを削除します。

ドメイン管理サーバ構成からインスタンスを削除する。

ファイルシステムからインスタンスのファイルを削除する。

削除対象のインスタンスが、ノードディレクトリーを使用する唯一のインスタンスである場合、そのディレクトリーも削除されます。

スタンドアロンサーバインスタンスを削除する場合、インスタンスのスタンドアロン構成も削除されます。スタンドアロン構成とは、スタンドアロンサーバインスタンスが参照し、かつ、ほかのクラスターまたはクラスター化されていないインスタンスが参照していない、instance-name-configという名前付きの構成のことです。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

instance-name

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

型：String

指定できる値を次に示します。

インスタンス名

デフォルト値：なし

使用例

次の例では、 サーバインスタンスのpmdsainstを削除します。

asadmin delete-instance pmdsainst

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.11　delete-prf

PRFの削除

書式

asadmin [asadmin-options] delete-prf [--force={false|true}] prf-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-prfサブコマンドは、指定した名称のPRFをドメインから削除します。PRFがほかのサーバに関連している場合（PRFが関連元である関連が存在する場合）は、その関連も削除します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

PRFを構築済みであること。

PRFを停止済みであること。

引数

--force={false|true}

強制削除するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

強制削除します。ノード上のPRFが停止状態以外の場合や、PRFの削除に失敗した場合でも、ドメインからPRFの情報を削除します。

false

強制削除しません。ノード上のPRFの削除に失敗した場合、ドメインからPRFの情報を削除しないで、エラー終了します。

デフォルト値：false

prf-name

削除するPRFのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するPRFのサーバ名

デフォルト値：なし（必須）

使用例

PRF1という名称のPRFを削除する場合

asadmin delete-prf PRF1

PRFを強制削除する場合

asadmin delete-prf --force true PRF1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.12　delete-webserver

Webサーバの削除

書式

asadmin [asadmin-options] delete-webserver [--force={false|true}]
    webserver-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-webserverサブコマンドは、Webサーバをドメインから削除します。Webサーバがほかのサーバに関連している場合（Webサーバが関連元である関連が存在する場合）は、その関連も削除します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

Webサーバを構築済みであること。

Webサーバを停止済みであること。

引数

--force={false|true}

Webサーバを強制削除するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

強制削除します。ノード上のWebサーバが停止状態以外の場合や、Webサーバの削除に失敗した場合でも、ドメインからWebサーバの情報を削除します。

false

強制削除しません。ノード上のWebサーバの削除に失敗した場合、ドメインからWebサーバの情報を削除しないで、エラー終了します。

デフォルト値：false

webserver-name

削除するWebサーバのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するWebサーバ名

デフォルト値：なし（必須）

使用例

Web1という名称のWebサーバを削除する場合

asadmin delete-webserver Web1

Webサーバを強制削除する場合

asadmin delete-webserver --force true Web1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.13　export-sync-bundle

クラスターまたはスタンドアロンサーバインスタンスの構成データのアーカイブファイルへのエクスポート

書式

asadmin [asadmin-options] export-sync-bundle [--help]
    --target target
    [--retrieve={false|true}]
    [file-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

export-sync-bundleサブコマンドは、クラスターまたはスタンドアロンサーバインスタンスの構成データをアーカイブファイルにエクスポートします。このアーカイブファイルは、import-sync-bundleサブコマンドで構成データを復元するときに使用できます。

インスタンスの構成データをインポートすると、インスタンスがドメイン管理サーバと通信できる状態にしなくても、インスタンスのホストにデータが転送されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

このサブコマンドでは、次のファイルとディレクトリーを含むアーカイブを現在のドメインディレクトリー内に作成します。

次のディレクトリーに含まれるすべてのファイル

config

docroot

次のディレクトリーとサブディレクトリーの全内容

applications

config/target（targetは構成データをエクスポートするクラスターまたはスタンドアロンサーバインスタンス）

generated

lib

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

エクスポートする構成データの対象を指定します。

このオプションには、クラスター化したサーバインスタンスを指定できません。このオプションにクラスター化されたインスタンスを指定すると、エラーが発生します。クラスター化されたインスタンスの構成データをエクスポートするには、そのインスタンスではなく、インスタンスが所属するクラスターの名称を指定します。

型：String

指定できる値を次に示します。

cluster_name

指定した名称のクラスターを対象とします。

standalone_instance_name

指定した名称のスタンドアロンのサーバインスタンスを対象とします。

デフォルト値：なし

--retrieve={false|true}

ドメイン管理サーバのホストから、このサブコマンドが実行されるホストにアーカイブファイルをダウンロードするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

このサブコマンドが実行されるホストにアーカイブファイルがダウンロードされます。

false

アーカイブファイルはダウンロードされないで、ドメイン管理サーバのホストに保持されます。

デフォルト値：false

file-name

データをエクスポートするアーカイブファイルのファイル名と場所を指定します。

型：String

指定できる値を次に示します。

ファイル名

デフォルト値：

--retrieveオプションがfalseの場合

現在のドメインディレクトリー内のsync/target-sync-bundle.zip

--retrieveオプションがtrueの場合

現在の作業ディレクトリー内のtarget-sync-bundle.zip

使用例

次の例では、pmdclusterという名称のクラスターの構成データをエクスポートします。

asadmin export-sync-bundle --target pmdcluster

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.14　get-health

クラスターの状態表示

書式

asadmin [asadmin-options] get-health [--help]
    cluster_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

get-healthサブコマンドは、クラスターの状態に関する情報を取得し、表示します。グループ管理サービスが有効ではない場合、このクラスターのサーバインスタンスが動作しているかどうかに関する基本情報が返されないことに注意してください。サーバインスタンスごとに、次のどれかの状態がレポートされます。

not started

started

stopped

rejoined

failed

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

cluster_name

状態の情報を表示するクラスターの名称を指定します。クラスター名を指定しないと、クラスター名の入力を要求するプロンプトが表示されます。

クラスターはドメイン管理サーバに存在する必要があります。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

使用例

次の例では、クラスター内のサーバインスタンスの状態に関する情報を表示します。

asadmin get-health cluster1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.15　import-sync-bundle

クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データのインポート

書式

asadmin [asadmin-options] import-sync-bundle [--help]
    --instance instance-name
    [--nodedir node-dir] [--node node-name]
    file-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

import-sync-bundleサブコマンドは、export-sync-bundleサブコマンドで作成されたアーカイブファイルから、クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データをインポートします。インスタンスの構成データをインポートすると、インスタンスがドメイン管理サーバと通信できる状態でなくても、インスタンスのホストにデータを転送できます。

このサブコマンドはローカルモードだけサポートします。

このサブコマンドは、インスタンスが存在するホストで実行する必要があります。ドメイン管理サーバにアクセスするには、このサブコマンドでは、ドメイン管理サーバが稼働しているホストの名称が必要です。管理サーバでデフォルト以外のポートを使用している場合、ポート番号も指定する必要があります。

前提条件

--instanceオプションでは、ドメイン管理サーバの設定内の既存のインスタンスを指定する必要があります。また、データのインポート元のアーカイブファイルには、指定したインスタンスのデータが含まれている必要があります。

ファイル

import-sync-bundleサブコマンドは、クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データをexport-sync-bundleサブコマンドで作成したアーカイブファイル（sync-bundleアーカイブファイル）からインポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--instance instance-name

構成データをインポートする対象のインスタンスを指定します。ドメイン管理サーバ構成内の既存のインスタンスを指定する必要があります。また、データのインポート元のアーカイブファイルには、指定したインスタンスのデータが含まれている必要があります。

型：String

指定できる値を次に示します。

インスタンス名

デフォルト値：なし

--nodedir node-dir

インスタンスのノードディレクトリーが含まれるディレクトリーを指定します。インスタンスのファイルは、インスタンスのノードディレクトリーに格納されます。

型：String

指定できる値を次に示します。

ノードディレクトリーのパス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/nodes

--node node-name

インスタンスが存在するノードを指定します。このオプションを省略した場合、アーカイブファイルのドメイン管理サーバ構成からノードが判断されます。

型：String

指定できる値を次に示します。

ノード名

デフォルト値：ドメイン管理サーバ構成のノード

file-name

インポートするアーカイブファイルが含まれているファイル名（パスを含む）を指定します。

型：String

指定できる値を次に示します。

パスを含むファイル名

デフォルト値：なし

使用例

次の例では、アーカイブファイル/export/glassfish3/glassfish/domains/domain1/sync/ymlcluster-sync-bundle.zipから、ノードsj02のクラスター化されたインスタンスymli2の構成をインポートします。

コマンドは、ノードsj02で表されるホストsj02上で実行されます。ドメイン管理サーバはホストsr04上で稼働していて、管理用のデフォルトのHTTPポートを使用しています。

sj02# asadmin --host sr04 import-sync-bundle --node sj02 --instance ymli2
/export/glassfish3/glassfish/domains/domain1/sync/ymlcluster-sync-bundle.zip

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.16　list-clusters

ドメイン内の既存クラスターの一覧表示

書式

asadmin [asadmin-options] list-clusters [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-clustersサブコマンドは、ドメイン内の既存のクラスターを一覧表示します。リストは、クラスター、インスタンス、ノードまたは構成でフィルター処理できます。表示された各クラスターに対し、サブコマンドはクラスターが実行中かどうかを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するクラスターの対象を指定します。

型：String

指定できる値を次に示します。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

node_name

指定した名称のノードに存在するインスタンスを含むクラスターを一覧表示します。例えば、クラスターpmdcにインスタンスpmdi1、およびクラスターymlcにインスタンスymli1がノードn1に存在する場合、pmdcおよびymlcが一覧表示されます。

configuration_name

指定した名称の構成を対象とします。

デフォルト値：domain

使用例

次の例では、現在のドメイン内のクラスターをすべて一覧表示します。

asadmin list-clusters

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.17　list-instances

サーバインスタンスの一覧表示

書式

asadmin [asadmin-options] list-instances [--help]
    [--timeoutmsec timeout]
    [--long={false|true} | --nostatus={false|true}]
    [--standaloneonly={false|true} | target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-instancesサブコマンドは、ドメインにあるサーバインスタンスを一覧表示します。一覧は、クラスター、サーバインスタンス、ノードまたは構成でフィルター処理できます。

このサブコマンドは、サーバインスタンスを作成した方法に関係なく、指定した対象にあるすべてのサーバインスタンスを表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--timeoutmsec timeout

サーバインスタンスのステータスを判定するタイムアウト（ミリ秒単位）を指定します。

型：Integer

指定できる値を次に示します。

-2147483648〜2147483647

デフォルト値：60000

--long={false|true} | -l={false|true}

一覧表示されたサーバインスタンスごとに詳細情報を表示するかどうかを指定します。

--longオプションと--nostatusオプションは同時に指定できません。両方のオプションを指定した場合、エラーが発生します。

型：Boolean

指定できる値を次に示します。

true

一覧表示されたサーバインスタンスごとに、次の詳細情報が表示されます。

・サーバインスタンス名

・サーバインスタンスのノードが存在するホスト名

・サーバインスタンスが管理要求をリスニングするHTTPポート

・サーバインスタンスのプロセスのプロセスID（PID）、またはプロセスが動作していない場合は-1

・サーバインスタンスがクラスターのメンバーの場合はクラスター名

・runningまたはnot runningのどちらかのサーバインスタンス状態

サーバインスタンスが一覧表示された場合、サーバインスタンスに対するドメイン管理サーバの構成変更がサーバインスタンスに適用されないことがあります。このような状況の場合、変更を反映する必要があるコマンドがサーバインスタンス状態の隣に一覧表示されます。1つのサーバインスタンスに対して一覧表示されるコマンドの最大数は10です。

false

サーバインスタンス名およびサーバインスタンスが実行中であるかどうかだけが表示されます（デフォルト）。サーバインスタンスの実行時間は表示されません。

デフォルト値：false

--nostatus={false|true}

サーバインスタンスの実行状態を表示させないようにするかどうかを指定します。

--longオプションと--nostatusオプションは同時に指定できません。両方のオプションを指定すると、エラーが発生します。

型：Boolean

指定できる値を次に示します。

true

サーバインスタンスの実行状態を表示しません。各サーバインスタンスの名称だけが表示されます。

false

サーバインスタンスの実行状態を表示します。

デフォルト値：false

--standaloneonly={false|true}

スタンドアロンサーバインスタンスだけを一覧表示するかどうかを指定します。

--standaloneonlyオプションとtargetは同時に指定できません。同時に指定した場合はエラーが発生します。

型：Boolean

指定できる値を次に示します。

true

スタンドアロンサーバインスタンスだけを一覧表示します。

false

指定した対象のすべてのサーバインスタンスを一覧表示します。

デフォルト値：false

target

一覧表示するサーバインスタンスの対象を指定します。

targetと--standaloneonlyオプションは同時に指定できません。同時に指定した場合はエラーが発生します。

型：String

指定できる値を次に示します。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

node_name

指定した名称のノードに存在するサーバインスタンスを対象とします。

configuration_name

指定した名称の構成を対象とします。

デフォルト値：domain

使用例

次の例では、現在のドメインにあるすべてのサーバインスタンスに関する詳細情報を一覧表示します。

asadmin list-instances --long=true

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.18　list-prfs

PRFの一覧表示

書式

asadmin [asadmin-options] list-prfs [--long={false|true} |
    --nostatus={false|true}] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-prfsサブコマンドは、ドメインに構築されたPRFを一覧表示します。PRFの構成情報や稼働状態を確認できます。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

引数

--long={false|true}

一覧表示するPRFについて、詳細情報を表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

PRFのサーバ名とその詳細情報（ホスト名、プロセスID、ステータス）を表示します。ヘッダー情報も表示します。

false

PRFのサーバ名とステータスだけを表示します。ヘッダー情報は表示しません。

デフォルト値：false

--nostatus={false|true}

PRFのステータスを表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ステータスを表示しません。

false

ステータスを表示します。

デフォルト値：false

target

情報を表示する対象名を指定します。指定された名称から表示するPRFをフィルタリングします。

型：String

指定できる値を次に示します。

domain

ドメイン内のすべてのPRFの情報を表示します。

PRFのサーバ名

指定したPRFの情報を表示します。

ノード名

指定したノードに属するPRFの情報を表示します。

デフォルト値：domain

出力形式

1行目は出力情報のヘッダー部となり、固定文字列で出力形式を示します。

カラム間は、カラム内で最も長い文字列と次のカラムの先頭までを、2つの半角スペースで区切ります。

ステータスは、半角スペース1つを先頭に付けて表示します。

NAME          HOST     PID         STATE
PRFのサーバ名  ホスト名  プロセスID   ステータス

PRFのサーバ名：PRFの名称を表示します。

ホスト名：PRFが構築されているホスト名を表示します。

プロセスID：稼働中のPRFのプロセスIDを表示します。PRFが稼働していない場合は、--を表示します。

ステータス：PRFのステータスを表示します。表示されるステータスを次に示します。

not running（停止）

running（稼働）

使用例

PRFのサーバ名とステータスだけを表示する場合

asadmin list-prfs

[出力例]

PRF1   running
PRF2   not running
PRF4   running
PRF3   not running

PRFのすべての情報を表示する場合

asadmin list-prfs --long true

[出力例]

NAME  HOST       PID  STATE
PRF1  localhost  258   running
PRF2  localhost  --    not running
PRF4  WINHOST1   547   running
PRF3  WINHOST1   --    not running

PRFのステータスを表示しない場合

asadmin list-prfs --nostatus true

[出力例]

PRF1
PRF2
PRF4
PRF3

PRF1の情報だけを表示する場合

asadmin list-prfs PRF1

[出力例]

PRF1   running

ノードwinhost1-domain2（ホストWINHOST1）に属するPRFの情報を表示する場合

asadmin list-prfs --long true winhost1-domain2

[出力例]

NAME  HOST      PID  STATE
PRF4  WINHOST1  547   running
PRF3  WINHOST1  --    not running

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.19　list-webservers

Webサーバの一覧表示

書式

asadmin [asadmin-options] list-webservers [--long={false|true} |
    --nostatus={false|true}] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-webserversサブコマンドは、ドメインに構築されたWebサーバを一覧表示します。Webサーバの構成情報や稼働状態を確認できます。

このコマンドはリモートモードだけサポートします。

--longと--nostatusは形式上、同時に指定できませんが、両方またはどちらか一方を明示的にfalseに設定する場合は、同時指定できます。

実行権限

一般ユーザー

引数

--long={false|true}

一覧表示するWebサーバについて、詳細情報を表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

Webサーバ名とその詳細情報（ホスト名、プロセスID、ステータス）を表示します。ヘッダー情報も表示します。

false

Webサーバ名とステータスだけを表示します。ヘッダー情報は表示しません。

デフォルト値：false

--nostatus={false|true}

Webサーバのステータスを表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ステータスを表示しません。

false

ステータスを表示します。

デフォルト値：false

target

情報を表示する対象名を指定します。指定された名称から表示するWebサーバをフィルタリングします。

型：String

指定できる値を次に示します。

domain

ドメイン内のすべてのWebサーバの情報を表示します。

Webサーバ名

指定したWebサーバの情報を表示します。

ノード名

指定したノードに属するWebサーバの情報を表示します。

デフォルト値：domain

出力形式

1行目は出力情報のヘッダー部となり、固定文字列で出力形式を示します。

カラム間は、カラム内で最も長い文字列と次のカラムの先頭までを、2つの半角スペースで区切ります。

ステータスは、半角スペース1つを先頭に付けて表示します。

NAME       HOST    PID       STATE
Webサーバ名 ホスト名 プロセスID ステータス

Webサーバ名：Webサーバの名称を表示します。

ホスト名：Webサーバが構築されているホスト名を表示します。

プロセスID：稼働中のWebサーバのプロセスIDを表示します。Webサーバが稼働していない場合は、--を表示します。

ステータス：Webサーバのステータスを表示します。表示されるステータスを次に示します。

not running（停止）

running（稼働）

使用例

Webサーバ名とステータスだけを表示する場合

asadmin list-webservers

[出力例]

Web1 running
Web2 not running
Web4 running
Web3 not running

Webサーバのすべての情報を表示する場合

asadmin list-webservers --long true

[出力例]

NAME  HOST       PID  STATE
Web1  localhost  258   running
Web2  localhost  --    not running
Web4  WINHOST1   526   running
Web3  WINHOST1   --    not running

Webサーバのステータスを表示しない場合

asadmin list-webservers --nostatus true

[出力例]

Web1
Web2
Web4
Web3

Web1の情報だけを表示する場合

asadmin list-webservers Web1

[出力例]

Web1   running

ノードwinhost1-domain2（ホストWINHOST1）に属するWebサーバの情報を表示する場合

asadmin list-webservers winhost1-domain2

[出力例]

Web4   running
Web3   not running

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.20　start-cluster

クラスターの起動

書式

asadmin [asadmin-options] start-cluster [--help]
    [--verbose={false|true}] cluster-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-clusterサブコマンドは、クラスター内でまだ実行されていないすべてのサーバインスタンスを起動します。

このサブコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、起動のタイムアウトがあります。起動のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、起動処理は継続します。起動に成功したかどうかは、KDKD20031-IのログまたはGUIのサーバインスタンスの状態により確認できます。

前提条件

ドメイン管理サーバが稼働しているホストおよびクラスター内のインスタンスが存在するすべてのホストで、SSHを設定する必要があります。ただし、クラスター内のインスタンスがすべてconfigタイプのノード上に構築されている場合、SSHの設定は不要です。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--verbose={false|true}

クラスターの起動時に、追加のステータス情報を表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

クラスター内の各インスタンスを起動するコマンドおよび各インスタンスの起動が成功したかどうかを表示します。

false

追加のステータス情報を表示しません。

デフォルト値：false

cluster-name

起動するクラスターの名称を指定します。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

使用例

次の例では、クラスターymlclusterを起動します。クラスターの起動時に、追加のステータス情報が表示されます。

asadmin start-cluster --verbose ymlcluster

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.21　start-instance

サーバインスタンスの起動

書式

asadmin [asadmin-options] start-instance [--help]
    [--debug={false|true}] [--sync={normal|full|none}] instance-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-instanceサブコマンドは、サーバインスタンスを起動します。ドメイン管理サーバにアクセスできる任意のマシンから、このサブコマンドを実行できます。このサブコマンドは、任意のサーバインスタンスを起動できます。インスタンスが作成された方法は関係ありません。

このサブコマンドはリモートモードだけサポートします。

ノードルートディレクトリー/ノード名/Java EEサーバ名/configに出力される次のファイルは、ログ識別子をデフォルトから変更した場合やstart-instanceコマンドに"--sync=full"オプションを指定した場合、Java EEサーバ再起動のときに削除されます。必要に応じてこのサブコマンドの実行前に退避しておいてください。

サーバインスタンスのスレッドダンプログ（デフォルトのログ識別子 "javacore"）

メモリーダンプ（デフォルトのログ識別子 "core"、".core"、"*.dmp"）

エラーリポートファイル（デフォルトのログ識別子 "hs_err_pid"）

コンパイラーリプレイファイル（デフォルトのログ識別子 "replay_pid"）

なお、このサブコマンドには、起動のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、起動処理は継続します。起動のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、起動処理は継続します。起動に成功したかどうかは、KDKD20031-IのログまたはGUIのサーバインスタンスの状態により確認できます。

前提条件

インスタンスが存在するリモートのノードがリモート通信に対して有効になっている必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--debug={false|true}

Java Platform Debugger Architecture（JPDA）デバッグを有効にしてインスタンスを起動するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

JPDAデバッグを有効にしてインスタンスを起動し、JPDAデバッグのポート番号を表示します。

false

JPDAデバッグを無効にしてインスタンスを起動します。

デフォルト値：false

--sync={normal|full|none}

インスタンス起動時のドメイン管理サーバとインスタンスのファイル間の同期のタイプを指定します。

型：String

指定できる値を次に示します。

none

ドメイン管理サーバはインスタンスのファイルと変更を同期しません。このタイプの同期では、インスタンスを起動するのに必要な時間が最小限に抑えられます。

normal

ドメイン管理サーバは次のようにインスタンスと最後の同期以降の変更を同期します。

configディレクトリーの場合、ドメイン管理サーバはインスタンスとすべての変更を同期します。

applicationsディレクトリーおよびdocrootディレクトリーの場合、最上位のサブディレクトリーに対する変更があった場合だけ、ドメイン管理サーバはそのサブディレクトリー下のすべてのファイルを同期します。

最上位のサブディレクトリー内のファイルには変更がなく、その最上位サブディレクトリーの下のファイルに変更があった場合、完全な同期が必要です。通常の操作では、これらのディレクトリーの最上位のサブディレクトリーの下のファイルは変更されません。アプリケーションのデプロイ後にアンデプロイする場合、変更に合わせてインスタンスを更新するための完全な同期は不要です。

full

ドメイン管理サーバは、インスタンスとすべてのインスタンスファイルを同期します。最後の同期以降ファイルが変更されているかどうかは関係ありません。このタイプの同期では、ドメイン管理サーバがインスタンスのディレクトリー内のすべてのファイルを更新している間、インスタンスの起動が遅くなることがあります。

デフォルト値：normal

instance-name

起動するサーバインスタンスの名称を指定します。

型：String

指定できる値を次に示します。

サーバインスタンス名

デフォルト値：なし

使用例

次の例では、サーバインスタンスのpmdsa1を起動します。

asadmin start-instance pmdsa1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.22　start-prf

PRFの起動

書式

asadmin [asadmin-options] start-prf prf-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-prfサブコマンドは、指定した名称のPRFを起動します。

このコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、起動のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、起動処理は継続します。起動のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、起動処理は継続します。起動に成功したかどうかは、list-prfsサブコマンドまたはGUIのPRFの状態により確認できます。

実行権限

一般ユーザー

前提条件

PRFを構築済みであること。

引数

prf-name

起動するPRFのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するPRFのサーバ名

デフォルト値：なし（必須）

使用例

PRF1という名称のprfを起動する場合

asadmin start-prf PRF1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.23　start-servers

サーバの一括起動

書式

asadmin [asadmin-options] start-servers

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-serversサブコマンドは、ドメイン内に存在する各種サーバを一括で起動します。サーバ間に関連（依存関係）が設定されている場合は、その依存先のサーバを先に起動します。依存関係が多い場合は、依存先の先端に当たるサーバから順に起動します。サーバ間に関連（依存関係）が設定されていない場合は、すべてのサーバに対し、並行して処理します。

すでに稼働状態のサーバに対しては、起動処理を実行しません。

このコマンドはリモートモードだけサポートします。

ノードルートディレクトリー/ノード名/Java EEサーバ名/configに出力される次のファイルは、ログ識別子をデフォルトから変更した場合やstart-instanceコマンドに"--sync=full"オプションを指定した場合、Java EEサーバ再起動のときに削除されます。必要に応じてこのサブコマンドの実行前に退避しておいてください。

サーバインスタンスのスレッドダンプログ（デフォルトのログ識別子 "javacore"）

メモリーダンプ（デフォルトのログ識別子 "core"、".core"、"*.dmp"）

エラーリポートファイル（デフォルトのログ識別子 "hs_err_pid"）

コンパイラーリプレイファイル（デフォルトのログ識別子 "replay_pid"）

実行権限

一般ユーザー

前提条件

各種サーバを構築済みであること。

使用例

ドメイン内のすべてのサーバを起動する場合

asadmin start-servers

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.24　start-webserver

Webサーバの起動

書式

asadmin [asadmin-options] start-webserver webserver-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

start-webserverサブコマンドは、指定した名称のWebサーバを起動します。

このコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、起動のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、起動処理は継続します。起動のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、起動処理は継続します。起動に成功したかどうかは、list-webserversサブマンドまたはGUIのWebサーバの状態により確認できます。

実行権限

一般ユーザー

前提条件

Webサーバを構築済みであること。

引数

webserver-name

起動するWebサーバのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するWebサーバ名

デフォルト値：なし（必須）

使用例

Web1という名称のWebサーバを起動する場合

asadmin start-webserver Web1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.25　stop-cluster

Java EE Serverのクラスターの停止

書式

asadmin [asadmin-options] stop-cluster [--help]
    [--verbose={false|true}] [--kill={false|true}] cluster-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-clusterサブコマンドは、クラスター内で実行されているすべてのサーバインスタンスを停止することによって、そのクラスターを停止します。

このサブコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、停止のタイムアウトがあります。停止のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、停止処理は継続します。停止に成功したかどうかは、KDKD20032-IのログまたはGUIのサーバインスタンスの状態により確認できます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--verbose={false|true}

クラスターを停止するときに、クラスター内のインスタンスの状態に関する追加の進捗メッセージを表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

クラスター内のインスタンスの状態に関する追加の進捗メッセージが表示されます。

false

クラスター内のインスタンスの状態に関するメッセージは表示されません。

デフォルト値：false

--kill={false|true}

サーバインスタンスのプロセスを停止するOSの機能を使用して、クラスター内の各インスタンスを強制終了するかどうかを指定します。

型：String

指定できる値を次に示します。

false

インスタンスを強制終了しません。Javaプラットフォームの機能を使用して各サーバインスタンスのプロセスを停止します。

true

各インスタンスを強制終了します。OSの機能を使用して各サーバインスタンスのプロセスを停止します。

デフォルト値：false

cluster-name

停止するクラスターの名称を指定します。

型：String

指定できる値を次に示します。

クラスター名

デフォルト値：なし

使用例

次の例では、クラスターpmdclusterを停止します。

asadmin stop-cluster pmdcluster

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.26　stop-instance

実行中のサーバインスタンスの停止

書式

asadmin [asadmin-options] stop-instance [--help]
    [--kill={false|true}] instance-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-instanceサブコマンドは、実行中のサーバインスタンスを停止します。任意のサーバインスタンスを停止できます。インスタンスが作成された方法は関係ありません。

このサブコマンドはリモートモードだけサポートします。

サーバ停止時に、標準エラーおよびlogger.logファイルにKDKD45000-Eのメッセージを出力することがありますが、終了処理に影響はありません。

サーバインスタンスを停止させる場合、ロードバランサー、Webサーバなど、フロントエンドのサーバから先に停止させてください。フロントエンドのサーバを先に停止させないで、サーバインスタンス内にリクエストが滞留している場合、予期しない例外が発生する場合があります。

なお、このサブコマンドには、停止のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、停止処理は継続します。停止のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、停止処理は継続します。停止に成功したかどうかは、KDKD20032-IのログまたはGUIのサーバインスタンスの状態により確認できます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--kill={false|true}

サーバインスタンスのプロセスを停止するOSの機能を使用して、インスタンスを強制終了するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

false

インスタンスを強制終了しません。Javaプラットフォームの機能を使用してサーバインスタンスのプロセスを停止します。

true

インスタンスを強制終了します。OSの機能を使用してサーバインスタンスのプロセスを停止します。

デフォルト値：false

instance-name

停止するサーバインスタンスの名称を指定します。

型：String

指定できる値を次に示します。

サーバインスタンス名

デフォルト値：なし

使用例

次の例では、サーバインスタンスのyml-i-sj01を停止します。

asadmin stop-instance yml-i-sj01

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.6.27　stop-prf

PRFの停止

書式

asadmin [asadmin-options] stop-prf prf-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-prfサブコマンドは、指定した名称のPRFを停止します。

このコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、停止のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、停止処理は継続します。停止のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、停止処理は継続します。停止に成功したかどうかは、list-prfsサブコマンドまたはGUIのPRF状態により確認できます。

実行権限

一般ユーザー

前提条件

PRFを起動済みであること。

引数

prf-name

停止するPRFのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するPRFのサーバ名

デフォルト値：なし（必須）

使用例

PRF1という名称のPRFを停止する場合

asadmin stop-prf PRF1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.28　stop-servers

サーバの一括停止

書式

asadmin [asadmin-options] stop-servers [--graceful {false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-serversサブコマンドは、ドメイン内の各種サーバを一括で停止します。サーバ間に関連（依存関係）が設定されている場合は、その依存元のサーバを先に停止します。依存関係が多い場合は、依存元の末端に当たるサーバから順に停止します。サーバ間に関連（依存関係）が設定されていない場合は、すべてのサーバに対し、並行して処理します。

すでに停止状態のサーバに対しては、停止処理を実行しません。

このコマンドはリモートモードだけサポートします。

WebSocketを使用している場合、クライアント・サーバ間のコネクションが残存した状態になりやすいため、Webサーバが停止できないことがあります。コネクションを強制的に切断してWebサーバを停止したい場合は、--gracefulオプションにfalseを指定して実行してください。

実行権限

一般ユーザー

前提条件

各種サーバを起動済みであること。

引数

--graceful {false|true}

Webサーバを計画的に停止するかどうかを指定します。Webサーバ以外のサーバには適用されません。

型：Boolean

指定できる値を次に示します。

true

計画停止します。

false

通常停止します。

デフォルト値：true

使用例

ドメイン内のすべてのサーバを停止する場合

asadmin stop-servers

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.29　stop-webserver

Webサーバの停止

書式

asadmin [asadmin-options] stop-webserver [--graceful {false|true}]
    webserver-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

stop-webserverサブコマンドは、指定した名称のWebサーバを停止します。

このコマンドはリモートモードだけサポートします。

なお、このサブコマンドには、停止のタイムアウトがあります。ドメイン管理サーバのリクエストタイムアウトが発生した場合、停止処理は継続します。停止のタイムアウトまたはasadminリードタイムアウトが発生した場合、サブコマンドの実行は失敗しますが、停止処理は継続します。停止に成功したかどうかは、list-webserversサブコマンドまたはGUIのWebサーバの状態により確認できます。

WebSocketを使用している場合、クライアント・サーバ間のコネクションが残存した状態になりやすいため、Webサーバが停止できないことがあります。コネクションを強制的に切断してWebサーバを停止したい場合は、--gracefulオプションにfalseを指定して実行してください。

実行権限

一般ユーザー

前提条件

Webサーバを起動済みであること。

引数

--graceful {false|true}

Webサーバを計画的に停止するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

計画停止します。

false

通常停止します。

デフォルト値：true

webserver-name

停止するWebサーバのサーバ名を指定します。

型：String

指定できる値を次に示します。

ドメインに存在するWebサーバ名

デフォルト値：なし（必須）

使用例

asadmin stop-webserver Web1

asadmin stop-webserver --graceful true Web1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.6.30　validate-multicast

マルチキャストトランスポートの検証

書式

asadmin [asadmin-options] validate-multicast
    [--help] [--multicastport multicastport]
    [--multicastaddress multicastaddress] [--bindaddress bindaddress]
    [--sendperiod sendperiod] [--timeout timeout]
    [--timetolive timetolive] [--verbose={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

validate-multicastサブコマンドは、クラスターに対してマルチキャストトランスポートが使用できるかどうかを検証します。

検証するそれぞれのホストで同時にこのサブコマンドを実行します。すべてのマシンが相互に確認できれば、それらのマシンでマルチキャストは正常に動作しています。

マシンが相互に確認できない場合は、--bindaddressオプションを設定してすべてのマシンが同じサブネット上のインターフェースを使用していることを確認するか、--timetoliveオプションの値を増やします。

これらの変更を行ってもマルチキャストの問題が解決しない場合は、ネットワーク管理者に依頼して、クラスターの実行に使用されているすべてのマシンで、マルチキャストメッセージを受信できるようにネットワークが構成されているかどうかを確認してください。

このサブコマンドはローカルモードだけサポートします。

ドメイン管理サーバおよびクラスターの実行中は、ドメイン管理サーバおよびクラスターのマルチキャストアドレスとポートの値を使用してこのサブコマンドを実行しないでください。実行すると、エラーが発生します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--multicastport multicastport

グループ管理サービスがグループイベントをリッスンするマルチキャストソケットのポートを指定します。2048から32000までの標準のUDPポート番号を指定します。

型：Integer

指定できる値を次に示します。

2048〜32000

デフォルト値：2048

--multicastaddress multicastaddress

グループ管理サービスがグループイベントをリッスンするマルチキャストソケットのアドレスを指定します。クラスDのIPアドレスを指定します。クラスDのIPアドレスは224.0.0.0から239.255.255.255までです。アドレス224.0.0.0は予約済みのため使用できません。

型：IP

指定できる値を次に示します。

224.0.0.1〜239.255.255.255

デフォルト値：228.9.3.1

--bindaddress bindaddress

グループ管理サービスのマルチキャストデータグラムパケットを受信するローカルインターフェースのIPアドレスを指定します。

型：String

指定できる値を次に示します。

ローカルインターフェースのIPアドレス

デフォルト値：使用できるすべてのローカルインターフェースのIPアドレス

--sendperiod sendperiod

ノード間でテストメッセージを送信する間隔（ミリ秒）を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：2000

--timeout timeout

サブコマンドがタイムアウトし終了するまでの秒数を指定します。このサブコマンドは、［CTRL］＋［C］を使用して終了することもできます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：20

--timetolive timetolive

マルチキャストのスコープを制御するために、マルチキャストソケットから送信されるマルチキャストパケットのデフォルトの生存期間を指定します。生存期間の値は、0から255までの範囲にする必要があります。

型：Integer

指定できる値を次に示します。

0〜255

デフォルト値：JDKのデフォルトまたはグループ管理サービスサブシステムの定数のどちらか小さい方

--verbose={false|true}

trueに設定した場合、追加のデバッグ情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

使用例

次の例では、c1という名称のクラスターに対してマルチキャストトランスポートが使用できるかどうかを確認します。

ホストsr1から実行する場合：

asadmin validate-multicast

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.7　サーバ間関連設定で使用するコマンド

サーバ間関連設定で使用するコマンドの書式、機能などについて説明します。

2.7.1　create-relation

サーバ間関連を作成

書式

asadmin [asadmin-options] create-relation
    --relationtype relation-type-name --from server-name
    --to server-name [--order order]
    [--properties name=value[:name=value]...] relation-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-relationサブコマンドは、サーバ間の関連を作成します。関連種別に対応した関連元と関連先のサーバ名を指定することで、関連を作成できます。このコマンドは関連情報を、--fromに指定したサーバの関連情報として作成します。

このコマンドはリモートモードだけサポートします。

リダイレクト関連では、次の--propertiesオプションを使用して、必要な情報を設定します。

Java EEサーバと関連する場合

プロパティ

指定内容

path

リダイレクターの動作の定義で、マッピング定義のローカルの仮想パスの名前を指定します。

network-listener

リダイレクト先となるネットワークリスナー名を指定します。

proxy-pass-option

リダイレクターの動作の定義で、マッピング定義のコネクションプーリングの調整パラメーターを指定します。

set-proxy-pass-reverse-cookie

リダイレクターの動作の定義で、Set-Cookieヘッダーの再割り当てをするかどうかを指定します。

クラスターと関連する場合

プロパティ

指定内容

stickysession

リダイレクターの動作の定義で、Stickyを有効にするかどうかを指定します。

特定のURLのパスをリダイレクトさせないようにする場合

プロパティ

指定内容

negative

リダイレクターの動作の定義で、マッピング定義に対するリクエストを除外するかどうかを指定します。

実行権限

一般ユーザー

前提条件

各種サーバを構築済みであること。

引数

--relationtype relation-type-name

関連元と関連先のサーバを関連付ける関連種別を指定します。

型：String

指定できる値を次に示します。

prf-relation

PRF関連

redirect

リダイレクト関連

デフォルト値：なし（必須）

--from server-name

関連元となるサーバ名を指定します。関連種別の関連元サーバ種別に設定されているサーバ種別のサーバを指定します。

型：String

指定できる値を次に示します。

--relationtypeがprf-relationの場合

ドメインに存在するJavaEEサーバのサーバ名

ドメインに存在するWebサーバのサーバ名

--relationtypeがredirectの場合

ドメインに存在するWebサーバのサーバ名

デフォルト値：なし（必須）

--to server-name

関連先となるサーバ名を指定します。関連種別の関連先サーバ種別に設定されているサーバ種別のサーバを指定します。

型：String

指定できる値を次に示します。

--relationtypeがprf-relationの場合

ドメインに存在するPRFのサーバ名

--relationtypeがredirectの場合

ドメインに存在するJavaEEサーバのサーバ名またはクラスター名

デフォルト値：なし（必須）

--order order

1つのWebサーバに複数のリダイレクト関連を作成する場合に、リダイレクト先の優先順位を付けるための順序番号を指定します。サーバの起動順序および停止順序には影響しません。

型：Integer

指定できる値を次に示します。

0〜65535の整数

デフォルト値：0

--properties name=value[:name=value]...

サーバ間の関連情報に適用するプロパティーを、プロパティー名と値のペアで指定します。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

name

型：String

指定できる値を次に示します。

PRFの標準プロパティーまたは拡張プロパティー(ex_から始まるプロパティー)。

value

指定できる値を次に示します。

nameに指定したプロパティーの指定範囲に従います。

デフォルト値：--relationtypeにredirectが指定されている場合は、hitachi-relation-types.hitachi-relation-type.redirect.property.標準プロパティーキーの値が適用されます。prf-relationが指定されている場合は、なし。

relation-name

サーバ間関連に設定する名称を指定します。

型：String

指定できる値を次に示します。

ASCII文字であること。

名称は次の文字で構成すること。

英小文字<a〜z>

英大文字<A〜Z>

数字<0〜9>

ハイフン<->

アンダースコア<_>

先頭文字は英大文字または英小文字を使用すること。

ドメインに存在する次の名称は指定できません。

ノード名

JavaEEサーバ名

Webサーバ名

PRFのサーバ名

クラスター名

サーバ間関連名

JavaEEサーバの構成名

次に示す名称はシステムで使用済みまたは予約語のため指定できません。

domain

server

default

server-config

default-config

default-webserver-config

default-prf-config

javaee

webserver

prf

cluster

redirect

prf-relation

HJES_で始まる名称

構築済みWebサーバ名-config

構築済みPRF名-config

デフォルト値：なし（必須）

使用例

JavaEEサーバJavaEE1とPRFPRF1に対して、PRF関連（関連種別prf-relation、関連名redirect1）を作成する場合

asadmin create-relation --relationtype prf-relation --from JavaEE1
--to PRF1 redirect1

WebサーバWeb1とJavaEEサーバJavaEE1に対して、リダイレクト関連（関連種別redirect、関連名redirect3）を作成する場合

asadmin create-relation --relationtype redirect --from Web1 --to JavaEE1
--properties path=/aaa/:network-listener=http-listener-1 redirect3

順序番号を指定して複数のリダイレクト関連を作成する場合

asadmin create-relation --relationtype redirect --from Web1 --to JavaEE1
--order 20 --properties path=/aaa/:network-listener=http-listener-1 redirect3

asadmin create-relation --relationtype redirect --from Web1 --to JavaEE2
--order 10 --properties path=/:network-listener=http-listener-1 redirect4

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.7.2　delete-relation

サーバ間関連を削除

書式

asadmin [asadmin-options] delete-relation relation-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-relationサブコマンドは、サーバ間の関連をドメインから削除します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

サーバ間関連を作成済みであること。

引数

relation-name

削除するサーバ間関連の名称を指定します。

型：String

指定できる値を次に示します。

存在するサーバ間関連の名称

デフォルト値：なし（必須）

使用例

関連redirect1を削除する場合

asadmin delete-relation redirect1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.7.3　list-relations

サーバ間関連を一覧表示

書式

asadmin [asadmin-options] list-relations [{--long={false|true} |
    --output output} [--header={false|true}]]
    [--relationtype relation-type-name] [--from server-name]
    [--to server-name] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-relationsサブコマンドは、サーバ間の関連を一覧表示します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

引数

--long={false|true}

一覧表示するサーバ間関連について、詳細情報を表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

関連名とその詳細情報（関連種別、関連元サーバ名、関連先サーバ名、順序番号）を表示します。ヘッダー情報も表示します。なお、このオプションにtrueを指定した場合は、--outputオプションは指定できません。

false

--outputオプションおよび--headerオプションの指定に従います。

デフォルト値：false

--output output

リスト表示する項目およびその順序をコンマ区切りのリストで指定します。指定値の大文字、小文字は区別されません。

リスト表示する項目は、このオプションで指定した順番に左から表示します。また、リストの行は一番左の項目でソートされて表示されます。文字列でソートするため、一番左の項目にorderを指定した場合、数値の昇順にはなりません。

このオプションを省略した場合は、関連名、関連種別、関連元サーバ名、関連先サーバ名が表示されます。ただし、--longオプションにtrueを指定した場合は、その指定に従います。

型：String

指定できる値を次に示します。

name

関連名

type

関連種別名

from

関連元サーバ名

to

関連先サーバ名

order

順序番号

デフォルト値：なし

--header={false|true}

ヘッダー情報を表示するかどうかを指定します。ただし、--longオプションにtrueを指定した場合はこのオプションの指定は無視されます。

型：Boolean

指定できる値を次に示します。

true

ヘッダー情報を表示します。

false

ヘッダー情報を表示しません。

デフォルト値：なし

--relationtype relation-type-name

フィルタリングする関連種別を指定します。

型：String

指定できる値を次に示します。

prf-relation

PRF関連

redirect

リダイレクト関連

デフォルト値：なし

指定がない場合はすべての関連種別の関連を表示します。

--from server-name

フィルタリングする関連元のサーバ名を指定します。

型：String

指定できる値を次に示します。

存在する関連元のサーバ名

デフォルト値：なし

指定がない場合はすべての関連元のサーバ名を表示します。

--to server-name

フィルタリングする関連先のサーバ名を指定します。

型：String

指定できる値を次に示します。

存在する関連先のサーバ名

デフォルト値：なし

指定がない場合はすべての関連先のサーバ名を表示します。

target

情報を表示する対象名を指定します。

型：String

指定できる値を次に示します。

domain

ドメイン内のすべての関連の情報を表示します。

関連名

指定した関連の情報を表示します。

デフォルト値：domain

出力形式

1行目は出力情報のヘッダー部となり、固定文字列で出力形式を示します。

カラム間は、カラム内で最も長い文字列と次のカラムの先頭までを、2つの半角スペースで区切ります。

NAME    TYPE      FROM          TO            ORDER
関連名  関連種別名  関連元サーバ名  関連先サーバ名  順序番号

関連名：関連の名称を表示します。

関連種別名：関連種別の名称を表示します。

関連元サーバ名：関連元となるサーバの名称を表示します。

関連先サーバ名：関連先となるサーバの名称を表示します。

順序番号：関連の順序番号を表示します。

使用例

すべてのサーバ間関連を表示する場合

asadmin list-relations

[出力例]

relation1  prf-relation       JavaEE1       PRF1
relation2  prf-relation       Web1          PRF1
relation3  redirect           Web1          JavaEE1
relation4  redirect           Web1          JavaEE2
relation5  ex_relation_type1  custom_type1  Web1

すべてのサーバ間関連とヘッダーを表示する場合

asadmin list-relations --long=true

[出力例]

NAME       TYPE               FROM          TO       ORDER
relation1  prf-relation       JavaEE1       PRF1     0
relation2  prf-relation       Web1          PRF1     0
relation3  redirect           Web1          JavaEE1  20
relation4  redirect           Web1          JavaEE2  10
relation5  ex_relation_type1  custom_type1  Web1     0

すべてのサーバ間関連とヘッダー情報なしで表示する場合

asadmin list-relations --long=true --header=false

[出力例]

relation1  prf-relation       JavaEE1       PRF1     0
relation2  prf-relation       Web1          PRF1     0
relation3  redirect           Web1          JavaEE1  20
relation4  redirect           Web1          JavaEE2  10
relation5  ex_relation_type1  custom_type1  Web1     0

関連種別がredirectの関連だけを表示する場合

asadmin list-relations --relationtype  redirect

[出力例]

relation3  redirect  Web1  JavaEE1
relation4  redirect  Web1  JavaEE2

関連元のサーバがWeb1の関連だけを表示する場合

asadmin list-relations --from Web1

[出力例]

relation2  prf-relation  Web1  PRF1
relation3  redirect      Web1  JavaEE1
relation4  redirect      Web1  JavaEE2

関連先のサーバがPRF1の関連だけを表示する場合

asadmin list-relations --to PRF1

[出力例]

relation1  prf-relation  JavaEE1  PRF1
relation2  prf-relation  Web1     PRF1

関連名relation3だけの情報を表示する場合

asadmin list-relations relation3

[出力例]

relation3  redirect  Web1  JavaEE1

関連元のサーバがWeb1、関連種別がredirectの関連の、順序番号、間連名、および関連先サーバの情報だけを順序番号でソートして表示する場合

asadmin list-relations  --relationtype  redirect  --from Web1
--output order,name,to

[出力例]

10    relation4  JavaEE2
20    relation3  JavaEE1

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.8　アプリケーション管理で使用するコマンド

アプリケーション管理で使用するコマンドの書式、機能などについて説明します。

2.8.1　create-application-ref

アプリケーション参照の作成

書式

asadmin [asadmin-options] create-application-ref [--help]
    [--target target] [--virtualservers virtual_servers]
    [--enabled={true|false}] reference_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-application-refサブコマンドは、クラスターまたはクラスター構成ではないサーバインスタンスからすでにデプロイされているアプリケーション（Java EEアプリケーション、Webモジュール、Enterprise Beanモジュール）への参照を作成します。

これによってアプリケーション要素が実際にデプロイされ、ターゲットのインスタンスまたはクラスターで使用できるようになります。

対象のインスタンスやクラスターのインスタンスが、起動していなかったり、使用できなくても、このサブコマンドは正常に実行されます。1つ以上のインスタンスがアプリケーション参照を作成できない場合、これらのインスタンスは次の起動時にアプリケーション要素を受け取ります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

このサブコマンドを使用して参照を作成するアプリケーションまたはモジュールは、事前にデプロイしておく必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するアプリケーション参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--virtualservers virtual_servers

コンマ区切りの仮想サーバIDリストをデプロイ先に指定します。このオプションはWeb モジュール（スタンドアロンまたはJava EE アプリケーション内のどれか）にだけ適用されます。このオプションを指定しない場合、アプリケーションは管理対象サーバ、__asadmin以外のすべての仮想サーバにデプロイされます。

型：String

指定できる値を次に示します。

指定したコンマ区切りの仮想サーバIDリストの名称

デフォルト値：なし

--enabled={true|false}

アプリケーションを有効にする（ロードする）必要があるかどうかを示します。この値は、アプリケーションがグローバルレベルで有効な場合にだけ有効になります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

reference_name

アプリケーション名またはモジュール名を指定します。次のものが含まれます。名称にはオプションでバージョン識別子を入れることができます。この場合、名称の後にコロン（:）で区切って追加します。次に示すアプリケーション名またはモジュール名を指定できます。

型：String

指定できる値を次に示します。

JavaEEアプリケーション

Webモジュール

EJBモジュール

リソースアダプターアーカイブ

アプリケーションクライアントのモジュール

ライフサイクルモジュール

デフォルト値：なし

使用例

次の例では、クラスター構成ではないサーバインスタンス上のWebモジュールMyWebAppへのアプリケーション参照を作成します。

asadmin create-application-ref --target NewServer MyWebApp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.2　delete-application-ref

アプリケーション参照の削除

書式

asadmin [asadmin-options] delete-application-ref [--help]
    [--target target] [--cascade={false|true}] reference_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-application-refサブコマンドは、クラスターまたはクラスター構成ではないサーバインスタンスから、アプリケーション参照を削除します。これによって、アプリケーション要素は対象のインスタンス上またはクラスター上でアンデプロイされ、使用できなくなります。

このサブコマンドを実行するとき、クラスターを構成する対象のインスタンスが、実行中または使用できる状態である必要はありません。

1つ以上のインスタンスが使用できない場合、それらのインスタンスは次回の起動時にアプリケーションをロードしなくなります。

アプリケーション参照を削除しても、アプリケーションがドメインから削除されることはありません。アプリケーションを削除できるのはundeployサブコマンドだけです。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するアプリケーション参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--cascade={false|true}

リソースアダプターアーカイブに関し、モジュールに依存するリソースも再帰的に削除するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

reference_name

次に示すアプリケーションまたはモジュールの名称を指定します。

Java EEアプリケーションアーカイブ

Webモジュール

EJBモジュール

リソースアダプターアーカイブ

アプリケーションクライアントのモジュール

ライフサイクルモジュール

型：String

指定できる値を次に示します。

アプリケーション名、またはモジュール名

デフォルト値：なし

使用例

次の例では、クラスター構成ではないサーバインスタンスNewServerから、WebモジュールMyWebAppへのアプリケーション参照を削除します。

asadmin delete-application-ref --target NewServer MyWebApp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.3　deploy

コンポーネントのデプロイ

書式

asadmin [asadmin-options] deploy [--help]
    [--force={false|true}]
    [--virtualservers virtual_servers]
    [--contextroot context_root]
    [--precompilejsp={false|true}]
    [--name component_name]
    [--upload={true|false}]
    [--retrieve local_dirpath]
    [--deploymentplan deployment_plan]
    [--altdd alternate_deploymentdescriptor]
    [--runtimealtdd runtime_alternate_deploymentdescriptor]
    [--deploymentorder deployment_order]
    [--enabled={true|false}]
    [--generatermistubs={false|true}]
    [--availabilityenabled={false|true}]
    [--libraries jar_file[,jar_file]...]
    [--target target]
    [--type pkg-type]
    [--properties name=value[:name=value]...]
    file_archive|filepath

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

deployサブコマンドは、アプリケーションをサーバにデプロイします。アプリケーションには、エンタープライズアプリケーション、Webアプリケーション、EJBモジュール、リソースアダプターアーカイブ、およびアプリケーションクライアントのモジュールがあります。コンポーネントがすでにデプロイされている場合、--force オプションに true を設定すると、強制的にリデプロイされます。

このサブコマンドはリモートモードだけサポートします。

アプリケーションのデプロイの実行時にドメイン管理サーバでOutOfMemoryErrorが発生した場合、ドメイン管理サーバのJavaヒープが不足している可能性があります。ドメイン管理サーバのJavaヒープサイズは、デプロイするアプリケーションアーカイブのサイズを考慮したサイズにしてください。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

file_archiveまたはfilepathには、コマンドでデプロイされる入力ファイルを与えます。

--retrieveオプションを使用すると、--retrieveオプションで指定したファイルパスにクライアントスタブのJARファイルを生成します。

--deploymentplanオプションには、Java EE RIのDDを含む入力JARファイルを与えます。

--altddオプションには、標準DDを含む入力JARファイルを与えます。

--runtimealtddオプションには、Java EE RIのDDを与えます。

--generatermistubsオプションを使用すると、静的RMI-IIOPスタブが生成され、client.jarに包含されます。

--librariesオプションには、デプロイされたアプリケーションで利用できる入力ライブラリーJARファイルを与えます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--force={false|true}

指定したコンポーネントがすでにデプロイされている場合に、コンポーネントをリデプロイするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--virtualservers virtual_servers

仮想サーバIDを指定します。複数のIDはコンマ（,）で区切ります。

型：String

指定できる値を次に示します。

仮想サーバID

デフォルト値：なし

--contextroot context_root

アプリケーションのコンテキストルートを指定します。アーカイブがWebモジュールの場合にだけ有効です。

型：String

指定できる値を次に示します。

Webモジュールのコンテキストルート

デフォルト値：Webモジュールのアーカイブファイル（拡張子なし）

--precompilejsp={false|true}

Webアプリケーションのデプロイ中に、Webアプリケーションが同梱するJSPファイルを、Java EEサーバが事前コンパイルするかどうかを指定します。事前コンパイルでは、Webアプリケーションに含まれる次の拡張子のファイルは、すべてコンパイルされます。

jsp

jspx

なお、JSPセグメントがWebアプリケーションに含まれる場合、JSPセグメントのファイル名に上記の拡張子を指定しないでください。JSPセグメントはJSP構文として成立しないことがあります。そのため、JSPセグメントのファイル名の拡張子に"jsp"または"jspx"を指定すると、JSP構文として成立しないJSPセグメントも事前コンパイルされ、コンパイルエラーとなる場合があります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--name component_name

デプロイするコンポーネントの名称を指定します。

名称にはオプションでバージョン識別子を入れることができます。この場合、名前の後にコロン（:）で区切って追加します。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。

型：String

指定できる値を次に示します。

コンポーネント名

デフォルト値：なし

--upload={true|false}

ファイルをドメイン管理サーバにアップロードするかどうかを指定します。

filepathにディレクトリーが指定された場合、このオプションは無視されます。

型：Boolean

指定できる値を次に示します。

false

ファイルをアップロードしないで、指定したファイル名でファイルへのアクセスを試みます。ドメイン管理サーバがファイルにアクセスできない場合、このサブコマンドは失敗します。

例えば、ドメイン管理サーバが管理ユーザーとは異なるユーザーとして稼働している可能性があり、ファイルへのアクセス権がドメイン管理サーバにない場合があります。この状況では、--uploadオプションをfalseに設定すると、サブコマンドは失敗します。

true

ネットワーク接続経由でファイルをドメイン管理サーバにアップロードします。

デフォルト値：

サブコマンドを実行するホスト上にドメイン管理サーバがある場合

false

リモートホスト上にドメイン管理サーバがある場合

true

--retrieve local_dirpath

サーバマシンからローカルディレクトリーにクライアントスタブのJARファイルを取得します。

型：String

指定できる値を次に示します。

クライアントスタブのJARファイルの格納先ディレクトリーパス

デフォルト値：なし

--deploymentplan deployment_plan

Java EE RIのDDを含むJARファイルである、デプロイメントプランをデプロイします。

型：String

指定できる値を次に示します。

JARファイル名

デフォルト値：なし

--altdd alternate_deploymentdescriptor

アプリケーションアーカイブの外にある標準DDを使用してアプリケーションをデプロイします。

代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。例えばEARの場合は、--altddオプションはapplication.xmlファイルをオーバーライドします。スタンドアロンモジュールの場合、--altddオプションはweb.xmlなどの最上位のモジュール記述子をオーバーライドします。

型：String

指定できる値を次に示します。

標準DD

デフォルト値：なし

--runtimealtdd runtime_alternate_deploymentdescriptor

アプリケーションアーカイブの外にあるJava EE RIのDDを使用してアプリケーションをデプロイします。

代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。

スタンドアロンモジュールの場合、-runtimealtddオプションはglassfish-web.xmlなどの最上位のモジュール記述子をオーバーライドします。Java EE ServerのDDだけに適用されます（glassfish-*.xml）。代替となるDDファイルの名称は、glassfish-で始まる必要があります。非推奨のsun-*.xml DDには適用されません。

型：File

指定できる値を次に示します。

Java EE RIのDDのファイル名

デフォルト値：なし

--deploymentorder deployment_order

アプリケーションのデプロイ順序を指定します。

小さい数値のアプリケーションは、大きい数値のアプリケーションの前にロードされます。

2つのアプリケーションのデプロイ順序が同じ場合、最初にデプロイされたアプリケーションがサーバ起動時に先にロードされます。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：100

--enabled={true|false}

ユーザーがアプリケーションにアクセスできるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--generatermistubs={true|false}

スタブを生成するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--availabilityenabled={false|true}

Stateful Session Beanのチェックポインティングと潜在的なパッシべーション、およびWebセッションに対して、高可用性を有効にするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--libraries jar_file[,jar_file]...

add-libraryサブコマンドでJava EE Serverに追加したライブラリーJARファイルをコンマ区切りで指定します。ライブラリーJARファイルは、domain-dir/lib/applibsに対する相対パスで指定します。

型：String

デフォルト値：なし

--target target

デプロイする対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

ドメインが初期デプロイの対象の場合、アプリケーションはドメインにデプロイされます。このとき、サーバインスタンスまたはクラスターはアプリケーションを参照しません。ドメインがリデプロイの対象（--forceオプションでtrueを設定）で、アプリケーションを参照するクラスターまたはサーバインスタンスに対して動的再構成が有効な場合、参照しているクラスターまたはサーバインスタンスは自動的に新しいバージョンのアプリケーションを取得します。ドメインがリデプロイの対象で動的再構成が無効の場合、参照しているクラスターまたはサーバインスタンスは、クラスターまたはスタンドアロンのサーバインスタンスが再起動するまで新しいバージョンのアプリケーションを取得しません。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--type pkg-type

デプロイする対象コンポーネントのアーカイブの形式を指定します。

型：String

指定できる値を次に示します。

car

コンポーネントはCARファイルとしてパッケージされます。

ear

コンポーネントはEARファイルとしてパッケージされます。

ejb

コンポーネントはJARファイルとしてパッケージされたEJBになります。

rar

コンポーネントはRARファイルとしてパッケージされます。

war

コンポーネントはWARファイルとしてパッケージされます。

デフォルト値：なし

--properties name=value | --property name=value

デプロイメントに追加するプロパティーをキーと値のペア（キー = 値）で指定します。

型：String

デプロイメントには次のプロパティーを指定できます。

preserveAppScopedResources={false|true}

trueを設定した場合、アプリケーションスコープのすべてのリソースを保存し、リデプロイのあいだに復元します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

これら以外に利用できるプロパティーは、リデプロイするコンポーネントの実装によって決まります。

デフォルト値：なし

file_archive|filepath

デプロイするアプリケーションを含むアーカイブへのパスを指定します。

型：String

アプリケーションを含むアーカイブファイルへのパス

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、Cart.earファイルに含まれるエンタープライズアプリケーションをデプロイします。

asadmin deploy --target instance1 Cart.ear

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.4　disable

コンポーネントの無効化

書式

asadmin [asadmin-options] disable [--help]
    [--target target] component_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

disableサブコマンドは、指定したデプロイ済みコンポーネントをただちに無効にします。コンポーネントがデプロイされていない場合は、エラーメッセージが返ります。

このサブコマンドはリモートモードだけサポートします。

このサブコマンドはリモートでコンポーネントを無効にするとき、サーバと通信します。この通信に対するタイムアウト時間を、asenvファイルのAS_ADMIN_READ_TIMEOUTパラメーターで設定できます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

サブコマンドのヘルプテキストを表示します。

--target target

無効にするコンポーネントの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

スタンドアロンのサーバインスタンス、もしくは、クラスター内のサーバインスタンスを単体で、対象とします。

デフォルト値：server

component_name

無効にするコンポーネントの名称を指定します。

型：String

コンポーネント名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスにデプロイされたコンポーネントsampleAppを無効にします。

asadmin disable --target instance1 sampleApp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

コンポーネントをアンデプロイ、または参照を削除するとメモリーからインスタンスが解放されますが、コンポーネントを無効化（disableコマンドを実行）した状態ではインスタンスが解放されません。多量のコンポーネントを無効化した場合、使用中のメモリーが増えてOutOfMemoryErrorが発生しやすくなる場合があるため注意してください。

2.8.5　enable

コンポーネントの有効化

書式

asadmin [asadmin-options] enable [--help]
    [--target target] component_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

enableサブコマンドは、指定したデプロイ済みコンポーネントを有効にします。コンポーネントがすでに有効である場合には、再度有効化されます。デプロイされていない場合、エラーメッセージが返ります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

有効にするコンポーネントの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

スタンドアロンのサーバインスタンス、もしくは、クラスター内のサーバインスタンスを単体で、対象とします。

デフォルト値：server

component_name

オプションのバージョンIDを含むコンポーネントの名称を指定します。IDはコロン（:）で区切って名称に続けます。

バージョンIDの先頭は、文字か数字である必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。

型：String

指定できる値を次に示します。

コンポーネント名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、無効になっているsampleAppという名称のコンポーネントを有効にします。

asadmin enable --target instance1 sampleApp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.6　get-client-stubs

クライアントスタブのJARファイルの取得

書式

asadmin [asadmin-options] get-client-stubs [--help]
    --appname application_name
    local_directory_path

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

get-client-stubsサブコマンドは、アプリケーションクライアントのスタンドアロンモジュールまたはアプリケーションクライアントのモジュールを含むアプリケーション用のクライアントスタブJARファイルを、サーバマシンからローカルディレクトリーに取得します。生成されたクライアントスタブJARファイルは、サポートするすべてのJARファイルとともに取得されます。クライアントスタブJARファイル名は、アプリケーション名Client.jar の形式です。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

get-client-stubsサブコマンドを実行する前に、アプリケーションまたはモジュールをデプロイしておく必要があります。

ファイル

get-client-stubsサブコマンドは、アプリケーションクライアントのスタンドアロンモジュールまたはアプリケーションクライアントのモジュールを含むアプリケーション用のクライアントスタブJARファイルを、サーバマシンからローカルディレクトリーに取得します。

クライアントスタブJARファイル名は、アプリケーション名Client.jar の形式です。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--appname application_name

アプリケーションクライアントのモジュールまたはスタンドアロンのアプリケーションクライアントのモジュールの名称を指定します。

名称には任意のバージョンIDを指定できます。この場合、名称の後にコロン（:）で区切って追加します。バージョンIDの先頭は文字か数字である必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

local_directory_path

クライアントスタブのJARファイルを格納するディレクトリーのパスを指定します。

型：String

指定できる値を次に示します。

ディレクトリーのパス

デフォルト値：なし

使用例

次の例では、デプロイ済みであるmyapplicationという名称のアプリケーションのクライアントスタブを取得します。

asadmin get-client-stubs --appname myapplication

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.7　list-application-refs

既存のアプリケーション参照の一覧表示

書式

asadmin [asadmin-options] list-application-refs [--help]
    [--long={false|true}] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-application-refsサブコマンドは、クラスターまたはクラスター化されていないサーバインスタンスにあるすべてのアプリケーション参照を一覧表示します。指定した対象に配備されているモジュールはすべて一覧表示されます。複数のバージョンのモジュールまたはアプリケーションが配備されている場合、このサブコマンドはすべてのバージョンを一覧表示します。

このサブコマンドを正常に実行するために、クラスターを構成している対象のインスタンスが実行中または使用できる状態である必要はありません。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true}

trueを指定した場合、一覧表示される各モジュールまたはアプリケーションが有効になっているかどうかが表示されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

target

一覧表示するアプリケーション参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、クラスター化されていないサーバインスタンスNewServerのアプリケーション参照を一覧表示します。

asadmin list-application-refs NewServer

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.8　list-applications

デプロイ済みアプリケーションの一覧表示

書式

asadmin [asadmin-options] list-applications [--help]
    [--long={false|true}] [--resources] [--subcomponents]
    [--type type] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-applicationsサブコマンドは、デプロイされたJava EEアプリケーションと各アプリケーションの種類を一覧表示します。複数のバージョンのモジュールまたはアプリケーションがデプロイされている場合、このサブコマンドはすべてのバージョンを一覧表示します。

--typeオプションが指定されていない場合、すべてのアプリケーションが一覧表示されます。--typeオプションを指定する場合、種類を指定する必要があります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--long={false|true}

trueを指定した場合、一覧表示される各モジュールまたはアプリケーションが有効になっているかどうかが表示されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--resources

各アプリケーションのアプリケーションスコープのリソースを一覧表示します。

--subcomponentsオプションも使用した場合、アプリケーション内のコンポーネントごとにアプリケーションスコープのリソースを一覧表示します。

--subcomponents

各アプリケーションのサブコンポーネントを一覧表示します。

一覧表示されるサブコンポーネントはアプリケーションの種類によって異なります。例えば、Java EEアプリケーション（EARファイル）ではモジュールが一覧表示されます。WebアプリケーションではサーブレットとJSPページが一覧表示されます。EJBモジュールではEJBサブコンポーネントが一覧表示されます。

--type type

一覧表示するアプリケーションの種類を指定します。

型：String

指定できる値を次に示します。

application

appclient

connector

ejb

web

webservice

デフォルト値：なし（すべてのアプリケーションが一覧表示されます）

target

このサブコマンドを実行する対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、Webアプリケーションを一覧表示します。

asadmin list-applications --type web

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

Java EE Serverで提供しているGUIやオンラインヘルプがこのコマンドの結果として表示されます。これらは製品の動作に必要なアプリケーションのため、アンデプロイなどの操作をしないでください。

__internal_adminをアンデプロイしてしまった場合、Administration Consoleにアクセスできなくなります。回復するためには、コマンドプロンプトから手動で次のコマンドを実行してください。

asadmin deploy --name __internal_admin --contextroot
admin "Application Serverインストールディレクトリー¥javaee¥glassfish¥admin¥admin"

__internal_manualをアンデプロイした場合には、GUIのオンラインヘルプやメッセージIDが表示されなくなります。回復するためには、コマンドプロンプトから手動で次のコマンドを実行してください。

asadmin deploy --name __internal_manual --contextroot
manual "Application Serverインストールディレクトリー¥common¥docs"

2.8.9　list-containers

アプリケーションコンテナーの一覧表示

書式

asadmin [asadmin-options] list-containers [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-containersサブコマンドは、アプリケーションコンテナーのリストを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、現在のアプリケーションコンテナーを一覧表示します。

asadmin list-containers

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.10　list-modules

Java EE Serverモジュールの一覧表示

書式

asadmin [asadmin-options] list-modules [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-modulesサブコマンドは、Java EE Serverからアクセス可能なモジュールの一覧を表示します。サブコマンドを実行すると各モジュールのバージョンが表示されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、Java EE Serverからアクセス可能なモジュールの一覧を表示します。

asadmin list-modules

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.11　list-sub-components

デプロイされたモジュール内またはデプロイされたアプリケーションモジュール内のEJBまたはサーブレットのコンポーネントの一覧表示

書式

asadmin [asadmin-options] list-sub-components [--help]
    [--type type]
    [--appname appname] [--resources]
    modulename

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-sub-componentsサブコマンドは、デプロイされたモジュール内、またはデプロイされたアプリケーションのモジュール内のEJBまたはサーブレットのコンポーネントを一覧表示します。アプリケーション内の特定のモジュールを表示するには、--appnameオプションでモジュール名を指定する必要があります。モジュールが指定されていない場合、すべてのモジュールが一覧表示されます。--appnameオプションは、指定されたモジュールがスタンドアロンの場合だけ機能します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

--appnameオプションは、指定されたモジュールがスタンドアロンの場合にだけ機能します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--type type

一覧表示するコンポーネントのタイプを指定します。指定がない場合、すべてのコンポーネントが一覧表示されます。

型：String

指定できる値を次に示します。

ejb

servlet

デフォルト値：すべてのコンポーネント

--appname appname

アプリケーション名を指定します。

このオプションは、デプロイされたアプリケーションの組み込みモジュールのサブコンポーネントを出力する場合には必須です。

アプリケーション名にはオプションのバージョン識別子を入れることができます。このバージョン識別子は、アプリケーション名のあとにコロン（:）で区切ります。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）、およびピリオド（.）です。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

--resources

各サブコンポーネントのアプリケーションスコープのリソースを一覧表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

modulename

サブコンポーネントを含むモジュールの名称を指定します。

型：String

指定できる値を次に示します。

モジュール名

デフォルト値：なし

使用例

次の例では、mejb.jarモジュール内のMEjbAppアプリケーションのサブコンポーネントを一覧表示します。

asadmin list-sub-components --appname MEjbApp mejb.jar

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.12　list-timers

サーバインスタンスが所有する永続タイマーの一覧表示

書式

asadmin [asadmin-options] list-timers [--help] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-timersサブコマンドは、指定されたサーバインスタンスまたはサーバインスタンスのクラスターが所有する永続タイマーを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するタイマーの対象を指定します。

対象がスタンドアロンのサーバインスタンスの場合、インスタンスが所有するタイマーの数が一覧表示されます。対象がクラスターの場合、クラスターにある各インスタンスが所有するタイマーの数が一覧表示されます。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

standalone_instance_name

指定した名称のスタンドアロンのサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、指定したスタンドアロンのサーバインスタンスにある永続タイマーを一覧表示します。

asadmin list-timers server

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.13　list-web-context-param

デプロイされたWebアプリケーションまたはモジュールのServletContext初期化パラメーターの一覧表示

書式

asadmin [asadmin-options] list-web-context-param [--help]
    [--name=context-param-name] application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-web-context-paramサブコマンドは、次のどちらかについてServletContext初期化パラメーターを一覧表示します。

デプロイされたWebアプリケーション

デプロイされたJava EEアプリケーションのWebモジュール

list-web-context-paramサブコマンドは、set-web-context-paramサブコマンドで事前に設定されたパラメーターだけを一覧表示します。アプリケーションのDDだけで設定されたパラメーターは一覧表示しません。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

アプリケーションがすでにデプロイされている必要があります。それ以外の場合は、エラーが発生します。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されています。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=context-param-name

一覧表示するServletContext初期化パラメーターの名称を指定します。

型：String

指定できる値を次に示します。

ServletContext初期化パラメーターの名称

デフォルト値：事前に設定されたアプリケーションのすべてのパラメーター

application-name/module

アプリケーションの名称を指定します。アプリケーションの名称は、list-applicationsサブコマンドを使用して取得できます。

moduleは、ServletContext初期化パラメーターがJava EEアプリケーションのWebモジュールに適用される場合だけ必要です。

アプリケーション名に加えてモジュール名を指定する場合は、myApp/myWebModule.warとなります。

moduleオプションは、スラッシュ（/）で区切ってapplication-nameオプションのあとに指定する必要があります。

型：String

指定できる値を次に示します。

application-name

アプリケーション名を指定します。

module

モジュール名を指定します。

デフォルト値：なし

使用例

次の例では、set-web-context-paramサブコマンドで設定されたWebアプリケーションbasic-ezcompのすべてのServletContext初期化パラメーターを一覧表示します。

asadmin list-web-context-param basic-ezcomp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.14　list-web-env-entry

デプロイされたWebアプリケーションまたはモジュールの環境エントリーの一覧表示

書式

asadmin [asadmin-options] list-web-env-entry [--help]
    [--name=env-entry-name] application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-web-env-entryサブコマンドは、次の項目のどちらかについて環境エントリーを一覧表示します。

デプロイされたWebアプリケーション

デプロイされたJava EEアプリケーションのWebモジュール

list-web-env-entryサブコマンドは、set-web-env-entryサブコマンドで事前に設定されたパラメーターだけを一覧表示します。アプリケーションのDDだけで設定されたパラメーターは一覧表示しません。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

アプリケーションがデプロイ済みである必要があります。それ以外の場合は、エラーが発生します。

moduleオプションは、スラッシュ（/）で区切ってapplication-nameオプションのあとに指定する必要があります。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されています。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=env-entry-name

一覧表示する環境エントリーの名称を指定します。

型：String

指定できる値を次に示します。

環境エントリーの名称

デフォルト値：アプリケーションに対して事前に設定されたすべての環境エントリー

application-name/module

アプリケーションの名称を指定します。名称は、list-applicationsサブコマンドを使用して取得できます。

moduleは、環境エントリーがJava EEアプリケーションのWebモジュールに適用される場合だけ必要です。

アプリケーション名に加えてモジュール名を指定する場合は、myApp/myWebModule.warとなります。

型：String

指定できる値を次に示します。

application-name

アプリケーション名を指定します。

module

モジュール名を指定します。

デフォルト値：なし

使用例

次の例では、set-web-env-entryサブコマンドを使用してWebアプリケーションhelloに設定されたすべての環境エントリーを一覧表示します。

asadmin list-web-env-entry hello

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.15　redeploy

コンポーネントのリデプロイ

書式

asadmin [asadmin-options] redeploy [--help]
    --name component_name
    [--upload={true|false}]
    [--retrieve local_dirpath]
    [--deploymentplan deployment_plan]
    [--altdd alternate_deploymentdescriptor]
    [--runtimealtdd runtime_alternate_deploymentdescriptor]
    [--deploymentorder deployment_order]
    [--enabled={true|false}]
    [--generatermistubs={false|true}]
    [--contextroot context_root]
    [--precompilejsp={true|false}]
    [--virtualservers virtual_servers]
    [--libraries jar_file[,jar_file]...]
    [--target target]
    [--type pkg-type]
    [--properties name=value[:name=value]...]
    file_archive|filepath

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

redeployサブコマンドは、デプロイ済みまたは既存のエンタープライズアプリケーション、Webアプリケーション、EJBモジュール、リソースアダプターアーカイブ、またはアプリケーションクライアントのモジュールをリデプロイします。

redeployサブコマンドは、アプリケーションが最初にデプロイされたときの設定およびほかのオプションを保存します。

このサブコマンドはリモートモードだけサポートします。

アプリケーションのデプロイの実行時にドメイン管理サーバでOutOfMemoryErrorが発生した場合、ドメイン管理サーバのJavaヒープが不足している可能性があります。ドメイン管理サーバのJavaヒープサイズは、デプロイするアプリケーションアーカイブのサイズを考慮したサイズにしてください。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

file_archiveまたはfilepathには、コマンドでデプロイされる入力ファイルを与えます。

--retrieveオプションを使用すると、--retrieveオプションで指定したファイルパスにクライアントスタブのJARファイルを生成します。

--deploymentplanオプションには、Java EE RIのDDを含む入力JARファイルを与えます。

--altddオプションには、標準DDを含む入力JARファイルを与えます。

--runtimealtddオプションには、Java EE RIのDDを与えます。

--generatermistubsオプションを使用すると、静的RMI-IIOPスタブが生成され、client.jarに包含されます。

--librariesオプションには、デプロイされたアプリケーションで利用できる入力ライブラリーJARファイルを与えます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--virtualservers virtual_servers

仮想サーバIDを指定します。複数のIDはコンマ（,）で区切ります。

型：String

指定できる値を次に示します。

仮想サーバID

デフォルト値：なし

--contextroot context_root

アプリケーションのコンテキストルートを指定します。アーカイブがWebモジュールの場合にだけ有効です。

型：String

指定できる値を次に示します。

Webモジュールのコンテキストルート

デフォルト値：Webモジュールのアーカイブファイル（拡張子なし）

--precompilejsp={true|false}

デプロイ中にJSPを事前コンパイルするかどうかを指定します。

コンパイルエラー発生時、エラー内容によっては原因のファイル名が表示されない場合があります。この場合は、jspcコマンドによってjspコマンドを一つ一つコンパイルすることで、原因のファイルを特定してください。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--name component_name

デプロイするコンポーネントの名称を指定します。

名称にはオプションでバージョン識別子を入れることができます。この場合、名前の後にコロン（:）で区切って追加します。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。

型：String

指定できる値を次に示します。

コンポーネント名

デフォルト値：なし

--upload={true|false}

ファイルをドメイン管理サーバにアップロードするかどうかを指定します。

filepathにディレクトリーが指定された場合、このオプションは無視されます。

型：Boolean

指定できる値を次に示します。

false

ファイルをアップロードしないで、指定したファイル名でファイルへのアクセスを試みます。ドメイン管理サーバがファイルにアクセスできない場合、このサブコマンドは失敗します。

例えば、ドメイン管理サーバが管理ユーザーとは異なるユーザーとして稼働している可能性があり、ファイルへのアクセス権がドメイン管理サーバにない場合があります。この状況では、--uploadオプションをfalseに設定すると、サブコマンドは失敗します。

true

ネットワーク接続経由でファイルをドメイン管理サーバにアップロードします。

デフォルト値：

サブコマンドを実行するホスト上にドメイン管理サーバがある場合

false

リモートホスト上にドメイン管理サーバがある場合

true

--retrieve local_dirpath

サーバマシンからローカルディレクトリーにクライアントスタブのJARファイルを取得します。

型：String

指定できる値を次に示します。

クライアントスタブのJARファイルの格納先ディレクトリーパス

デフォルト値：なし

--deploymentplan deployment_plan

Java EE RIのDDが含まれたJARファイルであるデプロイメントプランをデプロイします。

純粋なEARファイルをデプロイするときにこのオプションを指定します。純粋なEARファイルとは、Java EE Serverの記述子がないEARです。

型：String

指定できる値を次に示します。

JARファイル名

デフォルト値：なし

--altdd alternate_deploymentdescriptor

アプリケーションアーカイブの外にある標準DDを使用してアプリケーションをデプロイします。

代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。例えばEARの場合は、--altddオプションはapplication.xmlファイルをオーバーライドします。スタンドアロンモジュールの場合、--altddオプションはweb.xmlなどの最上位のモジュール記述子をオーバーライドします。

型：String

指定できる値を次に示します。

DDファイルへのパス

デフォルト値：なし

--runtimealtdd runtime_alternate_deploymentdescriptor

アプリケーションアーカイブの外にあるJava EE RIのDDを使用してアプリケーションをデプロイします。

代替となるDDは、アーカイブに含まれる最高位のDDをオーバーライドします。

スタンドアロンモジュールの場合、-runtimealtddオプションはglassfish-web.xmlなどの最上位のモジュール記述子をオーバーライドします。Java EE ServerのDDだけに適用されます（glassfish-*.xml）。代替となるDDファイルの名称は、glassfish-で始まる必要があります。非推奨のsun-*.xml DDには適用されません。

型：String

指定できる値を次に示します。

代替となるDDファイルへの絶対パスまたは相対パスを指定します。

相対パスは、Application Serverインストールディレクトリー/javaee/glassfish/binです。

デフォルト値：なし

--deploymentorder deployment_order

アプリケーションのデプロイ順序を指定します。

小さい数値のアプリケーションは、大きい数値のアプリケーションの前にロードされます。

2つのアプリケーションのデプロイ順序が同じ場合、最初にデプロイされたアプリケーションがサーバ起動時に先にロードされます。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：100

--enabled={true|false}

ユーザーがアプリケーションにアクセスできるかどうかを指定します。

対象ドメインにデプロイする場合、特定のインスタンスまたはクラスターへのデプロイはしないため、このオプションは無視されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--generatermistubs={false|true}

trueに設定すると、静的RMI-IIOPスタブが生成され、client.jarに追加されます。falseに設定すると、スタブは生成されません。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--libraries jar_file[,jar_file]...

add-libraryサブコマンドでJava EE Serverに追加したライブラリーJARファイルをコンマ区切りで指定します。ライブラリーJARファイルは、domain-dir/lib/applibsに対する相対パスで指定します。

型：String

指定できる値を次に示します。

コンマ区切りのライブラリーJARファイルのリスト

デフォルト値：なし

--target target

デプロイ先の対象を指定します。

ドメインが初回デプロイの対象の場合、アプリケーションはドメインにデプロイされますが、サーバインスタンスおよびクラスターはアプリケーションを参照しません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

ドメインが初回デプロイの対象の場合、アプリケーションはドメインにデプロイされますが、サーバインスタンスおよびクラスターはアプリケーションを参照しません。

ドメインがリデプロイの対象で、アプリケーションを参照するクラスターまたはサーバインスタンスの動的構成が有効になっている場合、参照しているクラスターまたはサーバインスタンスはアプリケーションの新しいバージョンを自動的に取得します。

動的構成が無効な状態でリデプロイする場合、参照しているクラスターまたはサーバインスタンスは、クラスター化されたまたはスタンドアロンのサーバインスタンスが再起動するまでアプリケーションの新しいバージョンを取得しません。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--type pkg-type

デプロイするコンポーネントのアーカイブの形式を指定します。

型：String

指定できる値を次に示します。

car

コンポーネントはCARファイルとしてパッケージされます。

ear

コンポーネントはEARファイルとしてパッケージされます。

ejb

コンポーネントはJARファイルとしてパッケージされたEJBです。

rar

コンポーネントはRARファイルとしてパッケージされます。

war

コンポーネントはWARファイルとしてパッケージされます。

デフォルト値：なし

{--properties | --property} name=value[:name=value]...

デプロイのプロパティーをプロパティー名と値のペアで指定します。

使用できるプロパティーは、デプロイまたはリデプロイされているコンポーネントの実装で決まります。--propertiesオプションと--propertyオプションは同じです。指定するプロパティーの数に関係なく、どちらのオプションも利用できます。

型：String

デプロイには次のプロパティーを指定できます。

preserveAppScopedResources={false|true}

trueに設定すると、アプリケーションスコープのリソースを保持し、リデプロイ中に復元されます。

その他の利用できるプロパティーは、リデプロイされているコンポーネントの実装で決まります。

その他のプロパティーは修飾プロセスで使用されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

file_archive|filepath

リデプロイするアプリケーションを含むアーカイブへのパスを指定します。相対パスまたは絶対パスのどちらでも指定できます。相対パスは、Application Serverインストールディレクトリー/javaee/glassfish/binです。

ディレクトリーまたはアーカイブファイルを指定できます。

型：String

指定できる値を次に示します。

アーカイブへのパス

デフォルト値：なし

使用例

次の例では、Webアプリケーションhellodirをリデプロイします。アプリケーションは、instance1という名称のサーバインスタンス上のディレクトリーから初期設定でリデプロイされます。

asadmin redeploy --target instance1 --name hellodir

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.16　set-web-context-param

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定

書式

asadmin [asadmin-options] set-web-context-param
    [--help] --name=context-param-name
    {--value=value|--ignoredescriptoritem={false|true}}
    [--description description] application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

set-web-context-paramサブコマンドは、次のどちらかの項目のServletContext初期化パラメーターを設定します。

デプロイ済みのWebアプリケーション

デプロイ済みのJava EEアプリケーション内のWebモジュール

このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。

デプロイ済みのアプリケーションのServletContext初期化パラメーターを設定した場合、ドメイン管理サーバまたはサーバインスタンスを再起動する必要があります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

アプリケーションがデプロイされている必要があります。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=context-param-name

設定するServletContext初期化パラメーターの名称を指定します。

型：String

指定できる値を次に示します。

パラメーター名

デフォルト値：なし

--value=value

ServletContext初期化パラメーターに設定する値を指定します。

--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

型：String

指定できる値を次に示します。

パラメーター値

デフォルト値：なし

--ignoredescriptoritem={false|true}

ServletContext初期化パラメーターがアプリケーションのDDに設定されている場合、そのパラメーターを無視するかどうかを指定します。パラメーターを無視する場合、アプリケーションはDDにパラメーターが設定されたことがないかのように動作します。この状況でのアプリケーションの動作は、アプリケーションによって異なります。

型：Boolean

指定できる値を次に示します。

false

値は無視されません。

true

値は無視されます。--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

set-web-context-paramサブコマンドで以前に設定したServletContext初期化パラメーターの設定を取り消す場合、--ignoredescriptoritemオプションを使用しないでください。代わりにunset-web-context-paramサブコマンドを使用してください。

デフォルト値：false

--description description

設定するコンテキストパラメーターの説明となるテキストを指定します。

型：String

指定できる値を次に示します。

環境エントリーの説明

デフォルト値：なし

application-name

アプリケーションの名称を指定します。この名称は、list-applicationsサブコマンドで取得できます。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

module

アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。moduleは、ServletContext初期化パラメーターをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。モジュールは、myApp/myWebModule.warの形式で指定します。

モジュールは、application-nameの後にスラッシュ（/）で区切って指定する必要があります。

型：String

指定できる値を次に示します。

アプリケーション内のモジュール名

デフォルト値：なし

使用例

次の例では、Webアプリケーションbasic-ezcompのServletContext初期化パラメーターjavax.faces.STATE_SAVING_METHODをclientに設定します。このパラメーターには、「The location where the application's state is preserved」という説明が設定されています。

asadmin set-web-context-param --name=javax.faces.STATE_SAVING_METHOD
--description "The location where the application's state is preserved"
--value=client basic-ezcomp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.17　set-web-env-entry

Webアプリケーションまたはモジュールの環境エントリーの設定

書式

asadmin [asadmin-options] set-web-env-entry [--help]
    --name=env-entry-name --type=env-entry-type
    {--value=value|--ignoredescriptoritem={true|false}}
    [--description description] application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

set-web-env-entryサブコマンドは、次のどちらかの項目の環境エントリーを設定します。

デプロイ済みのWebアプリケーション

デプロイ済みのJava EEアプリケーション内のWebモジュール

このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

アプリケーションがデプロイされている必要があります。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=env-entry-name

設定する環境エントリーの名称を指定します。この名称はjava:comp/envコンテキストに相対するJNDI名です。この名称はデプロイ機能内で一意でなければなりません。

型：String

指定できる値を次に示します。

環境エントリー名

デフォルト値：なし

--type=env-entry-type

アプリケーションのコードが求める環境エントリー値の完全修飾Javaタイプを指定します。

型：String

指定できる値を次に示します。

java.lang.Boolean

java.lang.Byte

java.lang.Character

java.lang.Double

java.lang.Float

java.lang.Integer

java.lang.Long

java.lang.Short

java.lang.String

デフォルト値：なし

--value=value

環境エントリーに設定する値を指定します。

--typeがjava.lang.Characterの場合、値は1文字でなければなりません。そうでない場合は、指定したタイプのコンストラクターに有効な文字列でなければなりません。

--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

型：String

指定できる値を次に示します。

環境エントリー値

デフォルト値：なし

--ignoredescriptoritem={true|false}

環境エントリーがアプリケーションのDDに設定されている場合、そのエントリーを無視するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

false

値は無視されません。

true

値は無視されます。--valueオプションまたは--ignoredescriptoritemオプションを設定する必要があります。

set-web-env-entryサブコマンドで以前に設定した環境エントリーの設定を取り消す場合、--ignoredescriptoritemオプションを使用しないでください。その用途では、代わりにunset-web-env-entryサブコマンドを使用してください。

デフォルト値：false

--description description

設定する環境エントリーの説明となるテキストを指定します。

型：String

指定できる値を次に示します。

パラメーターの説明

デフォルト値：なし

application-name

アプリケーションの名称を指定します。この名称は、list-applicationsサブコマンドで取得できます。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

module

アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。moduleは、環境エントリーをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。モジュールはmyApp/myWebModule.warの形式で指定します。

モジュールは、application-nameの後にスラッシュ（/）で区切って指定する必要があります。

型：String

指定できる値を次に示します。

アプリケーション内のモジュール名

デフォルト値：なし

使用例

次の例では、アプリケーションhelloの環境エントリーHello Userをtechscribeに設定します。このエントリーのJavaタイプはjava.lang.Stringです。

asadmin set-web-env-entry --name="Hello User"
--type=java.lang.String --value=techscribe
--description "User authentication for Hello application" hello

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.18　show-component-status

デプロイ済みのコンポーネントの状態の表示

書式

asadmin [asadmin-options] show-component-status [--help]
    [--target target] component-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

show-component-statusサブコマンドは、デプロイ済みのコンポーネントの状態（有効または無効）を取得します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

表示するコンポーネントの状態の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

component-name

状況を一覧表示するコンポーネントの名前を指定します。

名前にはオプションでバージョン識別子を入れることができます。このバージョン識別子は名前の後に続き、コロン（:）で区切ります。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。複数のバージョンを一覧表示する場合、アスタリスク（*）をワイルドカードとして使用できます。

型：String

指定できる値を次に示します。

コンポーネント名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスについて、MEjbAppコンポーネントの状態を取得します。

asadmin show-component-status --target instance1 MEjbApp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.19　undeploy

デプロイ済みのコンポーネントの削除

書式

asadmin [asadmin-options] undeploy [--help]
    [--target target]
    [--cascade={false|true}] name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

undeployサブコマンドは、デプロイ済みのアプリケーションまたはモジュールをアンインストールし、リポジトリーから削除します。

このサブコマンドはリモートモードだけサポートします。

タイムアウトなどでデータベースへのアクセスが失敗することによって、EJBタイマーアプリケーションのアンデプロイに失敗した場合、そのアプリケーションがデプロイできなくなります。この場合は、次の手順でEJBタイマーアプリケーションをデプロイし直してください。

サーバインスタンスを再起動します。

EJBタイマーアプリケーションをアンデプロイします。

EJBタイマーアプリケーションをデプロイします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--cascade={false|true}

関連リソースを削除するかどうかを指定します。

trueに設定した場合、アンデプロイするリソースアダプターに関連づけられたすべてのコネクションプールやコネクターリソースを削除します。

falseに設定した場合、リソースアダプターに関連づけられているプールやリソースが残っていると、アンデプロイが失敗します。その場合、それらのプールやリソースを明示的に削除するか、オプションをtrueに設定する必要があります。

このオプションをfalseに設定し、リソースアダプターに関連づけられているプールやリソースが残っていない場合、リソースアダプターはアンデプロイされます。

このオプションはコネクター（リソースアダプター）とアプリケーションに適用されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--target target

削除するデプロイの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

name

デプロイ済みのコンポーネントの名前を指定します。

名前にはオプションでバージョン識別子を入れることができます。このバージョン識別子は名前の後に続き、コロン（:）で区切ります。バージョン識別子は、文字または数値で始まる必要があります。使用できる文字は、英数字のほかに、アンダースコア（_）、ハイフン（-）およびピリオド（.）です。複数のバージョンを削除する場合、アスタリスク（*）をワイルドカードとして使用できます。

型：String

指定できる値を次に示します。

コンポーネント名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、Cart.earという名称のエンタープライズアプリケーションをアンデプロイします。

asadmin undeploy --target instance1 Cart

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.20　unset-web-context-param

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定の解除

書式

asadmin [asadmin-options] unset-web-context-param [--help]
    --name=context-param-name application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

unset-web-context-paramサブコマンドは、次のどちらかの項目のServletContext初期化パラメーターの設定を解除します。

デプロイ済みのWebアプリケーション

デプロイ済みのJava EEアプリケーション内のWebモジュール

パラメーターの設定が解除されると、アプリケーションのDDに設定された値があれば、パラメーターの値はその値に戻ります。

このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

環境エントリーが設定されている必要があります。

アプリケーションがデプロイされている必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=context-param-name

設定を解除するServletContext初期化パラメーターの名称を指定します。

型：String

指定できる値を次に示します。

変数名

デフォルト値：なし

application-name

アプリケーションの名称を指定します。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

module

アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。moduleは、ServletContext初期化パラメーターをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。

指定する場合、moduleはapplication-nameの後にスラッシュ（/）で区切って指定する必要があります。例えば、myAppアプリケーションのapplication.xmlファイルには、Webモジュールを次のように指定します。

<module>

<web>

<web-uri>myWebModule.war</web-uri>

</web>

</module>

モジュールは、myApp/myWebModule.warのような形式となります。

型：String

指定できる値を次に示します。

アプリケーションモジュール

デフォルト値：なし

使用例

次の例では、Webアプリケーションbasic-ezcompのServletContext初期化パラメーターjavax.faces.STATE_SAVING_METHODの設定を解除します。パラメーターは、アプリケーションのDDに定義された値があれば、その値に戻ります。

asadmin unset-web-context-param --name=javax.faces.STATE_SAVING_METHOD
basic-ezcomp

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.8.21　unset-web-env-entry

Webアプリケーションまたはモジュールの環境エントリーの設定の解除

書式

asadmin [asadmin-options] unset-web-env-entry [--help]
    --name=env-entry-name application-name[/module]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

unset-web-env-entryサブコマンドは、次のどちらかの項目の環境エントリーの設定を解除します。

デプロイ済みのWebアプリケーション

デプロイ済みのJava EEアプリケーション内のWebモジュール

エントリーの設定が解除されると、アプリケーションのDDに設定された値があれば、エントリーの値はその値に戻ります。

このサブコマンドによって、デプロイ済みのアプリケーションのDDを変更したり、アプリケーションを再パッケージおよびリデプロイしたりすることなく、アプリケーションの設定を変更できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

アプリケーションがデプロイされている必要があります。

エントリーが設定済みである必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

環境変数

モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name=env-entry-name

設定を解除する環境エントリーの名称を指定します。この名前はjava:comp/envコンテキストに相対するJNDI名です。この名前はデプロイ機能内で一意でなければなりません。

型：String

指定できる値を次に示します。

環境エントリー名

デフォルト値：なし

application-name

アプリケーションの名称を指定します。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

module

アプリケーションのEARファイル内のモジュールへの相対パスを指定します。モジュールへのパスは、アプリケーションのapplication.xmlファイルのmodule要素に指定されます。

moduleは、環境エントリーをJava EEアプリケーションのWebモジュールに適用する場合にだけ必要です。

指定する場合、moduleはapplication-nameの後にスラッシュ（/）で区切って指定する必要があります。例えば、myApp/myWebModule.warのような形式です。

型：String

指定できる値を次に示します。

アプリケーションモジュール名

デフォルト値：なし

使用例

次の例では、アプリケーションhelloの環境エントリーHello Userの設定を解除します。エントリーは、アプリケーションのDDに定義された値があれば、その値に戻ります。

asadmin unset-web-env-entry --name="Hello User" hello

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9　セキュリティー管理で使用するコマンド

セキュリティー管理で使用するコマンドの書式、機能などについて説明します。

2.9.1　change-master-password

マスターパスワードの変更

書式

asadmin [asadmin-options] change-master-password [--help]
    [--nodedir node-dir] [--domaindir domain-dir]
    [--savemasterpassword={false|true}] [domain-name|node-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

change-master-passwordサブコマンドは、マスターパスワードを変更するのに使用します。このサブコマンドでは、古いマスターパスワードと新しいマスターパスワードの入力が対話型で求められます。

このサブコマンドは、サーバが停止しているときだけ動作します。

分散環境では、ドメイン内の各マシン上でコマンドを実行する必要があります。

前提条件

ドメイン管理サーバまたはサーバインスタンスは、change-master-passwordサブコマンドの実行前に停止する必要があります。

環境変数

AS_DEF_DOMAINS_PATH

ファイル

change-master-passwordサブコマンドの--savemasterpasswordオプションがtrueに設定されている場合、マスターパスワードが変更され、domains/domain-dirディレクトリー内のmaster-passwordファイルに書き込まれます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--nodedir node-dir

パスワードを変更するノードのインスタンスを含むディレクトリーの名称を指定します。このオプションを実行すると、変更がドメイン全体に適用されます。

型：String

指定できる値を次に示します。

ノードが存在するディレクトリーのパス

デフォルト値：なし

--domaindir domain-dir

この操作で使用するドメインディレクトリーの名称を指定します。

型：String

指定できる値を次に示します。

ドメインディレクトリー名

デフォルト値：asenv.batファイルまたはasenv.confファイルに定義される環境変数$AS_DEF_DOMAINS_PATH

--savemasterpassword={false|true}

ファイルシステムへのマスターパスワードの書き込みをユーザーに要求するかどうかを確認します。start-domainサブコマンドを使うと、ユーザーにパスワード入力を要求しないでサーバを起動できるようになります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

domain-name | node-name

パスワードを変更するドメインまたはノードの名称を指定します。ドメインが1つだけの場合、このオプションは任意です。

型：String

指定できる値を次に示します。

ドメイン名、またはノード名

デフォルト値：なし

使用例

次の例では、domain44psドメインのマスターパスワードを変更します。

asadmin change-master-password domain44ps

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.2　create-auth-realm

名前付き認証レルムの追加

書式

asadmin [asadmin-options] create-auth-realm [--help]
    --classname realm_class [--property name=value[:name=value]...]
    [--target target_name] auth_realm_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-auth-realmサブコマンドは、名前付き認証レルムを追加します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

各レルムに対して、ユーザー名、パスワード、グループ名を保管するキーファイルを指定できます。デフォルトファイルはdomain-dir/config/keyfileです。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target_name

作成するレルムの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--classname realm_class

このレルムを実装するJavaクラスを指定します。

型：String

指定できる値を次に示します。

com.sun.enterprise.security.auth.realm.file.FileRealm

com.sun.enterprise.security.auth.realm.certificate.CertificateRealm

com.sun.enterprise.security.auth.realm.jdbc.JDBCRealm

com.sun.enterprise.security.auth.realm.ldap.LDAPRealm

com.sun.appserv.security.AppservPasswordLoginModuleクラスを実装するjavaクラスの名称

デフォルト値：なし

--property name=value[:name=value]...

認証レルムを構成するためのオプションのプロパティー名と値のペアを指定します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

プロパティー名とvalueに指定できる値を次に示します。

次のプロパティーは、FileRealm、CertificateRealm、JDBCRealm、およびLDAPRealmを含むサポートされているすべてのレルムに共通です。

jaas-context=value

Java Authentication and Authorization Service（JAAS）コンテキストを指定します。

型：String

デフォルト値：なし

assign-groups=value

このプロパティーを指定する場合、valueにはグループ名がコンマで区切られたリストを記述します。

有効な証明書を提示するすべてのクライアントには、WebおよびEJBコンテナーでの認可決定のために、これらのグループに対するメンバーシップが割り当てられます。

型：String

デフォルト値：なし

次のプロパティーは、FileRealmに指定できます。

file=value

ユーザー名、パスワードおよびグループ名を保存するファイルを指定します。

型：String

デフォルト値：domain-dir/config/keyfile

次のプロパティーは、CertificateRealmに指定できます。

LoginModule=value

認証の実行に使用するJAAS LoginModuleの名称を指定します。JAAS LoginModuleを使用するには、最初にjavax.security.auth.spi.LoginModuleインターフェースの実装を作成してから、モジュールをjaas-contextにプラグインする必要があります。

型：String

デフォルト値：なし

次のプロパティーは、JDBCRealmに指定できます。

datasource-jndi=value

データベースのjdbc-resourceのjndi-nameを指定します。

型：String

デフォルト値：なし

user-table=value

データベース内のユーザーテーブルの名称を指定します。

型：String

デフォルト値：なし

user-name-column=value

データベースのユーザーテーブル内のユーザー名列の名称を指定します。

型：String

デフォルト値：なし

password-column=value

データベースのユーザーテーブル内のパスワード列の名称を指定します。

型：String

デフォルト値：なし

group-table=value

データベース内のグループテーブルの名称を指定します。

JDBCRealmクラスの認証レルムのグループテーブルを指定します。

型：String

デフォルト値：なし

group-name-column=value

データベースのグループテーブル内のグループ名列の名称を指定します。

型：String

デフォルト値：なし

db-user=value

jdbc-connection-poolの代わりに、レルムにデータベースユーザー名を指定できます。これによって、ほかのアプリケーションによるデータベースの検索、接続の取得、ユーザーテーブルの参照を回避できます。デフォルトでは、jdbc-connection-pool構成が使用されます。

型：String

デフォルト値：なし

db-password=value

jdbc-connection-poolの代わりに、レルムにデータベースパスワードを指定できます。これによって、ほかのアプリケーションによるデータベースの検索、接続の取得、ユーザーテーブルの参照を回避できます。デフォルトでは、jdbc-connection-pool構成が使用されます。

型：String

デフォルト値：なし

digest-algorithm=value

メッセージダイジェストアルゴリズムを指定します。デフォルトのアルゴリズムはSHA-256です。JDKでサポートされているアルゴリズム、またはnoneを使用できます。アプリケーションがMD5アルゴリズムに依存している場合は、asadmin setサブコマンドを使用してデフォルトのSHA-25アルゴリズムを上書きできます。

asadmin set
server.security-service.property.default-digest-algorithm=MD5

asadminのgetサブコマンドを使用して、どのアルゴリズムが現在使用されているか確認できます。

asadmin get
server.security-service.property.default-digest-algorithm

型：String

デフォルト値：SHA-256

digestrealm-password-enc-algorithm=value

データベースに格納されたパスワードを暗号化するためのアルゴリズムを指定します。パスワード暗号化アルゴリズムを指定しないと、セキュリティー上のリスクが発生します。

型：String

デフォルト値：なし

encoding=value

エンコーディングを指定します。

型：String

指定できる値を次に示します。

Hex

Base64

デフォルト値：digest-algorithmが指定された場合、デフォルトではHexが指定されます。その他の場合は、デフォルトでは文字コードは指定されません。

charset=value

メッセージダイジェストアルゴリズムのcharsetを指定します。

型：String

デフォルト値：なし

次のプロパティーは、LDAPRealmに指定できます。

directory=value

サーバに対するLDAP URLを指定します。

型：String

デフォルト値：なし

base-dn=value

ユーザーデータの位置のLDAPベースDNを指定します。ツリー範囲検索が実行されるため、このベースDNはユーザーデータよりも上の任意のレベルになります。検索ツリーが小さくなるほど、パフォーマンスが向上します。

型：String

デフォルト値：なし

search-filter=value

ユーザーの検索に使用する検索フィルターを指定します。

型：String

デフォルト値：uid=%s（%sはサブジェクト名に展開されます）

group-base-dn=value

グループデータの位置のベースDNを指定します。デフォルトではbase-dnと同じですが、必要に応じて調整できます。

型：String

デフォルト値：なし

group-search-filter=value

ユーザーのグループを検索する検索フィルターを指定します。

型：String

デフォルト値：uniquemember=%d（%dはユーザーの要素DNに展開されます）

group-target=value

グループ名のエントリーを含むLDAP属性名を指定します。デフォルト値はCNです。

型：String

デフォルト値：CN

search-bind-dn=value

search-filter検索を実行する際にディレクトリーの認証で使用するオプションのDNを指定します。匿名検索を許可しないディレクトリーにだけ必要です。

型：String

デフォルト値：なし

search-bind-password=value

search-bind-dnで指定されたDNのLDAPパスワードを指定します。

型：String

デフォルト値：なし

auth_realm_name

レルムの短縮名を指定します。この名称はレルムの参照に使用します。

型：String

指定できる値を次に示します。

レルム名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、認証レルムを新規に作成します。

asadmin  create-auth-realm --target instance1
--classname com.sun.enterprise.security.auth.realm.file.FileRealm
--property file=${com.sun.aas.instanceRoot}/config/
admin-keyfile:jaas-context=fileRealm file

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.3　create-file-user

ファイルユーザーの作成

書式

asadmin [asadmin-options] create-file-user [--help]
    [--authrealmname auth_realm_name] [--target target]
    [--groups user_groups[:user_groups]...] user_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-file-userサブコマンドは、次のようなキーファイルのエントリーを作成します。

指定のユーザー名

パスワード

グループ

複数のグループは、コロン（:）で区切って作成できます。

--authrealmnameオプションが指定されていない場合、エントリーはデフォルトのレルムに対してキーファイルに作成されます。--authrealmnameオプションが指定されている場合、エントリーはauth_realm_nameの値を使用してキーファイルに作成されます。

asadminコマンドの--passwordfileオプションを使用すると、ユーザーのパスワードを指定できます。パスワードファイルのエントリーは、AS_ADMIN_USERPASSWORD=user-passwordの形式にする必要があります。セキュア管理が有効で、作成するユーザーが管理ユーザーの場合、パスワードを指定しないと、このサブコマンドは失敗します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

create-file-userサブコマンドを--passwordfileオプションを指定して実行する場合、パスワードファイルのエントリーはAS_ADMIN_USERPASSWORD=user-passwordの形式にする必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

このサブコマンドが動作する対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--groups user_groups[:user_groups]...

このファイルユーザーに関連づけるグループを指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--authrealmname auth_realm_name

新しいユーザーが作成されるレルム名を指定します。このオプションを指定しない場合、ユーザーはレルム名「file」に作成されます。

型：String

指定できる値を次に示します。

レルム名

デフォルト値：file

user_name

作成するファイルユーザーの名称を指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、ファイルユーザーを作成します。

asadmin create-file-user --target instance1 --groups staff:manager
--authrealmname auth-realm1 sample_user

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.4　create-jacc-provider

任意の認証モジュールで使用できるJACCプロバイダーの作成

書式

asadmin [asadmin-options] create-jacc-provider [--help]
    --policyproviderclass pol-provider-class
    --policyconfigfactoryclass pc-factory-class
    [--property name=value[:name=value]...]
    [--target target] jacc-provider-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jacc-providerサブコマンドは、JSR-115準拠のJava Authorization Contract for Containers（JACC）プロバイダーを作成します。JSR-115準拠のJACCプロバイダーは、Java EE Serverで実行するアプリケーションの認証に使用できます。

Application Serverのデフォルトのインストール環境には、defaultおよびsimpleという名前の2つのJACCプロバイダーが含まれています。create-jacc-providerサブコマンドによって、任意の認証モジュールを追加できます。

このサブコマンドはリモートモードだけサポートします。

JACCプロバイダーは、domain.xmlファイルのsecurity-service要素内にjacc-provider要素として作成されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

JACCプロバイダーは、ドメインのdomain.xmlファイルのsecurity-service要素内にjacc-provider要素として作成されます。

jacc-provider-nameには、domain.xmlファイルのjacc-provider要素を参照するために使用されるプロバイダーの名称を使用します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--policyproviderclass pol-provider-class

java.security.Policyを実装するjavax.security.jacc.policy.providerの完全修飾クラス名を指定します。

型：String

指定できる値を次に示します。

java.security.Policyインターフェースを実装するクラスの名称

デフォルト値：なし

--policyconfigfactoryclass pc-factory-class

プロバイダー固有のjavax.security.jacc.PolicyConfigurationFactoryを実装するjavax.security.jacc.PolicyConfigurationFactory.providerの完全修飾クラス名を指定します。

型：String

指定できる値を次に示します。

javax.security.jacc.PolicyConfigurationFactoryインターフェースを実装するクラスの名称

デフォルト値：なし

--property name=value[:name=value]...

JACCプロバイダー構成時のオプションをプロパティー名と値のペアで指定します。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

name

型：String

指定できる値を次に示します。

repository

JACCポリシーファイルを格納するディレクトリーを指定します。このプロパティーは、Java EE ServerのJACCプロバイダーではデフォルトで定義されません。

デフォルト値：なし

value

型：String

指定できる値を次に示します。

JACCポリシーファイルを格納するディレクトリーへのパス

デフォルト値：${com.sun.aas.instanceRoot}/generated/policy（default Java EE ServerのJACCプロバイダーのデフォルトのディレクトリー）

--target target

作成するJACCプロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jacc-provider-name

domain.xmlのjacc-provider要素を参照するために使用するプロバイダーの名称を指定します。

型：String

指定できる値を次に示します。

プロバイダーの名称

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、JACCプロバイダーを作成します。

asadmin create-jacc-provider --target instance1
--policyproviderclass com.sun.enterprise.security.provider.PolicyWrapper
--policyconfigfactoryclass
com.sun.enterprise.security.provider.PolicyConfigurationFactoryImpl
testJACC

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.5　create-password-alias

パスワードエイリアスの作成

書式

asadmin [asadmin-options] create-password-alias [--help] aliasname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-password-aliasサブコマンドは、パスワードに対するエイリアスを作成します。

エイリアスは、${ALIAS=aliasname}という形式で指定します。エイリアス名に対応するパスワードは暗号化されて格納されます。

このサブコマンドは対話形式でも非対話形式でも実行できます。

対話形式で実行すると、エイリアスパスワードの入力と確認入力が要求されます。

非対話形式で実行すると、asadminユーティリティーの--passwordfileオプションで渡されるファイルからエイリアスパスワードをコマンドが読み込みます。このファイルには、AS_ADMIN_ALIASPASSWORD=alias-passwordという形式のエントリーが必要です（alias-passwordはエイリアスパスワード）。このサブコマンドの非対話形式は、スクリプトでの使用が適しています。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

--passwordfileオプションで渡されるファイルからエイリアスパスワードをサブコマンドが読み込みます。このファイルには、AS_ADMIN_ALIASPASSWORD=alias-passwordという形式のエントリーが必要です（alias-passwordはエイリアスパスワード）。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

aliasname

パスワードエイリアスの名称を指定します。

型：String

指定できる値を次に示します。

パスワード

デフォルト値：なし

使用例

次の例では、パスワードエイリアスを対話形式で作成します。

asadmin create-password-alias jmspassword-alias

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

作成したパスワードエイリアスを適用するには、ドメイン管理サーバを再起動する必要があります。

2.9.6　delete-auth-realm

名前付き認証レルムの削除

書式

asadmin [asadmin-options] delete-auth-realm [--help] [--target target]
    auth_realm_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-auth-realmサブコマンドは、名前付き認証レルムを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除する認証レルムの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

auth_realm_name

レルムの名称を指定します。

型：String

指定できる値を次に示します。

レルム名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、認証レルムdbを削除します。

asadmin delete-auth-realm --target instance1 db

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.7　delete-file-user

ファイルユーザーの削除

書式

asadmin [asadmin-options] delete-file-user [--help]
    [--authrealmname auth_realm_name] [--target target] username

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-file-userサブコマンドは、指定したユーザー名に対するキーファイルのエントリーを削除します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--authrealmname auth_realm_name

ユーザーの作成に使用された認証レルムの名称を指定します。

型：String

指定できる値を次に示します。

認証レルム名

デフォルト値：file

--target target

削除するファイルユーザーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

username

ファイルユーザーの名称を指定します。

型：String

指定できる値を次に示します。

ファイルユーザー名

デフォルト値：なし

使用例

次の例では、デフォルトのレルムfileから、sample_userという名称のユーザーを削除します。

asadmin delete-file-user sample_user

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.8　delete-jacc-provider

JACCプロバイダーの削除

書式

asadmin [asadmin-options] delete-jacc-provider [--help]
    [--target target] jacc-provider-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jacc-providerサブコマンドは、ドメインに対して定義されたJACCプロバイダーを削除します。このサブコマンドは管理ユーザーだけが使用できます。 JACCプロバイダーは、該当するドメインのdomain.xmlファイルのsecurity-service要素内にjacc-provider要素として定義されます。JACCプロバイダーはcreate-jacc-providerサブコマンドを使用して作成できます。

デフォルトのJava EE Serverには、defaultおよびsimpleという名前の2つのJACCプロバイダーが含まれています。これらのデフォルトプロバイダーは削除できません。

Java EE Serverで承認に使用するJACCプロバイダーは、domain.xml内のsecurity-serviceのjacc-provider要素によって識別されます。したがって、jacc-providerプロバイダーを削除する場合は、jacc-providerを必ずsecurity-serviceに存在するほかのJACCプロバイダーの名称に変更してください。

jacc-provider要素を変更して別のJACCプロバイダーをポイントするようにした場合は、Java EE Serverの再起動が必要です。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

JACCプロバイダーは、該当するドメインのdomain.xmlファイルのsecurity-service要素内にjacc-provider要素として定義されます。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するJACCプロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jacc-provider-name

JACCプロバイダーの名称を指定します。

型：String

指定できる値を次に示します。

JACCプロバイダー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスのデフォルトのドメインから、testJACCという名称のJACCプロバイダーを削除します。

asadmin delete-jacc-provider --target instance1 testJACC

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.9　delete-password-alias

パスワードエイリアスの削除

書式

asadmin [asadmin-options] delete-password-alias [--help]
    aliasname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-password-aliasサブコマンドは、パスワードエイリアスを削除します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

aliasnameには、domain.xmlに記載されているパスワードエイリアスの中から、削除するパスワードエイリアスを指定します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

aliasname

domain.xmlに記載されているパスワードエイリアスの中から、削除するパスワードエイリアスを指定します。

型：String

指定できる値を次に示します。

パスワード

デフォルト値：なし

使用例

次の例では、jdbcpassword-aliasという名称のパスワードエイリアスを削除します。

asadmin delete-password-alias
jdbcpassword-alias

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.10　disable-secure-admin

secure admin機能の無効化

書式

asadmin [asadmin-options] disable-secure-admin [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

disable-secure-adminサブコマンドは、secure admin機能がすでに有効な場合に、secure admin機能を無効にします。

secure admin機能を有効または無効にしたあとにドメインで動作しているサーバを再起動する必要があります。ドメイン管理サーバだけが動作しているときにsecure admin機能を有効または無効にし、ドメイン管理サーバを再起動した後で、ほかのインスタンスを起動するとより簡単です。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、ドメインのsecure admin機能を無効にします。

asadmin disable-secure-admin

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.11　enable-secure-admin

secure admin機能の有効化

書式

asadmin [asadmin-options] enable-secure-admin [--help]
    [--adminalias=alias]
    [--instancealias=alias]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

enable-secure-adminサブコマンドは、secure admin機能を有効にします（すでに有効になっていない場合）。

また、オプションでドメイン管理サーバからインスタンスへの管理メッセージに使用するエイリアス、またはインスタンスからドメイン管理サーバへの管理メッセージに使用するエイリアスを変更します。

ドメイン内のドメイン管理サーバとインスタンスで、相互に送信するメッセージの暗号化にSSL証明書が使用されるようにします。

このサブコマンドを使用すると、asadminコマンドやIDEなど、リモート管理クライアントからの管理メッセージもドメイン管理サーバで受け入れることができます。

デフォルトでは、secure admin機能が有効であるとき、ドメイン管理サーバとインスタンスは、これらのSSL証明書を使用して、双方をセキュリティーのプリンシパルとして認証し、管理アクセスを許可します。

--adminaliasオプションの値は、ドメイン管理サーバがインスタンスに対して自身を識別するために使用するSSL証明書をドメイン管理サーバに指示します。

--instancealiasオプションの値は、インスタンスがドメイン管理サーバに対して自身を識別するために使用するSSL証明書を決定します。

enable-secure-adminサブコマンドは、ドメイン内のどれかの管理ユーザーのパスワードが空白の場合は失敗します。

前提条件

ドメイン管理サーバが稼働し、インスタンスは稼働していない必要があります。

ドメイン管理サーバのHTTPS通信ポートは、開いている必要があります。

インスタンスのHTTPS通信ポートは、開く設定である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--adminalias=alias

ドメイン管理サーバでSSL/TLS証明書を参照するエイリアスを指定します。このエイリアスは、インスタンスがドメイン管理サーバを識別できるようにドメイン管理サーバ自体で使用します。

型：String

指定できる値を次に示します。

SSL/TLS証明書のエイリアス名

デフォルト値：s1as

--instancealias=alias

インスタンス上でSSL/TLS証明書を参照するエイリアスを 指定します。このエイリアスは、 ドメイン管理サーバが各インスタンスを識別できるようにインスタンス自体で使用します。

型：String

指定できる値を次に示します。

SSL/TLS証明書のエイリアス名

デフォルト値：glassfish-instance

使用例

次の例では、adtestという名称のadminのエイリアスおよびintestという名称のインスタンスのエイリアスを使用してドメインのsecure admin機能 を有効にします。

asadmin enable-secure-admin --adminalias adtest --instancealias intest

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.12　list-auth-realms

認証レルムの一覧表示

書式

asadmin [asadmin-options] list-auth-realms [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-auth-realmsサブコマンドは、認証レルムを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示する認証レルムの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、認証レルムを一覧表示します。

asadmin list-auth-realms

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.13　list-file-groups

ファイルグループの一覧表示

書式

asadmin [asadmin-options] list-file-groups [--help]
    [--name username] [--authrealmname auth_realm_name]
    target

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-file-groupsサブコマンドは、ファイルレルム認証によってサポートされるファイルユーザーとグループを一覧表示します。このサブコマンドはファイルユーザーに利用されているグループを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

--nameオプションを指定しない場合、すべてのグループが一覧表示されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--name username

グループを一覧表示するファイルユーザーの名称を指定します。

型：String

指定できる値を次に示します。

ファイルユーザー名

デフォルト値：なし

--authrealmname auth_realm_name

グループを一覧表示する認証レルムの名称を指定します。

型：String

指定できる値を次に示します。

認証レルム名

デフォルト値：なし

target

一覧表示するファイルグループの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、サーバに定義されたファイルグループをすべて一覧表示します。

asadmin list-file-groups

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.14　list-file-users

ファイルユーザーの一覧表示

書式

asadmin [asadmin-options] list-file-users [--help]
    [--authrealmname auth_realm_name] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-file-usersサブコマンドは、ファイルレルム認証でサポートされるファイルユーザーの一覧を表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--authrealmname auth_realm_name

指定した認証レルムのユーザーだけを一覧表示します。

型：String

指定できる値を次に示します。

認証レルム名

デフォルト値：なし

target

一覧表示するファイルユーザーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのfileレルムファイルのファイルユーザーを一覧表示します。

asadmin list-file-users

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.15　list-jacc-providers

JACCプロバイダーの一覧表示

書式

asadmin [asadmin-options] list-jacc-providers [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jacc-providersサブコマンドで、管理者は、ドメインに定義されたJACCプロバイダーを一覧表示できます。

JACCプロバイダーは、ドメインのdomain.xmlファイルにある security-service要素にjacc-provider要素として定義されます。JACCプロバイダーはcreate-jacc-providerサブコマンドで作成できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

JACCプロバイダーは、ドメインのdomain.xmlファイルにある security-service要素にjacc-provider要素として定義されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するJACCプロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのドメインのJACCプロバイダーを一覧表示します。

asadmin list-jacc-providers

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.16　list-password-aliases

パスワードエイリアスの一覧表示

書式

asadmin [asadmin-options] list-password-aliases [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-password-aliasesサブコマンドは、すべてのパスワードエイリアスを一覧表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、すべてのパスワードエイリアスを一覧表示します。

asadmin list-password-aliases

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.17　list-supported-cipher-suites

Java EE Serverで利用できる暗号化方式群の一覧表示

書式

asadmin [asadmin-options] list-supported-cipher-suites [--help]
    [--target target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-supported-cipher-suitesサブコマンドを使用すると、管理者は、サポートされている暗号化方式群のうち、指定したJava EE Serverで利用できる暗号化方式群を一覧表示できます。

Java EE Serverパッケージに含まれているデフォルトのSSL/TLSプロバイダーのほかに利用できる暗号化方式群は、プロバイダー（他社製）によって異なります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示する暗号化方式群の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのドメインの暗号化方式群を一覧表示します。

asadmin list-supported-cipher-suites

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.18　update-file-user

現在のファイルユーザーの更新

書式

asadmin [asadmin-options] update-file-user [--help]
    [--groups user_groups[:user_groups]...] [--target target]
    [--authrealmname authrealm_name] username

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-file-userサブコマンドは、指定したユーザー名、パスワード、グループを使用して、キーファイル内の既存のエントリーを更新します。複数のグループをコロン（:）で区切って入力できます。

新たなパスワードを指定しない場合、セキュア管理が有効で、更新するユーザーが管理ユーザーなら、このサブコマンドは失敗します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

domain-dir/domain_name/configディレクトリーのkeyfileファイルが更新されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--groups user_groups[:user_groups]...

ファイルユーザーが所属するグループの名称を指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--target target

更新するファイルユーザーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--authrealmname authrealm_name

更新するユーザーが存在するユーザー認証レルムを指定します。

型：String

指定できる値を次に示します。

認証レルム名

デフォルト値：file

username

更新するファイルユーザーの名称を指定します。

型：String

指定できる値を次に示します。

ファイルユーザー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、sample_userという名称のファイルレルムユーザーの情報を更新します。

asadmin update-file-user --target instance1
--groups staff:manager:engineer sample_user

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.9.19　update-password-alias

パスワードエイリアスの更新

書式

asadmin [asadmin-options] update-password-alias [--help]
    aliasname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-password-aliasサブコマンドは、指定されたターゲットでパスワードエイリアスIDを更新します。

エイリアスは、${ALIAS=password-alias-password}という形式で指定します。エイリアス名に対応するパスワードは暗号化されて格納されます。

update-password-aliasサブコマンドでは、次に示す両方の形式を使用できます。

ユーザーがすべての情報の入力を求められる安全な対話形式。

パスワードがコマンドラインで伝達されるが、スクリプトの処理しやすい形式。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

domain.xmlに記録されているパスワードの名称。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

aliasname

domain.xmlファイルに記録されているパスワードの名称を指定します。

型：String

指定できる値を次に示します。

パスワードエイリアス名

デフォルト値：なし

使用例

次の例では、jmspassword-aliasエイリアスのパスワードを更新します。

asadmin update-password-alias jsmpassword-alias

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

変更したパスワードエイリアスを適用するには、ドメイン管理サーバを再起動する必要があります。

2.10　ログ管理で使用するコマンド

ログ管理で使用するコマンドの書式、機能などについて説明します。

2.10.1　collect-local-snapshot

ドメイン管理サーバ非稼働時のシステム情報の収集

書式

asadmin [asadmin-options] collect-local-snapshot
    [--infotype info-type1[,info-type2]...]
    [--domaindir domain-root-dir]
    [--domain domain-name] [--nodedir node-root-dir]
    --targettype={node|server}
    [--targetname target-name1[,target-name2]...]
    [--archivefile archive-file] [--timeout timeout]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

collect-local-snapshotサブコマンドは、Application Serverを構成する製品のシステム情報を収集します。集めた情報は、システム情報アーカイブファイルとして出力します。

このサブコマンドの実行中に強制終了した場合、システム情報アーカイブファイルの出力先ディレクトリーに、次に示すファイルやディレクトリーが残ることがあります。

拡張子が"zip"の、サブコマンドが一時的に生成したファイル

拡張子が"tmp"の、サブコマンドが一時的に生成したファイル

サブコマンドが一時的に生成したディレクトリー（ディレクトリー名は実行ごとに異なります）

出力先ディレクトリーに生成されるシステム情報アーカイブファイルの数は上限値を設定できるため、拡張子が"zip"のファイルが残り続けることはありません。これ以外のファイルおよびディレクトリーは適宜削除してください。削除するときは、collect-snapshotサブコマンドおよびcollect-local-snapshotサブコマンドが動作中でないことをメッセージログで確認してください。

重要

collect-local-snapshotサブコマンドを実行するごとにスレッドダンプファイルが生成されます。スレッドダンプファイルを残しておく必要がない場合は、サブコマンドの実行完了後に削除してください。スレッドダンプファイルは、デフォルトではカレントディレクトリーに出力されます。ドメイン管理サーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/domains/ドメイン名/config」、Java EEサーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/nodes/ノード名/サーバインスタンス名/config」になります。

スレッドダンプファイルの出力先をカレントディレクトリーから変更した場合は、システム情報アーカイブファイルにスレッドダンプファイルが含まれなくなります。

タイムアウトによってシステム情報の収集が中断された場合は、collect-local-snapshotサブコマンドが内部で呼び出したプロセスの実行も中断されます。ただし、collect-local-snapshotサブコマンドが呼び出したプロセスがさらに別のプロセスを呼び出している場合、このプロセスを中断できない場合があります。

実行権限

一般ユーザー

前提条件

このサブコマンドを、同一のサーバに対して複数同時に実行しないこと

引数

--infotype info-type1[,info-type2]...

収集するシステム情報の種類を指定します。複数の種類をコンマで区切って記述できます。

型：String

指定できる値を次に示します。

initinfo

問題点の切り分けに最低限必要な、初期調査用のシステム情報を収集します。

sysinfo

原因の調査に必要な、すべてのシステム情報を収集します。初期調査用のシステム情報も含みます。

デフォルト値：initinfo,sysinfo

--domaindir domain-root-dir

ドメインルートディレクトリーの絶対パスを指定します。ドメインルートディレクトリーをApplication Serverのデフォルト値から変更していない場合や、ドメイン管理サーバが存在しないホストで実行する場合は省略できます。

型：String

指定できる値を次に示します。

ドメインルートディレクトリーの絶対パス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/domains

--domain domain-name

同じ名称のノードやサーバが複数のドメインに存在する場合は、システム情報を収集したいノードやサーバが所属するドメインの名称を指定します。それ以外の場合は省略できます。

このオプションに指定した名称のドメインが複数あり、各ドメインに存在する同じ名称のサーバを--targetnameオプションに指定した場合は、ドメイン名とサーバ名が一致するすべてのサーバのシステム情報を収集します。

型：String

指定できる値を次に示します。

ドメイン名

デフォルト値：なし

--nodedir node-root-dir

サーバ（Java EEサーバ、Webサーバ、PRF）が構築されているノードルートディレクトリーの絶対パスを指定します。サーバが構築されているノードルートディレクトリーをApplication Serverのデフォルト値から変更していない場合や、ノードが存在しないホストで実行する場合は省略できます。

このオプションは、ノードルートディレクトリーを1つだけ指定できます。異なるノードルートディレクトリー下にあるノードやサーバのシステム情報を取得する場合は、それぞれのノードルートディレクトリーでcollect-local-snapshotサブコマンドを実行してください。

型：String

指定できる値を次に示します。

ノードルートディレクトリーの絶対パス

デフォルト値：Application Serverインストールディレクトリー/javaee/glassfish/nodes

--targettype={node|server}

システム情報を収集する対象を指定します。

型：String

指定できる値を次に示します。

node

--targetnameで指定したノードを構成する全サーバのシステム情報を収集します。

server

--targetnameで指定したサーバ（Java EEサーバ、Webサーバ、PRF）のシステム情報を収集します。

デフォルト値：なし

--targetname target-name1[,target-name2]...

システム情報を収集するノードまたはサーバの名称を指定します。複数の名称をコンマで区切って記述できます。

型：String

指定できる値を次に示します。

ノード名またはサーバ名

デフォルト値：server

--archivefile archive-file

システム情報アーカイブファイルの末尾に付く文字列を指定します。文字列の形式を次に示します。

snapshot-info-type-archive-file

info-type：--infotypeオプションの指定値。

archive-file：--archivefileオプションの指定値。

--infotypeオプションに複数の値を指定した場合は、それぞれの指定値に対応するシステム情報アーカイブファイルを作成します。

システム情報アーカイブファイルの出力先ディレクトリーに同じ名前のファイルが存在する場合は、既存のファイルが上書きされます。

型：String

指定できる値を次に示します。

システム情報アーカイブファイルの末尾に付く文字列

次の半角文字が使用できます。

英小文字

英大文字

数字

ハイフン

ピリオド

アンダースコア

デフォルト値：domain-name-date-process-id-thread-id.zip

dateの形式は"yyyyMMddHHmmss"。

process-idはcollect-local-snapshotサブコマンドのプロセスIDの16進数表記。

thread-idはcollect-local-snapshotサブコマンドのスレッドIDの16進数表記。

--timeout timeout

システム情報の収集を中止してコマンド実行を終了するまでの時間を指定します。

システム情報の収集が中止された場合、システム情報アーカイブファイルの出力先ディレクトリーに生成途中のファイルが残ることがあるため、適宜削除してください。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：なし（collect-local-snapshotサブコマンドはタイムアウトしない）

使用例

次の例では、サーバ名serverのシステム情報を収集します。

asadmin collect-local-snapshot --targettype=server

戻り値

戻り値

説明

0

正常終了

1

異常終了

出力形式

このサブコマンドは、--infotypeオプションで指定したシステム情報を収集して、それぞれに対応するシステム情報アーカイブファイルを生成します。

システム情報アーカイブファイルの名称は--archivefileオプションの説明を参照してください。

システム情報アーカイブファイルは、サブコマンドを実行したホストの、次に示すディレクトリーに出力されます。

Application Serverインストールディレクトリー/javaee/snapshot

出力先ディレクトリーの場所や出力先ディレクトリーに生成できるシステム情報アーカイブファイル数は、asadminユーティリティーのsetサブコマンドおよびgetサブコマンドの次のプロパティーで設定および確認できます。

hitachi-domain.hitachi-snapshot.output-dir※

hitachi-domain.hitachi-snapshot.max-num

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.output-dir※

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.max-num

注※

アクセス権のないディレクトリーを出力先に指定した場合は、エラーメッセージ（KDKD10211-E）を出力してシステム情報収集処理が中断されます。

プロパティーの詳細は、「setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧」を参照してください。

2.10.2　collect-snapshot

ドメイン管理サーバ稼働時のシステム情報の収集

書式

asadmin [asadmin-options] collect-snapshot
    [--infotype info-type1[,info-type2]...]
    --targettype={domain|node|server}
    [--targetname target-name1[,target-name2]...] [--timeout timeout]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

collect-snapshotサブコマンドは、Application Serverを構成する製品のシステム情報を収集します。ドメインを構成するノードやサーバが存在する複数のホストで収集します。収集した情報は各ホスト内にシステム情報アーカイブファイルとして出力されます。

このサブコマンドの実行中に強制終了した場合、システム情報アーカイブファイルの出力先ディレクトリーに、次に示すファイルやディレクトリーが残ることがあります。

拡張子が"zip"の、サブコマンドが一時的に生成したファイル

拡張子が"tmp"の、サブコマンドが一時的に生成したファイル

サブコマンドが一時的に生成したディレクトリー（ディレクトリー名は実行ごとに異なります）

出力先ディレクトリーに生成されるシステム情報アーカイブファイルの数は上限値を設定できるため、拡張子が"zip"のファイルが残り続けることはありません。これ以外のファイルおよびディレクトリーは適宜削除してください。削除するときは、collect-snapshotサブコマンドおよびcollect-local-snapshotサブコマンドが動作中でないことをメッセージログで確認してください。

重要

collect-snapshotサブコマンドを実行するごとにスレッドダンプファイルが生成されます。スレッドダンプファイルを残しておく必要がない場合は、サブコマンドの実行完了後に削除してください。スレッドダンプファイルは、デフォルトではカレントディレクトリーに出力されます。ドメイン管理サーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/domains/ドメイン名/config」、Java EEサーバのカレントディレクトリーは「Application Serverインストールディレクトリー/javaee/glassfish/nodes/ノード名/サーバインスタンス名/config」になります。

スレッドダンプファイルの出力先をカレントディレクトリーから変更した場合は、システム情報アーカイブファイルにスレッドダンプファイルが含まれなくなります。

タイムアウトによってシステム情報の収集が中断された場合は、collect-snapshotサブコマンドが内部で呼び出したプロセスの実行も中断されます。ただし、collect-snapshotサブコマンドが呼び出したプロセスがさらに別のプロセスを呼び出している場合、このプロセスを中断できない場合があります。

ドメイン管理サーバのあるホストから通信できないホストがある場合は、そのホストにあるノードおよびサーバを収集対象から除外して、collect-snapshotサブコマンドを実行してください。

実行権限

一般ユーザー

前提条件

ドメイン管理サーバが稼働していること

システム情報アーカイブファイルを収集するホストと正常に通信できること

このサブコマンドを、同一のサーバに対して複数同時に実行しないこと

引数

--infotype info-type1[,info-type2]...

収集するシステム情報の種類を指定します。複数の種類をコンマで区切って記述できます。

型：String

指定できる値を次に示します。

initinfo

問題点の切り分けに最低限必要な、初期調査用のシステム情報を収集します。

sysinfo

原因の調査に必要な、すべてのシステム情報を収集します。初期調査用のシステム情報も含みます。

デフォルト値：initinfo,sysinfo

--targettype={domain|node|server}

システム情報を収集する対象を指定します。

型：String

指定できる値を次に示します。

domain

ドメインを構成する全サーバのシステム情報を収集します。--targetnameの指定値は使用されません。

node

--targetnameで指定したノードを構成する全サーバのシステム情報を収集します。

server

--targetnameで指定したサーバ（Java EEサーバ、Webサーバ、PRF）のシステム情報を収集します。

デフォルト値：なし

--targetname target-name1[,target-name2]...

システム情報を収集するノードまたはサーバの名称を指定します。複数の名称をコンマで区切って記述できます。

--targettypeにdomainを指定した場合は、このオプションの指定値は使用されません。

型：String

指定できる値を次に示します。

ノード名またはサーバ名

デフォルト値：server

--timeout timeout

このサブコマンドが呼び出したcollect-local-snapshotサブコマンドが、システム情報の収集を中止してコマンド実行を終了するまでの時間を指定します。

システム情報の収集が中止された場合、システム情報アーカイブファイルの出力先ディレクトリーに生成途中のファイルが残ることがあるため、適宜削除してください。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：なし（collect-local-snapshotサブコマンドはタイムアウトしない）

使用例

次の例では、ドメインを構成する全サーバのシステム情報を収集します。

asadmin collect-snapshot --targettype=domain

戻り値

戻り値

説明

0

正常終了

1

異常終了

出力形式

このサブコマンドは、--infotypeオプションで指定したシステム情報を収集して、それぞれに対応するシステム情報アーカイブファイルを生成します。システム情報アーカイブファイルは次の名称で生成されます。

snapshot-info-type※1-収集対象名※2-日時※3-プロセスID※4-スレッドID※5.zip

※1

--infotypeオプションの指定値です。複数の値を指定した場合は、各指定値に対応する複数のシステム情報アーカイブファイルが生成されます。

※2

ドメイン管理サーバがあるホストに出力するファイルではドメイン名、ドメイン管理サーバがないノードに出力するファイルではドメイン名-ホスト名となります。

※3

形式はyyyyMMddHHmmssです。--targetnameオプションで複数のホスト上にあるノードやサーバを指定した場合、各ホストで出力するファイル名の日時は、すべてcollect-snapshotサブコマンドを実行した時点の日時になります。

※4

ドメイン管理サーバのプロセスIDの16進数表記です。

※5

ドメイン管理サーバ上で動作しているcollect-snapshotサブコマンドのスレッドIDの16進数表記です。

システム情報アーカイブファイルは、--targetnameオプションで指定したサーバが存在するホストの、次に示すディレクトリーに出力されます。

Application Serverインストールディレクトリー/javaee/snapshot

出力先ディレクトリーの場所や出力先ディレクトリーに生成できるシステム情報アーカイブファイル数は、asadminユーティリティーのsetサブコマンドおよびgetサブコマンドの次のプロパティーで設定および確認できます。

hitachi-domain.hitachi-snapshot.output-dir※

hitachi-domain.hitachi-snapshot.max-num

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.output-dir※

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.max-num

注※

アクセス権のないディレクトリーを出力先に指定した場合は、エラーメッセージ（KDKD10211-E）を出力してシステム情報収集処理が中断されます。

プロパティーの詳細は、「setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧」を参照してください。

2.10.3　list-log-attributes

ログ属性の一覧表示

書式

asadmin [asadmin-options] list-log-attributes [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-log-attributesサブコマンドは、指定されたJava EE Serverドメインまたはドメイン内の対象に現在定義されているログ属性をすべて一覧表示します。一覧表示された値はドメインのlogging.propertiesファイルの値に対応します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

ログ属性は指定したJava EE Serverドメインまたはドメイン内の対象に対して定義されています。一覧表示された値はドメインのlogging.propertiesファイルの値に対応します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するログ属性の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのドメインのすべてのログ属性を一覧表示します。

asadmin list-log-attributes

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.10.4　set-log-attributes

1つ以上のロガーのロギング属性の設定

書式

asadmin [asadmin-options] set-log-attributes [--help]
    [--target=target]
    attribute-name=attribute-value[:attribute-name=attribute-value]...

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

set-log-attributesサブコマンドは、1つ以上のロガーのロギング属性を設定します。設定する属性は、ドメインのlogging.propertiesファイルで使用できる属性に対応しています。設定した属性によっては、サーバの再起動が必要になることがあります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

設定できる属性は、ドメインのlogging.propertiesファイルで使用できる属性に対応しています。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target=target

設定するロギング属性の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

attribute-name

ロギング属性の完全スコープ名を指定します。

指定できる属性名については「set-log-attributesコマンドで使用するパラメーター一覧」を参照してください。

attribute-value

指定された属性に適用する値を指定します。

指定できる属性値については「set-log-attributesコマンドで使用するパラメーター一覧」を参照してください。

使用例

次の例では、サーバインスタンスinstanceAのメッセージログ切り替えサイズを16777216に設定します。

asadmin set-log-attributes --target instanceA
ServerInstance.message_log.rotation-size=16777216

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.10.5　set-log-attributesコマンドで使用するパラメーター一覧

ここでは、set-log-attributesサブコマンドのattribute-nameオプションに指定できるパラメーターについて説明します。

set-log-attributesコマンドで使用するパラメーター

項番

パラメーター名

説明

指定できる値※1

デフォルト値

--targetオプションに指定する値

指定例

1

ServerInstance.message_log.enabled

サーバインスタンスのメッセージログ出力の有効／無効を切り替えます。

true|false

true

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.message_log.enabled=true

2

ServerInstance.message_log.rotation-size

サーバインスタンスのメッセージログの切り替えサイズを指定します。

4096〜2147483647

16777216

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.message_log.rotation-size=4096

3

ServerInstance.message_log.rotation-time

サーバインスタンスのメッセージログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.message_log.rotation-time=000000

4

ServerInstance.message_log.file-number

サーバインスタンスのメッセージログの保持面数を指定します。

1〜16

8

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.message_log.file-number=8

5

ServerInstance.message_log.log-level

サーバインスタンスのメッセージログのログレベルを指定します。※2

1〜3

2

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.message_log.log-level=2

6

ServerInstance.stacktrace_log.enabled

サーバインスタンスのスタックトレースログ出力の有効／無効を切り替えます。

true|false

true

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.stacktrace_log.enabled=true

7

ServerInstance.stacktrace_log.rotation-size

サーバインスタンスのスタックトレースログの切り替えサイズを指定します。

4096〜2147483647

16777216

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.stacktrace_log.rotation-size=4096

8

ServerInstance.stacktrace_log.rotation-time

サーバインスタンスのスタックトレースログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.stacktrace_log.rotation-time=000000

9

ServerInstance.stacktrace_log.file-number

サーバインスタンスのスタックトレースログの保持面数を指定します。

1〜16

8

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.stacktrace_log.file-number=8

10

ServerInstance.websocket_access_log.enabled

サーバインスタンスのWebSocketアクセスログ出力の有効／無効を切り替えます。

true|false

true

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.websocket_access_log.enabled=false

11

ServerInstance.websocket_access_log.format

サーバインスタンスのWebSocketアクセスログの出力フォーマットを指定します。

WebSocketアクセスログにペイロードデータを出力する場合、%PAYLOADDATA%と%PAYLOADDATA(文字数)%は同時に指定できません。

%TS%

%CLIENTADDR%

%SERVERADDR%

%IO%

%URI%

%SESSIONID%

%OPCODE%

%FIN%

%PAYLOADDATALEN%

%MASK%

%ROOTAP%

%MASKKEY%

%ISEXTENDED%

%RSV%

%FRAMEMAINTYPE%

%CLOSEREASON%

%PAYLOADDATA%

%PAYLOADDATA(文字数)%

%CLIENTAP%

%TS% %IO% %OPCODE% %URI% %FIN% %CLOSEREASON% %PAYLOADDATALEN% %ROOTAP% %CLIENTAP%

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.websocket_access_log.format=%TS% %IO% %OPCODE% %URI% %FIN% %CLOSEREASON% %PAYLOADDATALEN% %ROOTAP%

12

ServerInstance.websocket_access_log.rotation-size

サーバインスタンスのWebSocketアクセスログの切り替えサイズを指定します。

4096〜2147483647

314572800

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.websocket_access_log.rotation-size=16777216

13

ServerInstance.websocket_access_log.rotation-time

サーバインスタンスのWebSocketアクセスログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.websocket_access_log.rotation-time=000000

14

ServerInstance.websocket_access_log.file-number

サーバインスタンスのWebSocketアクセスログの保持面数を指定します。

1〜16

8

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.websocket_access_log.file-number=2

15

ServerInstance.maintenance_log.enabled

サーバインスタンスの保守ログ出力の有効／無効を切り替えます。

true|false

true

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.maintenance_log.enabled=true

16

ServerInstance.maintenance_log.rotation-size

サーバインスタンスの保守ログの切り替えサイズを指定します。

4096〜2147483647

16777216

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.maintenance_log.rotation-size=4096

17

ServerInstance.maintenance_log.rotation-time

サーバインスタンスの保守ログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.maintenance_log.rotation-time=000000

18

ServerInstance.maintenance_log.file-number

サーバインスタンスの保守ログの保持面数を指定します。

1〜16

8

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.maintenance_log.file-number=8

19

ServerInstance.maintenance_log.maintenance-log-level

サーバインスタンスの保守ログのログレベルを指定します。

1〜2

1

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.maintenance_log.maintenance-log-level=1

20

ServerInstance.glassfish_debug_log.enabled

サーバインスタンスのデバッグログ出力の有効／無効を切り替えます。

true|false

false

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.glassfish_debug_log.enabled=false

21

ServerInstance.glassfish_debug_log.rotation-size

サーバインスタンスのデバッグログの切り替えサイズを指定します。

4096〜2147483647

2147483647

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.glassfish_debug_log.rotation-size=4096

22

ServerInstance.glassfish_debug_log.rotation-time

サーバインスタンスのデバッグログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.glassfish_debug_log.rotation-time=000000

23

ServerInstance.glassfish_debug_log.file-number

サーバインスタンスのデバッグログの保持面数を指定します。

1〜16

8

サーバインスタンス名またはクラスター名

asadmin set-log-attributes --target=instanceA ServerInstance.glassfish_debug_log.file-number=8

24

DAS.message_log.enabled

ドメイン管理サーバのメッセージログ出力の有効／無効を切り替えます。

true|false

true

server

asadmin set-log-attributes --target=server DAS.message_log.enabled=true

25

DAS.message_log.rotation-size

ドメイン管理サーバのメッセージログの切り替えサイズを指定します。

4096〜2147483647

16777216

server

asadmin set-log-attributes --target=server DAS.message_log.rotation-size=4096

26

DAS.message_log.rotation-time

ドメイン管理サーバのメッセージログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

server

asadmin set-log-attributes --target=server DAS.message_log.rotation-time=000000

27

DAS.message_log.file-number

ドメイン管理サーバのメッセージログの保持面数を指定します。

1〜16

8

server

asadmin set-log-attributes --target=server DAS.message_log.file-number=8

28

DAS.message_log.log-level

ドメイン管理サーバのメッセージログのログレベルを指定します。※2

1〜3

2

server

asadmin set-log-attributes --target=server DAS.message_log.log-level=2

29

DAS.stacktrace_log.enabled

ドメイン管理サーバのスタックトレースログ出力の有効／無効を切り替えます。

true|false

true

server

asadmin set-log-attributes --target=server DAS.stacktrace_log.enabled=true

30

DAS.stacktrace_log.rotation-size

ドメイン管理サーバのスタックトレースログの切り替えサイズを指定します。

4096〜2147483647

16777216

server

asadmin set-log-attributes --target=server DAS.stacktrace_log.rotation-size=4096

31

DAS.stacktrace_log.rotation-time

ドメイン管理サーバのスタックトレースログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

server

asadmin set-log-attributes --target=server DAS.stacktrace_log.rotation-time=000000

32

DAS.stacktrace_log.file-number

ドメイン管理サーバのスタックトレースログの保持面数を指定します。

1〜16

8

server

asadmin set-log-attributes --target=server DAS.stacktrace_log.file-number=8

33

DAS.maintenance_log.enabled

ドメイン管理サーバの保守ログ出力の有効／無効を切り替えます。

true|false

true

server

asadmin set-log-attributes --target=server DAS.maintenance_log.enabled=true

34

DAS.maintenance_log.rotation-size

ドメイン管理サーバの保守ログの切り替えサイズを指定します。

4096〜2147483647

16777216

server

asadmin set-log-attributes --target=server DAS.maintenance_log.rotation-size=4096

35

DAS.maintenance_log.rotation-time

ドメイン管理サーバの保守ログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

server

asadmin set-log-attributes --target=server DAS.maintenance_log.rotation-time=000000

36

DAS.maintenance_log.file-number

ドメイン管理サーバの保守ログの保持面数を指定します。

1〜16

8

server

asadmin set-log-attributes --target=server DAS.maintenance_log.file-number=8

37

DAS.maintenance_log.maintenance-log-level

ドメイン管理サーバの保守ログのログレベルを指定します。

1〜2

1

server

asadmin set-log-attributes --target=server DAS.maintenance_log.maintenance-log-level=1

38

DAS.glassfish_debug_log.enabled

ドメイン管理サーバのデバッグログ出力の有効／無効を切り替えます。

true|false

false

server

asadmin set-log-attributes --target=server DAS.glassfish_debug_log.enabled=false

39

DAS.glassfish_debug_log.rotation-size

ドメイン管理サーバのデバッグログの切り替えサイズを指定します。

4096〜2147483647

2147483647

server

asadmin set-log-attributes --target=server DAS.glassfish_debug_log.rotation-size=4096

40

DAS.glassfish_debug_log.rotation-time

ドメイン管理サーバのデバッグログの切り替え時間を指定します。

HHMMSSの形式でラップ時刻を指定します。

000000

server

asadmin set-log-attributes --target=server DAS.glassfish_debug_log.rotation-time=000000

41

DAS.glassfish_debug_log.file-number

ドメイン管理サーバのデバッグログの保持面数を指定します。

1〜16

8

server

asadmin set-log-attributes --target=server DAS.glassfish_debug_log.file-number=8

注※1

範囲外の値を指定した場合は、コマンドの実行に失敗します。

注※2

標準出力に出力するメッセージをメッセージログに出力するためには、ログレベルを3に設定してください。標準エラー出力に出力するメッセージはデフォルトの設定（2）でメッセージログに出力します。

2.11　パラメーター設定で使用するコマンド

パラメーター設定で使用するコマンドの書式、機能などについて説明します。

2.11.1　create-jvm-options

Java VMオプションの作成

書式

asadmin [asadmin-options] create-jvm-options [--help] [--target target]
    [--profiler={true|false}]
    option-name[=option-value][:option-name[=option-value]]...

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jvm-optionsサブコマンドは、Java EE Serverが起動されるときに、Java VMに渡されるコマンドラインの各オプションを作成します。このサブコマンドで作成されるオプションは、Java EE Serverで事前設定されているオプションに追加されます。

Java VMのオプションは、Java構成（domain.xmlファイルのprofiler要素/java—config要素）に格納されます。domain.xmlファイルのprofiler要素、java-config要素に表示される順序でオプションはコマンドラインに送られます。

このサブコマンドを使用して次のタイプのオプションを作成できます。

Javaシステムプロパティー：これらのオプションの前に-Dオプションで設定します。

Java VMのスタートアップパラメーター：これらのオプションの前にはハイフン（-）をつけます。

このサブコマンドはリモートモードだけサポートします。

ドメイン管理サーバのJava VMオプションに不適切な値を指定した場合、ドメイン管理サーバが起動しないで、ドメインの再構築が必要になることがあります。このような事態を避けるために、ドメイン管理サーバのJava VMオプションを変更するときには、あらかじめ、backup-domainコマンドを使用してドメインのバックアップを採取しておくことをお勧めします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

Java VMの各オプションは、Java構成（domain.xmlファイルのprofiler要素/java—config要素）に格納されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するJava VMオプションの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--profiler={true|false}

Java VMオプションがプロファイラー用かどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

option-name[=option-value][:option-name[=option-value]]...

オプションを指定します。複数の場合は、コロン（:）で区切ります。

オプションの形式は、次のとおりです。

オプションに名前と値がある場合は、形式はoption-name=valueです。

オプションが名前だけの場合は、形式はoption-nameです。

型：String

指定できる値を次に示します。

jvm-option名、または値を持つ名称

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、Java VMオプションを作成します。

asadmin create-jvm-options --target instance1 -Dunixlocation=/root/example:
-Dvariable=¥$HOME:-Dwindowslocation=d¥:¥¥sun¥¥appserver:-Doption1=-value1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

このコマンドのオプションに次のシステムプロパティーを指定しないでください。Message Queueのログの設定（config.properties）に影響を与えます。

java.util.logging.FileHandler.count

java.util.logging.FileHandler.limit

java.util.logging.FileHandler.level

java.util.logging.FileHandler.pattern

2.11.2　create-system-properties

構成のほかの部分から参照できるシステムプロパティーの追加

書式

asadmin [asadmin-options] create-system-properties [--help]
    [--target target] [name=value[:name=value]...]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-system-propertiesサブコマンドは、サーバの各所から参照できる各システムプロパティーを追加または更新します。

Java EE Serverには、各トークン（システムプロパティー）を指定できるフックが用意されています。Java EE Serverには複数サーバ要素がないので、任意のレベルで特定のトークンを指定できます。ドメインが複数サーバをサポートするとき、優先原則が悪用されるおそれがあります。

ドメインが起動または再起動されるとき、すべてのsystem-property要素はSystem.setProperty()呼び出しによって解決され、Java VMで利用できるようになります（要素の名前と値は、対応する要素属性から抽出されます）。この機能は、Javaのコマンドラインを使用して、要素を-Dパラメーターとして送信する機能に類似しています。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するシステムプロパティーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

name=value[:name=value]...

指定した対象に追加するシステムプロパティーのプロパティー名と値のペアを指定します。

複数システムプロパティー記述する場合コロン（:）で区切る必要があります。コロン（:）がシステムプロパティーの名前や値に含まれる場合、円記号（¥）でエスケープする必要があります。

型：String

指定できる値を次に示します。

システムプロパティーのプロパティー名と値のペア

デフォルト値：なし

使用例

次の例では、myserverという名称のサーバインスタンス上に、HTTPリスナーに関連したシステムプロパティーを作成します。

asadmin create-system-properties --target myserver http-listener-port=1088

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

注意事項

このコマンドのオプションに次のシステムプロパティーを指定しないでください。Message Queueのログの設定（config.properties）に影響を与えます。

java.util.logging.FileHandler.count

java.util.logging.FileHandler.limit

java.util.logging.FileHandler.level

java.util.logging.FileHandler.pattern

2.11.3　delete-jvm-options

Java VMオプションの削除

書式

asadmin [asadmin-options] delete-jvm-options [--help]
    [--target target] [--profiler={true|false}]
    option-name[=option-value] [:option-name[=option-name]]...

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jvm-optionsサブコマンドは、Java VMのコマンドラインオプションを削除します。これらのオプションは、domain.xmlでの、Javaに関する構成であるjava-config要素、またはプロファイラーに関する構成であるprofiler要素から削除されます。

削除するオプションによっては、このコマンドの実行後にドメイン管理サーバの再起動が必要です。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

指定したオプションはJava構成のjava-config要素またはdomain.xmlファイルのprofiler要素から削除されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するJava VMオプションの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--profiler={true|false}

Java VMオプションがプロパティーに対して存在するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

option-name=option-value

削除するJava VMオプションを次の形式で指定します。

オプションに名称と値がある場合は、「option-name=value」の形式で指定します。

オプションが名称だけの場合は、「option-name」を指定します（例：-Xmx2048m）。

複数のオプションを指定する場合はコロン（:）で区切ります。コロン（:）がオプションの名称や値に含まれる場合、円記号（¥）で名称や値のコロンをエスケープする必要があります。

型：String

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、複数のJava VMのオプションを削除します。

asadmin delete-jvm-options --target instance1 -Doption1=value1
"-Doption1=value1:-Doption2=value2"

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.4　delete-system-property

システムプロパティー（ドメイン／構成／クラスター／サーバインスタンス）の削除

書式

asadmin [asadmin-options] delete-system-property [--help]
    [--target target] property_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-system-propertyサブコマンドは、ドメイン、構成、クラスターまたはサーバインスタンスのシステムプロパティーを削除します。このサブコマンドを実行する前に、システムプロパティーが構成内のどこからも参照されていないことを確認してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するシステムプロパティーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

property_name

削除対象のシステムプロパティーの名称を指定します。

型：String

指定できる値を次に示します。

システムプロパティー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、http-listener-portという名称のシステムプロパティーを削除します。

asadmin delete-system-property --target instance1 http-listener-port

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.5　get

構成属性値の取得

書式

asadmin [asadmin-options] get [--help]
    attribute-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

getサブコマンドは、設定対象識別子を使用してApplication Serverの設定値を取得します。

設定対象識別子として指定できるパラメーターについては「setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧」を参照してください。

PRF関連のパラメーターでは、「hitachi-prfs.hitachi-prf.PRF名.で始まるパラメーター」と「hitachi-prf-configs.hitachi-prf-config.PRFのコンフィグ名で始まるパラメーター」の両方に値が設定されている場合、「hitachi-prfs.hitachi-prf.PRF名.で始まるパラメーター」の値が有効になります。

Webサーバ関連のパラメーターでは、「hitachi-webservers.hitachi-webserver.Webサーバ名で始まるパラメーター」と「hitachi-webserver-configs.hitachi-webserver-config.Webサーバのコンフィグ名で始まるパラメーター」の両方に値が設定されている場合、「hitachi-webservers.hitachi-webserver.Webサーバ名で始まるパラメーター」の値が有効になります。

サーバインスタンス関連のパラメーターでは、「servers.server.Java EEサーバ名で始まるパラメーター」と「configs.config.Java EEサーバの構成名で始まるパラメーター」の両方に値が設定されている場合、「servers.server.Java EEサーバ名で始まるパラメーター」の値が有効になります。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

attribute-name

設定対象識別子を指定します。少なくとも1つの設定対象識別子を指定してください。設定対象識別子は、Application Serverの設定を参照するために使用されます。

また、設定対象識別子にはワイルドカード"*"を利用することもできます。ワイルドカード"*"を使用するときには設定対象識別子をダブルクォーテーション（"）で囲んでください。

型：String

指定できる値を次に示します。

設定対象識別子

使用例

次の例では、listener.http-listener-1の属性を取得します。

asadmin get server.http-service.http-listener.http-listener-1.*

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.6　list

構成属性値の一覧表示

書式

asadmin [asadmin-options] list [--help]
    dotted-parent-element-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

listサブコマンドは、Java EE Serverの構成属性値を一覧表示します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

dotted-parent-element-name

構成属性値の名称を指定します。

型：String

指定できる値を次に示します。

ドット表記名で指定した要素名

デフォルト値：なし

使用例

次の例では、構成属性値を一覧表示します。

asadmin list *

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.7　list-configs

ドメイン管理サーバの構成中の、名前付き構成の一覧表示

書式

asadmin [asadmin-options] list-configs [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-configsサブコマンドは、ドメイン管理サーバの構成中の、名前付き構成を一覧表示します。一覧は、クラスター、インスタンス、または構成でフィルター処理できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示する構成の対象を指定します。

型：String

指定できる値を次に示します。

domain

ドメインを対象とします。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：domain

使用例

次の例では、現在のドメイン上にあるすべての構成を一覧表示します。

asadmin list-configs

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.8　list-jvm-options

Java VMオプションの一覧表示

書式

asadmin [asadmin-options] list-jvm-options [--help]
    [--target target]
    [--profiler={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jvm-optionsサブコマンドは、Java EE Server起動時にJava VMに渡されるコマンドラインオプションを一覧表示します。

オプションは、create-jvm-optionsサブコマンドおよびdelete-jvm-optionsサブコマンドを使用して管理されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するJava VMのオプションの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--profiler={false|true}

一覧表示するJava VMのオプションがプロファイラー用かどうかを指定します。

このオプションは、プロファイラーが設定されている場合だけ、trueに設定します。このオプションをtrueに設定してもプロファイラーが設定されていない場合、エラーが発生します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

使用例

次の例では、instance1という名称のサーバインスタンスについて、Java VMオプションを一覧表示します。

asadmin list-jvm-options --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.9　list-system-properties

ドメイン、構成、クラスターまたはサーバインスタンスのシステムプロパティーの一覧表示

書式

asadmin [asadmin-options] list-system-properties [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-system-propertiesサブコマンドは、ドメイン、構成、クラスターまたはサーバインスタンスのシステムプロパティーを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するシステムプロパティーの対象を指定します。

型：String

指定できる値を次に示します。

domain

ドメインを対象とします。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

デフォルト値：server

使用例

次の例では、localhostのシステムプロパティーを一覧表示します。

asadmin list-system-properties

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.10　set

構成属性値の設定

書式

asadmin [asadmin-options] set [--help]
    attribute-name=value

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

setサブコマンドは、設定対象識別子を使用して、Application Serverの設定値を変更します。

設定対象識別子として指定できるパラメーターについては「set サブコマンドおよびgetサブコマンドで使用するパラメーター一覧」を参照してください。

アスタリスク（*）のようなシェルやコマンドインタープリターに特別な意味を持つ文字は、例えば引数をダブルクォーテーションで囲むなど、シェルに応じてダブルクォーテーションで囲むかエスケープする必要があります。

設定値を変更することによって、サービスを有効にしたり無効にしたり、既存の要素がどのように機能するかカスタマイズしたりできます。asadminユーティリティーのサブコマンドを使用した変更は、関連づけられたドメイン構成ファイルに自動的に適用されます。

設定値を反映するため、このサブコマンドの実行後には、設定対象のサーバ（ドメイン管理サーバ、Webサーバ、Java EEサーバ、PRFデーモン）を再起動してください。

ファイル書き込みの失敗などによって設定値の永続化に失敗した場合、コマンドの実行には成功しますが、再起動後に設定値が反映されないことがあります。永続化に失敗した場合はドメイン管理サーバのメッセージログにエラーが出力されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

attribute-name=value

設定対象識別子とその値を指定します。

型：String

指定できる値を次に示します。

設定対象識別子とその値

デフォルト値：なし

使用例

次の例では、DerbyPoolコネクションプールの通常プールサイズを9に変更します。

asadmin set resources.jdbc-connection-pool.DerbyPool.steady-pool-size=9

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.11.11　setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧

ここでは、setサブコマンドおよびgetサブコマンドの設定対象識別子に指定できるパラメーターについて説明します。

リソース関連

applications.application.アプリケーション名.module.モジュール名.resourcesで始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値

製品出荷時の値

指定例

1

connector-connection-pool.コネクターコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。モジュールスコープのコネクターコネクションプールに設定します。

true|false

なし

false

asadmin set applications.application.myapplication.module.mymodule.resources.connector-connection-pool.myconnectorconnectionpool.hitachi-connection-sharing-component-enabled=false

2

jdbc-connection-pool.JDBCコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。モジュールスコープのJDBCコネクションプールに設定します。

true|false

なし

false

asadmin set applications.application.myapplication.module.mymodule.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-connection-sharing-component-enabled=false

3

jdbc-connection-pool.JDBCコネクションプール名.hitachi-jdbc-transaction-rollback-enabled

コネクションクローズ時のJDBCトランザクションのロールバックの有効／無効を設定します。モジュールスコープのJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set applications.application.myapplication.module.mymodule.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-jdbc-transaction-rollback-enabled=true

4

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout

コネクション障害検知のタイムアウトの時間を、秒単位で指定します。モジュールスコープのJDBCコネクションプールに設定します。

1〜2147483647

なし

5

asadmin set applications.application.myapplication.module.mymodule.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout=5

5

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout-enabled

コネクション障害検知のタイムアウトの有効／無効を設定します。モジュールスコープのJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set applications.application.myapplication.module.mymodule.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout-enabled=true

applications.application.アプリケーション名.resourcesで始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値

製品出荷時の値

指定例

1

connector-connection-pool.コネクターコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。アプリケーションスコープのコネクターコネクションプールに設定します。

true|false

なし

false

asadmin set applications.application.myapplication.resources.connector-connection-pool.myconnectorconnectionpool.hitachi-connection-sharing-component-enabled=false

2

jdbc-connection-pool.JDBCコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。アプリケーションスコープのJDBCコネクションプールに設定します。

true|false

なし

false

asadmin set applications.application.myapplication.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-connection-sharing-component-enabled=false

3

jdbc-connection-pool.JDBCコネクションプール名.hitachi-jdbc-transaction-rollback-enabled

コネクションクローズ時のJDBCトランザクションのロールバックの有効／無効を設定します。アプリケーションスコープのJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set applications.application.myapplication.resources.jdbc-connection-pool.myjdbcconnectionpool. hitachi-jdbc-transaction-rollback-enabled=true

4

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout

コネクション障害検知のタイムアウトの時間を、秒単位で指定します。アプリケーションスコープのJDBCコネクションプールに設定します。

1〜2147483647

なし

5

asadmin set applications.application.myapplication.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout=5

5

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout-enabled

コネクション障害検知のタイムアウトの有効／無効を設定します。アプリケーションスコープのJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set applications.application.myapplication.resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout-enabled=true

resourcesで始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値

製品出荷時の値

指定例

1

connector-connection-pool.コネクターコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。ドメインに作成したコネクターコネクションプールに設定します。

true|false

なし

false

asadmin set resources.connector-connection-pool.myconnectorconnectionpool.hitachi-connection-sharing-component-enabled=false

2

connector-connection-pool.コネクターコネクションプール名.idle-timeout-in-seconds

アイドル状態のコネクションがタイムアウトするまでの時間を、秒単位で設定します。

1〜2147483647

300

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.idle-timeout-in-seconds=200

3

connector-connection-pool.コネクターコネクションプール名.max-pool-size

クライアントのリクエストに対応するために作成できるコネクションの最大数を設定します。

1〜2147483647

24

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.max-pool-size=60

4

connector-connection-pool.コネクターコネクションプール名.max-wait-time-in-millis

コネクションが使用できない場合、コネクションが作成されるまでに呼び出し側が待機しなければならない時間をミリ秒単位で設定します。

0〜2147483647

60000

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.max-wait-time-in-millis=700000

5

connector-connection-pool.コネクターコネクションプール名.pool-resize-quantity

プールがコネクション数をスケールアップまたはスケールダウンするときの単位量を設定します。

1〜2147483647

2

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.pool-resize-quantity=4

6

connector-connection-pool.コネクターコネクションプール名.property.プロパティー名

プールを構成するときのプロパティー名およびその値を設定します。

Type: String

なし

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.property.User=User1

7

connector-connection-pool.コネクターコネクションプール名.steady-pool-size

プールに保持されるコネクション数の最小値を設定します。

0〜2147483647

24

なし

asadmin set resources.connector-connection-pool.ConnectionPool1.steady-pool-size=30

8

jdbc-connection-pool.JDBCコネクションプール名.hitachi-connection-sharing-component-enabled

コネクションシェアリングのコンポーネント内シェアリングの有効／無効を設定します。ドメインに作成したJDBCコネクションプールに設定します。

true|false

なし

false

asadmin set resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-connection-sharing-component-enabled=false

9

jdbc-connection-pool.JDBCコネクションプール名.hitachi-jdbc-transaction-rollback-enabled

コネクションクローズ時のJDBCトランザクションのロールバックの有効／無効を設定します。ドメインに作成したJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-jdbc-transaction-rollback-enabled=true

10

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout

コネクション障害検知のタイムアウトの時間を、秒単位で指定します。ドメインに作成したJDBCコネクションプールに設定します。

1〜2147483647

なし

5

asadmin set resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout=5

11

jdbc-connection-pool.JDBCコネクションプール名.hitachi-validation-timeout-enabled

コネクション障害検知のタイムアウトの有効／無効を設定します。ドメインに作成したJDBCコネクションプールに設定します。

true|false

なし

true

asadmin set resources.jdbc-connection-pool.myjdbcconnectionpool.hitachi-validation-timeout-enabled=true

12

jdbc-connection-pool.JDBCコネクションプール名.idle-timeout-in-seconds

アイドル状態のコネクションがタイムアウトするまでの時間を、秒単位で設定します。

アプリケーション内に使用できないコネクションが蓄積しないように、このタイムアウト値にはデータベース側のタイムアウト値よりも常に小さい値を設定してください。

0〜2147483647

300

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.idle-timeout-in-seconds=200

13

jdbc-connection-pool.JDBCコネクションプール名.max-pool-size

作成できるコネクションの最大数を設定します。

1〜2147483647

24

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.max-pool-size=60

14

jdbc-connection-pool.JDBCコネクションプール名.max-wait-time-in-millis

JDBCコネクションタイムアウトが送信されるまでの、呼び出し側が待機する時間をミリ秒単位で設定します。

0を指定した場合、呼び出し側の待機時間は無制限となります。

0〜2147483647

60000

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.max-wait-time-in-millis=70000

15

jdbc-connection-pool.JDBCコネクションプール名.pool-resize-quantity

idle-timeout-in-secondsタイマーがタイムアウトしたときに削除されるコネクション数を設定します。

1〜2147483647

2

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.pool-resize-quantity=4

16

jdbc-connection-pool.JDBCコネクションプール名.property.プロパティー名

プールを構成するときのプロパティー名およびその値を設定します。

Type: String

なし

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.property.User=User1

17

jdbc-connection-pool.JDBCコネクションプール名.steady-pool-size

プールに保持されるコネクション数の最小値を設定します。

0〜2147483647

24

なし

asadmin set resources.jdbc-connection-pool.ConnectionPool1.steady-pool-size=30

18

mail-resource.JavaMailリソース名.property.プロパティー名

JavaMailリソースを構成するときのプロパティー名およびその値を設定します。

Type: String

なし

なし

asadmin set resources.mail-resource.mymailresource.property.mail-from=xyz@abc.com

PRF関連

hitachi-prfs.hitachi-prf.PRF名.で始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

property.拡張プロパティー

PRFに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、PRFのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.ex_timeout=600

2

property.env_環境変数名

PRF起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどれかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

サーバテンプレートの起動用バッチまたはシェルスクリプト

このプロパティーで指定できない文字をサーバの環境変数に設定する必要がある場合は、次の方法で環境変数を設定してください。

環境変数設定用にサーバに拡張プロパティーを設け、この拡張プロパティーに環境変数に設定する値を設定する。

[環境変数設定用の拡張プロパティーの例]

拡張プロパティー名：ex_myenv

拡張プロパティーの値：環境変数に設定する値

サーバテンプレートの中のサーバを起動するスクリプト中に、拡張プロパティーの値を環境変数に設定する処理を追加する。

[追加する行の例]

MY_ENV=${property.ex_myenv.value}

export MY_ENV

Type: String

半角英数字と次の記号だけが指定できます。パーセント（%）、単価記号（@）、プラス（+）、ハイフン（-）、アンダースコア（_）、コンマ（,）、ピリオド（.）。

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.env_TZ=JST-9

3

property.log-file-count

PRFが出力するログファイルの面数を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogFileCountオプションに対応します。

1〜32

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.log-file-count=16

4

property.log-file-size

PRFが出力するログファイルサイズの上限を、メガバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogFileSizeオプションに対応します。

1〜100

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.log-file-size=20

5

property.log-shift-time

PRFが出力するログファイルのシフト時刻を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogShiftTimeオプションに対応します。

HHMMSS（000000〜235959）

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.log-shift-time=121530

6

property.prf-spool

PRFトレース出力ディレクトリーを指定します。

デフォルトの出力先は、HJES_LOGSDIR/nodes/ノード名/PRF識別子です。

Type: String

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.prf-spool=C:¥PRFSPOOL¥PRF1

7

property.trace-buffer-size

共用メモリーに確保するPRFトレースファイルのバッファーサイズを、キロバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceBufferSizeオプションに対応します。

512〜102400

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.trace-buffer-size=16384

8

property.trace-count

PRFトレースファイルの面数を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceCountオプションに対応します。

3〜256

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.trace-count=8

9

property.trace-file-size

PRFトレースファイルの1ファイル当たりの最大容量を、キロバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceFileSizeオプションに対応します。

1024〜1048576

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.trace-file-size=16384

10

property.trace-level

PRFトレース取得レベルを、4バイトの16進数（8桁の値）で指定します。先頭に0xを付けられますが、0xは無視されます。各インデックス番号のレベル値を左からコンマ（,）で区切ることで複数指定できます。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceLevelオプションに対応します。

4バイトの16進数（8桁の値）[,4バイトの16進数（8桁の値）...]

プロパティー削除

なし

asadmin set hitachi-prfs.hitachi-prf.PRF1.property.trace-level=0x44445555

11

hitachi-prf-config-ref

PRFの設定要素を指定します。この属性の値はsetサブコマンドで変更できません。

ドメインに存在するPRFのコンフィグ名

変更不可

なし

変更不可

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

hitachi-prf-configs.hitachi-prf-config.PRFのコンフィグ名で始まるパラメーター

パラメーター名がproperty.で始まるパラメーターをhitachi-prfs.hitachi-prf.PRF名.で始まるパラメーターでも定義している場合は、hitachi-prfs.hitachi-prf.PRF名.で始まるパラメーターの値が優先されます。

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

hitachi-manage-info.running-watch-interval-in-seconds

PRFの動作確認間隔を、秒単位で指定します。

1〜86400

省略不可

10

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.running-watch-interval-in-seconds=20

2

hitachi-manage-info.start-timeout-in-seconds

PRFの起動監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜3600

省略不可

60

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.start-timeout-in-seconds=180

3

hitachi-manage-info.start-type

PRFの起動方法を指定します。

direct： 直接起動

direct

省略不可

direct

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.start-type=direct

4

hitachi-manage-info.starting-watch-interval-in-seconds

PRFの起動時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.starting-watch-interval-in-seconds=3

5

hitachi-manage-info.starting-watch-start-time-in-seconds

PRFで起動コマンドを実行してから動作確認を開始するまでの時間を、秒単位で指定します。

0〜86400

省略不可

0

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.starting-watch-start-time-in-seconds=10

6

hitachi-manage-info.stop-timeout-in-seconds

PRFの停止監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜1800

省略不可

60

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.stop-timeout-in-seconds=180

7

hitachi-manage-info.stopping-watch-interval-in-seconds

PRFの停止時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.stopping-watch-interval-in-seconds=3

8

hitachi-manage-info.template-path

PRFのサーバテンプレートのパスを絶対パスで指定します。

存在するディレクトリーパス

省略不可

ドメインルートディレクトリー/ドメイン名/server_templates/サーバ種別

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.hitachi-manage-info.template-path=C:¥temp¥prf

9

property.拡張プロパティー

PRFに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、PRFのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.ex_timeout=600

10

property.env_環境変数名

PRF起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverのインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどれかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

サーバテンプレートの起動用バッチまたはシェルスクリプト

このプロパティーで指定できない文字をサーバの環境変数に設定する必要がある場合は、次の方法で環境変数を設定してください。

環境変数設定用にサーバに拡張プロパティーを設け、この拡張プロパティーに環境変数に設定する値を設定する。

[環境変数設定用の拡張プロパティーの例]

拡張プロパティー名：ex_myenv

拡張プロパティーの値：環境変数に設定する値

サーバテンプレートの中のサーバを起動するスクリプト中に、拡張プロパティーの値を環境変数に設定する処理を追加する。

[追加する行の例]

MY_ENV=${property.ex_myenv.value}

export MY_ENV

Type: String

半角英数字と次の記号だけが指定できます。パーセント（%）、単価記号（@）、プラス（+）、ハイフン（-）、アンダースコア（_）、コンマ（,）、ピリオド（.）。

プロパティー削除

なし

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.env_TZ=JST-9

11

property.log-file-count

PRFが出力するログファイルの面数を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogFileCountオプションに対応します。

1〜32

プロパティー削除

8

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.log-file-count=16

12

property.log-file-size

PRFが出力するログファイルサイズの上限を、メガバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogFileSizeオプションに対応します。

1〜100

プロパティー削除

10

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.log-file-size=20

13

property.log-shift-time

PRFが出力するログファイルを時刻でシフトさせる場合のシフト時刻を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfLogShiftTimeオプションに対応します。

HHMMSS（000000〜235959）

プロパティー削除

000000

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.log-shift-time=121530

14

property.prf-spool

PRFトレース出力ディレクトリーを指定します。

デフォルトの出力先は、HJES_LOGSDIR/nodes/ノード名/PRF識別子です。

Type: String

プロパティー削除

なし

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.prf-spool=C:¥PRFSPOOL¥PRF1

15

property.trace-buffer-size

共用メモリーに確保するPRFトレースファイルのバッファーサイズを、キロバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceBufferSizeオプションに対応します。

512〜102400

プロパティー削除

8192

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.trace-buffer-size=16384

16

property.trace-count

PRFトレースファイルの面数を指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceCountオプションに対応します。

3〜256

プロパティー削除

4

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.trace-count=8

17

property.trace-file-size

PRFトレースファイルの1ファイル当たりの最大容量を、キロバイト単位で指定します。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceFileSizeオプションに対応します。

1024〜1048576

プロパティー削除

262144

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.trace-file-size=16384

18

property.trace-level

PRFトレース取得レベルを、4バイトの16進数（8桁の値）で指定します。先頭に0xを付けられますが、0xは無視されます。各インデックス番号のレベル値を左からコンマ（,）で区切ることで複数指定できます。

このプロパティーは、PRFのcprfstartコマンドの-PrfTraceLevelオプションに対応します。

4バイトの16進数（8桁の値）[,4バイトの16進数（8桁の値）...]

プロパティー削除

0

asadmin set hitachi-prf-configs.hitachi-prf-config.PRF1-config.property.trace-level=0x44445555

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

Webサーバ関連

hitachi-webservers.hitachi-webserver.Webサーバ名で始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

hitachi-relations.hitachi-relation-type-ref.hitachi-relation.関連名.order

サーバ間関連の順序番号を指定します。

0〜65535

省略不可

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirect1.order=10

2

hitachi-relations.prf-relation.hitachi-relation.関連名.property.拡張プロパティー

WebサーバのPRF関連に追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、サーバ間関連の関連元であるWebサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.prf-relation.hitachi-relation.prfref2.property.ex_timeout=600

3

hitachi-relations.redirect.hitachi-relation.関連名.property.拡張プロパティー

リダイレクト関連に追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、サーバ間関連の関連元であるWebサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.ex_timeout=600

4

hitachi-relations.redirect.hitachi-relation.関連名.property.negative

リダイレクターの動作の定義で、マッピング定義に対するリクエストを除外するかどうかを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブの!オプションに対応します。

true|false

プロパティー削除

false

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.negative=true

5

hitachi-relations.redirect.hitachi-relation.関連名.property.network-listener

リダイレクト先となるネットワークリスナー名を指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのURLに対応します。URLには、指定したネットワークリスナー名から特定したホスト名とポート番号が設定されます。

ネットワークリスナー名の文字列

プロパティー削除

http-listener-1

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.network-listener=http-listener-1

6

hitachi-relations.redirect.hitachi-relation.関連名.property.path

リダイレクターの動作の定義で、マッピング定義のローカルの仮想パスの名前を指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのパス名指定に対応します。

httpsd.confファイルのProxyPassに定義するpath（ローカルの仮想パスの名前）の形式

プロパティー削除

/

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.path=/news/

7

hitachi-relations.redirect.hitachi-relation.関連名.property.proxy-pass-option

リダイレクターの動作の定義で、マッピング定義のコネクションプーリングの調整パラメーターを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブの「キー=値」指定に対応します。

httpsd.confファイルのProxyPassに定義するコネクションプーリングの調整パラメーターの形式（[key=value key=value …]）

プロパティー削除

空文字

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.proxy-pass-option=timeout=300

8

hitachi-relations.redirect.hitachi-relation.関連名.property.set-proxy-pass-reverse-cookie

リダイレクターの動作の定義で、Set-Cookieヘッダーの再割り当てを行うかどうかを指定します。

このプロパティーは、Web ServerのHWSProxyPassReverseCookieディレクティブに対応します。

true|false

プロパティー削除

true

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.set-proxy-pass-reverse-cookie=true

9

hitachi-relations.redirect.hitachi-relation.関連名.property.stickysession

リダイレクターの動作の定義で、Stickyを有効にするかどうかを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのstickysessionキーに対応します。

また、このプロパティーにtrueを指定すると、必要なHeaderディレクティブが追加されます。

true|false

プロパティー削除

true

asadmin set hitachi-webservers.hitachi-webserver.Web1.hitachi-relations.redirect.hitachi-relation.redirector1.property.stickysession=true

10

hitachi-webserver-config-ref

Webサーバのコンフィグ名を指定します。

この属性の値はsetサブコマンドで変更できません。

ドメインに存在するWebサーバのコンフィグ名

変更不可

なし

編集不可

11

property.拡張プロパティー

Webサーバに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、Webサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.ex_timeout=600

12

property.user

Web Serverのサーバプロセスが動作するときのユーザー名を指定します。このプロパティーは、Web ServerのUserディレクティブに対応します。

Type: String

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.user=user01

13

property.group

Web Serverのサーバプロセスが動作するときのグループ名を指定します。このプロパティーは、Web ServerのGroupディレクティブに対応します。

Type: String

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.group=group01

14

property.env_環境変数名

Webサーバ起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverのインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどれかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

サーバテンプレートの起動用シェルスクリプト

このプロパティーで指定できない文字をサーバの環境変数に設定する必要がある場合は、次の方法で環境変数を設定してください。

環境変数設定用にサーバに拡張プロパティーを設け、この拡張プロパティーに環境変数に設定する値を設定する。

[環境変数設定用の拡張プロパティーの例]

拡張プロパティー名：ex_myenv

拡張プロパティーの値：環境変数に設定する値

サーバテンプレートの中のサーバを起動するスクリプト中に、拡張プロパティーの値を環境変数に設定する処理を追加する。

[追加する行の例]

MY_ENV=${property.ex_myenv.value}

export MY_ENV

Type: String

半角英数字と次の記号だけが指定できます。パーセント（%）、単価記号（@）、プラス（+）、ハイフン（-）、アンダースコア（_）、コンマ（,）、ピリオド（.）。

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.env_TZ=JST-9

15

property.listen-add-count

複数のListenディレクティブを指定する場合に、追加するListenディレクティブの数を指定します。

このプロパティーは、プロパティーlisten-portおよびlisten-hostに指定したListenディレクティブ設定以外の追加数を指定するため、Listenディレクティブの総数は、「このプロパティーの指定値+1」になります。デフォルトは0です。

このプロパティーに指定した数だけ、次のプロパティーを指定する必要があります。

listen-add_portn※

listen-add_hostn※

注※

n：1〜このプロパティーの指定値

0〜2147483647

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.listen-add-count=2

16

property.listen-add-hostn

追加ListenディレクティブのIPアドレスを指定します。プロパティー名のnには、1〜listen-add-countの指定値の値を指定します。nが同じ数値のlisten-add-portnと対で、Listenディレクティブが指定されます。

このプロパティーは省略できます。

1〜listen-add-countの指定値の範囲外の値をnに指定した場合、そのポート番号はWebサーバに適用されません。

このプロパティーは、Web ServerのListenディレクティブに対応します。

ホスト名|IPv4ドット記法|IPv6ドット記法（前後に[]を指定）

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.listen-add-host1=192.168.1.102

17

property.listen-add-portn

追加Listenディレクティブのポート番号を指定します。プロパティー名のnには、1〜listen-add-countの指定値の値を指定します。nが同じ数値のlisten-add-hostnと対で、Listenディレクティブが指定されます。

1〜listen-add-countの指定値の範囲外の値をnに指定した場合、そのポート番号はWebサーバに適用されません。

このプロパティーは、Web ServerのListenディレクティブに対応します。

1〜65535

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.listen-add-port1=82

18

property.listen-host

リクエストを受け付けるIPアドレスを指定します。

このプロパティーは省略できます。

このプロパティーは、Web ServerのListenディレクティブに対応します。

ホスト名|IPv4ドット記法|IPv6ドット記法（前後に[]を指定）

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.listen-host=192.168.1.101

19

property.listen-port

リクエストを受け付けるポート番号を指定します。

このプロパティーは、Web ServerのListenディレクティブに対応します。

1〜65535

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.listen-port=81

20

property.max-request-workers

同時に接続できるクライアントの最大数を指定します。

このプロパティーは、Web ServerのMaxRequestWorkersディレクティブに対応します。

1〜1024

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.max-request-workers=300

21

property.server-name

Web Serverのサーバ名およびポート番号を指定します。

このプロパティーは、Web ServerのServerNameディレクティブに対応します。

Type: String

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.server-name=www.host1.co.jp

22

property.start-servers

Webサーバ起動時のサーバプロセス数を指定します。

このプロパティーは、Web ServerのStartServersディレクティブに対応します。

1〜1024

プロパティー削除

なし

asadmin set hitachi-webservers.hitachi-webserver.Web1.property.start-servers=10

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

hitachi-webserver-configs.hitachi-webserver-config.Webサーバのコンフィグ名で始まるパラメーター

パラメーター名がproperty.で始まるパラメーターをhitachi-webservers.hitachi-webserver.Webサーバ名で始まるパラメーターでも定義している場合は、hitachi-webservers.hitachi-webserver.Webサーバ名で始まるパラメーターの値が優先されます。

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

hitachi-manage-info.running-watch-interval-in-seconds

Webサーバの動作確認間隔を、秒単位で指定します。

1〜86400

省略不可

10

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.running-watch-interval-in-seconds=20

2

hitachi-manage-info.start-timeout-in-seconds

Webサーバの起動監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜3600

省略不可

60

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.start-timeout-in-seconds=180

3

hitachi-manage-info.start-type

Webサーバの起動方法を指定します。

direct： 直接起動

direct

省略不可

direct

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.start-type=direct

4

hitachi-manage-info.starting-watch-interval-in-seconds

Webサーバの起動時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.starting-watch-interval-in-seconds=3

5

hitachi-manage-info.starting-watch-start-time-in-seconds

Webサーバの起動で、起動コマンドを実行してから動作確認を開始するまでの時間を、秒単位で指定します。

0〜86400

省略不可

0

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.starting-watch-start-time-in-seconds=20

6

hitachi-manage-info.stop-timeout-in-seconds

Webサーバの停止監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜1800

省略不可

60

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.stop-timeout-in-seconds=180

7

hitachi-manage-info.stopping-watch-interval-in-seconds

Webサーバの停止時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.stopping-watch-interval-in-seconds=3

8

hitachi-manage-info.template-path

Webサーバのサーバテンプレートのパスを絶対パスで指定します。

存在するディレクトリーパス

省略不可

ドメインルートディレクトリー/ドメイン名/server_templates/サーバ種別

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.hitachi-manage-info.template-path=C:¥temp¥webserver

9

property.拡張プロパティー

Webサーバに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、Webサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.ex_timeout=600

10

property.user

Web Serverのサーバプロセスが動作するときのユーザー名を指定します。このプロパティーは、Web ServerのUserディレクティブに対応します。

Type: String

プロパティー削除

なし

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.user=user01

11

property.group

Web Serverのサーバプロセスが動作するときのグループ名を指定します。このプロパティーは、Web ServerのGroupディレクティブに対応します。

Type: String

プロパティー削除

なし

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.group=group01

12

property.env_環境変数名

Webサーバ起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverのインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどれかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

サーバテンプレートの起動用シェルスクリプト

このプロパティーで指定できない文字をサーバの環境変数に設定する必要がある場合は、次の方法で環境変数を設定してください。

環境変数設定用にサーバに拡張プロパティーを設け、この拡張プロパティーに環境変数に設定する値を設定する。

[環境変数設定用の拡張プロパティーの例]

拡張プロパティー名：ex_myenv

拡張プロパティーの値：環境変数に設定する値

サーバテンプレートの中のサーバを起動するスクリプト中に、拡張プロパティーの値を環境変数に設定する処理を追加する。

[追加する行の例]

MY_ENV=${property.ex_myenv.value}

export MY_ENV

Type: String

半角英数字と次の記号だけが指定できます。パーセント（%）、単価記号（@）、プラス（+）、ハイフン（-）、アンダースコア（_）、コンマ（,）、ピリオド（.）。

プロパティー削除

なし

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.env_TZ=JST-9

13

property.listen-add-count

複数のListenディレクティブを指定する場合に、追加するListenディレクティブの数を指定します。

このプロパティーは、プロパティーlisten-portおよびlisten-hostに指定したListenディレクティブ設定以外の追加数を指定するため、Listenディレクティブの総数は、「このプロパティーの指定値+1」になります。デフォルトは0です。

このプロパティーに指定した数だけ、次のプロパティーを指定する必要があります。

listen-add_portn※

listen-add_hostn※

注※

n：1〜このプロパティーの指定値

0〜2147483647

プロパティー削除

なし（未定義）

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.listen-add-count=2

14

property.listen-add-hostn

追加ListenディレクティブのIPアドレスを指定します。プロパティー名のnには、1〜listen-add-countの指定値の値を指定します。nが同じ数値のlisten-add-portnと対で、Listenディレクティブが指定されます。

このプロパティーは省略できます。

1〜listen-add-countの指定値の範囲外の値をnに指定した場合、そのポート番号はWebサーバに適用されません。

このプロパティーは、Web ServerのListenディレクティブに対応します。

ホスト名|IPv4ドット記法|IPv6ドット記法（前後に[]を指定）

プロパティー削除

なし（未定義）

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.listen-add-host1=192.168.1.102

15

property.listen-add-portn

追加Listenディレクティブのポート番号を指定します。プロパティー名のnには、1〜listen-add-countの指定値の値を指定します。nが同じ数値のlisten-add-hostnと対で、Listenディレクティブが指定されます。

1〜listen-add-countの指定値の範囲外の値をnに指定した場合、そのポート番号はWebサーバに適用されません。

このプロパティーは、Web ServerのListenディレクティブに対応します。

1〜65535

プロパティー削除

なし（未定義）

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.listen-add-port1=82

16

property.listen-host

リクエストを受け付けるIPアドレスを指定します。

このプロパティーは省略できます。

このプロパティーは、Web ServerのListenディレクティブに対応します。

ホスト名|IPv4ドット記法|IPv6ドット記法（前後に[]を指定）

プロパティー削除

なし（未定義）

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.listen-host=192.168.1.101

17

property.listen-port

リクエストを受け付けるポート番号を指定します。

このプロパティーは、Web ServerのListenディレクティブに対応します。

1〜65535

プロパティー削除

80

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.listen-port=81

18

property.max-request-workers

同時に接続できるクライアントの最大数を指定します。

このプロパティーは、Web ServerのMaxRequestWorkersディレクティブに対応します。

1〜1024

プロパティー削除

150

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.max-request-workers=300

19

property.server-name

Web Serverのサーバ名およびポート番号を指定します。

このプロパティーは、Web ServerのServerNameディレクティブに対応します。

Type: String

プロパティー削除

www.example.com

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.server-name=www.host1.co.jp

20

property.start-servers

Webサーバ起動時のサーバプロセス数を指定します。

このプロパティーは、Web ServerのStartServersディレクティブに対応します。

1〜1024

プロパティー削除

20

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.start-servers=10

21

property.threads-per-child

サーバとして起動するスレッド数を指定します。

このプロパティーは、Web ServerのThreadsPerChildディレクティブに対応します。

1〜1024

プロパティー削除

50

asadmin set hitachi-webserver-configs.hitachi-webserver-config.Web1-config.property.threads-per-child=100

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

サーバインスタンス関連

servers.server.Java EEサーバ名で始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

hitachi-relations.hitachi-relation-type-ref.hitachi-relation.関連名.order

サーバ間関連の順序番号を指定します。

0〜65535

省略不可

なし

asadmin set servers.server.JavaEE1.hitachi-relations.redirect.hitachi-relation.redirect1.order=10

2

hitachi-relations.prf-relation.hitachi-relation.関連名.property.拡張プロパティー

Java EEサーバのPRF関連に追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、サーバ間関連の関連元であるJava EEサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set servers.server.JavaEE1.hitachi-relations.prf-relation.hitachi-relation.prfref1.property.ex_timeout=600

3

hitachi-session-config.server-id

Web Serverで負荷分散を行う場合に、負荷分散先のJava EEサーバを特定するためのサーバIDを設定します。

このプロパティーで指定したサーバIDが、セッションIDの33文字目以降に設定されます。

サーバIDを明示的に設定しない場合は、Java EEサーバが動作しているホスト名、ドメイン名、サーバインスタンス名を基に、自動生成された最大52桁の英数字が設定されます。セッションIDを一意にするために、自動生成された値を使用することを推奨します。

Type : String

自動生成された最大52桁の英数字

なし

asadmin set servers.server.JavaEE1.hitachi-session-config.server-id=server1

4

property.拡張プロパティー

Java EEサーバに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、Java EEサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set servers.server.JavaEE1.property.ex_timeout=600

5

property.balancer-member-root-id

Webサーバからクラスターを介してこのサーバにリダイレクトする場合に使用するcookie-idを指定します。

Type: String

プロパティー削除

なし

asadmin set servers.server.JavaEE1.property.balancer-member-root-id=route01

6

property.env_環境変数名

Java EEサーバ起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverのインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどちらかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

Type: String

プロパティー削除

なし

asadmin set servers.server.JavaEE1.property.env_TZ=JST-9

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

configs.config.Java EEサーバの構成名で始まるパラメーター

パラメーター名がproperty.で始まるパラメーターをservers.server.Java EEサーバ名で始まるパラメーターでも定義している場合は、servers.server.Java EEサーバ名で始まるパラメーターの値が優先されます。また、構成名がクラスターで使用される場合は、クラスターに属するすべてのJava EEサーバに対して適用されます。

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

admin-service.jmx-connector.system.port

JMXのネットワークポートを設定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

なし

${JMX_SYSTEM_CONNECTOR_PORT}

asadmin set configs.config.JavaEE1-config.admin-service.jmx-connector.system.port=8686

2

availability-service.availability-enabled

特定のクラスター、またはasadmin setサブコマンドを使用する特定のWeb、EJB、JMSコンテナーの可用性を有効にするかどうかを設定します。

true|false

true

なし

asadmin set configs.config.Cluster1-config.availability-service.availability-enabled=true

3

connector-service.shutdown-timeout-in-seconds

Application Serverのシャットダウン時に、すべてのリソースアダプターが停止されます。シャットダウンはリソースを集中的に使用することが多い動作のため、シャットダウン中にリソースアダプターがハングアップする可能性があります。

このような状況を回避するため、リソースアダプターのシャットダウンを中断するためのタイムアウト値を設定できます。デフォルトのタイムアウト値は、リソースアダプターモジュール単位で30秒です。

1〜2147483647

30

なし

asadmin set configs.config.JavaEE1-config.connector-service.shutdown-timeout-in-seconds=60

4

ejb-container.max-cache-size

キャッシュできる最大インスタンス数を指定します。

0〜2147483647

512

2000

asadmin set configs.config.JavaEE1-config.ejb-container.max-cache-size=1000

5

ejb-container.max-pool-size

プールできる最大サイズを指定します。値が0の場合は、プールのサイズに制限がないことを示します。サイズが無制限のプールは、pool-resize-quantityの定義に従って、steady-pool-sizeへ収縮していきます。

0〜2147483647

32

24

asadmin set configs.config.JavaEE1-config.ejb-container.max-pool-size=30

6

ejb-container.steady-pool-size

通常プールに保持されるbeanインスタンスの数を指定します。

0〜2147483647

0

24

asadmin set configs.config.JavaEE1-config.ejb-container.steady-pool-size=20

7

group-management-service.group-discovery-timeout-in-millis

グループのほかのメンバーを見つけるためにインスタンスを起動しているとき、インスタンスのグループ管理サービスモジュールが待つ時間を、ミリ秒単位で指定します。

group-discovery-timeout-in-millisタイムアウトには、デフォルト値、またはそれより高い値を設定する必要があります。デフォルトは5000です。

1000〜120000

5000

なし

asadmin set configs.config.Cluster1-config.group-management-service.group-discovery-timeout-in-millis=8000

8

hitachi-eheap.httpsession-enabled

HTTPセッションに対して明示管理ヒープ機能を適用するかどうかを設定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-eheap.httpsession-enabled=false

9

hitachi-jaxrs-config.connect-timeout

jerseyが提供するClient configuration propertiesのjersey.config.client.connectTimeoutの初期値を、ミリ秒単位で設定します。

整数値（Type : Integer）

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxrs-config.connect-timeout=60000

10

hitachi-jaxrs-config.read-timeout

jerseyが提供するClient configuration propertiesのjersey.config.client.readTimeoutの初期値を、ミリ秒単位で設定します。

整数値（Type : Integer）

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxrs-config.read-timeout=300000

11

hitachi-jaxws-config.connect-timeout

JAX-WS仕様でのBindingProvider propertiesの、JAX-WS RIが提供するプロパティーcom.sun.xml.ws.connect.timeoutの初期値を、ミリ秒単位で設定します。

整数値（Type : Integer）

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxws-config.connect-timeout=60000

12

hitachi-jaxws-config.request-timeout

JAX-WS仕様でのBindingProvider propertiesの、JAX-WS RIが提供するプロパティーcom.sun.xml.ws.request.timeoutの初期値を、ミリ秒単位で設定します。

整数値（Type : Integer）

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxws-config.request-timeout=300000

13

hitachi-jaxws-config.security-auth-password

JAX-WS仕様でのBindingProvider propertiesのjavax.xml.ws.security.auth.passwordの初期値を設定します。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxws-config.security-auth-password=pass

14

hitachi-jaxws-config.security-auth-username

JAX-WS仕様でのBindingProvider propertiesのjavax.xml.ws.security.auth.usernameの初期値を設定します。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxws-config.security-auth-username=user

15

hitachi-jaxws-config.session-maintain

JAX-WS仕様でのBindingProvider propertiesのjavax.xml.ws.session.maintainの初期値を設定します。

true|false

なし

なし

asadmin set configs.config.JavaEE1-config.hitachi-jaxws-config.session-maintain=true

16

hitachi-jca.connection-auto-close-enabled

コネクション自動クローズの有効または無効を設定します。

サーブレットおよびJSPでユーザーが生成したスレッドで取得したコネクションは、自動クローズされません。

サーブレットおよびJSPの各種コールバックメソッド（initメソッドなど）、ならびにEJBの各種コールバックメソッド（ejbCreateメソッド、PostConstructメソッドなど）で取得したコネクションが明示的にクローズされていない場合、自動クローズされることがあります。

true|false

なし

true

asadmin set configs.config.JavaEE1-config.hitachi-jca.connection-auto-close-enabled=true

17

hitachi-manage-info.running-watch-interval-in-seconds

Java EEサーバの動作確認間隔を、秒単位で指定します。

1〜86400

省略不可

10

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.running-watch-interval-in-seconds=20

18

hitachi-manage-info.start-timeout-in-seconds

Java EEサーバの起動監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜3600

省略不可

60

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.start-timeout-in-seconds=180

19

hitachi-manage-info.starting-watch-interval-in-seconds

Java EEサーバの起動時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.starting-watch-interval-in-seconds=3

20

hitachi-manage-info.starting-watch-start-time-in-seconds

Java EEサーバの起動で、起動コマンドを実行してから動作確認を開始するまでの時間を、秒単位で指定します。

0〜86400

省略不可

0

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.starting-watch-start-time-in-seconds=60

21

hitachi-manage-info.stop-timeout-in-seconds

Java EEサーバの停止監視時間を、秒単位で指定します。0を指定した場合は、監視しません。

0〜1800

省略不可

60

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.stop-timeout-in-seconds=180

22

hitachi-manage-info.stopping-watch-interval-in-seconds

Java EEサーバの停止時監視間隔を、秒単位で指定します。

1〜86400

省略不可

1

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.stopping-watch-interval-in-seconds=3

23

hitachi-manage-info.template-path

Java EEサーバのサーバテンプレートのパスを絶対パスで指定します。

存在するディレクトリーパス

省略不可

ドメインルートディレクトリー/ドメイン名/server_templates/サーバ種別

asadmin set configs.config.JavaEE1-config.hitachi-manage-info.template-path=C:¥temp¥javaee

24

hitachi-monitoring.hitachi-statistics-files.base-time

稼働情報ファイルを切り替える際の基点時刻を、ローカルタイムの1970年1月1日0時0分0秒からの増分として分単位で指定します。

h時m分を基点にする場合には、h×60＋mを指定します。

0〜1439の整数（0〜23時間59分）

0

0

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.base-time=360

25

hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.jvm-memory-extensions

Java EE Server の稼働情報収集機能が収集するJava VMメモリー拡張稼働情報をファイルに蓄積するかどうかを指定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.jvm-memory-extensions=true

26

hitachi-monitoring.hitachi-statistics-files.interval

稼働情報ファイルの蓄積間隔を、秒単位で指定します。

1〜86400の整数（1秒〜1日）

60

60

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.interval=300

27

hitachi-monitoring.hitachi-statistics-files.output-dir

稼働情報ファイルの出力先を変更したいときに出力先ディレクトリーを絶対パスで指定します。

複数のサーバインスタンスで同じ出力先ディレクトリーを指定すると複数のサーバインスタンスが稼働情報を同じファイルに出力する可能性があるため、サーバインスタンスごとに異なる出力先ディレクトリーを指定してください。

半角英数字、-（ハイフン）、_（アンダースコア）、:（コロン）、¥（円記号）、/（スラッシュ）

空文字

空文字

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.output-dir=D:/monitoring_dir

28

hitachi-monitoring.hitachi-statistics-files.num

稼働情報ファイルのファイル面数を指定します。

2〜168の整数

8

8

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.num=14

29

hitachi-monitoring.hitachi-statistics-files.period

稼働情報ファイルの切り替え時間を、時間単位で指定します。

1〜744の整数（1時間〜31日）

24（1日）

24（1日）

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.period=1

30

http-service.virtual-server.id.property.errorReportValve.value

この仮想サーバ上のアプリケーションのデフォルトエラーページを生成するカスタムバルブの完全修飾クラス名を指定します。

この仮想サーバのデフォルトエラーページの方式を有効にするには、org.apache.catalina.valves.ErrorReportValveを指定してください。

この仮想サーバのデフォルトエラーページの方式を無効にするには、空文字を指定してください。

次のどちらかを指定します。

org.apache.catalina.valves.ErrorReportValve

空文字

org.apache.catalina.valves.ErrorReportValve

空文字

仮想サーバのデフォルトエラーページの方式を有効にする場合

asadmin set configs.config.JavaEE1-config.http-service.virtual-server.server.property.errorReportValve.value=org.apache.catalina.valves.ErrorReportValve

仮想サーバのデフォルトエラーページの方式を無効にする場合

asadmin set configs.config.JavaEE1-config.http-service.virtual-server.server.property.errorReportValve.value=""

31

iiop-service.iiop-listener.id.port

リスナーのポート番号を指定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

1072

3700 <Java EEサーバの構成名="server-config", id="orb-listener-1"の場合>

${IIOP_LISTENER_PORT}<サーバインスタンスの場合>

asadmin set configs.config.JavaEE1-config.iiop-service.iiop-listener.orb-listener-1.port=9999

32

java-config.native-library-path-prefix

ネイティブライブラリーへのパスのプレフィックスを設定します。

パス区切り文字は、":"です。

このパラメーターを変更したあとに、サーバを再起動する必要があります。

Type: String

空文字

なし

asadmin set configs.config.JavaEE1-config.java-config.native-library-path-prefix=D:¥usr¥nativelib

33

jms-service.jms-host.JMS host name.port

JMSプロバイダーのネットワークポートを指定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

なし

${JMS_PROVIDER_PORT}

asadmin set configs.config.JavaEE1-config.jms-service.jms-host.default_JMS_host.port=7677

34

jms-service.reconnect-interval-in-seconds

再接続を試行する間隔を、秒単位で指定します。

この間隔は、AddressListの各JMSホストへの試行、およびAddressList中の連続するアドレスに対して適用されます。この間隔が短過ぎると、JMSホストが回復する時間がなくなります。また、長過ぎると、再コネクトが遅くなります。

1〜2147483647

5

なし

asadmin set configs.config.JavaEE1-config.jms-service.reconnect-interval-in-seconds=5

35

mdb-container.max-pool-size

クライアントのリクエストに対応するために作成できるコネクションの最大数を指定します。

0〜2147483647

32

なし

asadmin set configs.config.JavaEE1-config.mdb-container.max-pool-size=20

36

monitoring-service.module-monitoring-levels.hitachi-jvm-memory-extensions

Java VMメモリー拡張稼働情報の監視レベルを指定します。

LOW|HIGH|OFF

OFF

HIGH

asadmin set configs.config.JavaEE1-config.monitoring-service.module-monitoring-levels.hitachi-jvm-memory-extensions=OFF

37

monitoring-service.module-monitoring-levels.http-service

HTTPサービスの監視レベルを指定します。

監視レベルにHIGHまたはLOWを設定すると、HTTPサービスの監視が有効になります。監視レベルにOFFを設定すると、HTTPサービスの監視が無効になります。

OFF：監視は行いません。パフォーマンスへの影響はありません。

LOW：作成数やバイト数などの簡易的な統計を行います。

HIGH：簡易的な統計に加えて、メソッド数や期間などのメソッド統計を行います

OFF|LOW|HIGH

OFF

HIGH

asadmin set configs.config.JavaEE1-config.monitoring-service.module-monitoring-levels.http-service=HIGH

38

monitoring-service.module-monitoring-levels.jdbc-connection-pool

JDBCコネクションプールの監視レベルを指定します。

監視レベルにHIGHまたはLOWを設定すると、JDBCコネクションプールの監視が有効になります。監視レベルにOFFを設定すると、JDBCコネクションプールの監視が無効になります。

OFF：監視は行いません。パフォーマンスへの影響はありません。

LOW：作成数やバイト数などの簡易的な統計を行います。

HIGH：簡易的な統計に加えて、メソッド数や期間などのメソッド統計を行います。

OFF|LOW|HIGH

OFF

HIGH

asadmin set configs.config.JavaEE1-config.monitoring-service.module-monitoring-levels.jdbc-connection-pool=HIGH

39

monitoring-service.module-monitoring-levels.web-container

Webコンテナーの監視レベルを指定します。

監視レベルにHIGHまたはLOWを設定すると、Webコンテナーの監視が有効になります。監視レベルにOFFを設定すると、Webコンテナーの監視が無効になります。

OFF：監視は行いません。パフォーマンスへの影響はありません。

LOW：作成数やバイト数などの簡易的な統計を行います。

HIGH：簡易的な統計に加えて、メソッド数や期間などのメソッド統計を行います。

OFF|LOW|HIGH

OFF

HIGH

asadmin set configs.config.JavaEE1-config.monitoring-service.module-monitoring-levels.web-container=HIGH

40

network-config.network-listeners.network-listener.name.enabled

リスナーをアクティブにするかどうかを指定します。

true|false

true

なし

asadmin set configs.config.JavaEE1-config.network-config.network-listeners.network-listener.http-listener-1.enabled=false

41

network-config.network-listeners.network-listener.name.port

ネットワークリスナーのネットワークポートを指定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

なし

8080<ドメイン管理サーバのhttp-listener-1の場合>

8181<ドメイン管理サーバのhttp-listener-2の場合>

${HTTP_LISTENER_PORT}<サーバインスタンスのhttp-listener-1の場合>

${HTTP_SSL_LISTENER_PORT}<サーバインスタンスのhttp-listener-2の場合>

asadmin set configs.config.JavaEE1-config.network-config.network-listeners.network-listener.http-listener-1.port=8080

42

network-config.protocols.protocol.admin-listener.http.request-timeout-seconds

リクエストがタイムアウトするまでの時間を、秒単位で指定します。

リクエストの処理時間（リクエストの処理の開始から完了まで）が、 このパラメーターに設定した時間を越えた場合、リクエストタイムアウトが発生します。

0を指定した場合は、タイムアウトしません。

タイムアウト値に0（タイムアウト無効）を指定することは推奨しません。0を指定した場合、admin-listenerのリクエストの処理時間が長期化すると、そのコマンド処理がasadminサブコマンドおよびユーザーリクエストを処理するスレッドを専有してしまうおそれがあります。

0〜2147483647

900

900

asadmin set configs.config.JavaEE1-config.network-config.protocols.protocol.admin-listener.http.request-timeout-seconds=600

43

network-config.protocols.protocol.http-listener-1.http.max-connections

サーバによってコネクションが閉じられるまでにパイプライン化できるHTTPリクエストの最大数を指定します。

このプロパティーに1を設定すると、HTTP/1.0 keep-alive、HTTP/1.1 keep-alive、およびパイプライン化が無効になります。

1〜2147483647

256

なし

asadmin set configs.config.JavaEE1-config.network-config.protocols.protocol.http-listener-1.http.max-connections=120

44

network-config.protocols.protocol.http-listener-1.http.request-timeout-seconds

リクエストがタイムアウトするまでの時間を、秒単位で指定します。

リクエストの処理時間（リクエストの処理の開始から完了まで）が、このパラメーターに設定した時間を越えた場合、リクエストタイムアウトが発生し ます。

0を指定した場合は、タイムアウトしません。単位は秒です。

WebSocketを使用する場合も、このタイムアウトは有効です。WebSocketの場合は、受信したWebSocketフレームに関連するServerEndpointの処理時間に対してのタイムアウトに使用されます。

0〜2147483647

900

190

asadmin set configs.config.JavaEE1-config.network-config.protocols.protocol.http-listener-1.http.request-timeout-seconds=600

45

network-config.protocols.protocol.http-listener-1.http.timeout-seconds

keep-alive状態およびアイドル状態であるコネクションが、タイムアウトするまでの時間を、秒単位で指定します。

0未満の値を指定した場合は、タイムアウトしません。単位は秒です。

-1〜2147483647

30

-1

asadmin set configs.config.JavaEE1-config.network-config.protocols.protocol.http-listener-1.http.timeout-seconds=20

46

network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds

リクエストがタイムアウトするまでの時間を、秒単位で指定します。

リクエストの処理時間（リクエストの処理の開始から完了まで）が、 このパラメーターに設定した時間を越えた場合、リクエストタイムアウトが発生します。

0を指定した場合は、タイムアウトしません。

タイムアウト値に0（タイムアウト無効）を指定することは推奨しません。0を指定した場合、admin-listenerのリクエストの処理時間が長期化すると、そのコマンド処理がasadminサブコマンドおよびユーザーリクエストを処理するスレッドを専有してしまうおそれがあります。

0〜2147483647

900

900

asadmin set configs.config.JavaEE1-config.network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds=600

47

property.拡張プロパティー

Java EEサーバに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、Java EEサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set configs.config.JavaEE1-config.property.ex_timeout=600

48

property.balancer-member-root-id

Webサーバからクラスターを介してこのサーバにリダイレクトする場合に使用するcookie-idを指定します。

Type: String

プロパティー削除

なし

asadmin set configs.config.JavaEE1-config.property.balancer-member-root-id=route01

49

property.env_環境変数名

Java EEサーバ起動時に設定する環境変数を指定します。複数の環境変数を指定する場合は、この標準プロパティーを複数指定します。

環境変数の指定値に${apserver.home}が含まれている場合は、Application Serverのインストールディレクトリーに置換されます。

なお、このプロパティー値に環境変数値を引き継ぐ指定（%PATH%;C:¥tempや${PATH}:/tempという指定）をしても、その環境変数の値は引き継がれません。指定する場合は、次のどちらかの場所で定義してください。

ノード上OSのシステム環境変数

ノード上のasenvの定義

Type: String

プロパティー削除

なし

asadmin set configs.config.JavaEE1-config.property.env_TZ=JST-9

50

security-service.activate-default-principal-to-role-mapping

アプリケーション固有のマッピングが定義されていないロールマッピングに対して、デフォルトプリンシパルを適用します。各ロールは、mapped-principal-classで定義されたjava.security.Principal実装クラスのインスタンスへマッピングされます。このクラスは、ロールと同じ名称を持っています。

true|false

false

なし

asadmin set configs.config.JavaEE1-config.security-service.activate-default-principal-to-role-mapping=true

51

security-service.default-principal

プリンシパルが提供されていない場合に、必要に応じてデフォルトセキュリティーコンテキストの識別に使用します。この属性は、通常のサーバ運用では設定する必要はありません。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.security-service.default-principal=dsmith

52

security-service.default-principal-password

デフォルトプリンシパルのパスワードを指定します。この属性は、通常のサーバ運用では設定する必要はありません。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.security-service.default-principal-password=secret

53

security-service.mapped-principal-class

activate-default-principal-to-role-mappingにtrueが設定された場合に使用される、java.security.Principalインプリメンテーションクラスをカスタマイズします。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.security-service.mapped-principal-class=CustomPrincipalImplClass

54

thread-pools.thread-pool.name.idle-thread-timeout-seconds

プールからアイドルスレッドが削除されるまでの時間 を、秒単位で指定します。

1〜2147483647

900

なし

asadmin set configs.config.JavaEE1-config.thread-pools.thread-pool.thread-pool-1.idle-thread-timeout-seconds=1000

55

thread-pools.thread-pool.name.max-queue-size

スレッドプールのキューに格納できる最大タスク数を指定します。

-1の場合、最大数のチェックは実施されません。

-1または1〜2147483647

4096

80 <http-thread-poolの場合>

asadmin set configs.config.JavaEE1-config.thread-pools.thread-pool.thread-pool-1.max-queue-size=1000

56

thread-pools.thread-pool.name.max-thread-pool-size

プールに含めることができるスレッドの最大数を指定します。iiop-listenerで使用するためにこのスレッドプールを最適化するには、この値を200に設定します。

1〜2147483647

5

200 <thread-pool-1の場合>

24 <http-thread-poolの場合>

asadmin set configs.config.JavaEE1-config.thread-pools.thread-pool.http-thread-pool.max-thread-pool-size=8

57

thread-pools.thread-pool.name.min-thread-pool-size

リクエストを処理する最小のスレッド数を指定します。このスレッドプールがインスタンス化されると、これらのスレッドは事前に作成されます。

1〜2147483647

2

24 <http-thread-poolの場合>

asadmin set configs.config.JavaEE1-config.thread-pools.thread-pool.thread-pool-1.min-thread-pool-size=20

58

transaction-service.automatic-recovery

サービスの起動時に保留中のトランザクションを完了させるかどうかを指定します。

true|false

false

true

asadmin set configs.config.JavaEE1-config.transaction-service.automatic-recovery=false

59

transaction-service.heuristic-decision

ほかのトランザクション参加者が到達できないために分散トランザクションの結果を決定できない場合、このプロパティーが結果を決定します。

commit|rollback

rollback

なし

asadmin set configs.config.JavaEE1-config.transaction-service.heuristic-decision=rollback

60

transaction-service.keypoint-interval

ログ内のキーポイント処理間のトランザクション数を指定します。キーポイント処理はトランザクションのステータスファイルを圧縮することでサイズ容量を減少させます。

この属性に対して大きな値を指定すると、より大きなトランザクションのステータスファイルになって、キーポイント処理が少なく、潜在的に優れた性能になります。

小さな値を指定すると、より小さなログファイルになって、キーポイント処理の頻度が高いため若干性能が低下します。

0〜2147483647

65536

なし

asadmin set configs.config.JavaEE1-config.transaction-service.keypoint-interval=2048

61

transaction-service.property.db-logging-resource

トランザクションサービスを構築するために使用します。このプロパティーにはデフォルト値がありません。また、デフォルトでは設定されていません。

Type: String

なし

なし

asadmin set configs.config.JavaEE1-config.transaction-service.property.db-logging-resource="jdbc/TxnDS"

62

transaction-service.property.oracle-xa-recovery-workaround

XAResource.commitメソッドに問題がある場合にサーバの回避方法を無効にするには、このプロパティー値にfalseを設定します。

true|false

true

なし

asadmin set configs.config.JavaEE1-config.transaction-service.property.oracle-xa-recovery-workaround=true

63

transaction-service.property.pending-txn-cleanup-interval

トランザクションサービスを構築するために使用します。このプロパティーに-1を指定した場合は、定期回復スレッドが実行されません。単位は秒です。

定期自動回復は、このプロパティーに正数の値が設定されている場合に、スレッドのバックグラウンドで実行されます。

-1または1〜2147483647

なし（プロパティーがあって値が空の場合は60）

なし

asadmin set configs.config.JavaEE1-config.transaction-service.property.pending-txn-cleanup-interval=-1

64

transaction-service.property.use-last-agent-optimization

トランザクションサービスを構築するために使用します。このプロパティーはデフォルトでtrueが設定されています。

trueの場合、トランザクション処理能力を向上させる最終エージェント最適化を有効にします。同じトランザクション内で非XAリソースとXAリソースが使用された場合、非XAリソースが最後のエージェントになります。

true|false

true

なし

asadmin set configs.config.JavaEE1-config.transaction-service.property.use-last-agent-optimization=true

65

transaction-service.property.wait-time-before-recovery-insec

トランザクションサービスを構築するために使用します。

1〜2147483647

60

なし

asadmin set configs.config.JavaEE1-config.transaction-service.property.wait-time-before-recovery-insec=60

66

transaction-service.property.xaresource-txn-timeout

トランザクションサービスを構築するために使用します。このプロパティーに0を指定した場合は、タイムアウトしません。単位は秒です。

XAResourceタイムアウトを変更します。場合によっては、XAResourceのデフォルトのタイムアウトはトランザクションが中止される可能性があるため、値の変更を推奨します。

0〜2147483647

120（XAResourceに依存します）

180

asadmin set configs.config.JavaEE1-config.transaction-service.property.xaresource-txn-timeout=0

67

transaction-service.retry-timeout-in-seconds

次の場合でのリトライ時間を決定します。

トランザクションリカバリータイムでリソースへの到達が不可能な場合

2相コミットプロトコルの第2相に一時的な例外がある場合

-1を指定した場合は、無限にリトライします。

0を指定した場合は、リトライしません。

正の値は、リトライが試みられるまでの時間を意味します。

-1〜2147483647

600

なし

asadmin set configs.config.JavaEE1-config.transaction-service.retry-timeout-in-seconds=600

68

transaction-service.timeout-in-seconds

トランザクションが中止されるまでの時間を指定します。0を指定した場合、トランザクションはタイムアウトしません。

0〜2147483647

0

180

asadmin set configs.config.JavaEE1-config.transaction-service.timeout-in-seconds=0

69

web-container.session-config.session-manager.manager-properties.max-sessions

キャッシュに格納できるセッションの最大数を指定します。制限を設けない場合は、-1を指定します。

指定した 最大数に達した状態で新規のセッションを作成すると、IllegalStateExceptionが発生します。

-1または1〜2147483647

-1

なし

asadmin set configs.config.JavaEE1-config.web-container.session-config.session-manager.manager-properties.max-sessions=10

70

web-container.session-config.session-properties.timeout-in-seconds

セッションがタイムアウトするまでの時間を、秒単位で指定します。

0を指定した場合、セッションはタイムアウトしません。

0〜2147483647

1800

7200

asadmin set configs.config.JavaEE1-config.web-container.session-config.session-properties.timeout-in-seconds=5000

71

hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.network-connection-queue

Java EE Serverの稼働情報収集機能が収集するネットワークコネクションキュー稼働情報をファイルに蓄積するかどうかを指定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.network-connection-queue=true

72

hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.network-thread-pool

Java EE Serverの稼働情報収集機能が収集するネットワークスレッドプール稼働情報をファイルに蓄積するかどうかを指定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.network-thread-pool=true

73

hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.jdbc-connection-pool

Java EE Serverの稼働情報収集機能が収集するリソース稼働情報（接続プール）のうち、JDBC接続プールの稼働情報をファイルに蓄積するかどうかを指定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.jdbc-connection-pool=true

74

hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.web-session

Java EE Serverの稼働情報収集機能が収集するWebセッション稼働情報をファイルに蓄積するかどうかを指定します。

true|false

true

true

asadmin set configs.config.JavaEE1-config.hitachi-monitoring.hitachi-statistics-files.hitachi-output-enabled.web-session=true

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

clusters.cluster.クラスター名で始まるパラメーター

項番

パラメーター名

説明

指定できる値

デフォルト値

製品出荷時の値

指定例

1

config-ref

サーバインスタンスが使用するconfigの名称を参照します。

Type: String

なし

なし

asadmin get clusters.cluster.Cluster1.config-ref

2

gms-bind-interface-address

グループ管理サービスがバインドするネットワークインターフェースのIPアドレスです。

Type: String

なし

なし

asadmin set clusters.cluster.Cluster1.gms-bind-interface-address=%GMS-BIND-INTERFACE-ADDRESS-mycluster%

運用管理関連

運用管理関連

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

hitachi-domain.hitachi-snapshot.max-num

システム情報アーカイブファイルの出力先ディレクトリーに生成できるファイルの数を指定します。ドメインや複数のノードのアーカイブファイル出力先に同じディレクトリーを指定する場合は、このパラメーターに同じ数値を指定してください。

指定したファイル数を超える場合は、古いファイルから削除されます。

このパラメーターの設定値は、ドメイン全体に適用されます。設定値を反映するため、設定後には、ドメイン内のすべてのWebサーバ、Java EEサーバ、およびPRFデーモンを再起動してください。

5〜2147483647

10

10

asadmin set hitachi-domain.hitachi-snapshot.max-num=20

2

hitachi-domain.hitachi-snapshot.output-dir

システム情報アーカイブファイルの出力先ディレクトリーを、絶対パスで指定します。出力先ディレクトリーには、ローカルドライブ上の作成済みディレクトリーだけを指定できます。

このパラメーターの設定値は、ドメイン全体に適用されます。設定値を反映するため、設定後には、ドメイン内のすべてのWebサーバ、Java EEサーバ、およびPRFデーモンを再起動してください。

半角英数字、-（ハイフン）、_（アンダースコア）、:（コロン）、¥（円記号）、/（スラッシュ）

Application Serverインストールディレクトリー/javaee/snapshot

Application Serverインストールディレクトリー/javaee/snapshot

asadmin set hitachi-domain.hitachi-snapshot.output-dir=/logs/snapshot

3

hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.enabled

このイベント検知時コマンドを実行するかどうかを指定します。

true|false

省略不可

true

asadmin set hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.Event1.enabled=false

4

hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.monitoring-max-count

hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.monitoring-time-span-in-secondsで設定した時間内に、同じ種類のイベントに対するイベント検知時コマンドの実行を、最大何回許すかを指定します。

0を指定した場合は、常にイベント検知時コマンドの実行を許可します。

1以上を指定した場合は、hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.monitoring-time-span-in-secondsで設定した時間内に指定回数を超えるイベントが発生すると、指定回数を超えた分のイベントに対するイベント検知時コマンドは実行されません。

0〜256

省略不可

0

asadmin set hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.Event1.monitoring-max-count=5

5

hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.monitoring-time-span-in-seconds

最大許容実行回数※を設定する時間間隔を、秒単位で指定します。

0を指定した場合は、監視しません。

1以上を指定した場合は、指定時間の間監視します。

注※

最大許容実行回数は、hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.monitoring-max-countで設定します。

0〜2147483647

省略不可

0

asadmin set hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.Event1.monitoring-time-span-in-seconds=60

6

hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.イベント名.path

イベント検知時コマンドを絶対パスで指定します。ファイルの区切りには/を使用します。

イベント検知時コマンドをシェルスクリプトで作成した場合、コマンド名の前に/bin/shを追加して指定してください。/bin/shが指定されていない場合、コマンドが正常に動作しないことがあります。

指定例

/bin/sh /home/user1/javaeeabnormalend.sh

Type: String

省略不可

Application Serverインストールディレクトリー/glassfish/config/manager/snapshot_event-hook

このスクリプトを正常に稼働させるためには、スクリプトファイルの次の変数を設定する必要があります。

ADMIN_HOST

UID

PWDFILE

asadmin set hitachi-manage-configs.hitachi-hook-policy.hitachi-event-hooks.hitachi-event-hook.Event1.path=/temp/event-hook.sh

7

hitachi-relation-types.hitachi-relation-type.prf-relation.property.拡張プロパティー

PRF関連に追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、サーバ間関連の関連元サーバを設定するサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-relation-types.hitachi-relation-type.prf-relation.property.ex_timeout=600

8

hitachi-relation-types.hitachi-relation-type.redirect.property.拡張プロパティー

リダイレクト関連に追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、サーバ間関連の関連元であるWebサーバを設定するサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.ex_timeout=600

9

hitachi-relation-types.hitachi-relation-type.redirect.property.negative

リダイレクターの動作の定義で、マッピング定義に対するリクエストを除外するかどうかを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブの!オプションに対応します。

true|false

プロパティー削除

false

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.negative=true

10

hitachi-relation-types.hitachi-relation-type.redirect.property.network-listener

リダイレクト先となるネットワークリスナー名を指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのURLに対応します。URLには指定したネットワークリスナー名から特定されたホスト名とポート番号が設定されます。

ネットワークリスナー名の文字列

プロパティー削除

http-listener-1

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.network-listener=http-listener-1

11

hitachi-relation-types.hitachi-relation-type.redirect.property.path

リダイレクターの動作の定義で、マッピング定義のローカルの仮想パスの名前を指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのパス名指定に対応します。

Type: String（httpsd.confファイルのProxyPassに定義するパス名（ローカルの仮想パスの名前）の形式）

プロパティー削除

/

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.path=/news/

12

hitachi-relation-types.hitachi-relation-type.redirect.property.proxy-pass-option

リダイレクターの動作の定義で、マッピング定義のコネクションプーリングの調整パラメーターを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブの「キー=値」指定に対応します。

httpsd.confファイルのProxyPassに定義するコネクションプーリングの調整パラメーターの形式（[key=value key=value …]）

プロパティー削除

空文字

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.proxy-pass-option=timeout=300

13

hitachi-relation-types.hitachi-relation-type.redirect.property.set-proxy-pass-reverse-cookie

リダイレクターの動作の定義で、Set-Cookieヘッダーの再割り当てをするかどうかを指定します。

このプロパティーは、Web ServerのHWSProxyPassReverseCookieディレクティブに対応します。

true|false

プロパティー削除

true

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.set-proxy-pass-reverse-cookie=true

14

hitachi-relation-types.hitachi-relation-type.redirect.property.stickysession

リダイレクターの動作の定義で、Stickyを有効にするかどうかを指定します。

このプロパティーは、Web ServerのProxyPassディレクティブのstickysessionキーに対応します。

また、このプロパティーにtrueを指定すると、必要なHeaderディレクティブが追加されます。

true|false

プロパティー削除

true

asadmin set hitachi-relation-types.hitachi-relation-type.redirect.property.stickysession=true

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

ドメイン管理サーバ関連

項番

パラメーター名

説明

指定できる値

デフォルト値

製品出荷時の値

指定例

1

configs.config.server-config.network-config.network-listeners.network-listener.name.port

ネットワークリスナーのネットワークポートを指定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

なし

8080<http-listener-1の場合>

8181<http-listener-2の場合>

4848<admin-listenerの場合>

asadmin set configs.config.server-config.network-config.network-listeners.network-listener.http-listener-1.port=8080

2

configs.config.server-config.network-config.network-listeners.network-listener.name.enabled

リスナーをアクティブにするかどうかを指定します。

true|false

true

なし

asadmin set configs.config.server-config.network-config.network-listeners.network-listener.http-listener-1.enabled=false

3

configs.config.server-config.network-config.protocols.protocol.admin-listener.http.request-timeout-seconds

リクエストがタイムアウトするまでの時間を、秒単位で指定します。

リクエストの処理時間（リクエストの処理の開始から完了まで）が、このパラメーターに設定した時間を超えた場合、リクエストタイムアウトが発生します。

0を指定した場合は、タイムアウトしません。

タイムアウト値に0（タイムアウト無効）を指定することは推奨しません。0を指定した場合、admin-listenerのリクエスト処理時間が長期化すると、そのコマンド処理がasadminサブコマンドのスレッドを占有し、asadminコマンドが使用できなくなるおそれがあります。

0〜2147483647

900

900

asadmin set configs.config.server-config.network-config.protocols.protocol.admin-listener.http.request-timeout-seconds=600

4

configs.config.server-config.network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds

リクエストがタイムアウトするまでの時間を、秒単位で指定します。

リクエストの処理時間（リクエストの処理の開始から完了まで）が、このパラメーターに設定した時間を超えた場合、リクエストタイムアウトが発生します。

0を指定した場合は、タイムアウトしません。

タイムアウト値に0（タイムアウト無効）を指定することは推奨しません。0を指定した場合、sec-admin-listenerのリクエスト処理時間が長期化すると、そのコマンド処理がasadminサブコマンドのスレッドを占有し、asadminコマンドが使用できなくなるおそれがあります。

本パラメーターはsecure admin機能が有効な場合に使用します。

0〜2147483647

900

900

asadmin set configs.config.server-config.network-config.protocols.protocol.sec-admin-listener.http.request-timeout-seconds=600

5

configs.config.server-config.admin-service.jmx-connector.system.port

JMXのネットワークポートを設定します。

UNIX上でポート番号1〜1024をリッスンするソケットを作成するには、スーパーユーザー権限が必要です。

1〜65535

なし

8686

asadmin set configs.config.server-config.admin-service.jmx-connector.system.port=8686

ノード関連

ノード関連

項番

パラメーター名

説明

指定できる値

デフォルト値※

製品出荷時の値

指定例

1

nodes.node.ノード名.node-host

ノードが表すホストの名前を指定します。

Type: String

なし

localhost

asadmin set nodes.nodenode1.node-host=HostA

2

nodes.node.ノード名.hitachi-node.property.拡張プロパティー

ノードに追加する拡張プロパティーとして、任意のプロパティー名およびその値を指定します。プロパティー名はex_から始まる名称で指定します。

追加した拡張プロパティーは、ノードに存在するサーバのサーバテンプレートの各ファイルに記述する置き換え文字列として使用できます。

Type: String

プロパティー削除

なし

asadmin set nodes.node.node1.hitachi-node.property.ex_timeout=600

3

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.output-dir

各ノードのシステム情報アーカイブファイルの出力先ディレクトリーを絶対パスで指定します。ドメイン管理サーバのシステム情報の出力に関する設定は、デフォルトノード（localhost-ドメイン名）のパラメーターを指定することで変更できます。

出力先ディレクトリーには、ローカルドライブ上の作成済みディレクトリーだけを指定できます。

設定値が空文字の場合は、hitachi-domain.hitachi-snapshot.output-dirパラメーターの設定値が適用されます。

空文字以外の値を設定した場合は、hitachi-domain.hitachi-snapshot.output-dirパラメーターの値より優先して適用されます。

このパラメーターは、値を設定したノードだけに適用されます。

半角英数字、-（ハイフン）、_（アンダースコア）、:（コロン）、¥（円記号）、/（スラッシュ）

hitachi-domain.hitachi-snapshot.output-dirパラメーターの設定値

空文字

asadmin set nodes.node.node1.hitachi-node.hitachi-node-snapshot.output-dir=/logs/node1/snapshot

4

nodes.node.ノード名.hitachi-node.hitachi-node-snapshot.max-num

各ノードのシステム情報アーカイブファイルの出力先ディレクトリーに生成できるファイルの数を指定します。ドメイン管理サーバのシステム情報の出力に関する設定は、デフォルトノード（localhost-ドメイン名）のパラメーターを指定することで変更できます。

ドメインや複数のノードのアーカイブファイル出力先に同じディレクトリーを指定する場合は、このパラメーターに同じ数値を指定します。

指定したファイル数を超える場合は、古いファイルから削除されます。

設定値が空文字の場合は、hitachi-domain.hitachi-snapshot.max-numパラメーターの設定値が適用されます。

空文字以外の値を設定した場合は、hitachi-domain.hitachi-snapshot.max-numパラメーターの値より優先して適用されます。

このパラメーターは、値を設定したノードだけに適用されます。

5〜2147483647

hitachi-domain.hitachi-snapshot.max-numパラメーターの設定値

空文字

asadmin set nodes.node.node1.hitachi-node.hitachi-node-snapshot.max-num=20

注※

デフォルト値欄に「プロパティー削除」と記載されているパラメーターは、空文字を指定することでプロパティー自体が削除されます。

2.12　システム管理で使用するコマンド

システム管理で使用するコマンドの書式、機能などについて説明します。

2.12.1　add-library

1つ以上のライブラリーのアーカイブをJava EE Serverに追加

書式

asadmin [asadmin-options] add-library [--help]
    [--type={common|ext|app}] [--upload={false|true}]
    library-file-path [library-file-path ... ]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

add-libraryサブコマンドは、1つ以上のライブラリーのアーカイブをJava EE Serverに追加します。

このサブコマンドはリモートモードだけサポートします。

サーバのランタイムによってライブラリーのアーカイブが確実に取り込まれるように、ドメイン管理サーバまたはサーバインスタンスを再起動する必要があります。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

ドメイン管理サーバまたはサーバインスタンスに追加するライブラリーのアーカイブは、add-libraryサブコマンドの実行時に入力データとして使用されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--type={common|ext|app}

ライブラリータイプと、ライブラリーのアーカイブの追加先のディレクトリーを指定します。

型：String

指定できる値を次に示します。

common

Commonクラスローダーディレクトリー、domain-dir/libにライブラリーのアーカイブを追加します。

ext

Javaオプションパッケージディレクトリー、domain-dir/lib/extにライブラリーのアーカイブを追加します。

app

アプリケーション固有のクラスローダーディレクトリー、domain-dir/lib/applibsにライブラリーのアーカイブを追加します。Applibクラスローダーでロードするには、追加したライブラリーをdeployまたはredeployサブコマンドの--librariesオプションに指定してください。

デフォルト値：common

--upload={false|true}

ライブラリーのアーカイブをドメイン管理サーバにアップロードするかどうかを指定します。ディレクトリーが指定されている場合、このオプションは無視されます。

型：Boolean

指定できる値を次に示します。

true

ドメイン管理サーバにライブラリーのアーカイブをアップロードします。

false

ドメイン管理サーバにライブラリーのアーカイブをアップロードしません。add-libraryサブコマンドは、指定のファイル名でファイルアクセスを試行します。

ドメイン管理サーバが管理ユーザーと異なるユーザーで動作していて、ファイルの読み取りアクセス権がないなど、ドメイン管理サーバがライブラリーのアーカイブにアクセスできない場合は、このサブコマンドはエラーになります。

デフォルト値：

デフォルト値は、ドメイン管理サーバがサブコマンド実行中のホスト上にあるか、リモートホスト上にあるかに依存します。

ドメイン管理サーバがサブコマンドが動作するホスト上にある場合、false。

ドメイン管理サーバがリモートホスト上にある場合、true。

library-file-path

追加するライブラリーのアーカイブのパスを指定します。複数のパスを指定する場合は、各パスをスペースで区切ります。絶対パスでも相対パスでも指定できます。相対パスは、ディレクトリーApplication Serverインストールディレクトリー/javaee/glassfish/binからの相対パスを指定します。

型：String

指定できる値を次に示します。

スペースで区切られたライブラリーのアーカイブのパス

デフォルト値：なし

使用例

次の例では、mylib.jarライブラリーのアーカイブ内のライブラリーを、デフォルトのサーバインスタンス上にある、アプリケーション固有のクラスローダーディレクトリーに追加します。

asadmin add-library --type app /tmp/mylib.jar

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.2　create-profiler

プロファイラー要素の作成

書式

asadmin [asadmin-options] create-profiler [--help]
    [--target target] [--classpath classpath]
    [--nativelibrarypath native_library_path] [--enabled={false|true}]
    profiler_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-profilerサブコマンドでは、プロファイラー要素を作成します。サーバインスタンスは、Java構成のプロファイラー要素によってプロファイラーに結び付けられます。一度に存在できるのは1つのプロファイラーだけです。プロファイラーがすでにあるときに作成しようとすると、エラーメッセージが表示されます。変更を有効にするには、サーバを再起動する必要があります。

このサブコマンドはリモートモードだけサポートします。

一度に存在できるのは1つのプロファイラーだけです。プロファイラーがすでにあるときに作成しようとすると、エラーメッセージが表示されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するプロファイラーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--classpath classpath

プロファイラーで必要なJavaクラスを指定します。

型：String

指定できる値を次に示します。

プロファイラーに必要なクラスパス

デフォルト値：なし

--nativelibrarypath native_library_path

自動的に構築されるパスを指定します。このパスは次の要素を連結したものです。

Java EE Serverインストールディレクトリからの相対パス（ネイティブ共有ライブラリー用）

標準JRE ネイティブライブラリーへのパス

シェル環境設定（UNIXでのLD_LIBRARY_PATH）

プロファイル要素で指定した任意のパス

型：String

指定できる値を次に示します。

ネイティブライブラリーへのパス

デフォルト値：なし

--enabled={false|true}

プロファイラーがデフォルトで有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

profiler_name

プロファイラーの名称を指定します。

型：String

指定できる値を次に示します。

プロファイラー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、プロファイラーを作成します。

asadmin create-profiler --target instance1 --classpath /home/appserver/
 --nativelibrarypath /u/home/lib --enabled=false sample_profiler

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.3　delete-profiler

プロファイラー要素の削除

書式

asadmin [asadmin-options] delete-profiler [--help]
    [--target target] profiler_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-profilerサブコマンドは、Java構成のプロファイラー要素を削除します。

一度に存在できるのは1つのプロファイラーだけです。プロファイラーが存在しないときに削除しようとすると、エラーメッセージが表示されます。

このサブコマンドによる変更を有効にするには、サーバを再起動する必要があります。

このコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するプロファイラーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

profiler_name

プロファイラー名を指定します。

型：String

指定できる値を次に示します。

プロファイラー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスのプロファイラーを削除します。

asadmin delete-profiler --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.4　list-commands

使用できるコマンドの一覧表示

書式

asadmin [asadmin-options] list-commands [--help]
    [--localonly={false|true}] [--remoteonly={false|true}]
    [pattern-list]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-commandsサブコマンドはasadminのサブコマンドを一覧表示します。デフォルトでは、list-commandsサブコマンドはローカルサブコマンドの一覧と、それに続いてリモートサブコマンドの一覧を表示します。リモートサブコマンドまたはローカルサブコマンドだけを表示したり、指定したテキスト文字列を名称に含むサブコマンドだけを表示したりするように指定することもできます。

このサブコマンドはローカルモードとリモートモードをサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--localonly={false|true}

trueを設定した場合、ローカルコマンドだけが一覧表示されます。

なお、trueを設定した場合、--remoteonlyオプションはfalseを設定する必要があります。それ以外の場合は、エラーが発生します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--remoteonly={false|true}

trueを設定した場合、リモートコマンドだけが一覧表示されます。

なお、trueを設定した場合、--localonlyオプションはfalseを設定する必要があります。それ以外の場合は、エラーが発生します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

pattern-list

サブコマンドの一覧をフィルター処理するためのテキスト文字列の空白区切りのリストを指定します。指定したテキスト文字列のどれかが含まれるサブコマンドだけが一覧表示されます。

型：String

指定できる値を次に示します。

サブコマンド名

デフォルト値：なし

使用例

次の例では、ローカルサブコマンドだけを一覧表示します。

asadmin list-commands --localonly=true

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.5　list-libraries

ライブラリーのアーカイブの一覧表示

書式

asadmin [asadmin-options] list-libraries [--help]
    [--type={common|ext|app}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-librariesサブコマンドは、Java EE Serverのライブラリーのアーカイブを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

--typeオプションには、ライブラリータイプを指定することで、対応するディレクトリー内のライブラリーのアーカイブを一覧表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--type={common|ext|app}

ライブラリータイプを指定することで、対応するディレクトリー内のライブラリーのアーカイブを一覧表示します。

型：String

指定できる値を次に示します。

common

Commonクラスローダーディレクトリーdomain-dir/libのライブラリーのアーカイブを一覧表示します。

ext

Javaオプションパッケージディレクトリーdomain-dir/lib/extのライブラリーのアーカイブを一覧表示します。

app

アプリケーション固有のクラスローダーディレクトリーdomain-dir/lib/applibsのライブラリーのアーカイブを一覧表示します。

デフォルト値：common

使用例

次の例では、デフォルトのサーバインスタンスにあるアプリケーション固有のクラスローダーディレクトリー内のライブラリーのアーカイブを一覧表示します。

asadmin list-libraries --type app

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.6　login

ドメインへのログイン

書式

asadmin [asadmin-options] login [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

loginサブコマンドは、特定のドメインへログインできる状態にし、ドメイン管理を簡略化します。

Java EE Serverドメインが複数のマシンに作成されている場合、そのどのマシンからでもasadminユーティリティーコマンドを実行してほかの場所にあるドメインをリモート管理できます。

複数のドメインおよびサーバの管理クライアントとして、特定の1台のマシンが設定されている場合に有用です。

ファイル

ユーザーのホームディレクトリーにある.asadminpassファイル

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、別のマシンにあるドメインにログインします。loginサブコマンドの前にホストおよびポートを指定しています。

asadmin --host foo --port 8282 login

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.7　remove-library

1つ以上のライブラリーJARファイルのJava EE Serverからの除去

書式

asadmin [asadmin-options] remove-library [--help]
    [--type={common|ext|app}]
    library-name [library-name ...]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

remove-libraryサブコマンドは、1つ以上のライブラリーJARファイルをJava EE Serverから除去します。Commonクラスローダーディレクトリー、Javaオプションパッケージディレクトリー、またはアプリケーション固有のクラスローダーディレクトリーからライブラリーを除去するかどうかを指定できます。

このサブコマンドはリモートモードだけサポートします。

ライブラリーのアーカイブがドメイン管理サーバから除去されます。共通ライブラリーおよび拡張ライブラリーの場合、サーバ実行時にライブラリーの除去が反映されるようにドメイン管理サーバを再起動する必要があります。ほかのサーバインスタンスからライブラリーを除去するには、そのインスタンスを再起動してドメイン管理サーバと同期させます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ライブラリーがすでにJava EE Serverに追加されている必要があります。

ファイル

commonタイプの場合

Commonクラスローダーディレクトリーdomain-dir/libからライブラリーファイルを除去します。

extタイプの場合

Javaオプションパッケージディレクトリーdomain-dir/lib/extからライブラリーファイルを除去します。

appタイプの場合

アプリケーション固有のクラスローダーディレクトリーdomain-dir/lib/applibsからライブラリーファイルを除去します。

上記のディレクトリーのうち、指定されたライブラリーJARファイルがドメイン管理サーバから削除されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--type={common|ext|app}

ライブラリータイプと、ライブラリーの除去元であるJava EE Serverのディレクトリーを指定します。

型：String

指定できる値を次に示します。

common

Commonクラスローダーディレクトリーdomain-dir/libからライブラリーファイルを除去します。

ext

Javaオプションパッケージディレクトリーdomain-dir/lib/extからライブラリーファイルを除去します。

app

アプリケーション固有のクラスローダーディレクトリーdomain-dir/lib/applibsからライブラリーファイルを除去します。

デフォルト値：common

library_name

除去するライブラリーを含むJARファイルの名称を指定します。

型：String

指定できる値を次に示します。

アーカイブの名称

デフォルト値：なし

使用例

次の例では、アーカイブファイルmylib.jar内のライブラリーを、デフォルトのサーバインスタンス上にある、アプリケーション固有のクラスローダーディレクトリーから除去します。

asadmin remove-library --type app mylib.jar

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.12.8　version

Java EE Serverのバージョン情報の表示

書式

asadmin [asadmin-options] version [--help]
    [--verbose={false|true}] [--local={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

versionサブコマンドは、Java EE Serverのバージョン情報を表示します。このサブコマンドがドメイン管理サーバにアクセスできない場合、デフォルトでは、ローカルでバージョンを取得し、警告メッセージを表示します。

このサブコマンドはローカルモードとリモートモードをサポートします。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

{--verbose|-v}={false|true}

trueに設定した場合、サーバが稼働しているJava Runtime Environment（JRE）のバージョンを表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--local={false|true}

バージョン情報をローカルで取得するかどうかを指定します。

trueに設定した場合、このサブコマンドを実行するホスト上のJava EE Serverをインストールした環境から、ローカルでバージョンを取得します。

falseに設定した場合、このサブコマンドは、ドメイン管理サーバにアクセスしてバージョンの取得を試みます。ドメイン管理サーバへのアクセスに失敗した場合、ローカルでバージョンを取得し、警告メッセージを表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

使用例

次の例では、稼働しているドメイン管理サーバからバージョン情報を取得します。

asadmin version

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13　インターネット接続管理で使用するコマンド

インターネット接続管理で使用するコマンドの書式、機能などについて説明します。

2.13.1　create-protocol

新規プロトコルの追加

書式

asadmin [asadmin-options] create-protocol [--help]
    [--securityenabled={false|true}] [--target target] protocol-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-protocolサブコマンドはプロトコルを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--securityenabled={false|true}

プロトコルでSSLを実行するかどうかを指定します。この値にtrueを設定すると、プロトコルでSSLを実行します。

さらにSSL2またはSSL3を有効または無効にすると、ssl要素を使用して暗号を設定できます。セキュリティー設定でSSLをグローバルレベルで有効または無効にするには、サーバインスタンスで利用できる証明書を作成します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--target target

作成するプロトコルの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

standalone_instance_name

指定した名称のスタンドアロンのサーバインスタンスを対象とします。

デフォルト値：server

protocol-name

プロトコルの名称を指定します。

型：String

指定できる値を次に示します。

プロトコル名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、プロトコルを作成します。

asadmin create-protocol --target instance1 --securityenabled=true http-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.2　create-ssl

セキュア通信の構成

書式

asadmin [asadmin-options] create-ssl [--help] [--target target]
    --type listener_or_service_type --certname cert_name
    [--ssl2enabled={false|true}] [--ssl2ciphers ss12ciphers]
    [--ssl3enabled={true|false}] [--tlsenabled={true|false}]
    [--ssl3tlsciphers ssl3tlsciphers]
    [--clientauthenabled={false|true}] [listener_id]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-sslサブコマンドは、選択したHTTPリスナー、IIOPリスナーまたはIIOPサービスにSSL要素を作成し、それらリスナー、サービスでセキュア通信を有効にするように構成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

--typeオプションでは、タイプがiiop-serviceであると、組み込みSSL要素とともにssl-client-configがdomain.xmlに作成されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

SSL要素の構成対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--type listener_or_service_type

SSLを作成するサービスやリスナーのタイプを指定します。

--typeがiiop-serviceである場合、listener_idは必要ありません。タイプがiiop-serviceの場合、組み込みSSL要素と一緒にssl-client-configがdomain.xmlに作成されます。

型：String

指定できる値を次に示します。

http-listener

iiop-listener

iiop-service

jmx-connector

network-listener

デフォルト値：なし

--certname cert_name

証明書名またはPKCS#11トークンを指定します。

証明書名のフォーマットは、"トークン名:ニックネーム"です。このプロパティー中の、"トークン名:"の指定は任意です。

型：String

指定できる値を次に示します。

証明書名

デフォルト値：なし

--ssl2enabled={false|true}

SSL2を有効にするかどうかを指定します。仮想サーバに対してSSL2とSSL3の両方を有効にした場合、サーバは最初にSSL3暗号化を試行します。SSL3暗号化が使用できない場合、サーバはSSL2暗号化を試行します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--ssl2ciphers ss12ciphers

使用するSSL2暗号をコンマ区切りリストで指定します。

指定できる値に記載のない暗号は、ユーザーが利用している特定の暗号スイートにおいて利用できる暗号であっても使用できません。

型：String

指定できる値を次に示します。

rc4

rc4export

rc2

rc2export

idea

des

desede3

デフォルト値：

rc4

rc4export

rc2

rc2export

idea

des

desede3

--ssl3enabled={true|false}

SSL3を有効にするかどうかを指定します。

仮想サーバに対してSSL2とSSL3の両方を有効にした場合、サーバは最初にSSL3暗号化を試行します。SSL3暗号化が使用できない場合、サーバはSSL2暗号化を試行します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--tlsenabled={true|false}

TLSを有効にするかどうかを指定します。

SSLはTLSを有効にすると、よりセキュアになります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--ssl3tlsciphers ssl3tlsciphers

使用するSSL3暗号やTLS暗号をコンマ区切りリストで指定します。

指定できる値に記載のない暗号は、ユーザーが特定の暗号スイートで利用している場合でも、使用できません。

このオプションの指定がない場合、サポートされた暗号のすべてが有効になります。

--typeオプションにiiop-listenerまたはiiop-serviceを指定した場合は、--ssl3tlsciphersオプションで指定する暗号アルゴリズムの前に'+'を指定してください。

型：String

指定できる値を次に示します。

SSL_RSA_WITH_RC4_128_MD5

SSL_RSA_WITH_3DES_EDE_CBC_SHA

SSL_RSA_WITH_DES_CBC_SHA

SSL_RSA_EXPORT_WITH_RC4_40_MD5

SSL_RSA_WITH_NULL_MD5

SSL_RSA_WITH_RC4_128_SHA

SSL_RSA_WITH_NULL_SHA

デフォルト値：

SSL_RSA_WITH_RC4_128_MD5

SSL_RSA_WITH_3DES_EDE_CBC_SHA

SSL_RSA_WITH_DES_CBC_SHA

SSL_RSA_EXPORT_WITH_RC4_40_MD5

SSL_RSA_WITH_NULL_MD5

SSL_RSA_WITH_RC4_128_SHA

SSL_RSA_WITH_NULL_SHA

--clientauthenabled={false|true}

ACLベースのアクセス制御に関係なく、すべての要求に対してSSL3クライアント認証を有効にするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

listener_id

SSL要素を作成する、HTTPまたはIIOPリスナーのIDを指定します。

--typeがiiop-serviceの場合、listener_idは必要ありません。

型：String

指定できる値を次に示します。

HTTPリスナーのID、またはIIOPリスナーのID

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、http-listener-1という名称のHTTPリスナーにSSL要素を作成する方法を示します。

asadmin create-ssl --type http-listener --target instance1
--certname sampleCert http-listener-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.3　delete-protocol

プロトコルの削除

書式

asadmin [asadmin-options] delete-protocol [--help]
    [--target target] protocol-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-protocolサブコマンドは指定されたプロトコルを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するプロトコルの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

standalone_instance_name

指定した名称のスタンドアロンのサーバインスタンスを対象とします。

デフォルト値：server

protocol-name

プロトコルの名称を指定します。

型：String

指定できる値を次に示します。

プロトコル名

デフォルト値：なし

使用例

次のコマンドは、instance1という名称のサーバインスタンスから、http-1という名称のプロトコルを削除します。

asadmin delete-protocol --target instance1 http-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.4　delete-ssl

SSL設定の削除

書式

asadmin [asadmin-options] delete-ssl [--help]
    [--target target] --type listener_or_service_type
    listener_id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-sslサブコマンドは、選択したHTTPリスナー、IIOPリスナー、またはIIOPサービスのSSL要素を削除します。--typeオプションでiiop-serviceを指定した場合、listener_idの指定は不要です。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target

削除するSSLの対象を指定します。指定した対象の、リスナーまたはIIOPサービスからSSLが削除されます。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--type

SSL要素を削除するサービスやリスナーのタイプを指定します。

型：String

指定できる値を次に示します。

http-listener

iiop-listener

iiop-service

デフォルト値：なし

listener_id

削除対象のSSL要素があるリスナーのIDを指定します。

--typeオプションでiiop-serviceを指定した場合、リスナーIDの指定は不要です。

型：String

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、http-listener-1という名称のHTTPリスナーからSSL要素を削除します。

asadmin delete-ssl --target instance1 --type http-listener http-listener-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.5　list-network-listeners

ネットワークリスナーの一覧表示

書式

asadmin [asadmin-options] list-network-listeners [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-network-listenersサブコマンドは、既存のネットワークリスナーを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するネットワークリスナーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、サーバインスタンスのすべてのネットワークリスナーを一覧表示します。

asadmin list-network-listeners

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.6　list-protocols

プロトコルの一覧表示

書式

asadmin [asadmin-options] list-protocols [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-protocolsサブコマンドは、既存のプロトコルを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するプロトコルの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンスのすべてのプロトコルを一覧表示します。

asadmin list-protocols

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.7　list-transports

トランスポートの一覧表示

書式

asadmin [asadmin-options] list-transports [--help]
    target

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-transportsサブコマンドは、 既存のトランスポートを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するトランスポートの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：なし

使用例

次の例では、デフォルトのサーバインスタンスのすべてのトランスポートを一覧表示します。

asadmin list-transports server

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.13.8　list-virtual-servers

仮想サーバの一覧表示

書式

asadmin [asadmin-options] list-virtual-servers [--help]
    [--target target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-virtual-serversサブコマンドは、既存の仮想サーバを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

targetに指定した対象に仮想サーバが存在している必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示する仮想サーバの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、instance1という名称のサーバインスタンスについて、すべての仮想サーバを一覧表示します。

asadmin list-virtual-servers --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.14　ORB管理機能で使用するコマンド

ORB管理機能で使用するコマンドの書式、機能などについて説明します。

2.14.1　create-iiop-listener

IIOPリスナーの追加

書式

asadmin [asadmin-options] create-iiop-listener [--help]
    --listeneraddress address [--iiopport iiop-port-number]
    [--securityenabled={false|true}] [--enabled={true|false}]
    [--target target] listener_id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-iiop-listenerサブコマンドはIIOPリスナーを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--listeneraddress address

IPアドレスまたはDNSで解決できるホスト名を指定します。

型：String

指定できる値を次に示します。

IPアドレスまたはホスト名

デフォルト値：なし

--iiopport iiop-port-number

IIOPポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：1072

--securityenabled={false|true}

trueに設定の場合、IIOPリスナーがSSLを実行するよう指定します。SSL2またはSSL3を有効または無効にすると、SSL要素を使用して暗号を設定できます。

セキュリティー設定によって、証明書をサーバインスタンスで利用できるまたはできないようにすることで、SSLをグローバルレベルで有効または無効にします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--enabled={true|false}

trueに設定の場合、IIOPリスナーを実行時に有効にします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--target target

作成するIIOPリスナーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

stand-alone_instance_name

指定した名称のスタンドアロンのサーバインスタンスを対象とします。

デフォルト値：server

listener_id

IIOPリスナーの一意の識別子を作成します。

型：String

指定できる値を次に示します。

リスナーID

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、IIOPリスナーを作成します。

asadmin create-iiop-listener --target instance1 --listeneraddress 192.168.1.100
--iiopport 1400 sample_iiop_listener

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.14.2　delete-iiop-listener

IIOPリスナーの削除

書式

asadmin [asadmin-options] delete-iiop-listener [--help]
    [--target target] listener_id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-iiop-listenerサブコマンドは、指定したIIOPリスナーを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するIIOPリスナーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

listener_id

削除対象であるIIOPリスナーの一意の識別子を指定します。

型：String

指定できる値を次に示します。

IIOPリスナーの一意のID

デフォルト値：なし

使用例

次のコマンドは、instance1という名称のサーバインスタンスから、sample_iiop_listenerという名称のIIOPリスナーを削除します。

asadmin delete-iiop-listener --target instance1 sample_iiop_listener

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.14.3　list-iiop-listeners

IIOPリスナーの一覧表示

書式

asadmin [asadmin-options] list-iiop-listeners [--help] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-iiop-listenersサブコマンドは、既存のIIOPリスナーを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するIIOPリスナーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、サーバインスタンスのすべてのIIOPリスナーを一覧表示します。

asadmin list-iiop-listeners

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.15　リソース管理で使用するコマンド

リソース管理で使用するコマンドの書式、機能などについて説明します。

2.15.1　add-resources

XMLファイルに指定されたリソースの追加

書式

asadmin [asadmin-options] add-resources [--help] [--target target]
    [--upload={false|true}] xml-file-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

add-resourcesサブコマンドは、指定したXMLファイル内で指名されているリソースを追加します。DOCTYPEは、resources.xmlファイルでhttp://glassfish.org/dtds/glassfish-resources_1_5.dtdとして指定されている必要があります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

絶対パスで任意の場所のXMLファイルを指定してください。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster-name

指定した名称のクラスターを対象とします。

instance-name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--upload={false|true}

ファイルをドメイン管理サーバにアップロードするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

ドメイン管理サーバへファイルをアップロードします。

false

ドメイン管理サーバにファイルをアップロードしません。

ドメイン管理サーバが管理ユーザーと異なるユーザーで動作していて、ファイルの読み取りアクセス権がないなど、ドメイン管理サーバがファイルにアクセスできない場合は、このサブコマンドはエラーになります。

デフォルト値：

デフォルト値は、ドメイン管理サーバがサブコマンド実行中のホスト上にあるか、リモートホスト上にあるかに依存します。

ドメイン管理サーバがサブコマンドが動作するホスト上にある場合、false。

ドメイン管理サーバがリモートホスト上にある場合、true。

xml-file-name

リソースを含むxmlファイルの名称を指定します。

型：String

指定できる値を次に示します。

xmlファイル名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、resource.xmlファイルの内容を使用しているリソースを追加します。

asadmin add-resources --target instance1
domain-dir/domain_name/config/resource.xml

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.15.2　create-resource-ref

リソースへの参照の作成

書式

asadmin [asadmin-options] create-resource-ref [--help]
    [--target target] [--enabled={false|true}] reference_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-resource-refサブコマンドは、クラスターまたはサーバインスタンスから、あらかじめ作成されたリソースへの参照を作成します。このサブコマンドは、クラスターまたはサーバインスタンスが開始状態でない場合でも成功します。新たに作成したリソースが反映されるのは、次回の起動時です。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するリソース参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--enabled={false|true}

リソースを有効にするかどうかを指定します。

この値が有効になるのは、リソースがグローバルレベルで有効な場合だけです。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

reference_name

リソースの名称、またはJNDI名を指定します。

型：String

指定できる値を次に示します。

リソース名、またはリソースのJNDI名

デフォルト値：なし

使用例

次の例では、クラスターCluster1上にあるjdbc/DerbyPoolという名称のJDBCリソースへの参照を作成します。

asadmin create-resource-ref --target Cluster1 jdbc/DerbyPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.15.3　delete-resource-ref

リソース参照の削除

書式

asadmin [asadmin-options] delete-resource-ref [--help]
    [--target target] reference_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-resource-refサブコマンドは、クラスターまたはクラスター化されていないサーバインスタンスから、リソース（JDBCリソースなど）参照を削除します。このサブコマンドを実行すると、対象インスタンスまたはクラスターのJNDIツリーからリソース参照が削除されます。このサブコマンドの実行には、クラスターを構成する対象でサーバインスタンスが実行されていないことが必要です。

このサブコマンドでリソース参照を削除しても、ドメインからリソースは削除されません。リソースを削除したい場合は、リソース用のdeleteサブコマンド（delete-jdbc-resource など）を使用してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するリソース参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

reference_name

リソースのJNDI名を指定します。

型：String

デフォルト値：なし

使用例

次の例では、cluster1クラス上のjdbc/DerbyPoolという名称のJDBCリソースへの参照を削除します。

asadmin delete-resource-ref --target cluster1 jdbc/DerbyPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.15.4　list-resource-refs

リソース参照の一覧表示

書式

asadmin [asadmin-options] list-resource-refs [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-resource-refsサブコマンドは、クラスターまたはクラスター化されていないサーバインスタンスにあるすべてのリソース参照を一覧表示します。指定された対象のJNDIツリーにある有効なすべてのリソース（JDBCリソースなど）を一覧表示できます。

クラスターを構成する1つ以上の対象のインスタンスは実行されていなくても、また使用できなくても、このサブコマンドは正常に実行されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するリソース参照の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、クラスターcluster1のリソース参照を一覧表示します。

asadmin list-resource-refs cluster1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16　データベースコネクション管理で使用するコマンド

データベースコネクション管理で使用するコマンドの書式、機能などについて説明します。

2.16.1　create-jdbc-connection-pool

JDBCコネクションプールの登録

書式

asadmin [asadmin-options] create-jdbc-connection-pool [--help]
    [--datasourceclassname=datasourceclassname]
    [--restype=resourcetype]
    [--steadypoolsize=poolsize]
    [--maxpoolsize=maxpoolsize]
    [--maxwait=maxwaittime]
    [--poolresize=poolresizelimit]
    [--idletimeout=idletimeout]
    [--isolationlevel=isolationlevel]
    [--isisolationguaranteed={true|false}]
    [--isconnectvalidatereq={false|true}]
    [--validationmethod=validationmethod]
    [--validationtable=validationtable]
    [--nontransactionalconnections={false|true}]
    [--validateatmostonceperiod=validationinterval]
    [--leaktimeout=leaktimeout]
    [--leakreclaim={false|true}]
    [--creationretryattempts=creationretryattempts]
    [--creationretryinterval=creationretryinterval]
    [--statementtimeout=statementtimeout]
    [--lazyconnectionenlistment={false|true}]
    [--lazyconnectionassociation={false|true}]
    [--driverclassname=jdbcdriverclassname]
    [--matchconnections={false|true}]
    [--maxconnectionusagecount=maxconnectionusagecount]
    [--ping={false|true}]
    [--pooling={false|true}]
    [--statementcachesize=statementcachesize]
    [--validationclassname=validationclassname]
    [--description description]
    [--property name=value[:name=value]...]
    connectionpoolid

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jdbc-connection-poolサブコマンドは、指定されたJDBCコネクションプール名を持つJava Database Connectivity（JDBC）ソフトウェアを新規登録します。

次のようにして、認証付きのJDBCコネクションプールは作成できます。

--propertyオプションを使用して、ユーザー、パスワードなどのコネクション情報を指定します。

XMLディスクリプターファイルでコネクション情報を指定します。

接続するデータベースに応じて次に示すオプションを指定します。

HiRDBに接続する場合に指定するオプション

オプション名

値

備考

--datasourceclassname

JP.co.Hitachi.soft.HiRDB.JDBC.PrdbDataSource

※1

JP.co.Hitachi.soft.HiRDB.JDBC.PrdbXADataSource

※2

--restype

javax.sql.DataSource

※1

javax.sql.XADataSource

※2

--validationmethod

custom-validation

※3

--validationclassname

com.hitachi.software.javaee.jca.connectionvalidation.HiRDBConnectionValidation

※3

--property

description

ポート番号

※1

環境変数グループ識別子

※2

DBHostName

HiRDBのホスト名

-

XALocalCommitMode

true

※2、※4

XAOpenString

環境変数グループ識別子+HiRDB.iniファイルのパス

※2

user

ユーザー名

-

password

パスワード

-

HiRDBINI

HiRDB.INIファイルが存在するディレクトリーの絶対パス

※5

Oracleに接続する場合に指定するオプション

オプション名

値

備考

--datasourceclassname

oracle.jdbc.pool.OracleDataSource

※1

oracle.jdbc.xa.client.OracleXADataSource

※2

--restype

javax.sql.DataSource

※1

javax.sql.XADataSource

※2

--validationmethod

custom-validation

※3

--validationclassname

org.glassfish.api.jdbc.validation.OracleConnectionValidation

※3

--property

databaseName

Oracle SID

※6

serverName

Oracleのホスト名称、またはIPアドレス

※6

portNumber

ポート番号

※6

user

ユーザー名

-

password

パスワード

-

driverType

thin

※6

url

jdbc:oracle:thin:@Oracleのホスト名称、またはIPアドレス:ポート番号:Oracle SID

※6

SQL Serverに接続する場合に指定するオプション

オプション名

値

備考

--datasourceclassname

com.microsoft.sqlserver.jdbc.SQLServerDataSource

※1

com.microsoft.sqlserver.jdbc.SQLServerXADataSource

※2

--restype

javax.sql.DataSource

※1

javax.sql.XADataSource

※2

--validationmethod

custom-validation

※3

--validationclassname

org.glassfish.api.jdbc.validation.MSSQLConnectionValidation

※3

--property

databaseName

SQL Serverデータベース名

-

serverName

SQL Serverのホスト名称、またはIPアドレス

-

portNumber

ポート番号

-

user

ユーザー名

-

password

パスワード

-

注※1

XAトランザクションを使用しない場合に指定します。

注※2

XAトランザクションを使用する場合に指定します。

注※3

コネクション障害検知を行う場合だけ指定します。

注※4

このオプションは、トランザクションがグローバルトランザクションでないときに、オートコミット機能を有効にするかどうかを設定します。この設定がtrueでない場合、コネクション障害検知機能が正常に動作しません。コネクション障害検知機能を使用する場合、trueを指定します。

注※5

XAトランザクションを使用しない場合、かつHiRDB.iniファイルに指定されている設定を使用する場合に指定します。

注※6

databaseName、serverName、portNumber、driverTypeの4つのプロパティーか、urlのどちらかを指定します。両方を指定した場合、urlが有効になり、それ以外の4つのプロパティーは無視されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

JDBCコネクションプールを作成するのに--propertyオプションを使用しない場合は、XMLディスクリプターでコネクション情報を指定します。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--datasourceclassname=datasourceclassname

ベンダー供給のJDBCデータソースのリソースマネージャーの名称を指定します。グローバルトランザクションを使用する場合は、javax.sql.XADatasourceインターフェースを実装したクラスを指定します。

型：String

指定できる値を次に示します。

datasourceクラス名

デフォルト値：なし

--restype=resourcetype

このオプションは次のどちらかの場合に必要になります。

DataSourceクラスが、javax.sql.DataSource、javax.sql.XADataSourceまたはjavax.sql.ConnectionPoolDataSourceのうち2つ以上のインターフェースを実装する時

Driverクラスの提供が必須の時

--restypeオプションにjava.sql.Driverを指定する場合、--driverclassnameオプションも必要です。

--restypeオプションにjavax.sql.DataSource、javax.sql.XADataSource、またはjavax.sql.ConnectionPoolDataSourceを指定する場合、--datasourceclassnameオプションも必要です。

--restypeオプションを指定しない場合、--driverclassnameオプションか--datasourceclassnameオプションのどちらか一方を必ず指定してください。

型：String

指定できる値を次に示します。

java.sql.Driver

javax.sql.DataSource

javax.sql.XADataSource

javax.sql.ConnectionPoolDataSource

デフォルト値：なし

--steadypoolsize=poolsize

プールに保持する初期コネクション数と最小コネクション数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：24

glassfish-resources.xmlのjdbc-connection-pool要素のsteady-pool-size属性のデフォルト値も、このオプションのデフォルト値と同じです。

--maxpoolsize=maxpoolsize

作成できる最大コネクション数を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：24

glassfish-resources.xmlのjdbc-connection-pool要素のmax-pool-size属性のデフォルト値も、このオプションのデフォルト値と同じです。

--maxwait=maxwaittime

コネクションタイムアウトが送信されるまでに、呼び出し側が待機する必要がある時間をミリ秒単位で指定します。

値0は、呼び出し側を無期限に待機させます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：60000

--poolresize=poolresizelimit

idle-timeout-in-secondsタイマーが終了の際、解除されるコネクション数を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：2

--idletimeout=idletimeout

コネクションをアイドル状態で維持できる最長時間を秒単位で指定します。

このタイムアウト値は、アプリケーションのコネクションに使えない時間の蓄積を避けるため、データベースサーバ側のタイムアウト値よりも短くする必要があります。

0を指定した場合、無効になります。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：300

--isolationlevel=isolationlevel

プール化データベースコネクションに設定されたトランザクションアイソレーションレベルを指定します。

プールされたコネクションに対して分離レベルをプログラム的に変更するようなアプリケーションを利用した場合、プールに不整合が起きる危険があります。これはプログラムエラーにつながります。

型：String

指定できる値を次に示します。

read-uncommitted

read-committed

repeatable-read

serializable

デフォルト値：JDBCドライバーのプロバイダーが設定する独立性レベル

--isisolationguaranteed={true|false}

特定の分離レベルがトランザクションアイソレーションレベルに指定された場合にだけ適用されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--isconnectvalidatereq={false|true}

コネクション障害検知機能を使用するかどうかを指定します。trueの場合、コネクション障害検知機能を使用します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--validationmethod=validationmethod

--isconnectvalidatereqオプションがtrueの場合、実行する検証のタイプを指定します。

auto-commitを指定した場合：

Connection#setAutoCommit(Connection#getAutoCommit())を実行します。

meta-dataを指定した場合：

Connection#getMetaData()を実行します。

tableを指定した場合：

--validationtableオプションで指定したテーブルに対して、SELECT文を実行します。

custom-validationを指定した場合：

--validationclassnameオプションで指定したユーザ定義のクラスを使用します。

型：String

指定できる値を次に示します。

auto-commit

meta-data

table

custom-validation

デフォルト値：table

--validationtable=validationtable

使用する検証テーブルの名称を指定し、SELECT文を実行してコネクションを検証します。

--isconnectvalidatereqオプションがtrueの場合、--validationmethodオプションがtableに設定されていれば、このオプションの設定は必須です。

型：String

指定できる値を次に示します。

検証テーブル名

デフォルト値：なし

--nontransactionalconnections={false|true}

このプロパティーを持つプールがtrueに設定の場合、非トランザクションコネクションを返します。このコネクションは、トランザクションマネージャーに自動的に登録されません。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--validateatmostonceperiod=validationinterval

連続するリクエスト間で、コネクションを検証する間隔を秒単位で指定します。この属性を適切な値に設定すると、コネクションの検証リクエスト数を最小限にします。

0を指定した場合、常にコネクションを検証します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--leaktimeout=leaktimeout

コネクションプール内のコネクションリークを追跡する時間を秒単位で指定します。指定の時間内にアプリケーションによってコネクションがプールに戻されない場合は、潜在的リークがあるものと見なされ、呼び出し側のスタックトレースが記録されます。0を指定した場合はコネクションリークを追跡しません。

コネクションリークがある場合にだけ、このオプションで検知できます。

--leakreclaimオプションがtrueに設定される場合だけ、コネクションは再開できます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--leakreclaim={false|true}

リークコネクションの追跡が完了した後で、リークコネクションをコネクションプールに復元するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

リークコネクションはコネクションプールに復元されます。

false

リークコネクションはコネクションプールに復元されません。

デフォルト値：false

--creationretryattempts=creationretryattempts

Java EE Serverが、最初のコネクションの確立に失敗した場合に、最大何回までコネクション再確立を試行するかを指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--creationretryinterval=creationretryinterval

コネクション確立のリトライ間隔を秒単位で指定します。

--creationretryattemptsが0の場合、--creationretryintervalオプションは無視されます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：10

--statementtimeout=statementtimeout

完了していないクエリーが終了するまでの時間を秒単位で指定します。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：-1

--lazyconnectionenlistment={false|true}

メソッドがリソースを実際に使用する場合、リソースをトランザクションに参加させるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

メソッドがリソースを実際に使用する場合に限り、リソースをトランザクションに参加させます。

false

リソースはトランザクションに常時参加させます。メソッドがリソースを実際に使用する場合に限りません。

デフォルト値：false

--lazyconnectionassociation={false|true}

物理コネクションを使用する際に、その物理コネクションを論理コネクションに関連づけ、および、トランザクションが完了した際には関連づけないことを指定します。関連づけの有無は物理コネクションの再使用を有効にします。

型：Boolean

指定できる値を次に示します。

true

物理コネクションは、物理コネクションを使用するときだけに関連づけられ、トランザクションが完了した際には関連づけられません。

--lazyconnectionenlistmentオプションもtrueに設定する必要があります。

false

物理コネクションは、物理コネクションを使用する前でも論理コネクションに関連づけられ、トランザクションが完了した際には関連づけられません。

デフォルト値：false

--driverclassname=jdbcdriverclassname

ベンダー供給のJDBCドライバーのクラス名を指定します。このドライバーはjava.sql.Driverインターフェースを実装している必要があります。

型：String

指定できる値を次に示します。

java.sql.Driverインターフェースを実装するJavaクラス

デフォルト値：なし

--matchconnections={false|true}

プールから選択したコネクションがリソースアダプターと一致する必要があるどうかを指定します。

プール内のすべてのコネクションが同一の場合、コネクションとリソースアダプターが一致する必要はありません。

型：Boolean

指定できる値を次に示します。

true

コネクションはリソースアダプターと一致する必要があります。

false

コネクションはリソースアダプターと一致する必要はありません。

デフォルト値：false

--maxconnectionusagecount=maxconnectionusagecount

コネクションを再使用できる最大回数を指定します。最大数に達すると、コネクションが閉じられます。コネクションを再使用できる最大回数を制限することで、ステートメントのリークが回避できます。0を指定した場合はコネクションを再使用できる回数の上限がなくなります。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--ping={false|true}

trueの場合、コネクションプール作成時または再構成時にコネクションプールが使用できるかどうかテストします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--pooling={false|true}

プールに対してコネクションのプーリングが有効かどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--statementcachesize=statementcachesize

デフォルトのキャッシュ機構を使用してキャッシュされるSQLステートメント数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--validationclassname=validationclassname

--validationmethodオプションがcustom-validationのときに独自の検証を提供するクラス名を指定します。このクラスは、org.glassfish.api.jdbc.ConnectionValidationインターフェースを実装する必要があり、さらにJava EE Serverにアクセスできるようにする必要があります。

--validationmethodオプションがcustom-validationに設定されている場合、このオプションは必須です。

型：String

指定できる値を次に示します。

org.glassfish.api.jdbc.ConnectionValidationインターフェースを実装したクラス

デフォルト値：なし

--description description

指定されたJDBCコネクションプールの詳細を説明するテキストを指定します。

型：String

指定できる値を次に示します。

テキストでの説明

デフォルト値：なし

--property name=value[:name=value]...

プールを構成するためのオプションの属性名と値のペアを指定します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

属性名または属性値にコロンが含まれる場合、そのコロンをエスケープするために円記号（¥）を使用する必要があります。別の文字でも、エスケープ文字が必要になることがあります。

HiRDBまたはOracleに接続するためのプロパティーは、それぞれ「HiRDBに接続する場合に指定するオプション」または「Oracleに接続する場合に指定するオプション」を参照してください。そのほかに指定できるプロパティーについては、使用するデータベースのマニュアルを参照してください。

プロパティー名とvalueに指定できる値を次に示します。

user=value

データベースに接続するために必要なユーザー名を指定します。

型：String

デフォルト値：なし

password=value

型：String

デフォルト値：なし

データベースに接続するために必要なパスワードを指定します。

databaseName=value

このコネクションプールのデータベースを指定します。

型：String

デフォルト値：なし

serverName=value

このコネクションプールのデータベースサーバを指定します。

型：String

デフォルト値：なし

portNumber=value

データベースサーバがリクエストをリッスンするポートを指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：なし

networkProtocol=value

通信プロトコルを指定します。

型：String

デフォルト値：なし

roleName=value

初期SQLロール名を指定します。

型：String

デフォルト値：なし

datasourceName=value

コネクションプーリングが動作するXADataSourceまたはConnectionPoolDataSourceを指定します。

型：String

デフォルト値：なし

description=value

テキストの説明を指定します。

型：String

デフォルト値：なし

url=value

このコネクションプールのURLを指定します。これは標準プロパティーではありませんが、共通に使用されます。

型：String

デフォルト値：なし

dynamic-reconfiguration-wait-timeout-in-seconds=value

コネクションプールの動的再構成を、コネクションプールを使用中のアプリケーションに透過的に有効にするために使用されます。これによって、プールへの属性またはプロパティーの変更を有効にするためにアプリケーションを再起動する必要がなくなります。

処理中のトランザクションのコネクション取得要求は、タイムアウト期間内のコネクション取得要求であるかぎり、トランザクションを完了するために古いプール構成のまま実行することが許可されます。新しいコネクション取得要求はプールの再構成が完了するまで待機し、コネクションは変更されたプール構成を使用して取得されます。

型：Long

指定できる値を次に示します。

x〜y（xの値×1000 ≧ -9223372036854775808 および yの値×1000 ≦ 9223372036854775807）

デフォルト値：0

connectionpoolid

作成するJDBCコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプールID

デフォルト値：なし

使用例

次の例は、JDBCコネクションプールを作成します。

asadmin create-jdbc-connection-pool
--datasourceclassname org.apache.derby.jdbc.ClientDataSource
--restype javax.sql.XADataSource
--property portNumber=1527:password=APP:user=APP:serverName=
localhost:databaseName=sun-appserv-samples:connectionAttributes=¥;
create¥¥=true sample_derby_pool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16.2　create-jdbc-resource

JDBCリソースの作成

書式

asadmin [asadmin-options] create-jdbc-resource [--help]
    --connectionpoolid connectionpoolid [--enabled={false|true}]
    [--description description][--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jdbc-resourceサブコマンドは新しいJDBCリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--connectionpoolid connectionpoolid

JDBCコネクションプールの名称を指定します。2つ以上のJDBCリソース要素が同じコネクションプール要素をポイントしている場合、それらは実行時に同じプール接続を使用します。

型：String

指定できる値を次に示します。

コネクションプールID

デフォルト値：なし

--enabled={false|true}

JDBCリソースを実行時に有効にするかどうかを確認します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--description description

JDBCリソースの詳細な説明をするテキストを記述します。

型：String

指定できる値を次に示します。

JDBCリソースの詳細な説明

デフォルト値：なし

--target target

作成するJDBCリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このJDBCリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、jdbc/DerbyPoolという名称のJDBCリソースを作成します。

asadmin create-jdbc-resource --target instance1
--connectionpoolid sample_derby_pool jdbc/DerbyPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16.3　delete-jdbc-connection-pool

JDBCコネクションプールの削除

書式

asadmin [asadmin-options] delete-jdbc-connection-pool [--help]
    [--cascade={false|true}] jdbc_connection_pool_id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jdbc-connection-poolサブコマンドはJDBCコネクションプールを削除します。このサブコマンドを実行する前に、必ずこのJDBCコネクションプールへのすべての関連づけを削除してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--cascade={false|true}

コネクションプールとそのプールに関連づけられているすべてのJDBCリソースを削除します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

jdbc_connection_pool_id

JDBCリソースの名称を指定します。

型：String

指定できる値を次に示します。

JDBCリソース名

デフォルト値：なし

使用例

次の例では、sample_derby_poolという名称のJDBCコネクションプールを削除します。

asadmin delete-jdbc-connection-pool --cascade=false sample_derby_pool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16.4　delete-jdbc-resource

JNDI名を持つJDBCリソースの削除

書式

asadmin [asadmin-options] delete-jdbc-resource [--help]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jdbc-resourceサブコマンドはJDBCリソースを削除します。このサブコマンドを実行する前に、必ずこのJDBCリソースへのすべての関連づけを削除してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するJDBCリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソース作成時に--targetオプションを使用して、resource-refが作成された対象だけがアクティブになります。

リソースの削除は、--targetオプションで指定した対象のresource-refだけを削除します。削除の対象としてドメインが指定されない限り、ドメイン全体からそのリソースは削除されません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

JDBCリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JDBCリソースのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、jdbc/DerbyPoolという名称のJDBCリソースを削除します。

asadmin delete-jdbc-resource --target instance1 jdbc/DerbyPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16.5　list-jdbc-connection-pools

JDBCコネクションプールの一覧表示

書式

asadmin [asadmin-options] list-jdbc-connection-pools [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jdbc-connection-poolsサブコマンドは、現在のJDBCコネクションプールを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、現在のJDBCコネクションプールを一覧表示します。

asadmin list-jdbc-connection-pools

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.16.6　list-jdbc-resources

JDBCリソースの一覧表示

書式

asadmin [asadmin-options] list-jdbc-resources [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jdbc-resourcesサブコマンドは、既存のJDBCリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するJDBCリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、現在のJDBCリソースを一覧表示します。

asadmin list-jdbc-resources

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.17　JavaMailサービス管理で使用するコマンド

JavaMailサービス管理で使用するコマンドの書式、機能などについて説明します。

2.17.1　create-javamail-resource

JavaMailセッションリソースの作成

書式

asadmin [asadmin-options] create-javamail-resource [--help]
    [--target target] --mailhost hostname --mailuser username
    --fromaddress address [--storeprotocol storeprotocol]
    [--storeprotocolclass storeprotocolclass]
    [--transprotocol transprotocol]
    [--transprotocolclass transprotocolclass]
    [--enabled={true|false}] [--description resource-description]
    [--property name=value[:name=value]...] jndi-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-javamail-resourceサブコマンドは、JavaMailセッションリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するJavaMailセッションリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--mailhost hostname

デフォルトメールサーバのDNS名を指定します。プロトコル固有のホストプロパティーが指定されていない場合、StoreおよびTransportオブジェクトの接続メソッドは、この値を使用します。

型：String

指定できる値を次に示します。

メールホスト名

デフォルト値：なし

--mailuser username

メールサーバへの接続時に使用されるメールアカウントユーザーの名前を指定します。

型：String

指定できる値を次に示します。

メールサーバのユーザー名

デフォルト値：なし

--fromaddress address

デフォルトユーザーのメールアドレスを username@host.domain形式で指定します。

型：String

指定できる値を次に示します。

デフォルトユーザーのメールアドレス

デフォルト値：なし

--storeprotocol storeprotocol

メールサーバのストアプロトコルを指定します。

型：String

指定できる値を次に示します。

imap

pop3

デフォルト値：imap

--storeprotocolclass storeprotocolclass

メールサーバのストアプロトコルクラス名を指定します。

型：String

指定できる値を次に示します。

com.sun.mail.imap.IMAPStore

com.sun.mail.pop.POPStore

デフォルト値：com.sun.mail.imap.IMAPStore

--transprotocol transprotocol

メールサーバのトランスポートプロトコルを指定します。

型：String

指定できる値を次に示します。

smtp

lmtp

デフォルト値：smtp

--transprotocolclass transprotocol

メールサーバのトランスポートプロトコルのクラス名を指定します。

型：String

指定できる値を次に示します。

com.sun.mail.smtp.SMTPTransport

com.sun.mail.lmtp.LMTPTransport

デフォルト値：com.sun.mail.smtp.SMTPTransport

--enabled={true|false}

trueを指定した場合、リソースは実行時に有効になります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--description resource-description

JavaMailリソースの詳細の一部を記述するテキストを指定します。

型：String

指定できる値を次に示します。

JavaMailリソースの説明

デフォルト値：なし

--property name=value[:name=value]...

JavaMailリソース構成時のオプションをプロパティー名と値のペアで指定します。Java EE Server固有のmail-プレフィックスは標準のメールプレフィックスに変換されます。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

nameに指定できる値については、Java Mail標準仕様のJavaDoc(http://docs.oracle.com/javaee/7/api/javax/mail/package-summary.html)から、javax.mailのパッケージサマリーを参照してください。デフォルト値はありません。

valueには、プロパティー名に指定したプロパティーの指定範囲に従う値が指定できます。

jndi-name

作成するJavaMailリソースのJNDI名を指定します。JavaMailリソースには、ネーミングサブコンテキストのプレフィックスmail/の使用を推奨します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、JavaMailセッションリソースを作成します。

asadmin create-javamail-resource --target instance1 --mailhost localhost
--mailuser sample --fromaddress sample@sun.com mail/MyMailSession

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.17.2　delete-javamail-resource

JavaMailセッションリソースの削除

書式

asadmin [asadmin-options] delete-javamail-resource [--help]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-javamail-resourceサブコマンドは指定したJavaMailセッションリソースを削除します。このサブコマンドを実行する前に、必ずこのリソースへのすべての参照を削除してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するJavaMailセッションリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

JavaMailセッションリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

リソースのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、mail/MyMailSessionという名称のJavaMailセッションリソースを削除します。

asadmin delete-javamail-resource --target instance1 mail/MyMailSession

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.17.3　list-javamail-resources

JavaMailセッションリソースの一覧表示

書式

asadmin [asadmin-options] list-javamail-resources [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-javamail-resourcesサブコマンドは、既存のJavaMailセッションリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するJavaMailセッションリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンスのJavaMailセッションリソースを一覧表示します。

asadmin list-javamail-resources

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18　JNDIサービス管理で使用するコマンド

JNDIサービス管理で使用するコマンドの書式、機能などについて説明します。

2.18.1　create-custom-resource

カスタムリソースの作成

書式

asadmin [asadmin-options] create-custom-resource [--help]
    --restype type --factoryclass classname
    [--enabled={true|false}] [--description text]
    jndi-name [--target target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-custom-resourceサブコマンドは、カスタムリソースを作成します。カスタムリソースは、javax.naming.spi.ObjectFactoryインターフェースを実装するサーバ全体のカスタムリソースのオブジェクトファクトリーを指定します。

カスタムリソースの作成後は、Java EE Serverを再起動してください。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するカスタムリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--restype type

作成するカスタムリソースのタイプを指定します。

型：String

指定できる値を次に示します。

カスタムリソース型

デフォルト値：なし

--factoryclass classname

カスタムリソースのファクトリークラス名を指定します。

型：String

指定できる値を次に示します。

javax.naming.spi.ObjectFactoryインターフェースを実装するクラスの名称

デフォルト値：なし

--enabled={true|false}

カスタムリソースをランタイムに有効にするかどうかを確認します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--description text

カスタムリソースの詳しい説明文を記述します。説明文の長さは最大250文字です。

型：String

指定できる値を次に示します。

テキストでの説明

デフォルト値：なし

jndi-name

このリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、カスタムリソースを作成します。

asadmin create-custom-resource --target instance1 --restype topic
--factoryclass com.imq.topic mycustomresource

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18.2　create-jndi-resource

JNDIリソースの登録

書式

asadmin [asadmin-options] create-jndi-resource [--help]
    [--target target] --restype restype --factoryclass factoryclass
    --jndilookupname jndilookupname [--enabled={true|false}]
    [--description description] jndi-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jndi-resourceサブコマンドでは JNDI リソースを登録します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するJNDIリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--restype restype

JNDIリソースのタイプを指定します。

型：String

指定できる値を次に示します。

topic

queue

デフォルト値：なし

--factoryclass factoryclass

このJNDIリソースを作成するクラスを指定します。

型：String

指定できる値を次に示します。

javax.naming.spi.InitialContextFactoryインターフェースを実装するクラスの名称

デフォルト値：なし

--jndilookupname jndilookupname

外部コンテナーが使用するルックアップ名を指定します。

型：String

指定できる値を次に示します。

JNDIルックアップ名

デフォルト値：なし

--enabled={true|false}

リソースが実行時に有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--description description

JNDIリソースに関する詳細情報を表すテキストを指定します。

型：String

指定できる値を次に示します。

テキストでの説明

デフォルト値：なし

jndi-name

作成対象であるJNDIリソースの一意の名称を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、my-jndi-resourceという名称のJNDIリソースを作成します。

asadmin create-jndi-resource --target instance1
--restype com.example.jndi.MyResourceType
--factoryclass com.example.jndi.MyInitialContextFactoryClass
--jndilookupname remote-jndi-name --description "sample JNDI resource"
my-jndi-resource

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18.3　delete-custom-resource

カスタムリソースの削除

書式

asadmin [asadmin-options] delete-custom-resource [--help]
    [--target target] jndi-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-custom-resourceサブコマンドはカスタムリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するカスタムリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

リソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

リソースのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、mycustomresourceという名称のカスタムリソースを削除します。

asadmin delete-custom-resource --target instance1 mycustomresource

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18.4　delete-jndi-resource

JNDIリソースの削除

書式

asadmin [asadmin-options] delete-jndi-resource [--help]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jndi-resourceサブコマンドは、指定した JNDIリソースを削除します。このサブコマンドを実行する前に、必ずこのJNDIリソースへのすべての関連づけを削除してください。このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するJNDIリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソース作成時に--targetオプションを使用して、resource-refが作成された対象だけがアクティブになります。

リソースの削除は、--targetオプションで指定した対象のresource-refのJNDIリソースだけを削除します。削除の対象としてdomainが指定されない限り、ドメイン全体からそのリソースは削除されません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

JNDIリソースの名称を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、sample_jndi_resourceという名称の既存のJNDIリソースを削除します。

asadmin delete-jndi-resource --target instance1 sample_jndi_resource

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18.5　list-custom-resources

カスタムリソースの取得

書式

asadmin [asadmin-options] list-custom-resources [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-custom-resourcesサブコマンドは、カスタムリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するカスタムリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンス上のカスタムリソースを一覧表示します。

asadmin list-custom-resources

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.18.6　list-jndi-resources

JNDIリソースの一覧表示

書式

list-jndi-resources [--help] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jndi-resourcesサブコマンドは、既存のすべてのJNDIリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するJNDIリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンス上のJNDIリソースを一覧表示します。

asadmin list-jndi-resources

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19　JMS管理で使用するコマンド

JMS管理で使用するコマンドの書式、機能などについて説明します。

2.19.1　create-jms-host

JMSホストの作成

書式

asadmin [asadmin-options] create-jms-host [--help] --mqhost mq-host
    --mqport mq-port --mquser mq-user --mqpassword mq-password
    [--target target] [--force={false|true}] jms_host_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

JMSサービス内にJMSホストを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--mqhost mq-host

JMSサービスのホスト名を指定します。

型：String

指定できる値を次に示します。

ホスト名

デフォルト値：localhost

--mqport mq-port

JMSサービスが使用するポート番号を指定します。

型：Integer

指定できる値を次に示します。

1〜65535

デフォルト値：7676

--mquser mq-user

JMSサービスのユーザー名を指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：admin

--mqpassword mq-password

JMSサービスのパスワードを指定します。

型：String

指定できる値を次に示します。

パスワード

デフォルト値：admin

--target target

作成するJMSホストの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--force={false|true}

このサブコマンドが既存の同名JMSホストを上書きするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

jms_host_name

作成するJMSホストの固有識別子を指定します。

型：String

指定できる値を次に示します。

JMSホストの固有の名称

デフォルト値：なし

使用例

次のコマンドは、instance1という名称のサーバインスタンス上の、システムpigeonに、MyNewHostという名称のJMSホストを作成します。

asadmin create-jms-host --target instance1 --mqhost pigeon.example.com --mqport 7677
--mquser admin --mqpassword admin MyNewHost

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.2　create-jms-resource

JMSリソースの作成

書式

asadmin [asadmin-options] create-jms-resource [--help] --restype type
    [--target target] [--enabled={true|false}]
    [--property name=value[:name=value]...] [--force={false|true}]
    jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jms-resourceサブコマンドは、Java Message Service（JMS）コネクションファクトリーリソースまたはJMS送信先リソースを作成します。

このサブコマンドはリモートモードだけサポートします。

asadmin create-jms-resourceコマンドのaddresslistプロパティー（host:mqport,host2:mqport,host3:mqport形式）を指定する場合、¥¥を使用して : 文字をエスケープします。例えば、host1¥¥:mqport,host2¥¥:mqport,host3¥¥:mqportのようにします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--restype type

JMSリソースのタイプを指定します。

型：String

指定できる値を次に示します。

javax.jms.Topic

javax.jms.Queue

javax.jms.ConnectionFactory

javax.jms.TopicConnectionFactory

javax.jms.QueueConnectionFactory

デフォルト値：なし

--target target

作成するJMSリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--enabled={true|false}

リソースを実行時に有効にするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--property name=value[:name=value]...

JMSリソースの構成時のオプションをプロパティー名と値のペアで指定します。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

プロパティー名とvalueに指定できる値を次に示します。

コネクションファクトリーリソースのプロパティー

ClientId=value

永続化サブスクライバーが使用するコネクションファクトリーのクライアントIDを指定します。

型：String

指定できる値を次に示します。

JMSリソースのID

デフォルト値：なし

AddressList=value

Message Queueのアドレスのコンマ区切りリストを指定します。アプリケーションが通信する1つまたは複数のメッセージブローカーのインスタンスのホスト名（およびオプションでポート番号）を指定します。

例えば、値にはearthまたはearth:7677を指定できます。メッセージブローカーがデフォルト（7676）以外のポートで動作している場合は、ポート番号を指定します。サーバのJMSサービス構成で定義されたJMSホストから構成されるデフォルト値はlocalhostで、デフォルトのポート番号は7676です。クライアントは、ローカルホストのポート7676のブローカーへの接続を試みます。

型：String

指定できる値を次に示します。

コンマで区切られたホスト名およびポート番号

デフォルト値：なし

UserName=value

コネクションファクトリーのユーザー名を指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：guest

Password=value

コネクションファクトリーのパスワードを指定します。

型：String

指定できる値を次に示します。

パスワード

デフォルト値：guest

ReconnectEnabled=value

値をtrueに設定すると、接続が失われたときに、クライアントのランタイムはメッセージサーバ（またはAddressListで指定したアドレスのリスト）への再接続を試みます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

ReconnectAttempts=value

クライアントのランタイムがリストの次のアドレスを試行する前に、AddressListに指定した各アドレスへの接続（または再接続）を試みる回数。値を-1に設定すると、再接続の試行回数が無制限になります（クライアントのランタイムは、接続が成功するまで最初のアドレスへの接続を試みます）。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：6

ReconnectInterval=value

再接続を試みる間隔（ミリ秒単位）を指定します。これは、AddressListで指定した各アドレスでの試行およびリストの連続するアドレスへの再接続に適用されます。間隔が短すぎると、ブローカーが回復できません。また間隔が長すぎると、処理遅延が発生することがあります。

型：Long

指定できる値を次に示します。

-1〜9223372036854775807L

デフォルト値：30000（ミリ秒）

AddressListIterations=value

接続を確立（または再確立）するために、クライアントのランタイムがAddressList経由で接続を試みる回数を指定します。値を-1に設定すると、接続回数が無制限になります。コネクターリソースのプロパティーとしてconnector-connection-pool属性を指定できます。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：-1

送信先リソースのプロパティー

Name=value

リソースが参照する物理送信先の名称。物理送信先は、送信先リソースを使用するアプリケーションを実行するときに自動的に作成されます。また、create-jmsdestサブコマンドで物理送信先を作成することもできます。このプロパティーを指定しない場合、JMSサービスは送信先リソースと同じ名称で物理送信先を作成します（JNDI名のスラッシュはアンダースコアに置換されます）。

型：String

指定できる値を次に示します。

物理送信先の名称

デフォルト値：_ replacing /を含む送信先リソースのJNDI名

Description=value

物理送信先の説明を記述します。

型：String

指定できる値を次に示します。

物理送信先の説明

デフォルト値：なし

--force={false|true}

このサブコマンドが既存の同名のJMSリソースを上書きするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

jndi_name

作成するJMSリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、JNDI名がjms/DurableConnectionFactorytypeである型javax.jms.ConnectionFactoryのコネクションファクトリーリソースを作成します。

ClientIdプロパティーは、クライアントIDをコネクションファクトリー上に設定し、コネクションファクトリーが持続性のあるサブスクリプションに使用できるようにします。JMSリソースのJNDI名は、習慣的に、jms/ネーミングサブコンテキストを含んでいます。

asadmin create-jms-resource --restype javax.jms.ConnectionFactory --target instance1
    --property ClientId=MyID jms/DurableConnectionFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.3　create-jmsdest

JMSの物理送信先の作成

書式

asadmin [asadmin-options] create-jmsdest [--help] --desttype dest_type
    [--property name=value[:name=value]...] [--target target]
    [--force={false|true}] dest_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-jmsdestサブコマンドはJMSの物理送信先を作成します。

このサブコマンドはリモートモードだけサポートします。

create-jms-resourceサブコマンドを使用しても、Nameプロパティーに物理送信先が指定された JMS送信先リソースを作成できます。この物理送信先は、ユーザーが送信先リソースを使用するアプリケーションを実行するときに自動的に作成されます。プロパティーにデフォルト値がない物理送信先を作成するには、create-jmsdestサブコマンドを使用します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--desttype dest_type

JMS送信先の種類を指定します。

型：String

指定できる値を次に示します。

topic

queue

デフォルト値：なし

--property name=value[:name=value]...

物理送信先を構成するためのプロパティー名と値のペアを指定します。指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

これらのプロパティーの値を変更するには、Application Serverインストールディレクトリー/javaee/glassfish/mq/bin/imqcmdコマンドを使用できます。

プロパティー名とvalueに指定できる値を次に示します。

MaxNumMsgs=value

送信先で格納できる未配信メッセージの最大数を選択できます。値に-1を指定すると、メッセージの数は制限されません。limitBehaviorプロパティーがFLOW_CONTROLに設定されている場合、ブローカーはメッセージの受信処理をすぐに停止できないため、指定されたメッセージ制限を超過することがあります。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：デッドメッセージキューの場合は、1000。その他の場合は、-1。

MaxBytesPerMsg=value

単一メッセージの最大サイズ（バイト単位）を指定します。永続メッセージが拒否されると、メッセージを生成しているクライアントに例外が報告されます。非永続メッセージの場合、例外はクライアントに報告されません。

値は、次のサフィックスを使用して、バイト単位、キロバイト単位、またはメガバイト単位で指定することができます。サフィックスのない値はバイト単位になります。値に-1を設定した場合、メッセージのサイズは制限されません。

b：バイト

k：キロバイト（1024バイト）

m：メガバイト（1024 x 1024 = 1,048,576バイト）

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：-1

MaxTotalMsgBytes=value

未配信メッセージの最大合計サイズ（バイト単位）を指定します。構文はmaxBytesPerMsgの場合と同じです。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：デッドメッセージキューの場合は、10000000。その他の場合は、-1

LimitBehavior=value

メモリー制限のしきい値に達したときのブローカーの動作を指定します。

型：String

指定できる値を次に示します。

REJECT_NEWEST

最新のメッセージを拒否し、メッセージを保持する場合だけ、メッセージを生成しているクライアントに例外を通知します。

FLOW_CONTROL

メッセージプロデューサーがメッセージを送信する頻度を下げます。

REMOVE_OLDEST

最も古いメッセージを廃棄します。

REMOVE_LOW_PRIORITY

優先度が最も低いメッセージを、メッセージを生成しているクライアントに通知することなく、古さに応じて削除します。

値がREMOVE_OLDESTまたはREMOVE_LOW_PRIORITYに設定され、さらにuseDMQプロパティーがtrueに設定されている場合は、制限を超えたメッセージはデッドメッセージキューに移動されます。

デッドメッセージキュー自体では、デフォルトの制限動作はREMOVE_OLDESTであり、値にFLOW_CONTROLは設定できません。

デフォルト値：REJECT_NEWEST

MaxNumProducers=value

送信先のメッセージプロデューサーの最大数を指定します。この制限に達すると、新しいプロデューサーを作成できなくなります。値に-1を指定すると、プロデューサーの数は制限されません。デフォルト値は100です。このプロパティーはデッドメッセージキューには適用されません。

型：Integer

指定できる値を次に示します。

-1および1〜2147483647

デフォルト値：100

ConsumerFlowLimit=value

単一のバッチでコンシューマーに配信できるメッセージの最大数を指定します。値に-1を指定すると、メッセージの数は制限されません。デフォルト値は1000です。クライアントのランタイムは、より小さい値をコネクションファクトリーオブジェクトに指定することで、この制限を上書きできます。

キュー送信でロードバランスを使用する場合、この値はロードバランスが始まる前に、キューにあるアクティブなコンシューマー宛てメッセージの初期数です。

型：Integer

指定できる値を次に示します。

-1〜2147483647

デフォルト値：1000

UseDMQ=value

trueに設定した場合、デッドメッセージはデッドメッセージキューに移動します。falseに設定した場合、デッドメッセージは破棄されます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

ValidateXMLSchemaEnabled=value

trueに設定した場合、送信先に対するXMLスキーマ検証が有効になります。

XML検証が有効になっている場合、MessageQueueクライアントのランタイムは、XMLメッセージをブローカーに送信する前に、指定されたXSD（XSDが指定されていない場合はDTD）に対するメッセージの妥当性の検証を試みます。指定したスキーマが見つからないかメッセージを検証できない場合、メッセージは送信されないで例外がスローされます。

このプロパティーは、送信先が非アクティブである、つまりコンシューマーまたはプロデューサーがない場合、および送信先にメッセージが存在しない場合に設定するようにしてください。それ以外の場合は、プロデューサーが再接続する必要があります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

XMLSchemaURIList=value

XMLスキーマ定義ファイルURI文字列の空白区切りのリストを指定します。validateXMLSchemaEnabledがtrueに設定されている場合、URLはXMLスキーマ検証に使用するために1つ以上のXSDの場所を指します。

複数のURIを指定する場合は、次の例に示すように、この値をダブルクォーテーションで囲みます。

"http://foo/flap.xsd http://test.com/test.xsd"

このプロパティーが設定されていないか、またはnullの場合にXML検証が有効になっていると、XMLドキュメント内で指定されたDTDを使用してXML検証が実行されます。

アプリケーションの要件が変更された結果XSDが変更された場合は、変更後のXSDに基づいてXMLメッセージを生成するすべてのクライアントアプリケーションをブローカーに再接続する必要があります。

型：String

指定できる値を次に示します。

スペースで区切られたXSDのURI文字列のリスト

デフォルト値：null

--target target

作成するJMSの物理送信先の対象を指定します。

create-jmsdestサブコマンドは各リソースに関連付けられていますが、物理送信先は、構成の一部のJMSサービス（ブローカー）を使用して作成されます。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--force={false|true}

同じ名称のJMS物理送信先が存在する場合に、このサブコマンドで上書きするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

dest_name

作成対象であるJMS送信先の一意の識別子を指定します。

型：String

指定できる値を次に示します。

物理送信先の名称

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、デフォルト値以外のプロパティー値を持つ、PhysicalQueueという名称のJMS物理キューを作成します。

asadmin create-jmsdest --target instance1 --desttype queue
    --property maxNumMsgs=1000:maxBytesPerMsg=5k PhysicalQueue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.4　delete-jms-host

JMSホストの削除

書式

asadmin [asadmin-options] delete-jms-host [--help] [--target target]
    jms_host_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jms-hostサブコマンドはJMSホストを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するJMSホストの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jms_host_name

削除するホストの名称を指定します。

型：String

指定できる値を次に示します。

ホスト名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、MyNewHostという名称のJMSホストを削除します。

asadmin delete-jms-host --target instance1 MyNewHost

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.5　delete-jms-resource

JMSリソースの削除

書式

asadmin [asadmin-options] delete-jms-resource [--help]
    [--target target]
    jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jms-resourceサブコマンドは、Java Message Service（JMS）コネクションファクトリーリソースまたはJMS送信先リソースを削除します。

このサブコマンドはリモートモードだけサポートします。このサブコマンドをリモートモードで実行するには、ドメイン管理サーバが稼働している必要があります。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するJMSリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソース作成時に--targetオプションを使用して、resource-refが作成された対象だけがアクティブになります。

リソースの削除は、--targetオプションで指定した対象のresource-refのJMSリソースだけを削除します。削除の対象としてドメインが指定されない限り、ドメイン全体からそのリソースは削除されません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

削除する JMSリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、jms/MyQueueという名称のJMS送信先リソースを削除します。

asadmin delete-jms-resource --target instance1 jms/MyQueue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.6　delete-jmsdest

JMS物理送信先の削除

書式

asadmin [asadmin-options] delete-jmsdest [--help]
    --desttype dest_type
    [--target target]
    dest_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-jmsdestサブコマンドはJMS物理送信先を削除します。

このサブコマンドはリモートモードだけサポートします。このサブコマンドをリモートモードで実行するには、ドメイン管理サーバが稼働している必要があります。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--desttype dest_type

JMS送信先のタイプを指定します。

型：string

指摘できる値を次に示します。

topic

queue

デフォルト値：なし

--target target

削除するJMSの物理送信先の対象を指定します。

型：String

指摘できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

dest_name

削除対象となるJMS送信先の一意の識別子を指定します。

型：String

指定できる値を次に示します。

物理送信先の名称

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、PhysicalQueueという名称のキューを削除します。

asadmin delete-jmsdest --target instance1 --desttype queue PhysicalQueue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.7　flush-jmsdest

JMS送信先内のメッセージの削除

書式

asadmin [asadmin-options] flush-jmsdest [--help]
    --desttype {topic|queue} [--target target] destname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

flush-jmsdestサブコマンドは、サーバのJMS構成にある物理送信先からメッセージを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--desttype {topic|queue}

メッセージを削除する物理送信先を指定します。

型：String

指定できる値を次に示します。

topic

queue

デフォルト値：なし

--target target

メッセージを削除する物理送信先の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

dest_name

削除対象であるJMS送信先の一意の識別子を指定します。

型：String

指定できる値を次に示します。

JMS送信先の識別子

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、PhysicalQueueという名称のキューからメッセージを削除します。

asadmin flush-jmsdest --target instance1 --desttype queue PhysicalQueue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.8　list-jms-hosts

JMSホストの一覧表示

書式

asadmin [asadmin-options] list-jms-hosts [--help] [--target target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jms-hostsサブコマンドは、JMSサービスの既存のJMSホストを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するJMSホストの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、instance1という名称のサーバインスタンスについて、JMSサービスのJMSホストを一覧表示します。

asadmin list-jms-hosts --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.9　list-jms-resources

JMSリソースの一覧表示

書式

asadmin [asadmin-options] list-jms-resources [--help]
    [--restype type] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jms-resourcesサブコマンドは、既存のJMSリソース（送信先とコネクションファクトリーリソース）を一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--restype type

一覧表示するJMSリソースのタイプを 指定します。

型：String

指定できる値を次に示します。

javax.jms.Topic

javax.jms.Queue

javax.jms.ConnectionFactory

javax.jms.TopicConnectionFactory

javax.jms.QueueConnectionFactory

デフォルト値：なし

target

一覧表示するJMSリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、すべてのjavax.jms.ConnectionFactoryリソースを一覧表示します。

asadmin list-jms-resources --restype javax.jms.ConnectionFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.19.10　list-jmsdest

JMS物理送信先の一覧表示

書式

asadmin [asadmin-options] list-jmsdest [--help]
    [--desttype type]
    target

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-jmsdestサブコマンドは、JMS物理送信先を一覧表示します。

このサブコマンドはリモートモードだけサポートします。asadminサブコマンドをリモートモードで実行するには、ドメイン管理サーバが動作していることが必要です。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--desttype type

一覧表示するJMS物理送信先のタイプを指定します。

型：String

指定できる値を次に示します。

topic

queue

デフォルト値：queue

target

一覧表示するJMS物理送信先の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、物理トピックをすべて一覧表示します。

asadmin list-jmsdest --desttype topic

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20　EIS接続管理で使用するコマンド

EIS接続管理で使用するコマンドの書式、機能などについて説明します。

2.20.1　create-admin-object

管理対象オブジェクトの作成

書式

asadmin [asadmin-options] create-admin-object [--help]
    [--target target] --restype restype [--classname classname]
    --raname raname [--enabled={true|false}]
    [--description description] [--property name=value[:name=value]...]
    jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-admin-objectサブコマンドは、指定したJNDI名で管理対象オブジェクト、およびリソースアダプターのインターフェース定義を作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

create-admin-objectサブコマンドを実行する前に、リソースアダプターをデプロイしておく必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成する管理対象オブジェクトの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の名前付き構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--restype restype

管理対象オブジェクトのインターフェース定義を指定します。リソース型は、リソースアダプターのra.xmlファイルに指定されるインターフェース定義である必要があります。

型：String

指定できる値を次に示します。

リソース型

デフォルト値：なし

--classname classname

管理対象オブジェクトのクラス名を指定します。複数の管理対象オブジェクトが同じインターフェース定義を使用する場合は必須です。

型：String

指定できる値を次に示します。

管理対象オブジェクトのクラス名

デフォルト値：なし

--raname raname

この管理対象オブジェクトに関連づけるリソースアダプターの名称を指定します。

型：String

指定できる値を次に示します。

リソースアダプター名

デフォルト値：なし

--enabled={true|false}

このオブジェクトを有効にするかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--description description

管理対象オブジェクトを説明するテキスト文字列を記述します。

型：String

指定できる値を次に示します。

作成される管理対象オブジェクトを説明するテキスト

デフォルト値：なし

--property name=value[:name=value]...

リソースの構成にプロパティー名と値のペアを記述します。リソースアダプターに依存します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

name

型：String

指定できる値を次に示します。

リソースアダプターがサポートするプロパティー名

デフォルト値：なし

value

指定できる値を次に示します。

nameに指定したプロパティーの指定範囲に従います。

jndi_name

作成する管理対象オブジェクトのJNDI名を指定します。

型：String

指定できる値を次に示します。

作成される管理対象オブジェクトのJNDI名

デフォルト値：なし

使用例

次の例では、jmsraは、管理対象オブジェクトのインターフェースであるjavax.jms.Queueおよびjavax.jms.Topicを持つ、Message Queueのリソースアダプターを作成します。

このjmsraリソースアダプターは、instance1という名称のサーバインスタンスに作成されます。

asadmin create-admin-object --target instance1 --restype javax.jms.Queue
--raname jmsra --description "sample administered object"
--property Name=sample_jmsqueue jms/samplequeue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.2　create-connector-connection-pool

コネクションプールの追加

書式

asadmin [asadmin-options] create-connector-connection-pool [--help]
    --raname raname
    --connectiondefinition connectiondefinitionname
    [--steadypoolsize steadypoolsize]
    [--maxpoolsize maxpoolsize]
    [--maxwait maxwait]
    [--poolresize poolresize]
    [--idletimeout idletimeout]
    [--isconnectvalidatereq={false|true}]
    [--leaktimeout=timeout]
    [--leakreclaim={false|true}]
    [--creationretryattempts=attempts]
    [--creationretryinterval=interval]
    [--lazyconnectionenlistment={false|true}]
    [--lazyconnectionassociation={false|true}]
    [--matchconnections={true|false}]
    [--maxconnectionusagecount=count]
    [--validateatmostonceperiod=interval]
    [--transactionsupport transactionsupport]
    [--description description]
    [--ping {false|true}]
    [--pooling {true|false}]
    [--property name=value[:name=value]...]
    poolname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-connector-connection-poolサブコマンドは、エンタープライズ情報システム（EIS）へのコネクションのプールを定義します。名前付きプールは複数のコネクターリソースから参照できます。

定義された各プールは、サーバの起動時にインスタンス化され、最初にアクセスされたときに読み込まれます。

同じコネクターコネクションプールに2つ以上のコネクターリソースがポイントする場合、実行時に同じコネクションプールが使用されます。

1つのリソースアダプター内のコネクション定義に対して複数のプールを指定できます。

認証付きのコネクターコネクションプールは、XMLディスクリプターファイルでコネクション情報を指定することによって作成できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--connectiondefinition connectiondefinitionname

コネクション定義の名称を指定します。

型：String

指定できる値を次に示します。

コネクション定義名

デフォルト値：なし

--creationretryattempts=attempts

サーバが最初のコネクションの確立に失敗した場合に、最大何回までコネクション確立を再試行するかを指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--creationretryinterval=interval

コネクション確立を連続して試行するときの間隔を秒単位で指定します。

--creationretryattemptsが0の場合、--creationretryintervalオプションは無視されます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：10

--description description

コネクターコネクションプールの詳しい説明文を記述します。

型：String

指定できる値を次に示します。

テキストでの説明

デフォルト値：なし

--idletimeout idletimeout

コネクションをアイドル状態で維持できる最長時間を秒単位で指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：300

--isconnectvalidatereq={false|true}

コネクション障害検知機能を使用するかどうかを指定します。trueの場合、コネクション障害検知機能を使用します。一定間隔のコネクション障害検知については、指定値に関係なく常に有効になります。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--lazyconnectionenlistment={false|true}

メソッドがリソースを実際に使用する場合、そのリソースをトランザクションに参加させるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--lazyconnectionassociation={false|true}

物理コネクションを使用する場合、その物理コネクションを論理コネクションに関連づけるべきかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

物理コネクションは、物理コネクションを使用する場合にだけ論理コネクションに関連づけられます。トランザクションが完了すると、関連づけは行われません。--lazyconnectionenlistmentオプションもtrueに設定される必要があります。

false

物理コネクションは、物理コネクションを使用する前から論理コネクションに関連づけられます。トランザクションが完了すると、関連づけは行われません。

デフォルト値：false

--leakreclaim={false|true}

リークコネクションの追跡が完了した後で、リークコネクションをコネクションプールに復元するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

リークコネクションはコネクションプールに復元されます。

false

リークコネクションはコネクションプールに復元されません。

デフォルト値：false

--leaktimeout=timeout

コネクションプール内のコネクションリークを追跡する時間を秒単位で指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--matchconnections={false|true}

プールから選択したコネクションがリソースアダプターと適合する必要があるどうかを指定します。

プール内のすべてのコネクションが同一の場合、コネクションとリソースアダプターが適合する必要はありません。

型：Boolean

指定できる値を次に示します。

true

コネクションはリソースアダプターと適合する必要があります。

false

コネクションはリソースアダプターと適合する必要はありません。

デフォルト値：true

--maxconnectionusagecount=count

コネクションを再使用できる最大回数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--maxpoolsize maxpoolsize

クライアントのリクエストを満たすために作成できるコネクションの最大数を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：24

--maxwait maxwait

コネクションが使用できない場合、呼び出し側がコネクション確立までに待機する必要がある時間をミリ秒単位で指定します。

値0は、呼び出し側を無期限に待機させます。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：60000

--ping {false|true}

作成時、この属性がtrueに設定されているプールが使用できるかどうかをテストします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--pooling {true|false}

falseに設定されている場合にコネクションプーリングを無効にします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--poolresize poolresize

プールがコネクション数を増加する量または減少する量を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：2

--property name=value[:name=value]...

プールを構成するためのオプションのプロパティー名と値のペアを指定します。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

このオプションを使用することで、ManagedConnectionFactoryクラスが保持している設定値を、JavaBeans仕様に基き上書きできます。プロパティー名は、ra.xmlのmanagedconnectionfactory-class要素に指定したManagedConnectionFactoryクラスのsetterに対応するJavaBeans仕様に従ったプロパティー名を指定します。ra.xmlのconfig-property要素とこのオプションに同じプロパティーを設定した場合、このオプションの設定が優先されます。

型：String

デフォルト値：なし

--raname raname

リソースアダプターの名称を指定します。

型：String

指定できる値を次に示します。

リソースアダプター名

デフォルト値：なし

--steadypoolsize steadypoolsize

プールに保持する初期コネクション数と最小コネクション数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：24

--transactionsupport transactionsupport

このプールでのトランザクションサポートのレベルを確認します。

型：String

指定できる値を次に示します。

XATransaction

LocalTransaction

NoTransaction

--validateatmostonceperiod=interval

連続するリクエスト間で、コネクションを検証する間隔を秒単位で指定します。

0を指定した場合、常にコネクションを検証します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

poolname

作成するコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

プール名

デフォルト値：なし

使用例

次の例では、コネクターコネクションプールを作成します。

asadmin create-connector-connection-pool --raname jmsra
--connectiondefinition javax.jms.QueueConnectionFactory --steadypoolsize 20
--maxpoolsize 100 --poolresize 2 --maxwait 60000 jms/qConnPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.3　create-connector-resource

コネクターリソースの登録

書式

asadmin [asadmin-options] create-connector-resource [--help]
    --poolname connectorConnectionPoolName [--enabled={true|false}]
    [--description description] [--objecttype objecttype]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-connector-resourceサブコマンドは、指定したJNDI名でコネクターリソースを登録します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--poolname connectorConnectionPoolName

コネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプール名

デフォルト値：なし

--enabled={true|false}

実行時にリソースを有効にするかどうかを確認します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--objecttype objecttype

コネクターリソースのタイプを定義します。

型：String

指定できる値を次に示します。

system-all

すべてのサーバインスタンスおよびドメイン管理サーバに対して有効なシステムリソース。

system-admin

ドメイン管理サーバにだけ有効なシステムリソース。

system-instance

すべてのサーバインスタンスにだけ有効なシステムリソース。

user

ユーザーリソース。

デフォルト値：user

--description description

コネクターリソースの詳しい説明文を表示します。

型：String

指定できる値を次に示します。

テキストでの説明

デフォルト値：なし

--target target

作成するコネクターリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソースのresource-refは指定した対象に対してだけ作成されるため、リソースがドメインで定義されても、リソースは指定した対象だけで使用できるようになります。複数の対象でリソースを参照する場合は、create-resource-refサブコマンドを使用します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このコネクターリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、コネクターリソースを作成します。

asadmin create-connector-resource --target instance1 --poolname jms/qConnPool
--description "sample connector resource" jms/qConnFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.4　create-connector-security-map

コネクターコネクションプールのセキュリティーマップの作成

書式

asadmin [asadmin-options] create-connector-security-map [--help]
    --poolname connector_connection_pool_name
    [--principals principal-name1[,principal-name2]...]
    [--usergroups user-group1[,user-group2]...]
    --mappedusername user-name mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-connector-security-mapサブコマンドは、指定したコネクターコネクションプールのセキュリティーマップを作成します。セキュリティーマップがない場合、新しいマップが作成されます。

このサブコマンドは、アプリケーションの呼び出し側識別（プリンシパルまたはユーザーグループ）をコンテナー管理による認証シナリオで、対応するエンタープライズ情報システム（EIS）プリンシパルにマップすることもできます。

コネクターコネクションプールには1つ以上の名前付きセキュリティーマップを関連づけることができます。

コネクターセキュリティーマップ構成では、ワイルドカードのアスタリスク（*）を使用して、すべてのユーザーまたはすべてのユーザーグループを示すことができます。

EISパスワードを指定する場合、AS_ADMIN_MAPPEDPASSWORDエントリーをパスワードファイルに追加してから--passwordfile asadminオプションを使用して、ファイルを指定できます。

このサブコマンドはリモートモードだけサポートします。

このサブコマンドを正常に実行するには、コネクターコネクションプールをcreate-connector-connection-poolサブコマンドを使用して作成する必要があります。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--poolname connector_connection_pool_name

セキュリティーマップが属すコネクターコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプール名

デフォルト値：なし

--principals principal-name1[,principal-name2]...

バックエンドEISプリンシパルのリストを指定します。

同じコマンドでは--principalsオプションまたは--usergroupsオプションのどちらかを使用し、両方のオプションは使用しません。

複数のプリンシパルはコンマ区切りのリストで指定できます。

型：String

指定できる値を次に示します。

バックエンドEIS主体名

デフォルト値：なし

--usergroups user-group1[,user-group2]...

バックエンドEISユーザーグループのリストを指定します。

同じコマンドでは--principalsオプションまたは--usergroupsオプションのどちらかを使用し、両方のオプションは使用しません。

複数のユーザーグループはコンマ区切りのリストで指定できます。

型：String

指定できる値を次に示します。

EISユーザーグループ

デフォルト値：なし

--mappedusername user-name

EISユーザー名を指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

mapname

作成するセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

マップ名

デフォルト値：なし

使用例

次の例では、コネクターセキュリティーマップを作成します。

asadmin create-connector-security-map --poolname connector-pool1
--principals principal1,principal2 --mappedusername backend-username
securityMap1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.5　create-connector-work-security-map

リソースアダプターのワークセキュリティーマップの作成

書式

asadmin [asadmin-options] create-connector-work-security-map [--help]
    --raname raname [--principalsmap eis-principal1=principal_name1
    [,eis-principal2=principal_name2]...|
    --groupsmap eis-group1=server-group1[,eis-group2=server-group2]...]
    mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-connector-work-security-mapサブコマンドは、リソースアダプターEISプリンシパルまたはEISユーザーグループによってサブミットされたワークの呼び出し側識別を、Java EE Serverセキュリティードメインに適しているプリンシパルまたはユーザーグループにマップします。

リソースアダプターには1つ以上のワークセキュリティーマップを関連づけることができます。

コネクターワークセキュリティーマップの構成では、ワイルドカードのアスタリスク（*）を使用して、すべてのユーザーまたはすべてのユーザーグループを示すことができます。

エンタープライズ情報システム（EIS）は、組織のデータを保持するあらゆるシステムです。メインフレーム、メッセージングシステム、データベースシステム、またアプリケーションなどが該当します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--groupsmap eis-group1=server-group1[,eis-group2=server-group2]...

バックエンドEISユーザーグループのJava EE Serverユーザーグループへのマッピングを指定します。

複数のマッピングを指定する場合は、コンマ区切りのリストを使用します。

--principalsmapオプションまたは--groupsmapオプションのどちらかを使用し、両方のオプションは使用しません。

型：String

指定できる値を次に示します。

バックエンドEISのマップ名

デフォルト値：なし

--principalsmap eis-principal1=principal_name1[,eis-principal2=principal_name2]...

バックエンドEISプリンシパルのJava EE Serverのプリンシパルへのマッピングを指定します。

複数のマッピングを指定する場合は、コンマ区切りのリストを使用します。

--principalsmapオプションまたは--groupsmapオプションのどちらかを使用し、両方のオプションは使用しません。

型：String

指定できる値を次に示します。

主体マップ名

デフォルト値：なし

--raname raname

リソースアダプターの名称であるリソースアダプターアーカイブ名を指定します。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

mapname

作成するワークセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

マップ名

デフォルト値：なし

使用例

次の例では、コネクターワークセキュリティーマップを作成します。

asadmin create-connector-work-security-map --raname my-resource-adapter
--principalsmap eis-principal-1=server-principal-1,eis-principal-2
=server-principal-2,eis-principal-3=server-principal-1 workSecurityMap1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.6　create-resource-adapter-config

リソースアダプターアーカイブ構成情報の作成

書式

asadmin [asadmin-options] create-resource-adapter-config [--help]
    [--objecttype object-type] raname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-resource-adapter-configサブコマンドはリソースアダプターアーカイブ構成情報を作成します。このサブコマンドは、リソースアダプターを配置する前に実行できます。つまり構成情報は、デプロイ時に利用できます。リソースアダプターアーカイブ構成は、リソースアダプターが配置された後でも作成できます。この場合、リソースアダプターは新しい構成で再起動されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

ranameは、domain.xmlファイルのresource-adapter-nameの値です。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--objecttype object-type

オブジェクトのタイプを指定します。

型：String

指定できる値を次に示します。

オブジェクトの型名

デフォルト値：user

raname

リソースアダプターアーカイブ名を指定します。domain.xmlファイルのresource-adapter-nameの値です。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

使用例

次の例では、ra1のリソースアダプターアーカイブ構成情報を作成します。

asadmin create-resource-adapter-config ra1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.7　delete-admin-object

管理対象オブジェクトの削除

書式

asadmin [asadmin-options] delete-admin-object [--help]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-admin-objectサブコマンドは、指定したJNDI名の管理対象オブジェクトを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除する管理対象オブジェクトの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソース作成時に--targetオプションを使用して、resource-refが作成された対象だけがアクティブになります。

リソースの削除は、--targetオプションで指定した対象のresource-refだけを削除します。削除の対象としてドメインが指定されない限り、ドメイン全体からそのリソースは削除されません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

管理対象オブジェクトのJNDI名を指定します。

型：String

指定できる値を次に示します。

管理対象オブジェクトのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、jdbc/samplequeueという名称の管理対象オブジェクトを削除します。

asadmin delete-admin-object --target instance1 jdbc/samplequeue

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.8　delete-connector-connection-pool

コネクターコネクションプールの削除

書式

asadmin [asadmin-options] delete-connector-connection-pool [--help]
    [--cascade={false|true}] poolname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-connector-connection-poolサブコマンドは、指定したコネクターコネクションプールを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--cascade={false|true}

コネクションプールとそのプールに関連づけられているすべてのコネクターリソースを削除します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

poolname

コネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプール名

デフォルト値：なし

使用例

次の例では、jdbc/qConnPoolという名称のコネクターコネクションプールを削除します。

asadmin delete-connector-connection-pool --cascade=false jdbc/qConnPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.9　delete-connector-resource

コネクターリソースの削除

書式

asadmin [asadmin-options] delete-connector-resource [--help]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-connector-resourceサブコマンドは、指定したJNDI名のコネクターリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するコネクターリソースの対象を指定します。

リソースは常にドメイン全体に対して作成されますが、リソース作成時に--targetオプションを使用して、resource-refが作成された対象だけがアクティブになります。

リソースの削除は、--targetオプションで指定した対象のresource-refだけを削除します。削除の対象としてドメインが指定されない限り、ドメイン全体からそのリソースは削除されません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

コネクターリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

コネクターリソースのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、jdbc/qConnFactoryという名称のコネクターリソースを削除します。

asadmin delete-connector-resource --target instance1 jdbc/qConnFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.10　delete-connector-security-map

コネクターコネクションプールのセキュリティーマップの削除

書式

asadmin [asadmin-options] delete-connector-security-map [--help]
    --poolname connector_connection_pool_name mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-connector-security-mapサブコマンドは、指定したコネクターコネクションプールのセキュリティーマップを削除します。

このサブコマンドを正常に実行するには、最初にcreate-connector-connection-poolサブコマンドを使用してコネクターコネクションプールを作成する必要があります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

--poolnameオプションを使用するには、コネクターコネクションプールを作成しておく必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--poolname connector_connection_pool_name

削除するセキュリティーマップが属するコネクターコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクターコネクションプール名

デフォルト値：なし

mapname

セキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

セキュリティーマップ名

デフォルト値：なし

使用例

次の例では、connector-pool1という名称の既存のコネクションプールに属するsecurityMap1を削除します。

asadmin delete-connector-security-map --poolname connector-pool1 securityMap1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.11　delete-connector-work-security-map

リソースアダプターのワークセキュリティーマップの削除

書式

asadmin [asadmin-options] delete-connector-work-security-map [--help]
    --raname raname mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-connector-work-security-mapサブコマンドは、指定したリソースアダプターに関連づけられているワークセキュリティーマップを削除します。このサブコマンドを正常に実行するには、最初に指定したリソースアダプターを作成してデプロイする必要があります。

エンタープライズ情報システム（EIS）は組織のデータを保持するシステムです。メインフレーム、メッセージングシステム、データベースシステム、またアプリケーションなどが該当します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

--ranameオプションを使用するには、指定したリソースアダプターを作成し、かつデプロイしておく必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--raname raname

ワークセキュリティーマップが関連づけられているリソースアダプターアーカイブ名を確認します。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

mapname

ワークセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

セキュリティーマップ名

デフォルト値：なし

使用例

次の例では、ra_nameという名称のリソースアダプターに関連するwork_security_map_nameという名称のワークセキュリティーマップを削除します。

asadmin delete-connector-work-security-map --raname ra_name
 work_security_map_name

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.12　delete-resource-adapter-config

リソースアダプターアーカイブ構成情報の削除

書式

asadmin [asadmin-options] delete-resource-adapter-config [--help]
    raname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-resource-adapter-configサブコマンドは、リソースアダプターアーカイブの構成情報を削除します。

このコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

raname

リソースアダプターアーカイブ名を指定します。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

使用例

次の例では、ra1のリソースアダプターアーカイブの構成情報を削除します。

asadmin delete-resource-adapter-config ra1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.13　flush-connection-pool

コネクションプールで確立されたコネクションの再初期化

書式

asadmin [asadmin-options] flush-connection-pool [--help]
    [--appname application [--modulename module]]
    [--target target] pool_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

flush-connection-poolサブコマンドは、JDBCコネクションプールまたはコネクターコネクションプールを初期状態にリセットします。このサブコマンドを実行すると、未使用のコネクションは削除されます。そのあと、プールの初期コネクションが再作成され、プールは通常プールサイズに復元されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--appname application

アプリケーションスコープのリソースが定義されているアプリケーション名を指定します。

型：String

指定できる値を次に示します。

アプリケーション名

デフォルト値：なし

--modulename module

モジュールスコープのリソースが定義されているモジュール名を指定します。

型：String

指定できる値を次に示します。

モジュール名

デフォルト値：なし

--target target

再初期化するコネクションプールの対象を指定します。

サーバインスタンス作成後、一度も起動していないサーバインスタンス名を指定した場合、コマンドの実行に成功します。

引数で指定するプール名に依存しません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

pool_name

再初期化するコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプール名

使用例

次の例では、instance1という名称のサーバインスタンス上の、__TimerPoolという名称のJDBCコネクションプールを再初期化します。

asadmin flush-connection-pool --target instance1 __TimerPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.14　list-admin-objects

管理された全オブジェクトの取得

書式

asadmin [asadmin-options] list-admin-objects [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-admin-objectsサブコマンドは、管理された全オブジェクトの一覧を表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示する管理対象オブジェクトの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、すべての管理対象オブジェクトを一覧表示します。

asadmin list-admin-objects

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.15　list-connector-connection-pools

コネクターコネクションプールの一覧表示

書式

asadmin [asadmin-options] list-connector-connection-pools [--help]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-connector-connection-poolsサブコマンドは、作成されたコネクターコネクションプールを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

使用例

次の例では、既存のコネクターコネクションプールを一覧表示します。

asadmin list-connector-connection-pools

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.16　list-connector-resources

コネクターリソースの一覧表示

書式

asadmin [asadmin-options] list-connector-resources [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-connector-resourcesサブコマンドはすべてのコネクターリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するコネクターリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では既存のコネクターリソースをすべて一覧表示します。

asadmin list-connector-resources

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.17　list-connector-security-maps

コネクターコネクションプールに属するセキュリティーマップの一覧表示

書式

asadmin [asadmin-options] list-connector-security-maps [--help]
    [--securitymap securitymap]
    [--verbose={false|true}]
    pool-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-connector-security-mapsサブコマンドは、指定されたコネクターコネクションプールに属するセキュリティーマップを一覧表示します。このサブコマンドを正常に実行するには、先にcreate-connector-connection-poolサブコマンドを使用してコネクターコネクションプールを作成する必要があります。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--securitymap securitymap

IDとプリンシパルを一覧表示する、コネクターコネクションプール内に含まれるセキュリティーマップの名称を指定します。

このオプションを指定した場合、--verboseオプションの指定に関係なく、詳細情報が表示されます。

型：String

指定できる値を次に示します。

セキュリティーマップ名

デフォルト値：なし

--verbose={false|true}

ID、プリンシパルおよびセキュリティー名を含む詳細情報を一覧表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

pool-name

セキュリティーマップを一覧表示する、コネクターコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクターコネクションプール名

デフォルト値：なし

使用例

次の例では、connector-Pool1というプール名のコネクターコネクションプールに属するセキュリティーマップを一覧表示します。

asadmin list-connector-security-maps connector-Pool1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.18　list-connector-work-security-maps

リソースアダプターに属するワークセキュリティーマップの一覧表示

書式

asadmin [asadmin-options] list-connector-work-security-maps [--help]
    [--securitymap securitymap]
    resource_adapter_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-connector-work-security-mapsサブコマンドは、指定されたリソースアダプターに属するワークセキュリティーマップを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--securitymap securitymap

IDとプリンシパルを一覧表示する、リソースアダプター内に含まれるセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

セキュリティーマップ名

デフォルト値：なし

resource_adapter_name

セキュリティーマップを一覧表示する、リソースアダプターの名称を指定します。

型：String

指定できる値を次に示します。

リソースアダプター名

デフォルト値：なし

使用例

次の例では、my_resource_adapterという名称のリソースアダプターについて、現在のワークセキュリティーマップを一覧表示します。

asadmin list-connector-work-security-maps my_resource_adapter

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.19　list-resource-adapter-configs

リソースアダプターアーカイブ構成の名称の一覧表示

書式

asadmin [asadmin-options] list-resource-adapter-configs [--help]
    [--raname raname] [--verbose={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-resource-adapter-configsサブコマンドは、domain.xml内のリソースアダプターアーカイブ構成情報を一覧表示します。domain.xmlファイルのresource-adapter-configというエントリーが一覧表示されます。--ranameオプションを指定した場合、指定したリソースアダプターアーカイブ構成だけが一覧表示されます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--raname raname

リソースアダプターアーカイブ名を指定します。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

--verbose={false|true}

構成されたプロパティーを一覧表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

使用例

次の例では、現在のリソースアダプターアーカイブ構成情報を一覧表示します。

asadmin list-resource-adapter-configs

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.20　ping-connection-pool

JDBCまたはコネクターコネクションプールの検証

書式

asadmin [asadmin-options] ping-connection-pool [--help]
    [--appname application [--modulename module]]
    [--target target] pool_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

ping-connection-poolサブコマンドは、既存のJDBCまたはコネクターコネクションプールが使用できるかどうかをテストします。ping-connection-poolサブコマンドは、glassfish-resources.xmlで定義したアプリケーションスコープまたはモジュールスコープのリソースも対象にできます。

このサブコマンドはリモートモードだけサポートします。

アプリケーションスコープまたはモジュールスコープのリソースのJNDI名は、java:app/jdbc/myDataSourceまたはjava:module/jdbc/myModuleLevelDataSourceの形式を使用して指定されます。この命名範囲は、Java EE 6仕様で定義されています。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

コネクションプールが使用できるかどうかをテストする前に、認証されたコネクションプールを作成し、サーバまたはデータベースが起動されていることを確認する必要があります。

ファイル

ping-connection-poolサブコマンドは、glassfish-resources.xmlで定義したアプリケーションスコープまたはモジュールスコープのリソースも対象にできます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--appname application

アプリケーションスコープのリソースが定義されているアプリケーションの名称を指定します。

アプリケーションスコープのリソースのJNDI名を参照するには、java:appプレフィックスを使用してルックアップを実行します。

型：String

指定できる値を次に示します。

アプリケーションの名称

デフォルト値：なし

--modulename module

モジュールスコープリソースが定義されているモジュールの名称を指定します。

モジュールスコープリソースのJNDI名を参照するには、java:moduleプレフィックスを使用してルックアップを実行します。

型：String

指定できる値を次に示します。

モジュールの名称

デフォルト値：なし

--target target

このサブコマンドの対象を指定します。

サーバインスタンス作成後、一度も起動していないサーバインスタンス名を指定した場合、コマンドの実行に成功します。

引数で指定するプール名に依存しません。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

pool_name

テストするコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプールの名称

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上の、DerbyPoolという名称のコネクションプールが使用できるかどうかをテストします。

asadmin ping-connection-pool --target instance1 DerbyPool

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.21　update-connector-security-map

コネクターコネクションプールのセキュリティーマップの変更

書式

asadmin [asadmin-options] update-connector-security-map [--help]
    --poolname connector_connection_pool_name
    [--addprincipals principal_name1[,principal_name2]...]
    [--addusergroups user_group1[,user_group2]...]
    [--removeprincipals principal_name1[,principal_name2]...]
    [--removeusergroups user_group1[,user_group2]...]
    [--mappedusername username] mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-connector-security-mapサブコマンド は、指定したコネクターコネクションプールのセキュリティーマップを変更します。

このサブコマンドはリモートモードだけサポートします。

前提条件

コネクターコネクションプールが存在している必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--poolname connector_connection_pool_name

更新するセキュリティーマップが属すコネクターコネクションプールの名称を指定します。

型：String

指定できる値を次に示します。

コネクションプール名

デフォルト値：なし

--addprincipals principal_name1[,principal_name2]...

追加するEIS固有のプリンシパルをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

プリンシパル名

デフォルト値：なし

--addusergroups user_group1[,user_group2]...

追加するEISユーザーグループをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--removeprincipals principal_name1[,principal_name2]...

削除するEIS固有のプリンシパルをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

プリンシパル名

デフォルト値：なし

--removeusergroups user_group1[,user_group2]...

削除するEISユーザーグループをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--mappedusername username

EISユーザー名を指定します。

型：String

指定できる値を次に示します。

ユーザー名

デフォルト値：なし

mapname

更新するセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

アプリケーションモジュール名

デフォルト値：なし

使用例

次の例では、securityMap1という名称の既存のセキュリティーマップにプリンシパルを追加します。

asadmin update-connector-security-map --poolname connector-pool1
--addprincipals principal1,principal2 securityMap1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.20.22　update-connector-work-security-map

リソースアダプターのワークセキュリティーマップの変更

書式

asadmin [asadmin-options] update-connector-work-security-map [--help]
    --raname raname
    [--addprincipals eis-principal1=server-principal1
    [, eis-principal2=server-principal2]...]
    --addgroups eis-group1=server-group1
    [, eis-group2=server-group2]...
    [--removeprincipals eis-principal1[,eis-principal2]...]
    [--removegroups eis-group1[, eis-group2]...] mapname

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

update-connector-work-security-mapサブコマンド は、指定したリソースアダプターのセキュリティーマップを変更します。

このサブコマンドはリモートモードだけサポートします。

前提条件

コネクターコネクションプールが存在している必要があります。

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--addgroups eis-group1=server-group1[, eis-group2=server-group2]...

追加するEISグループをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--addprincipals eis-principal1=server-principal1 [, eis-principal2=server-principal2]...

追加するEIS固有のプリンシパルをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

プリンシパル名

デフォルト値：なし

--removegroups eis-group1[, eis-group2]...

削除するEISグループをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

グループ名

デフォルト値：なし

--removeprincipals eis-principal1[,eis-principal2]...

削除するEIS固有のプリンシパルをコンマ区切りのリストで指定します。

型：String

指定できる値を次に示します。

プリンシパル名

デフォルト値：なし

--raname raname

ワークセキュリティーマップが関連づけられているリソースアダプターアーカイブ名を指定します。

型：String

指定できる値を次に示します。

リソースアダプターアーカイブ名

デフォルト値：なし

mapname

更新するワークセキュリティーマップの名称を指定します。

型：String

指定できる値を次に示します。

ワークセキュリティーマップ名

デフォルト値：なし

使用例

次の例では、ワークセキュリティーマップからプリンシパルを削除します。

asadmin update-connector-work-security-map --raname generic-ra
--removeprincipals eis-foo generic-ra-principals-map

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.21　スレッドプール管理で使用するコマンド

スレッドプール管理で使用するコマンドの書式、機能などについて説明します。

2.21.1　create-threadpool

スレッドプールの追加

書式

asadmin [asadmin-options] create-threadpool [--help] [--target target]
    [--maxthreadpoolsize maxthreadpoolsize]
    [--minthreadpoolsize minthreadpoolsize]
    [--idletimeout idletimeout] [--maxqueuesize maxqueuesize]
    threadpool-id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-threadpoolサブコマンドは、指定名でスレッドプールを作成します。プールの最小および最大スレッド数、メッセージ数、およびスレッドのタイムアウト時間を指定できます。

作成したスレッドプールは、IIOPリクエスト処理と、リソースアダプター処理で利用します。スレッドプールは複数リソースアダプターで使用できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するスレッドプールの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--maxthreadpoolsize maxthreadpoolsize

プールに保持できる最大スレッド数を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：5

--minthreadpoolsize minthreadpoolsize

プールの最小スレッド数を指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：2

--idletimeout idletimeout

使われていないスレッドをプールから削除するまでの時間を秒で指定します。

型：Integer

指定できる値を次に示します。

1〜2147483647

デフォルト値：900

--maxqueuesize maxqueuesize

ネットワークリスナーまたはIIOPリスナーのスレッドがメッセージを処理できるまで、キューに保持できるメッセージの最大数を指定します。値に-1を指定すると、メッセージの数は制限されません。

型：Integer

指定できる値を次に示します。

-1および1〜2147483647

デフォルト値：4096

threadpool-id

作業キューのIDを指定します。

型：String

指定できる値を次に示します。

スレッドプールID

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、threadpool-1というIDのスレッドプールを新規に作成します。

asadmin create-threadpool --target instance1 --maxthreadpoolsize 100
--minthreadpoolsize 20 --idletimeout 2 threadpool-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.21.2　delete-threadpool

スレッドプールの削除

書式

asadmin [asadmin-options] delete-threadpool [--help]
    [--target target] threadpool-id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-threadpoolサブコマンドは、指定したIDのスレッドプールを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するスレッドプールの対象を指定します。

指定できる値を次に示します。

型：String

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

threadpool-id

スレッドプールのIDを指定します。

型：String

スレッドプールのID

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、threadpool-1という名称のスレッドプールを削除します。

asadmin delete-threadpool --target instance1 threadpool-1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.21.3　list-threadpools

スレッドプールの一覧表示

書式

asadmin [asadmin-options] list-threadpools [--help]
    target

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-threadpoolsサブコマンドはJava EE Serverのスレッドプールを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するスレッドプールの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

configuration_name

指定した名称の構成を対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンスにある現在のスレッドプールを一覧表示します。

asadmin list-threadpools server

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.22　トランザクション管理で使用するコマンド

トランザクション管理で使用するコマンドの書式、機能などについて説明します。

2.22.1　recover-transactions

実行待ちトランザクションの手動での回復

書式

asadmin [asadmin-options] recover-transactions [--help]
    [--transactionlogdir transaction_log_dir]
    [--target target] server_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

recover-transactionsサブコマンドは、サーバ障害後にトランザクションを回復します。

複数サーバインスタンス環境の場合、残存しているサーバインスタンスにrecover-transactionsサブコマンドを実行できます。このサブコマンドを使用するには、次の条件を満たす必要があります。

代理トランザクション回復が無効化されている。

トランザクションサービスログが、すべてのサーバインスタンスがアクセスできる共有ファイルシステムまたはデータベースに格納されている。

スタンドアロンのサーバインスタンスの場合、サーバ障害後にトランザクションを回復するためにこのサブコマンドを使用しないでください。

このサブコマンドはリモートモードだけサポートします。

スタンドアロンのサーバインスタンスの場合、リソースに障害が発生してもサーバが稼働中の場合にだけ、recover-transactionsサブコマンドがトランザクションを回復できます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

複数サーバインスタンス環境の場合、サーバ障害後に残存しているサーバインスタンスにrecover-transactionsサブコマンドを実行してトランザクションを回復できます。このように使用するには、次の条件を満たす必要があります。

代理トランザクション回復が無効化されている。

トランザクションサービスログが、すべてのサーバインスタンスがアクセスできる共有ファイルシステムまたはデータベースに格納されている。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--transactionlogdir transaction_log_dir

トランザクションの回復が要求されたサーバのトランザクションのステータスファイルの場所を指定します。

このオプションは、共有ファイルシステム上にトランザクションのステータスファイルが格納されている場合にだけ適用されます。

型：String

指定できる値を次に示します。

ログの場所

デフォルト値：なし

--target target

server_nameで指定されたサーバの回復を実行する対象サーバを指定します。

型：String

指定できる値を次に示します。

対象サーバインスタンスの名称

デフォルト値：なし

server_name

サーバ名を指定します。スタンドアロンのサーバインスタンス用です。

このサーバが稼働している場合は、同じサーバによって回復が実行されます。この場合、--transactionlogdirおよび--targetオプションを省略する必要があります。

サーバが稼働していない場合、--targetオプションが必要です。また、共有ファイルシステム上にトランザクションのステータスファイルが格納されている場合は--transactionlogdirオプションも必要です。

型：String

指定できる値を次に示します。

サーバインスタンスの名称

デフォルト値：

スタンドアロンのサーバインスタンスの場合、serverです。

複数サーバインスタンス環境の場合、回復が必要なサーバの名称です。

使用例

次の例では、稼働していないサーバのトランザクションを回復します。

asadmin recover-transactions --transactionlogdir /logs/tx
--target server1 server2

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.23　バッチジョブ管理で使用するコマンド

バッチジョブ管理で使用するコマンド書式、機能などについて説明します。

2.23.1　list-batch-job-executions

バッチジョブ実行の一覧表示

書式

asadmin [asadmin-options] list-batch-job-executions [--help]
    [--target target]
    [--executionid execution-id]
    [--long={false|true}]
    [--output output]
    [--header={false|true}]
    [instance_ID]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-batch-job-executionsサブコマンドは、バッチジョブ実行と実行の詳細情報を一覧表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するバッチジョブ実行の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--executionid execution-id | -x execution-id

バッチジョブ実行の実行IDを指定します。

型：String

指定できる値を次に示します。

ジョブインスタンスID

デフォルト値：なし

--long={false|true} | -l={false|true}

バッチジョブ実行に関する詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--output output | -o output

バッチジョブ実行の特定の詳細情報を表示します。表示する詳細とその順序を指定するには、コンマ区切りのリストを使用します。値では大文字と小文字が区別されません。

型：String

指定できる値を次に示します。

jobname

ジョブの名称を表示します。

executionid

バッチジョブ実行に割り当てられたIDを表示します。ジョブが初めて開始したときと既存のジョブ実行が再開されるたびに、新しいジョブ実行が作成されます。

starttime

ジョブ実行の開始時間を表示します。

endtime

ジョブ実行の終了時間を表示します。

batchstatus

バッチ実行時に設定されたジョブの実行状態を表示します。

exitstatus

ジョブのジョブXMLまたはバッチアプリケーションによって設定されたジョブの実行状態を表示します。デフォルトでは、exitstatusが明示的にオーバーライドされないかぎり、exitstatusおよびbatchstatusは同じです。

jobparameters

バッチ実行時に設定されたジョブ実行のためのプロパティーのキーと値のペア一覧を表示します。

stepcount

バッチジョブ実行のステップ数を表示します。

デフォルト値：表示できるすべてのヘッダーのサブセット

--header={false|true} | -h={false|true}

--longオプションを使用したときに列ヘッダーを表示するかどうかを指定します。ヘッダーを表示しないようにするには、--headerオプションにfalseを設定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

instance_ID

実行の詳細を一覧表示するジョブインスタンスのIDを指定します。

型：Integer

指定できる値を次に示します。

ジョブインスタンスID

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに対して実行されたバッチジョブを一覧表示し、特定の詳細情報を表示します。

asadmin list-batch-job-executions --target instance1
-o=jobname,executionid,batchstatus,exitstatus

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.23.2　list-batch-job-steps

バッチジョブの実行ステップの一覧表示

書式

asadmin [asadmin-options] list-batch-job-steps [--help]
    [--long={false|true}]
    [--target target]
    [--output output]
    [--header={false|true}]
    execution_id

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-batch-job-stepsサブコマンドは、特定のバッチジョブの実行ステップを一覧表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するバッチジョブ実行ステップの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--long={false|true} | -l={false|true}

バッチジョブの実行ステップの詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--output output | -o output

バッチジョブの実行ステップに関する特定の情報を表示します。表示する詳細とその順序を指定するには、コンマ区切りのリストを使用します。値では大文字と小文字が区別されません。

型：String

指定できる値を次に示します。

stepname

ステップの名称を表示します。

stepid

ステップIDを表示します。

starttime

ステップの開始時間を表示します。

endtime

ステップの終了時間を表示します。

batchstatus

バッチ実行時に設定されたステップの状態を表示します。

exitstatus

ジョブのジョブXMLまたはバッチアプリケーションによって設定されたジョブの実行状態を表示します。デフォルトでは、exitstatusが明示的にオーバーライドされないかぎり、exitstatusおよびbatchstatusは同じです。

デフォルト値：表示できるすべてのヘッダーのサブセット

--header={false|true} | -h={false|true}

--longオプションを使用したときに列ヘッダーを表示するかどうかを指定します。ヘッダーを表示しないようにするには、--headerオプションにfalseを設定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

execution_id

バッチジョブのステップおよび詳細を一覧表示する実行IDを指定します。

型：Integer

指定できる値を次に示します。

ジョブインスタンスID

デフォルト値：なし

使用例

次の例では、バッチジョブの実行ステップおよび実行IDが7のジョブ実行について、特定のステップ詳細を一覧表示します。対象は、instance1という名称のサーバインスタンスです。

asadmin list-batch-job-steps --target instance1 o=stepname,stepid,batchstatus 7

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.23.3　list-batch-jobs

バッチジョブの一覧表示

書式

asadmin [asadmin-options] list-batch-jobs [--help]
    [--target target]
    [--long={false|true}]
    [--output output]
    [--header={false|true}]
    [job_name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-batch-jobsサブコマンドは、バッチジョブとジョブの詳細を一覧表示します。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するバッチジョブの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--long={false|true} | -l={false|true}

バッチジョブに関する詳細情報を表示します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--output output | -o output

バッチジョブに関する特定の情報を表示します。表示する詳細とその順序を指定するには、コンマ区切りのリストを使用します。値では大文字と小文字が区別されません。

型：String

指定できる値を次に示します。

jobname

ジョブの名称を表示します。

appname

アプリケーションの名称を表示します。

instancecount

ジョブインスタンス数を表示します。

instanceid

ジョブインスタンスに割り当てられたIDを表示します。

executionid

バッチジョブ実行に割り当てられたIDを表示します。ジョブが初めて開始したとき、および既存のジョブ実行が再開されるたびに新しいジョブ実行が作成されます。

batchstatus

バッチ実行時に設定されたジョブ状態を表示します。

starttime

ジョブの開始時間を表示します。

endtime

ジョブの終了時間を表示します。

exitstatus

ジョブのジョブXMLまたはバッチアプリケーションによって設定されたジョブの状態を表示します。デフォルトでは、exitstatusが明示的にオーバーライドされないかぎり、exitstatusおよびbatchstatusは同じです。

デフォルト値：jobname、instancecount

--header={false|true} | -h={false|true}

--longオプションを使用したときに列ヘッダーを表示するかどうかを指定します。ヘッダーを表示しないようにするには、--headerオプションにfalseを設定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

job_name

詳細を一覧表示するジョブの名称を指定します。

型：Integer

指定できる値を次に示します。

ジョブ名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスのバッチジョブを一覧表示します。

asadmin list-batch-jobs --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.23.4　list-batch-runtime-configuration

バッチ実行時の構成の表示

書式

asadmin [asadmin-options] list-batch-runtime-configuration [--help]
    [--target target]
    [--output output]
    [--header={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-batch-runtime-configurationサブコマンドは、バッチ実行時の構成を表示します。バッチ実行時の構成データはdomain.xmlファイルのconfig要素に格納されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

バッチ実行時の構成データはdomain.xmlファイルのconfig要素に格納されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

一覧表示するバッチ実行時の構成の対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--output output | -o output

バッチ実行時の構成に関する特定の情報を表示します。

表示する詳細とその順序を指定するには、コンマ区切りのリストを使用します。値では大文字と小文字が区別されません。

型：String

指定できる値を次に示します。

datasourcelookupname

ジョブ情報の格納に使用されるデータソースのJNDIルックアップ名です。デフォルトでは、バッチ実行時はデフォルトのデータソースjdbc/__BatchPoolが使用されます。

executorservicelookupname

ジョブへのスレッドの提供に使用される管理対象のManagedExecutorServiceのJNDIルックアップ名です。デフォルトでは、バッチ実行時はデフォルトの管理対象のManagedExecutorServiceのconcurrent/__defaultManagedExecutorServiceが使用されます。

デフォルト値：datasourcelookupname、executorservicelookupname

--header={false|true} | -h={false|true}

--longオプションを使用したときに列ヘッダーを表示するかどうかを指定します。ヘッダーを表示しないようにするには、--headerオプションにfalseを設定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

使用例

次の例では、instance1という名称のサーバインスタンスについて、バッチ実行時の構成を一覧表示します。

asadmin list-batch-runtime-configuration --target instance1

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.23.5　set-batch-runtime-configuration

バッチランタイムの設定

書式

asadmin [asadmin-options] set-batch-runtime-configuration [--help]
    [--target target]
    [--datasourcelookupname datasource-lookup-name]
    [--executorservicelookupname executor-service-lookup-name]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

set-batch-runtime-configurationサブコマンドは、バッチランタイムを設定します。ランタイムはデータソースとManagedExecutorServiceを使用してバッチジョブを実行します。バッチランタイムの構成データは domain.xmlファイルのconfig要素に格納されます。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

バッチランタイムの構成データはdomain.xmlファイルのconfig要素に格納されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

設定するバッチランタイムの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

{--datasourcelookupname | -d} datasource-lookup-name

ジョブ情報の格納に使用されるデータソースのJNDIルックアップ名を指定します。

データソースを変更する必要がある場合、ドメインを停止してから再起動し、ジョブが起動または再起動される前に変更します。なお、データソースを変更すると、以前のデータソースに格納されていた情報にはアクセスできなくなります。

型：String

指定できる値を次に示します。

JNDIルックアップ名

デフォルト値：jdbc/__BatchPool

{--executorservicelookupname | -x} executor-service-lookup-name

ジョブにスレッドを提供するために使用されるManagedExecutorServiceのJNDIルックアップ名を指定します。

型：String

指定できる値を次に示します。

ManagedExecutorServiceのJNDIルックアップ名

デフォルト値：concurrent/__defaultManagedExecutorService

使用例

次の例では、concurrent/myExecutorという名称の既存のManagedExecutorServiceを使用するために、instance1という名称のサーバインスタンスのバッチランタイムを設定します。

asadmin set-batch-runtime-configuration --target instance1
--executorservicelookupname concurrent/myExecutor

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24　並行リソース管理で使用するコマンド

並行リソース管理で使用するコマンドの書式、機能などについて説明します。

2.24.1　create-context-service

コンテキストサービスのリソースの作成

書式

asadmin [asadmin-options] create-context-service [--help]
    [--enabled={false|true}] [--contextinfoenabled={false|true}]
    [--contextinfo={Classloader|JNDI|Security|WorkArea}]
    [--description description] [--target target]
    jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-context-serviceサブコマンドは、コンテキストサービスのリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--enabled={false|true}

実行時にリソースを有効にするかどうかを決定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfoenabled={false|true}

コンテナーのコンテキストをスレッドに伝えるかどうかを決定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfo={Classloader|JNDI|Security|WorkArea}

各スレッドに伝える個別のコンテナーコンテキストを指定します。

型：String

指定できる値を次に示します。

Classloader

JNDI

Security

WorkArea

デフォルト値：Classloader、JNDI、SecurityおよびWorkArea

--description description

リソースについて詳細な説明を記述します。

型：String

指定できる値を次に示します。

リソースについての詳細説明

デフォルト値：なし

--target target

作成するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、コンテキストサービスを作成します。

asadmin create-context-service --target instance1 concurrent/myContextService

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.2　create-managed-executor-service

ManagedExecutorServiceリソースの作成

書式

asadmin [asadmin-options] create-managed-executor-service [--help]
    [--enabled={false|true}] [--contextinfoenabled={false|true}]
    [--contextinfo={Classloader|JNDI|Security|WorkArea}]
    [--threadpriority threadpriority] [--longrunningtasks={false|true}]
    [--hungafterseconds hungafterseconds] [--corepoolsize corepoolsize]
    [--maximumpoolsize maximumpoolsize]
    [--keepaliveseconds keepaliveseconds]
    [--threadlifetimeseconds threadlifetimeseconds]
    [--taskqueuecapacity taskqueuecapacity]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-managed-executor-serviceサブコマンドでは、ManagedExecutorServiceリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--enabled={false|true}

リソースが実行時に有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfoenabled={false|true}

コンテナーのコンテキストをスレッドに伝えるかどうかを決定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfo={Classloader|JNDI|Security|WorkArea}

スレッドに伝える個々のコンテナーコンテキストを指定します。デフォルトでは、すべてのコンテキストが伝えられます。

型：String

指定できる値を次に示します。

Classloader

JNDI

Security

WorkArea

デフォルト値：Classloader、JNDI、SecurityおよびWorkArea

--threadpriority threadpriority

作成済みスレッドに割り当てる優先順位を指定します。

型：Integer

指定できる値を次に示します。

1〜10

デフォルト値：5

--longrunningtasks={false|true}

リソースを長時間動作タスクで使用する必要があるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--hungafterseconds hungafterseconds

応答なしと見なされてタスクを実行できなくなるまでの秒数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--corepoolsize corepoolsize

スレッドプールに保持するスレッド数（アイドル状態も含む）を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--maximumpoolsize maximumpoolsize

スレッドプールに保持できる最大スレッド数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：2147483647

--keepaliveseconds keepaliveseconds

corepoolsizeよりスレッド数が多いとき、スレッドがアイドル状態でいられる秒数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：60

--threadlifetimeseconds threadlifetimeseconds

利用しなくなったスレッドをプールから削除するまでの秒数を指定します。スレッド数がcorepoolsizeより多い、またはスレッドがアイドル状態であるかに関係ありません。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--taskqueuecapacity taskqueuecapacity

実行を待っているタスクキューに格納できる、サブミットされたタスク数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：2147483647

--target target

作成するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、ManagedExecutorServiceを作成します。

asadmin create-managed-executor-service --target instance1 concurrent/myExecutor

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.3　create-managed-scheduled-executor-service

ManagedScheduledExecutorServiceリソースの作成

書式

asadmin [asadmin-options] create-managed-scheduled-executor-service
    [--help] [--enabled={false|true}]
    [--contextinfoenabled={false|true}]
    [--contextinfo={Classloader|JNDI|Security|WorkArea}]
    [--threadpriority threadpriority] [--longrunningtasks={false|true}]
    [--hungafterseconds hungafterseconds] [--corepoolsize corepoolsize]
    [--keepaliveseconds keepaliveseconds]
    [--threadlifetimeseconds threadlifetimeseconds]
    [--description description] [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-managed-scheduled-executor-serviceサブコマンドは、ManagedScheduledExecutorServiceリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--enabled={false|true}

リソースが実行時に有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfoenabled={false|true}

コンテナーのコンテキストをスレッドに伝えるかどうかを決定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfo={Classloader|JNDI|Security|WorkArea}

各スレッドに伝える個別のコンテナーコンテキストを指定します。

型：String

指定できる値を次に示します。

Classloader

JNDI

Security

WorkArea

デフォルト値：Classloader、JNDI、SecurityおよびWorkArea

--threadpriority threadpriority

作成済みスレッドに割り当てる優先順位を指定します。

型：Integer

指定できる値を次に示します。

1〜10

デフォルト値：5

--longrunningtasks={false|true}

リソースを長時間動作タスクで使用する必要があるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--hungafterseconds hungafterseconds

応答なしと見なされてタスクを実行できなくなるまでの秒数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--corepoolsize corepoolsize

スレッドプールに保持するスレッド数（アイドル状態も含む）を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--keepaliveseconds keepaliveseconds

corepoolsizeよりスレッド数が多いとき、スレッドがアイドル状態でいられる秒数を指定します。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：60

--threadlifetimeseconds threadlifetimeseconds

利用しなくなったスレッドをプールから削除するまでの秒数を指定します。スレッド数がcorepoolsizeより多い、またはスレッドがアイドル状態であるかに関係ありません。

型：Integer

指定できる値を次に示します。

0〜2147483647

デフォルト値：0

--description description

リソースに関する詳細情報を指定します。

型：String

指定できる値を次に示します。

リソースの説明

デフォルト値：なし

--target target

作成するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、ManagedScheduledExecutorServiceを作成します。

asadmin create-managed-scheduled-executor-service --target instance1
concurrent/myScheduledExecutor

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.4　create-managed-thread-factory

ManagedThreadFactoryリソースの作成

書式

asadmin [asadmin-options] create-managed-thread-factory [--help]
    [--enabled={false|true}] [--contextinfoenabled={false|true}]
    [--contextinfo={Classloader|JNDI|Security|WorkArea}]
    [--threadpriority threadpriority] [--description description]
    [--target target] jndi_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-managed-thread-factoryサブコマンドでは、ManagedThreadFactoryリソースを作成します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--enabled={false|true}

ManagedThreadFactoryが実行時に有効であるかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfoenabled={false|true}

コンテナーのコンテキストをスレッドに伝えるかどうかを決定します。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：true

--contextinfo={Classloader|JNDI|Security|WorkArea}

各スレッドに伝える個別のコンテナーコンテキストを指定します。

型：String

指定できる値を次に示します。

Classloader

JNDI

Security

WorkArea

デフォルト値：Classloader、JNDI、SecurityおよびWorkArea

--threadpriority threadpriority

作成済みスレッドに割り当てる優先順位を指定します。

型：Integer

指定できる値を次に示します。

1〜10

デフォルト値：5

--description description

リソースに関する詳細情報を指定します。

型：String

指定できる値を次に示します。

リソースの説明

デフォルト値：なし

--target target

作成するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

jndi_name

このリソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、ManagedThreadFactoryを作成します。

asadmin create-managed-thread-factory --target instance1
concurrent/myThreadFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.5　delete-context-service

コンテキストサービスのリソースの削除

書式

asadmin [asadmin-options] delete-context-service [--help]
    [--target target] context-service-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-context-serviceサブコマンドは指定したJNDI名のコンテキストサービスのリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストが表示されます。

--target target

削除するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

context-service-name

リソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

リソースのJNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、concurrent/myContextServiceという名称のコンテキストサービスのリソースを削除します。

asadmin delete-context-service --target instance1 concurrent/myContextService

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.6　delete-managed-executor-service

ManagedExecutorServiceリソースの削除

書式

asadmin [asadmin-options] delete-managed-executor-service [--help]
    [--target target]
    managed_executor_service_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-managed-executor-serviceサブコマンドは、指定されたJNDI名を持つManagedExecutorServiceリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

managed_executor_service_name

リソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、concurrent/myExecutorという名称のManagedExecutorServiceリソースを削除します。

asadmin delete-managed-executor-service --target instance1 concurrent/myExecutor

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.7　delete-managed-scheduled-executor-service

ManagedScheduledExecutorServiceリソースの削除

書式

asadmin [asadmin-options] delete-managed-scheduled-executor-service
    [--help] [--target target]
    managed_scheduled_executor_service_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-managed-scheduled-executor-serviceサブコマンドは、指定されたJNDI名を持つManagedScheduledExecutorServiceリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

managed_scheduled_executor_service_name

リソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、concurrent/myScheduledExecutorという名称のManagedScheduledExecutorServiceリソースを削除します。

asadmin delete-managed-scheduled-executor-service --target instance1
concurrent/myScheduledExecutor

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.8　delete-managed-thread-factory

ManagedThreadFactoryリソースの削除

書式

asadmin [asadmin-options] delete-managed-thread-factory [--help]
    [--target target]
    managed_thread_factory_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-managed-thread-factoryサブコマンドは、指定されたJNDI名を持つManagedThreadFactoryリソースを削除します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

managed_thread_factory_name

リソースのJNDI名を指定します。

型：String

指定できる値を次に示します。

JNDI名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスから、concurrent/myThreadFactoryという名称のManagedThreadFactoryリソースを削除します。

asadmin delete-managed-thread-factory --target instance1
concurrent/myThreadFactory

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.9　list-context-services

コンテキストサービスのリソースの一覧表示

書式

asadmin [asadmin-options] list-context-services [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-context-servicesサブコマンドは、コンテキストサービスのリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するコンテキストサービスのリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンス上のコンテキストサービスのリソースを一覧表示します。

asadmin list-context-services

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.10　list-managed-executor-services

ManagedExecutorServiceリソースの一覧表示

書式

asadmin [asadmin-options] list-managed-executor-services [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-managed-executor-servicesサブコマンドでは、ManagedExecutorServiceリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するManagedExecutorServiceリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンスにあるManagedExecutorServiceリソースを一覧表示します。

asadmin list-managed-executor-services

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.11　list-managed-scheduled-executor-services

ManagedScheduledExecutorServiceリソースの一覧表示

書式

asadmin [asadmin-options] list-managed-scheduled-executor-services
    [--help] [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-managed-scheduled-executor-servicesサブコマンドは、ManagedScheduledExecutorServiceリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するManagedScheduledExecutorServiceリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンス上のManagedScheduledExecutorServiceリソースを一覧表示します。

asadmin list-managed-scheduled-executor-services

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.24.12　list-managed-thread-factories

ManagedThreadFactoryリソースの一覧表示

書式

asadmin [asadmin-options] list-managed-thread-factories [--help]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-managed-thread-factoriesサブコマンドでは、ManagedThreadFactoryリソースを一覧表示します。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

target

一覧表示するManagedThreadFactoryリソースの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、デフォルトのサーバインスタンス上のManagedThreadFactoryリソースを一覧表示します。

asadmin list-managed-thread-factories

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.25　メッセージセキュリティープロバイダーの管理で使用するコマンド

メッセージセキュリティープロバイダーの管理で使用するコマンドの書式、機能などについて説明します。

2.25.1　create-message-security-provider

メッセージセキュリティープロバイダーの作成

書式

asadmin [asadmin-options] create-message-security-provider [--help]
    [--target target] --classname provider_class
    --layer message_layer [--providertype provider_type]
    [--requestauthsource request_auth_source]
    [--requestauthrecipient request_auth_recipient]
    [--responseauthsource response_auth_source]
    [--responseauthrecipient response_auth_recipient]
    [--isdefaultprovider]
    [--property name=value[:name=value]...]
    provider_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-message-security-providerサブコマンドでは、管理者がセキュリティーサービスのメッセージセキュリティープロバイダーを作成できます。これでSOAPメッセージを保護する方法を指定できます。

このサブコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

--propertyオプションで、セキュリティー構成ファイル（security.config）を指定できます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

作成するメッセージセキュリティープロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--classname provider_class

プロバイダーのJava実装クラスを定義します。クライアント認証の各プロバイダーはcom.sun.enterprise.security.jauth.ClientAuthModuleインターフェースを実装する必要があります。サーバ側プロバイダーは、com.sun.enterprise.security.jauth.ServerAuthModuleインターフェースを実装する必要があります。プロバイダーに両方のインターフェースを実装できますが、プロバイダーのタイプに応じたインターフェースを実装する必要があります。

型：String

指定できる値を次に示します。

com.sun.enterprise.security.jauth.ClientAuthModule

com.sun.enterprise.security.jauth.ServerAuthModule

デフォルト値：なし

--layer message_layer

message-security-config要素のauth-layer属性の値を定義するために使用するmessage-layerエンティティーを指定します。

型：String

指定できる値を次に示します。

HttpServlet

SOAP

デフォルト値：HttpServlet

--providertype provider_type

使用されるプロバイダーのタイプ（クライアント認証プロバイダー、サーバ認証プロバイダー、あるいは両方）を指定します。

型：String

指定できる値を次に示します。

client

server

client-server

デフォルト値：なし

--requestauthsource request_auth_source

message-layerセンダー認証（ユーザー名、パスワードなど）または内容認証（デジタル署名など）を要求メッセージに適用する要件を定義するauth-source属性を指定します。

型：String

指定できる値を次に示します。

sender

content

デフォルト値：なし

--requestauthrecipient request_auth_recipient

メッセージのレシーバーがセンダーをmessage-layer認証（XML暗号による場合など）する要件を定義するauth-recipient属性を指定します。

型：String

指定できる値を次に示します。

before-content

after-content

デフォルト値：after-content

--responseauthsource response_auth_source

message-layerセンダー認証（ユーザー名、パスワードなど）または内容認証（デジタル署名など）を応答メッセージに適用する要件を定義するauth-source属性を指定します。

型：String

指定できる値を次に示します。

sender

content

デフォルト値：なし

--responseauthrecipient response_auth_recipient

応答メッセージのレシーバーがセンダーをmessage-layer認証（XML暗号による場合など）する要件を定義するauth-recipient属性を指定します。

型：String

指定できる値を次に示します。

before-content

after-content

デフォルト値：after-content

--isdefaultprovider={false|true}

--providertypeで指定したタイプのレイヤーで、デフォルトプロバイダーにします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

--property name=value[:name=value]...

初期化されるときにプロバイダーに渡すプロバイダー特有のプロパティーの値を指定します。このようにして渡される各プロパティーには、プロバイダーがキーストア、署名、正規化、暗号アルゴリズムなどからキーを取得するために使用するキーエイリアスが含まれる場合があります。

指定形式は、name=valueです。複数指定する場合は、コロン（:）で区切ります。同じプロパティー名を複数指定した場合は、最後に指定したプロパティーの値が有効となります。

プロパティー名とvalueに指定できる値を次に示します。

security.config=value

メッセージセキュリティー構成ファイルのロケーションを指定します。domain-dir/configディレクトリーにある構成ファイルを指定する場合、システムプロパティー ${com.sun.aas.instanceRoot}/config/を使用します。例えば、${com.sun.aas.instanceRoot}/config/wss-server-config-1.0.xmlがあります。

型：String

デフォルト値：domain-dir/config/ wss-serverconfig-1.0.xml

debug=value

trueの場合、デバッグメッセージのサーバログへの出力を有効にします。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

dynamic.username.password=value

trueに設定の場合、プロバイダーに信号が送られ、各要求のCallbackHandlerからユーザー名とパスワードが収集されます。falseの場合、wsse:UsernameToken(s)に対するユーザー名とパスワードがモジュール初期化の間に一度収集されます。このプロパティーはClientAuthModuleにだけ適用できます。

型：Boolean

指定できる値を次に示します。

true

false

デフォルト値：false

encryption.key.alias=value

プロバイダーが使用する暗号化のキーを指定します。キーはキーストアエイリアスで確認されます。

型：String

デフォルト値：s1as

signature.key.alias=value

プロバイダーが使用する署名のキーを指定します。キーはキーストアエイリアスで確認されます。

型：String

デフォルト値：s1as

provider_name

provider-config要素を参照するために使用するプロバイダー名を指定します。

型：String

指定できる値を次に示します。

プロバイダー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンスに、メッセージセキュリティープロバイダーを作成します。

asadmin create-message-security-provider --target instance1
--classname com.sun.enterprise.security.jauth.ClientAuthModule --layer SOAP
--providertype client mySecurityProvider

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.25.2　delete-message-security-provider

メッセージセキュリティープロバイダーの削除

書式

asadmin [asadmin-options] delete-message-security-provider [--help]
    [--target target] --layer message_layer
    provider_name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-message-security-providerサブコマンドは、メッセージセキュリティープロバイダーを削除します。このサブコマンドを実行すると、指定したメッセージレイヤーのprovider-config子要素（domain.xmlのmessage-security-config要素）が削除されます。domain.xmlファイルには、Java EE Serverのパラメーターとプロパティーを指定します。このサブコマンドで指定したオプションは、domain.xmlのmessage-security-configおよびprovider-config子要素内の属性に適用されます。メッセージレイヤー（message-security-config要素）が存在しない場合は作成され、さらにその配下にprovider-config子要素が作成されます。

このコマンドはリモートモードだけサポートします。

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

ファイル

このサブコマンドを実行すると、指定したメッセージレイヤーのprovider-config子要素（domain.xmlのmessage-security-config要素）が削除されます。domain.xmlファイルには、Java EE Serverのパラメーターとプロパティーを指定します。このサブコマンドで指定したオプションは、domain.xmlのmessage-security-configおよびprovider-config子要素内の属性に適用されます。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--target target

削除するメッセージセキュリティープロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

--layer message_layer

削除対象のプロバイダーがあるメッセージレイヤーを指定します。

型：String

指定できる値を次に示します。

HttpServlet

SOAP

デフォルト値：HttpServlet

provider_name

provider-config要素を参照するときに使用されるプロバイダー名を指定します。

型：String

指定できる値を次に示します。

プロバイダー名

デフォルト値：なし

使用例

次の例では、instance1という名称のサーバインスタンス上のクライアントから、メッセージセキュリティープロバイダーを削除します。

asadmin delete-message-security-provider --target instance1 --layer SOAP mySecurityProvider

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.25.3　list-message-security-providers

メッセージレイヤーのメッセージセキュリティープロバイダーの一覧表示

書式

asadmin [asadmin-options] list-message-security-providers [--help]
    [--layer message_layer]
    [target]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-message-security-providersサブコマンドを使用すると、管理者は指定したメッセージレイヤー（domain.xmlのmessage-security-config要素）のすべてのメッセージセキュリティープロバイダー（provider-config子要素）を一覧表示できます。

このサブコマンドはリモートモードだけサポートします。

実行権限

スーパーユーザー

前提条件

ドメイン管理サーバは、稼働状態である必要があります。

引数

--help | -?

このサブコマンドのヘルプテキストを表示します。

--layer message_layer

プロバイダーを一覧表示するメッセージレイヤーを指定します。

型：String

指定できる値を次に示します。

SOAP

HttpServlet

デフォルト値：HttpServlet

target

一覧表示するメッセージセキュリティープロバイダーの対象を指定します。

型：String

指定できる値を次に示します。

server

ドメイン管理サーバを対象とします。serverはドメイン管理サーバの名称です。

domain

ドメインを対象とします。

cluster_name

指定した名称のクラスターを対象とします。

instance_name

指定した名称のサーバインスタンスを対象とします。

デフォルト値：server

使用例

次の例では、特定のメッセージレイヤーのメッセージセキュリティープロバイダーを一覧表示します。

asadmin list-message-security-providers --layer SOAP

戻り値

戻り値

説明

0

サブコマンドの実行に成功しました。

1

サブコマンドの実行中にエラーが発生しました。

2.26　イベント検知時コマンド実行で使用するコマンド

イベント検知時コマンド実行で使用するコマンドの書式、機能などについて説明します。

2.26.1　create-event-hook

イベント検知時コマンドの登録

書式

asadmin [asadmin-options] create-event-hook --messageid=messageid
    --script=script-file-path
    [--monitoring-time-span=monitoring-time-span
    --monitoring-max-count=monitoring-max-count] event-hook-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

create-event-hookサブコマンドは、ドメイン管理サーバでイベントが発生したときに、自動で実行される「イベント検知時コマンド」を登録します。イベント検知時コマンドには、ユーザーが作成した任意のスクリプトファイルを指定します。

イベント検知時には、指定したスクリプトファイルの配置場所で、登録したコマンドを実行します。

イベント検知時コマンドには任意の名称を指定できますが、次の引数の指定が同じ値のイベント検知時コマンドがすでに登録されている場合は、未登録の名称でもエラーとします。

--messageid

イベント検知時コマンドのタイムアウト時間は600秒です。イベント検知時コマンドが600秒以内に完了しない場合はタイムアウトが発生し、KDKD10153-Eメッセージがドメイン管理サーバのメッセージログに出力されます。このメッセージが出力されてもイベント検知時コマンドの処理は続行されます。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

引数

--messageid=messageid

イベント検知時コマンドを実行させる契機となるメッセージIDを指定します。

型：String

指定できる値を次に示します。

システムで公開されているメッセージID

デフォルト値：なし（必須）

--script=script-file-path

イベント検知時コマンドとして登録するスクリプトファイルを指定します。ドメイン管理サーバ上での絶対パスで指定してください。

型：String

指定できる値を次に示します。

存在するファイルの絶対パス

デフォルト値：なし（必須）

--monitoring-time-span=monitoring-time-span

このオプションで指定した時間ごとにイベント検知時コマンドが実行される回数を監視します。

値は秒数で指定します。0を指定した場合は、常にイベント検知時コマンドの実行を許可します（監視しません）。

イベント検知時コマンドを実行したことによってイベント検知対象のイベントが発生し、この繰り返しで無限にイベント検知時コマンドが実行される場合があります。このオプションと--monitoring-max-countオプションを同時に指定することで、イベント検知時コマンドが無限に繰り返されることを防げます。

型：Integer

指定できる値を次に示します。

0 〜 2147483647

デフォルト値：0

--monitoring-max-count=monitoring-max-count

--monitoring-time-spanオプションで指定した時間内に、同じ種類のイベントに対するイベント検知時コマンドを実行する回数の上限を指定します。0を指定した場合は、常にイベント検知時コマンドの実行を許可します。

同じ種類のイベントとは、次に示す条件を満たすイベントのことです。

サーバに関するイベントの場合、次のすべてが同じイベント

イベントの契機となったメッセージID

イベントが発生したサーバのサーバ名

ノードに関するイベントの場合、次のすべてが同じイベント

イベントの契機となったメッセージID

イベントが発生したノード名

サーバやノードとは関係ないイベントの場合、次の内容が同じイベント

イベントの契機となったメッセージID

型：Integer

指定できる値を次に示します。

0 〜 256

デフォルト値：0

event-hook-name

イベント検知時コマンドの名称を指定します。

型：String

指定できる値を次に示します。

ASCII文字であること。

名称は次の文字で構成すること。

英小文字<a〜z>

英大文字<A〜Z>

数字<0〜9>

ハイフン<->

アンダースコア<_>

先頭文字は英大文字または英小文字を使用すること。

ドメインに存在する次の名称は指定できません。

ノード名

JavaEEサーバ名

Webサーバ名

PRFのサーバ名

クラスター名

サーバ間関連名

JavaEEサーバの構成名

次に示す名称はシステムで使用済みまたは予約語のため指定できません。

domain

server

default

server-config

default-config

default-webserver-config

default-prf-config

javaee

webserver

prf

cluster

redirect

prf-relation

HJES_で始まる名称

構築済みWebサーバ名-config

構築済みPRF名-config

デフォルト値：なし（必須）

使用例

サーバの起動が成功したときにイベント検知時コマンドを実行する場合

asadmin create-event-hook --messageid KDKD10083-I
 --script /work/failure-script.sh Event01

サーバの停止が成功したときにイベント検知時コマンドを実行する場合（イベント検知時コマンドの実行監視オプションを指定する場合）

asadmin create-event-hook --messageid KDKD10094-I
--script /work/failure-script.sh --monitoring-time-span=180
--monitoring-max-count=3  Event02

戻り値

戻り値

説明

0

正常終了

1

異常終了

注意事項

登録したイベント検知時コマンドのスクリプトは、イベント検知時コマンドの登録を解除するまで、削除しないでください。

2.26.2　delete-event-hook

イベント検知時コマンドの登録解除

書式

asadmin [asadmin-options] delete-event-hook event-hook-name

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

delete-event-hookサブコマンドは、イベント検知時コマンドの登録を解除します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

前提条件

イベント検知時コマンドを登録済みであること。

引数

event-hook-name

登録解除するイベント検知時コマンドの名称を指定します。

型：String

指定できる値を次に示します。

存在するイベント検知時コマンドの名称

デフォルト値：なし（必須）

使用例

Event01のイベント検知時コマンドの登録を解除する場合

asadmin delete-event-hook Event01

戻り値

戻り値

説明

0

正常終了

1

異常終了

2.26.3　list-event-hooks

イベント検知時コマンドの一覧表示

書式

asadmin [asadmin-options] list-event-hooks [--long={false|true}]

格納先

Application Serverインストールディレクトリー/javaee/glassfish/bin

機能

list-event-hooksサブコマンドは、登録されているイベント検知時コマンドを一覧表示します。

このコマンドはリモートモードだけサポートします。

実行権限

一般ユーザー

引数

--long={false|true}

ヘッダー情報を表示するかどうかを指定します。

型：Boolean

指定できる値を次に示します。

true

すべてのイベント検知時コマンドの一覧およびヘッダー情報を表示します。一覧には、すべての項目を表示します。

false

すべてのイベント検知時コマンドの一覧だけを表示します。ヘッダー情報は表示しません。一覧には、名前、メッセージIDおよびスクリプトのパスを表示します。

デフォルト値：false

出力形式

1行目は出力情報のヘッダー部となり、固定文字列で出力形式を示します。

カラム間は、カラム内で最も長い文字列と次のカラムの先頭までを、2つの半角スペースで区切ります。

ヘッダーを除く各行はcreate-event-hookサブコマンドの登録順に表示します。

NAME   MESSAGEID   SCRIPT         MONITORING-TIME-SPAN  MONITORING-MAX-COUNT
名前   メッセージID  スクリプトのパス  時間間隔               最大許容実行回数

名前：イベント検知時コマンド名を表示します。

メッセージID：メッセージIDを表示します。

スクリプトのパス：実行するスクリプトの絶対パスを表示します。

時間間隔：最大許容実行回数を設定する時間間隔を表示します。

最大許容実行回数：最大許容実行回数を表示します。

使用例

ヘッダーを含め、登録されているすべてのイベント検知時コマンドを表示する場合

list-event-hooks --long=true

[出力例]

NAME       MESSAGEID    SCRIPT        MONITORING-TIME-SPAN  MONITORING-MAX-COUNT
Event01    KDKD10083-I  /work/failure-script.sh  180          3

ヘッダーを表示しない場合

list-event-hooks --long=false

[出力例]

Event01  KDKD10083-I  /work/failure-script.sh

戻り値

戻り値

説明

0

正常終了

1

異常終了

3　Webサーバで使用するコマンド

この章では、Webサーバで使用するコマンドの書式、機能などについて説明します。

3.1　Webサーバで使用するコマンドの一覧

Webサーバで使用するコマンドの一覧を次の表に示します。

Webサーバの運用で使用するコマンド

コマンド名称

要約

概要説明

htpasswd

ユーザー名とパスワードのパスワードファイルへの登録およびパスワードの変更

パスワードファイルにユーザー名、パスワードを登録します。パスワードを変更したり、パスワードファイルに登録されたユーザー名を削除したりできます。

httpsd

Webサーバの起動

デフォルト以外のhttpsd.confファイル名称を指定する場合またはサーバのルートディレクトリーやhttpsd.confファイルを指定して起動する場合に使用します。

httpsdctl

Webサーバの起動、再起動および停止

Webサーバを起動、再起動および停止します。

hwstraceinfo

内部トレースの採取

アプリケーションプログラムの実行時やリクエスト受け取り時など、システムで発生した事象を採取します。

logresolve

アクセスログファイル内のIPアドレスのホスト名への変換

レコードの先頭がIPアドレスであるアクセスログファイル内のIPアドレスをホスト名に変換し、新規ログファイルに出力します。

SSLによる認証、暗号化で使用するコマンド

コマンド名称

要約

概要説明

hwscertutil cert -hash

ハッシュリンクの作成

証明書のハッシュリンクを作成します。

hwscertutil cert -outform

証明書の形式変換

証明書の形式を変換します。

hwscertutil cert -text

証明書の内容表示

証明書ファイルの内容を表示します。

hwscertutil req

証明書発行要求（CSR）の内容表示

証明書発行要求（CSR）の内容を表示します。

hwscertutil reqgen

証明書発行要求（CSR）の作成

証明書発行要求（CSR）を作成します。ここで作成したCSRファイルをCAに提出して、署名済みの証明書を発行してもらいます。

hwskeygen

Webサーバの秘密鍵の作成

Webサーバの秘密鍵を作成します。作成したWebサーバの秘密鍵のファイルは、SSLCertificateKeyFileディレクティブに指定します。

sslpasswd

パスワード付きサーバ秘密鍵のパスワードファイル作成

パスワードによって保護されているサーバ秘密鍵を使用する場合、サーバ起動時のパスワード入力を省略できます。

重要

コマンドの引数には、各コマンドで指定できる値を指定してください。それ以外の値が指定された場合、動作は保証されません。

コマンドが正常に終了しても、エラーが発生している場合があります。メッセージログやスタックトレースログを確認してください。

3.2　Webサーバの運用で使用するコマンド

Webサーバの運用で使用するコマンドの書式、機能などについて説明します。

3.2.1　htpasswd

ユーザー名とパスワードのパスワードファイルへの登録およびパスワードの変更

書式

htpasswd [-b] [-c|-D] パスワードファイル名 ユーザー名 [パスワード]

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

パスワードファイルにユーザー名、パスワードを登録します。パスワードを変更したり、パスワードファイルに登録されたユーザー名を削除したりできます。

実行権限

スーパーユーザー

引数

-b

パスワードをコマンドラインに指定する場合に指定します。

-c

新規にパスワードファイルを作成する場合に指定します。すでに作成しているパスワードファイルにユーザーを追加する場合や、パスワードを変更する場合には、指定する必要はありません。

-D

ユーザーの登録を削除する場合に指定します。指定したパスワードファイルに、指定したユーザーが登録されている場合に、パスワードファイルから該当するユーザーを削除します。

パスワードファイル名

パスワードを登録、変更または削除するパスワードファイルを指定します。

ユーザー名

パスワードを登録、変更または削除するユーザー名を指定します。

パスワード

登録または変更するパスワードを指定します。-bオプションを指定したときだけ指定できます。

使用例

パスワードファイル名と、登録するユーザー名またはパスワードを変更するユーザー名を指定してhtpasswdを起動すると、そのユーザーのパスワードの入力が要求されます。入力確認を含め、2回パスワードを入力すると、パスワードファイルにそのユーザーのユーザー名と、パスワードが登録されます。

$ "Application Serverインストールディレクトリー/httpsd/sbin/htpasswd" .passwd userxx …1.
New password:                    …2.
Re-type new password:            …3.
Adding password for user userxx  …4.
$

userxxのパスワードの変更

新パスワード入力

新パスワード再入力

新パスワードの登録終了

登録を削除する場合は、-Dオプション、パスワードファイル名および削除するユーザー名を指定してhtpasswdを起動します。

$ "Application Serverインストールディレクトリー/httpsd/sbin/htpasswd" -D .passwd userxx …1.
Deleting password for user userxx    …2.
$

userxxの登録削除

userxxの登録削除終了

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

注意事項

ユーザー名の最大長とパスワードの最大長は128文字です。

htpasswdコマンド実行時は、パスワードファイルの作成先と同じディレクトリーに、作業ファイルが一時的に作成されます。作業ファイル名は、パスワードファイル名.プロセスIDです。この作業ファイルは、htpasswdコマンドの終了時に自動的に削除されます。ただし、実行中にキャンセルした場合など、作業ファイルが削除されないことがあります。作業ファイルが残っている場合は、手動で削除してください。

3.2.2　httpsd

Webサーバの起動

書式

httpsd [[-d ディレクトリー] [-f ファイル名] [-R ディレクトリー]|-v|-t]
    [-D HWS_OPTION_HWS2]

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

Webサーバを起動します。

デフォルト以外のhttpsd.confファイル名称を指定する場合またはサーバのルートディレクトリーやhttpsd.confファイルを指定して起動する場合に、この方法を使用します。

また、暗号化した秘密鍵を使ってSSLを利用する場合は、起動時に秘密鍵のパスワード入力要求があります。

実行権限

スーパーユーザーまたは一般ユーザー

前提条件

PRFデーモンが起動している必要があります。

環境変数

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

TZ

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

引数

-d ディレクトリー

ServerRootディレクティブが設定ファイルに指定されていない場合の、デフォルト値を指定できます。

-f ファイル名

httpsd.confファイルを指定できます。絶対パスまたはServerRootディレクティブの指定値からの相対パスで指定します。

-R ディレクトリー

DSO実行ライブラリーが格納されているディレクトリーを絶対パスで指定します。

-v

バージョン情報を表示します。このオプションを指定した場合は、Webサーバは起動しません。

-t

設定ファイルの文法チェックをします。文法エラーがあると、画面にエラーメッセージを表示します。このオプションを指定した場合は、Webサーバは起動しません。

-D HWS_OPTION_HWS2

Red Hat Enterprise Linux Server 6 (64-bit x86_64)、またはAIX V7.1で、SSL機能を使用する場合に指定します。その他のプラットフォームやSSL機能を使用しない場合は、指定しないでください。

起動確認方法

Webサーバの起動を確認するには、制御プロセスを確認してください。プロセス名（実行プログラム名）は、httpsdです。

また、Webサーバを起動したあと、エラーログにAH00163のメッセージが出力されていることを確認してください。

再起動方法

killコマンドでWebサーバを再起動できます。

kill ｛-HUP｜-USR1｝ `cat PidFileディレクティブ指定値`

-HUP

httpsdctlコマンドのrestartに相当する再起動をします。

-USR1

httpsdctlコマンドのgracefulに相当する再起動をします。

PidFileディレクティブ指定値

PidFileディレクティブで指定した値（ファイル名）を指定します。

終了方法

httpsdコマンドでWebサーバを起動した場合、次に示すコマンドを実行してプロセスを終了し、Webサーバを停止してください。

kill {-TERM|-USR2} `cat PidFileディレクティブ指定値`

-TERM

httpsdctlコマンドのstopに相当する停止をします。

-USR2

httpsdctlコマンドのgracefulstopに相当する停止をします。

関連項目

3.4　一般ユーザーによる運用

3.2.3　httpsdctl

Webサーバの起動、再起動および停止

書式

httpsdctl {start|stop|restart|graceful|gracefulstop|configtest|help}

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

Webサーバを起動、再起動および停止します。

実行権限

スーパーユーザーまたは一般ユーザー

前提条件

PRFデーモンが起動している必要があります。

環境変数

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

TZ

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

ファイル

httpsd.confファイル

引数

start

Webサーバを起動します。暗号化した秘密鍵を使って、SSLを利用する場合は、起動時に、秘密鍵のパスワードの入力要求があります。

stop

Webサーバを停止します。

restart

Webサーバを再起動します。実行中のサーバプロセスは、ただちに停止します。すべてのサーバプロセス終了後に再起動します。再起動時には、MaxRequestWorkersディレクティブ指定値の変更は反映されないで、前回の値が引き継がれます。Listenディレクティブ指定値およびSSL通信で使用する秘密鍵の設定（SSLCertificateKeyFileディレクティブ）を変更した場合は、いったんWebサーバを停止してから、起動し直してください。

graceful

Webサーバを再起動します。実行中のサーバプロセスは、実行終了後に停止します。サーバプロセスは、随時、新しい設定ファイルに基づいて起動します。再起動時には、MaxRequestWorkersディレクティブ指定値の変更は反映されないで、前回の値が引き継がれます。Listenディレクティブ指定値およびSSL通信で使用する秘密鍵の設定（SSLCertificateKeyFileディレクティブ）を変更した場合は、いったん Webサーバを停止してから、起動し直してください。

gracefulstop

Webサーバを停止します。実行中のサーバプロセスは、実行終了後に停止します。実行が終了しない場合は、HWSGracefulStopTimeoutディレクティブに指定した待ち時間が経過すると終了します。

configtest

設定ファイルの文法チェックをします。文法エラーがあると、画面にエラーメッセージを表示します。このオプションを指定した場合は、Webサーバは起動しません。

help

httpsdctlのヘルプテキストを表示します。

使用例

Webサーバを起動します。暗号化した秘密鍵を使用している場合はパスワードを入力します。

/opt/hitachi/APServer/httpsd/sbin/httpsdctl start
Enter PEM pass phrase:

起動確認方法

Webサーバの起動を確認するには、制御プロセスを確認してください。プロセス名（実行プログラム名）は、httpsdです。

また、Webサーバを起動したあと、エラーログにAH00163のメッセージが出力されていることを確認してください。

注意事項

httpsdctl stopおよびgracefulstopによるWebサーバ停止操作実行時に、Web Serverの設定ファイルの定義が不正な場合、httpsdctlの実行はエラーとなりWebサーバは停止しません。

httpsdctl restartおよびgracefulによるWebサーバ再起動実行時に、Web Serverの設定ファイルの定義が不正な場合、httpsdctlの実行はエラーとなり、Webサーバは停止しないで再起動しません。

httpsdctlコマンドによるWeb Serverの起動、再起動および停止操作を実行した場合、起動完了および停止完了を示すメッセージは出力されません。

関連項目

3.4　一般ユーザーによる運用

3.2.4　hwstraceinfo

内部トレースの採取

書式

hwstraceinfo -i 共有メモリー識別子 {-l ファイル名|-r}

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

アプリケーションプログラムの実行時やリクエスト受け取り時など、システムで発生した事象は内部トレースとして採取されています。内部トレースは、共有メモリーにいったん出力され、その後ディレクティブの指定やコマンドによって、ファイルに出力されます。

トレース情報の採取

Webサーバの各種事象発生を契機に、内部トレースが共有メモリーに採取されます。共有メモリーのメモリー識別子は、HWSTraceIdFileディレクティブに指定したファイルに格納されます。

ファイルへの出力方法

共有メモリーに採取された内部トレースは、サーバプロセスの異常終了時またはhwstraceinfoコマンドの実行によって、ファイルに出力されます。サーバプロセスが異常終了した場合は、HWSTraceLogFileディレクティブで指定したファイルに出力されます。

hwstraceinfoコマンドでは、共有メモリーのメモリー識別子、出力先のファイル名を指定します。

内部トレースの出力ファイルサイズは次のとおりです。

ps -eflコマンドの出力サイズ＋vmstatコマンドの出力サイズ＋ipcs -aコマンドの出力サイズ＋7KB×MaxRequestWorkers値

実行権限

スーパーユーザーまたは一般ユーザー

引数

-i 共有メモリー識別子

HWSTraceIdFileディレクティブで指定したファイルに出力されている共有メモリー識別子を指定します。

-l ファイル名

-iで指定した共有メモリー識別子に該当するトレースを出力するファイルを指定します。

-r

-iで指定した共有メモリー識別子に割り当てられている共有メモリーを解放します。

Webサーバが終了してもトレース用の共有メモリーは残ります。残った共有メモリーを解放するために、このオプションを使用します。

使用例

共有メモリー識別子1800_1133780652_0に該当するトレースを、traceinfo.logファイルに出力する例を示します。

hwstraceinfo -i 1800_1133780652_0 -l traceinfo.log

注意事項

Webサーバが終了しても、トレース情報を残すために共有メモリーは解放しません。また、Webサーバを再起動する場合は、共有メモリーが再利用されます。

Webサーバを停止したあとに起動した場合は、HWSTraceIdFileディレクティブに指定したファイルの値を基に、いったん共有メモリーを解放して、再度確保します。ただし、次のような場合は、以前使用していた共有メモリーが解放できなくなりますので、注意してください。

同一ユーザーで再起動していない（UserディレクティブまたはGroupディレクティブの値が変更されている）

HWSTraceIdFileディレクティブの値を変更している

HWSTraceIdFileディレクティブで指定していたファイルが消去されている

共有メモリーを解放する場合は、-rを指定したhwstraceinfoコマンドを実行してください。

3.2.5　logresolve

アクセスログファイル内のIPアドレスのホスト名への変換

書式

logresolve [-s ファイル名] [-c] < アクセスログファイル名 > 新ログファイル名

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

logresolveコマンドは、レコードの先頭がIPアドレスであるアクセスログファイル内のIPアドレスをホスト名に変換し、新規ログファイルに出力します。変換規則は、ホスト名のルックアップの逆引きによります。

実行権限

スーパーユーザー

引数

-s ファイル名

変換したときの情報を出力するファイルを指定します。

-c

変換後のホスト名が、変換前のIPアドレスと一致するかどうかチェックする場合に指定します。

アクセスログファイル名

入力ログファイル名を指定します。入力したファイルのIPアドレスから、ホスト名のルックアップの逆引きをします。レコードの先頭は、必ずIPアドレスでなければなりません。ホスト名の検索に失敗した場合、新ログファイルにはIPアドレスを出力します。

新ログファイル名

IPアドレスをホスト名に変換したアクセスログを出力するファイル名を指定します。

使用例

logs¥access.logに格納しているアクセスログ内のIPアドレスをホスト名に変換します。

アクセスログファイル：logs¥access.log

新ログファイル：logs¥new_access.log

logresolve < logs¥access.log > logs¥new_access.log

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

3.3　SSLによる認証、暗号化で使用するコマンド

SSLによる認証、暗号化で使用するコマンドの書式、機能などについて説明します。

3.3.1　hwscertutil cert -hash

ハッシュリンクの作成

書式

hwscertutil cert -noout -hash -in CAの証明書ファイル

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

証明書の妥当性チェックのために、証明書を発行したCAの証明書をSSLCACertificateFileディレクティブまたはSSLCACertificatePathディレクティブで指定します。SSLCACertificatePathディレクティブには、証明書発行元のCAの証明書をポイントするハッシュ値を使用したシンボリックリンク（ハッシュリンク）を格納したディレクトリーを指定します。

ハッシュ値はhwscertutil certコマンドで作成します。

SSLCACertificatePathディレクティブを指定すると、Webサーバでの証明書の検索はハッシュ値を用いて効率良く実行できます。したがって、CAの証明書が多い場合は、SSLCACertificateFileディレクティブよりもSSLCACertificatePathディレクティブを推奨します。なお、ハッシュ値は1つの証明書に1つである必要があるので、ハッシュリンク作成時には、複数の証明書が混在したファイルは指定できません。

SSLCACertificatePathディレクティブで指定するハッシュリンクディレクトリー内のシンボリックリンク生成時には、ハッシュ値に.0を付ける必要があります。また、SSLCACertificatePathディレクティブで指定するディレクトリーは、User、Groupディレクティブで指定したユーザーでアクセスできるように、ディレクトリーに読み込み権限、実行権限を設定してください。

実行権限

スーパーユーザー

引数

-in CAの証明書ファイル

ハッシュリンク値を作成するCAの証明書ファイルを指定します。

使用例

ハッシュリンクのディレクトリーおよびCAの証明書が次に示すディレクトリー、ファイルの場合の例を示します。

/opt/hitachi/APServer/httpsd/conf/ssl/cacerts：ハッシュリンクディレクトリー

/opt/hitachi/APServer/httpsd/conf/ssl/cacert/cacert.pem：CAの証明書

cd /opt/hitachi/APServer/httpsd/conf/ssl/cacerts
ln -s /opt/hitachi/APServer/httpsd/conf/ssl/cacert/cacert.pem `hwscertutil cert
 -noout -hash -in /opt/hitachi/APServer/httpsd/conf/ssl/cacert/cacert.pem`.0

これによって、/opt/hitachi/APServer/httpsd/conf/ssl/cacert/cacert.pemについてのハッシュリンク xxxxxxxx.0が作成されます。

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

3.3.2　hwscertutil cert -outform

証明書の形式変換

書式

hwscertutil cert -inform 入力形式 -outform 出力形式
    -in 入力ファイル -out 出力ファイル

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

証明書の形式を変換します。必要に応じて使用します。

実行権限

スーパーユーザー

引数

-inform 入力形式

入力形式を指定します。

指定できる値を次に示します。

DER

PEM

デフォルト値：PEM

-outform 出力形式

出力形式を指定します。

指定できる値を次に示します。

DER

PEM

デフォルト値：PEM

-in 入力ファイル

変換前の証明書ファイルを指定します。

-out 出力ファイル

変換後の証明書ファイルを指定します。

3.3.3　hwscertutil cert -text

証明書の内容表示

書式

hwscertutil cert -in 証明書ファイル -text

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

証明書ファイルの内容を表示します。

"-----BEGIN CERTIFICATE-----"から、"-----END CERTIFICATE----"の証明書ファイルの内容を表示します。

実行権限

スーパーユーザー

引数

-in 証明書ファイル

表示する証明書ファイルを指定します。

使用例

hwscertutil cert -in httpsd.pem -text

httpsd.pem：表示する証明書ファイル

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

3.3.4　hwscertutil req

証明書発行要求（CSR）の内容表示

書式

hwscertutil req -in CSRファイル -text

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

証明書発行要求（CSR）の内容を表示します。

実行権限

スーパーユーザー

引数

-in CSRファイル

表示するCSRファイルを指定します。

使用例

hwscertutil req -in httpsd.csr -text

httpsd.csr：表示するCSRファイル

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

3.3.5　hwscertutil reqgen

証明書発行要求（CSR）の作成

書式

hwscertutil reqgen [-sign {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}]
    -key 鍵ファイル -out CSRファイル

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

hwscertutil reqgenコマンドを使用して、証明書発行要求（CSR）を作成します。ここで作成したCSRファイルをCAに提出して、署名済みの証明書を発行してもらいます。CSRの形式はPKCS#10に準拠しています。

実行権限

スーパーユーザー

引数

-sign {MD5|SHA1|SHA224|SHA256|SHA384|SHA512}

CSR作成時に使用する署名アルゴリズムを指定します。

指定できる値を次に示します。

-MD5 ：md5WithRSAEncryptionを使用します。

-SHA1：sha1WithRSAEncryptionを使用します。

-SHA224：sha224WithRSAEncryptionを使用します。

-SHA256：sha256WithRSAEncryptionを使用します。

-SHA384：sha384WithRSAEncryptionを使用します。

-SHA512：sha512WithRSAEncryptionを使用します。

デフォルト値：SHA1

-key 鍵ファイル

Webサーバの秘密鍵のファイルを指定します。

-out CSRファイル

作成したCSRを出力するファイルを指定します。

使用例

証明書発行要求（CSR）を作成します。

hwscertutil reqgen -sign SHA1 -key httpsdkey.pem -out httpsd.csr

httpsdkey.pem：鍵ファイル

httpsd.csr：CSRファイル

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

3.3.6　hwskeygen

Webサーバの秘密鍵の作成

書式

hwskeygen -rand ファイル名[:ファイル名]... [-des|-des3] -out 鍵ファイル
    [-bits {512|1024|2048|4096}]

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

hwskeygenコマンドを使用して、Webサーバの秘密鍵を作成します。作成したWebサーバの秘密鍵のファイルは、SSLCertificateKeyFileディレクティブに指定します。

実行権限

スーパーユーザー

引数

-rand ファイル名[:ファイル名]...

乱数生成に利用する任意のファイルを指定します。乱数生成用のファイルは、十分大きい適当なファイルを指定してください。

-des|-des3

秘密鍵を暗号化する場合、暗号種別を指定します。このオプションを指定すると、秘密鍵作成時にパスワードの入力要求があります。パスワードは64文字以内です。また、証明書発行要求（CSR）の作成（hwscertutil reqgenコマンド）時およびWebサーバ起動時にパスワードの入力要求があります。

なお、Webサーバ起動時のパスワードの入力は省略できます。パスワードの入力を省略するには、sslpasswdコマンドで作成したパスワードファイルを指定したSSLCertificateKeyPasswordディレクティブを、サーバ秘密鍵ファイルを指定したSSLCertificateKeyFileディレクティブとともにhttpsd.confに設定します。

-desを指定した場合、暗号種別としてDES(Data Encryption Standard)が選択されます。-des3を指定した場合、トリプルDESが選択されます。WebサーバとWebブラウザー間の通信での暗号種別とは関係ありません。

-out 鍵ファイル

Webサーバの秘密鍵を出力するファイルを指定します。

-bits {512|1024|2048|4096}

作成するWebサーバの秘密鍵のビット長を指定します。

指定できる値を次に示します。

512

1024

2048

4096

デフォルト値：1024

使用例

Webサーバの秘密鍵httpsdkey.pemを作成します。

hwskeygen -rand file1:file2:file3:file4:file5 -out httpsdkey.pem -bits 1024

file1、file2、file3、file4、file5：任意のファイル

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

関連項目

3.3.5　hwscertutil reqgen

3.3.7　sslpasswd

3.3.7　sslpasswd

パスワード付きサーバ秘密鍵のパスワードファイル作成

書式

sslpasswd サーバ秘密鍵ファイル名 パスワードファイル名

格納先

Application Serverインストールディレクトリー/httpsd/sbin

機能

パスワードによって保護されているサーバ秘密鍵を使用する場合、パスワードをあらかじめファイルに格納しておき、ディレクティブを設定することで、Webサーバ起動時のパスワード入力を省略できます。その手順を次に示します。

hwskeygenコマンドによって、パスワード付きのサーバ秘密鍵を作成します。

sslpasswdコマンドによって、パスワードファイルを作成します。

作成したパスワードファイルを指定したSSLCertificateKeyPasswordディレクティブを、サーバ秘密鍵ファイルを指定したSSLCertificateKeyFileディレクティブとともにhttpsd.confに設定します。

Webサーバを起動または再起動します。

パスワードファイルの内容の漏洩には注意する必要があります。サーバ秘密鍵の格納ディレクトリーに加え、パスワードファイルの格納ディレクトリーでも、ほかのユーザーからのアクセスを禁止するように、ディレクトリーパーミッションやファイルパーミッションの設定をしてください。

実行権限

スーパーユーザー

引数

サーバ秘密鍵ファイル名

パスワードによって保護されたサーバ秘密鍵を指定します。

パスワードファイル名

パスワードファイルを出力するファイル名を指定します。

使用例

sslpasswd httpsdkey.pem .keypasswd

戻り値

戻り値

説明

0

正常終了

0以外

異常終了

注意事項

パスワードファイル名として、既存のファイル名は指定できません。

Windows版のsslpasswdコマンドで作成したパスワードファイルは、UNIX版では使用できません。

UNIX版のsslpasswdコマンドで作成したパスワードファイルは、Windows版では使用できません。

3.4　一般ユーザーによる運用

スーパーユーザーと一般ユーザーの違い、一般ユーザーによるWebサーバを運用するための環境構築方法などについて説明します。

Webサーバを運用するユーザー

Webサーバは、通常の運用方法として、スーパーユーザーによる運用を想定しています。

インストールした状態では、スーパーユーザーによる運用ができるように各種設定が施されています。

このことから、スーパーユーザー以外のユーザー（以下、一般ユーザーと呼びます）で運用する場合、Webサーバの設定ファイルや関連するディレクトリー・ファイルの各種設定内容の変更が必要になります。また、Webサーバの一部の機能については、一般ユーザーによる運用は制限事項になるものがあります。

ここでは、スーパーユーザーと一般ユーザーの違い、一般ユーザーによるWebサーバを運用するための環境構築方法などについて説明します。

各プロセスの権限

スーパーユーザーまたは一般ユーザーで運用した場合、Webサーバの各プロセスの権限を次に示します。

項番

プロセス

スーパーユーザーによる運用

一般ユーザーによる運用

1

制御プロセス

スーパーユーザー

一般ユーザー

2

rotatelogs、rotatelogs2プロセス

3

サーバプロセス

User、Groupディレクティブで指定したユーザー、グループ

4

CGIプロセス

5

gcacheサーバ

UNIXでのスーパーユーザーと一般ユーザーの違い

UNIXでは、スーパーユーザーは一般ユーザーと異なり、システムの管理者権限を持つユーザーになります。UNIXでのスーパーユーザーと一般ユーザーの権限の差異（一例）を次に示します。

項番

項目

スーパーユーザーによる運用

一般ユーザーによる運用

1

別のユーザーが起動したプロセスの停止

可

不可

2

well-knownポート（1023番以下のポート）を開く

可

不可

3

明示的に読み取り/書き込み権限が与えられていないファイルへのアクセス

可

不可

一般ユーザーでWebサーバを運用する場合、Webサーバの制御プロセスの権限が一般ユーザー権限で動作するため、このときの挙動はスーパーユーザーでWebサーバを運用した場合と異なる場合があります。したがって、一般ユーザーでWebサーバを運用する場合は、スーパーユーザーとの権限の差異を意識しながら環境を構築する必要があります。

リソースの所有者・グループの変更

Webサーバのコンテンツ、設定ファイル類、およびWebサーバが動作する際にアクセスする各種ファイル・ディレクトリーについて、UNIX上での所有者・グループを変更します。

最低限、インストールディレクトリー（Application Serverインストールディレクトリー/httpsdディレクトリー）以下のリソースに対しては変更が必要です。

将来、リソースの所有者・グループを元に戻したい場合は、変更作業の前に現在のリソースに対して、所有者とグループを保存しておきます。

保存作業は、スーパーユーザーで実行します。保存例を以下に示します。

（例）

/opt/hitachi/APServer/httpsdディレクトリー以下のリソースに対して、所有者とグループの一覧を作成する。

ls laR /opt/hitachi/APServer/httpsd

変更作業は、スーパーユーザーで実行します。変更例を以下に示します。

（例）

/opt/hitachi/APServer/httpsdディレクトリー以下のリソースに対して、所有者(hwsuser)とグループ(hwsgroup)を変更する。

chown R hwsuser:hwsgroup /opt/hitachi/APServer/httpsd

制限事項

次に示すコマンドは、一般ユーザーによる運用に対応していません。スーパーユーザーで運用してください。

hwscertutilコマンド

htpasswdコマンド

hwskeygenコマンド

logresolveコマンド

sslpasswdコマンド

一般ユーザーによる運用では次に示すディレクティブは指定できません。指定があっても無視します。

Groupディレクティブ

Userディレクティブ

一般ユーザーによる運用では、well-knownポート（1023番以下のポート）を開くことができません。

次のディレクティブにポート番号を指定する際は注意してください。

Listenディレクティブ

SSLCacheServerPortディレクティブ

4　Java VMで使用するコマンド

この章では、Java VMで使用するコマンドの書式、機能などについて説明します。

4.1　Java VMで使用するコマンドの一覧

Java VMで使用するコマンドの一覧を次の表に示します。

システムの運用で使用するコマンド

コマンド名称

要約

概要説明

car_tar_gz

coreアーカイブ機能

coreファイルと関連するライブラリーなどをまとめて、1つのアーカイブファイルに出力します。gzipコマンドで圧縮します。

car_tar_Z

coreアーカイブ機能

coreファイルと関連するライブラリーなどをまとめて、1つのアーカイブファイルに出力します。compressコマンドで圧縮します。

eheapprof

Explicitヒープ詳細情報付き拡張スレッドダンプの出力

指定したプロセスIDのjavaプロセスについて、Explicitヒープ詳細情報を含んだ拡張スレッドダンプを出力します。

java_hras

Application Serverと連携しないJavaアプリケーションプログラムの実行

トラブルシュートに関する独自機能を有効にしてJava VMを起動します。

javacore

coreファイルとスレッドダンプの取得

コマンド実行時のcoreファイルとスレッドダンプを同時に取得します。

javagc

GCの強制発生

指定したプロセスIDのjavaプロセスに対して、任意のタイミングでFullGCを発生させます。

javatrace

トレース情報の収集

coreファイルからスタックトレース情報を取得します。

jheapprof

クラス別統計情報付き拡張スレッドダンプの出力

指定したプロセスIDのjavaプロセスについて、クラス別統計情報を含んだ拡張スレッドダンプを出力します。

jheapprofanalyzer

クラス別統計情報解析ファイルのCSV出力

クラス別統計情報解析ファイルをCSV形式で出力します。

重要

コマンドの引数には、各コマンドで指定できる値を指定してください。それ以外の値が指定された場合、動作は保証されません。

コマンドが正常に終了しても、エラーが発生している場合があります。メッセージログやスタックトレースログを確認してください。

4.2　システムの運用で使用するコマンド

システムの運用で使用するコマンドの書式、機能などについて説明します。

4.2.1　car_tar_gz

coreアーカイブ機能

書式

car_tar_gz [-i 実行ファイル名] [-f] [-s|-S] [coreファイル名] >
    出力ファイル名

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

coreファイルと関連するライブラリーなどをまとめて、1つのアーカイブファイルに出力します。car_tar_gzコマンドは、gzipコマンドを使用して圧縮します。

引数

-i 実行ファイル名

実行ファイル名を指定します。

-f

パス名付きでライブラリーなどのファイルを取得します。

-s

出力するアーカイブファイルのサイズ（単位：バイト）を報告します。

この場合、アーカイブファイルは出力しません。

-S

アーカイブファイルを作成するための、シェルスクリプトを出力します。

このオプションを指定する場合、出力ファイル名には、シェルスクリプト名を指定してください。出力されたシェルスクリプトを実行すると、アーカイブファイルが出力されます。

coreファイル名

coreファイル名を指定します。

デフォルト値：core

出力ファイル名

アーカイブファイル、またはシェルスクリプトのファイル名を指定します。

入力例

アーカイブファイルを作成する場合

car_tar_gz -f core.8326 > corefile.tar.gz

アーカイブファイルのサイズを調べる場合

car_tar_gz -s core.8326

シェルスクリプトからアーカイブファイルを作成する場合

シェルスクリプトを作成します。

car_tar_gz -S core.8326 > collect_cores.csh

シェルスクリプトに実行権を付与します。

chmod +x ./collect_cores.csh

シェルスクリプトを実行して、アーカイブファイルを作成します。

./collect_cores.csh > corefile.tar.gz

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

出力メッセージ

次のメッセージを出力した場合、正常なアーカイブファイルは出力されません。

項番

エラーメッセージ

説明

1

usage: car_tar_gz [ -i executable-file ] [ -f ] [ -s | -S ] [ core-file ]

コマンドの引数が不正です。

2

car_tar_gz: inner error!

car_tar_gzコマンドの内部エラーです。

3

car_tar_gz: cannot create temporary name

一時的に使用するファイルが作成できません。カレントディレクトリーにある、ファイルcar_exec??（??は00〜99）を削除するか、移動してください。

4

car_tar_gz: 〜 : file not found

ファイルが見つかりません。coreファイルおよび-iオプションで指定した実行ファイルを確認してください。

5

car_tar_gz: 〜 : not supported platform

サポートしていないOSです。

注意事項

AIXでは使用できません。snapcoreコマンドを使用してください。

カレントディレクトリーに書き込み権限が必要です。

同じディレクトリー下で、同じcoreファイルまたは作成時間が同じcoreファイルに対して、car_tar_Zコマンドおよびcar_tar_gzコマンドは同時に実行できません。

システムにtarコマンドおよびgzipコマンドがインストールされている必要があります。

car_tar_gzコマンド実行中に強制終了した場合、カレントディレクトリーにcar_tar_gzコマンドが作成した一時的なファイルやディレクトリーが残ります。

一時的に作成されるファイル：car_exec??（??は、00〜99）

一時的に作成されるディレクトリー：carYYMMDDhhmm/（YYMMDDhhmmは、coreファイルの作成年月日時分）

4.2.2　car_tar_Z

coreアーカイブ機能

書式

car_tar_Z [-i 実行ファイル名] [-f] [-s|-S] [coreファイル名] >
    出力ファイル名

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

coreファイルと関連するライブラリーなどをまとめて、1つのアーカイブファイルに出力します。car_tar_Zコマンドは、compressコマンドを使用して圧縮します。

引数

-i 実行ファイル名

実行ファイル名を指定します。

-f

パス名付きでライブラリーなどのファイルを取得します。

-s

出力するアーカイブファイルのサイズ（単位：バイト）を報告します。

この場合、アーカイブファイルは出力しません。

-S

アーカイブファイルを作成するための、シェルスクリプトを出力します。

このオプションを指定する場合、出力ファイル名には、シェルスクリプト名を指定してください。出力されたシェルスクリプトを実行すると、アーカイブファイルが出力されます。

coreファイル名

coreファイル名を指定します。

デフォルト値：core

出力ファイル名

アーカイブファイル、またはシェルスクリプトのファイル名を指定します。

入力例

アーカイブファイルを作成する場合

car_tar_Z -f core.8326 > corefile.tar.Z

アーカイブファイルのサイズを調べる場合

car_tar_Z -s core.8326

シェルスクリプトからアーカイブファイルを作成する場合

シェルスクリプトを作成します。

car_tar_Z -S core.8326 > collect_cores.csh

シェルスクリプトに実行権を付与します。

chmod +x ./collect_cores.csh

シェルスクリプトを実行して、アーカイブファイルを作成します。

./collect_cores.csh > corefile.tar.Z

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

出力メッセージ

次のメッセージを出力した場合、正常なアーカイブファイルは出力されません。

項番

エラーメッセージ

説明

1

usage: car_tar_Z [ -i executable-file ] [ -f ] [ -s | -S ] [ core-file ]

コマンドの引数が不正です。

2

car_tar_Z: inner error!

car_tar_Zコマンドの内部エラーです。

3

car_tar_Z: cannot create temporary name

一時的に使用するファイルが作成できません。カレントディレクトリーにある、ファイルcar_exec??（??は00〜99）を削除するか、移動してください。

4

car_tar_Z: 〜 : file not found

ファイルが見つかりません。coreファイルおよび-iオプションで指定した実行ファイルを確認してください。

5

car_tar_Z: 〜 : not supported platform

サポートしていないOSです。

注意事項

AIXでは使用できません。snapcoreコマンドを使用してください。

カレントディレクトリーに書き込み権限が必要です。

同じディレクトリー下で、同じcoreファイルまたは作成時間が同じcoreファイルに対して、car_tar_Zコマンドおよびcar_tar_gzコマンドは同時に実行できません。

システムにtarコマンドおよびcompressコマンドがインストールされている必要があります。

car_tar_Zコマンド実行中に強制終了した場合、カレントディレクトリーにcar_tar_Zコマンドが作成した一時的なファイルやディレクトリーが残ります。

一時的に作成されるファイル：car_exec??（??は、00〜99）

一時的に作成されるディレクトリー：carYYMMDDhhmm/（YYMMDDhhmmは、coreファイルの作成年月日時分）

4.2.3　eheapprof

Explicitヒープ詳細情報付き拡張スレッドダンプの出力

書式

eheapprof [-i|-f] [-force] [-freeratio] -p プロセスID

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

引数に指定したプロセスIDのjavaプロセスについて、Explicitヒープ詳細情報を含んだ拡張スレッドダンプを出力します。また、Explicitメモリーブロック内のオブジェクトの統計情報、およびExplicitメモリーブロックの解放率情報も拡張スレッドダンプに出力できます。

実行権限

引数のプロセスIDで指定するjavaプロセスと同一のユーザーで実行してください。

引数

-i

Explicitヒープ詳細情報付き拡張スレッドダンプの出力処理の実行を確認するメッセージが表示されます。表示されたメッセージに対してyまたはnを入力します。このとき、yを入力すると、Explicitヒープ詳細情報を含んだ拡張スレッドダンプが出力されます。nを入力すると、何も出力しないで処理を終了します。省略した場合、-fオプションが指定されないかぎり、このオプションは有効です。

-f

-iオプションを無効にします。省略した場合、-iオプションが有効になります。

-force

javaプロセスが作成する/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対して拡張スレッドダンプの出力を要求します。

-freeratio

Explicitメモリーブロックのオブジェクト解放率情報の出力を有効にして、拡張スレッドダンプを出力します。

このオプションを指定してeheapprofコマンドを実行すると、Java VMによって次の処理が実行され、オブジェクト解放率情報が取得されます。

FullGC

Explicitメモリーブロックの解放処理

これらの処理によって、アプリケーションの実行が数秒間止まるおそれがあるため、Explicitメモリーブロックのオブジェクト解放率情報は、システム開発時や業務停止時間中に出力することをお勧めします。

-p プロセスID

Explicitヒープ詳細情報を含んだ拡張スレッドダンプを出力するjavaプログラムのプロセスIDを指定します。

型：Integer

指定できる値を次に示します。

0〜4294967295

出力形式

「Explicitメモリーブロックのオブジェクト解放率情報」が無効な場合

Explicit Heap Status
--------------------
 max EH_MAX, total EH_TOTAL, used EH_USED, garbage EH_GARB (EH_PER1
 used/max, EH_PER2 used/total, EH_PER3 garbage/used), EM_NUMS spaces exist

 Explicit Memories(EM_MGR_PTR)

 "EM_NAME" eid=EID(EM_PTR)/EM_TYPE, total EM_TOTAL, used EM_USED,
 garbage EM_GARB (EM_PER1 used/total, EM_PER2 garbage/used, FL_BLOCKS
 blocks) EM_STAT

    deployed objects
    ________________Size__Instances__Class________________
                   ISIZE       INUM  CNAME
                    ...
                  AISIZE      AINUM total

「Explicitメモリーブロックのオブジェクト解放率情報」が有効な場合

Explicit Heap Status
--------------------
 max EH_MAX, total EH_TOTAL, used EH_USED, garbage EH_GARB (EH_PER1
 used/max, EH_PER2 used/total, EH_PER3 garbage/used), EM_NUMS spaces exist

 Explicit Memories(EM_MGR_PTR)

 "EM_NAME" eid=EID(EM_PTR)/EM_TYPE, total EM_TOTAL, used EM_USED,
 garbage EM_GARB (EM_PER1 used/total, EM_PER2 garbage/used, FL_BLOCKS
 blocks) EM_STAT

    deployed objects
    ________________Size__Instances__FreeRatio__Class________________
                   ISIZE       INUM     FRATIO  CNAME
                    ...
                  AISIZE      AINUM total

出力形式で示した各項目について説明します。

分類

出力項目

出力内容

意味

Explicitヒープ情報

EH_MAX

<const>K

Explicitヒープの最大サイズが出力されます。単位はキロバイトです。

EH_TOTAL

<const>K

確保済みExplicitヒープサイズが出力されます。単位はキロバイトです。

EH_USED

<const>K

利用済みExplicitヒープサイズが出力されます。単位はキロバイトです。

EH_GARB

<const>K

Explicitヒープの内部状態が出力されます。

EH_PER1

<decimal>%

Explicitヒープ利用率（EH_USED/EH_MAX）が%表記で出力されます。

EH_PER2

<decimal>%

Explicitヒープ利用率（EH_USED/EH_TOTAL）が%表記で出力されます。

EH_PER3

<decimal>%

Explicitヒープの内部状態が出力されます。

EM_NUMS

<const>

有効なExplicitメモリーブロックの数が出力されます。

EM_MGR_PTR

<ptr>

Explicitヒープ制御のための内部情報があるメモリーアドレスが出力されます。障害調査時などに利用します。

Explicitメモリーブロック情報

EM_NAME

<letters>

Explicitメモリーブロックの名称が出力されます。

Explicitメモリーブロックの名称に多バイト文字が含まれている場合、出力内容は不定です（通常は文字化けして出力されます）。

Explicitメモリーブロックの初期化とほぼ同時に出力された場合や、Java VMが内部で生成したExplicitメモリーブロックの場合は、"NULL"が出力されることがあります。

EID

<const>

ExplicitメモリーブロックのIDが出力されます。

EM_PTR

<ptr>

Explicitメモリーブロック内部構造があるメモリーアドレスが出力されます。障害調査時などに利用します。

EM_TYPE

R|B|A

Explicitの種別が出力されます。

Rは、Application Serverの内部で利用されているExplicitメモリーブロックを示します。

Bは、アプリケーションが利用しているExplicitメモリーブロックを示します。

Aは、自動配置設定ファイルを使って指定したExplicitメモリーブロックを示します。

EM_TOTAL

<const>K

Explicitメモリーブロックのメモリー確保済みサイズが出力されます。単位はキロバイトです。

EM_USED

<const>K

Explicitメモリーブロックの利用済みサイズが出力されます。単位はキロバイトです。

EM_GARB

<const>K

Explicitメモリーブロックの内部状態が出力されます。単位はキロバイトです。

EM_PER1

<decimal>%

Explicitメモリーブロック利用率（EM_USED/EM_TOTAL）が%表記で出力されます。

EM_PER2

<decimal>%

Explicitメモリーブロックの内部状態が出力されます。

FL_BLOCKS

<const>

常に0が出力されます。

EM_STAT

Enable|Disable

Explicitメモリーブロックのサブ状態が出力されます。

オブジェクト統計情報※1

ISIZE

<const>

あるクラスをインスタンス化したオブジェクトのExplicitメモリーブロック内のサイズが出力されます。

INUM

<const>

あるクラスをインスタンス化したオブジェクトのExplicitメモリーブロック内の個数が出力されます。

CNAME

<letters>

ISIZEおよびINUMが示すクラスの完全クラス名が出力されます。

AISIZE

<const>

Explicitメモリーブロック内の全オブジェクトの合計サイズが出力されます。

AINUM

<const>

Explicitメモリーブロック内の全オブジェクトの個数が出力されます。

オブジェクト解放率情報※2

FRATIO

<decimal>%

Explicitメモリーブロックの自動解放処理で解放されたオブジェクトの割合（オブジェクト解放率）が%表記で出力されます。

オブジェクト解放率=（自動解放処理前のクラスのオブジェクト数-自動解放処理後のクラスのオブジェクト数）/自動解放処理前のクラスのオブジェクト数×100

なお、オブジェクト解放率情報出力時に、自動解放処理の対象とならなかったExplicitメモリーブロックには、「−」が出力されます。

（凡例）

<const>K：正の自然数を表します。

<decimal>K：正の整数（小数点第1位まで）を表します。

<ptr>K：ポインター値を表します。

<letters>K：任意の文字または任意の文字列を表します。

注※1

オブジェクト統計情報は、eheapprofコマンドを実行している場合に出力されます。なお、オブジェクト統計情報には、実際に作成したサイズ、個数よりも多く、int型配列を示す"［I"が出力されることがあります。この場合、"［I"は、Explicitメモリーブロック内で使用されていないオブジェクトを示します。Explicitメモリーブロック内で使用されていないオブジェクトは、Java VMの内部処理でint型配列化されます。

注※2

オブジェクト解放率情報は、-freeratioオプションを指定したeheapprofコマンドを実行している場合に出力されます。

出力例

「Explicitメモリーブロック内のオブジェクト統計情報」および「Explicitメモリーブロックのオブジェクト解放率情報」が無効な場合

Explicit Heap Status
--------------------
 max 31415926K, total 213971K, used 205369K, garbage 1234K (1.1% used/max,
 96.2% used/total, 0.0% garbage/used), 3 spaces exist

 Explicit Memories(0x12345678)

 "EJBMgrData" eid=1(0x02f25610)/R, total 154272K, used 150176K, garbage 1234K
 (97.0% used/total, 1.2% garbage/used, 0 blocks) Enable

 "VJBStored" eid=3(0x02f25910)/B, total 54272K, used 50176K, garbage 0K (90.9%
 used/total, 0.0% garbage/used, 2 blocks) Enable

 "ExplicitMemory-2" eid=2(0x02f25700)/R, total 5427K, used 5017K, garbage 0K
 (92.1% used/total, 0.0% garbage/used, 0 blocks) Enable

「Explicitメモリーブロック内のオブジェクト統計情報」および「Explicitメモリーブロックのオブジェクト解放率情報」が有効な場合

Explicit Heap Status
--------------------
 max 31415926K, total 162816K, used 150528K, garbage 10004K (0.0% used/max,
 91.1% used/total, 6.6% garbage/used), 3 spaces exist

 Explicit Memories(0x12345678)

  "EJBMgrData" eid=1(0x02f25610)/R, total 54272K, used 50176K, garbage 0K
 (91.2% used/total, 0.0% garbage/used, 0 blocks)
    deployed objects
    ________________Size__Instances__FreeRatio__Class________________
                35234568      10648          - java.util.HashMap
                 5678900      10668          - [Ljava.util.HashMap$Entry;
                 4456788       7436          - java.util.HashMap$Entry
                 4321000        200          - java.util.WeakHashMap
                 1234568        190          - [Ljava.util.WeakHashMap$Entry;
                  454400          4          - java.util.WeakHashMap$Entry
                51380224      29146 total

  "VJBStored" eid=3(0x02f25910)/B, total 54272K, used 50176K, garbage 10004K
 (90.7% used/total, 19.9% garbage/used, 5 blocks)
    deployed objects
    ________________Size__Instances__FreeRatio__Class________________
                35234568      10648         49 java.util.HashMap
                 5678900      10668         43 [Ljava.util.HashMap$Entry;
                 4456788       7436         50 java.util.HashMap$Entry
                 4321000        200         32 java.util.WeakHashMap
                 1234568        190         45 [Ljava.util.WeakHashMap$Entry;
                  454400          4         22 java.util.WeakHashMap$Entry
                51380224      29146 total

  "ExplicitMemory-2" eid=2(0x02f25700)/B, total 54272K, used 50176K,  garbage
 0K (91.1% used/total, 0.0% garbage/used, 0 blocks)
    deployed objects
    ________________Size__Instances__FreeRatio__Class________________
                35234568      10648          - java.util.HashMap
                 5678900      10668          - [Ljava.util.HashMap$Entry;
                 4456788       7436          - java.util.HashMap$Entry
                 4321000        200          - java.util.WeakHashMap
                 1234568        190          - [Ljava.util.WeakHashMap$Entry;
                  454400          4          - java.util.WeakHashMap$Entry
                51380224      29146 total

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

2

一定時間内にExplicitヒープ詳細情報を含んだ拡張スレッドダンプ出力処理終了の応答がありませんでした。

出力メッセージ

次のエラーメッセージまたは警告メッセージが出力された場合、Explicitヒープ詳細情報付き拡張スレッドダンプは出力されません。

項番

エラーメッセージ

説明

1

usage: eheapprof [-f|-i] [-force] [-freeratio] -p process-id

eheapprofコマンドへの引数の指定が間違っています。

2

eheapprof: illegal option -- オプション

eheapprofコマンドに指定したオプションが不正です。

3

プロセスID: Now processing previous request, this request canceled

eheapprofコマンドの引数に指定したプロセスIDに該当するプロセスが、現在Explicitヒープ詳細情報を出力しています。

4

プロセスID: No such process

eheapprofコマンドの引数に指定したプロセスIDに該当するプロセスがありません。または、eheapprofコマンドで指定したプロセスIDに該当するプロセスがjavaプロセス以外でした。

5

プロセスID: Not owner

eheapprofコマンドの引数に指定したプロセスIDのプロセスのオーナーではありません。

6

eheapprof: can't create work file at /tmp , this request canceled

一時ファイル用ディレクトリーに参照・書き込み権限がない場合、Explicitヒープ詳細情報付き拡張スレッドダンプを出力できません。Explicitヒープ詳細情報付き拡張スレッドダンプの出力要求はキャンセルされます。

7

eheapprof: please delete 削除できなかったファイル名 in 削除できなかったファイルの絶対パス

eheapprofコマンドを終了したときに、内部ファイルを削除できませんでした。削除できなかったファイルの絶対パスにある、削除できなかったファイルを削除してください。

8

eheapprof: unexpected error occurred: エラー原因

eheapprofコマンド実行中に予期しないエラーが発生しました。

エラー原因には、例えば下記のような表示がされます。

作業用メモリー確保に失敗した場合

malloc systemcall fail (errno=Y)

オブジェクトのクローズに失敗した場合

close systemcall fail (errno=Y)

9

プロセスID: Timeout occurred. Java process not responding

eheapprofコマンドの引数に指定したプロセスIDに該当するプロセスから、一定時間内にExplicitヒープ詳細情報出力処理終了の応答がありませんでした。

注意事項

eheapprofコマンドはプログラムの開発用ユーティリティーとして提供されているものです。システムの運用では使用しないでください。

同じjavaプロセスに対して、同時にeheapprofコマンドは実行できません。前回のeheapprofコマンドによるExplicitヒープ詳細情報が拡張スレッドダンプに出力されたあとに実行してください。

eheapprofコマンド実行時に、/tmp/hsperfdata_ユーザー名/プロセスIDファイルを使用します。該当するファイルが存在しない場合、eheapprofコマンドによるExplicitヒープ詳細情報付き拡張スレッドダンプは出力できません。ただし、-forceオプションを指定した場合、/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対して拡張スレッドダンプの出力を要求します。

4.2.4　java_hras

Application Serverと連携しないJavaアプリケーションプログラムの実行

書式

java_hras [options] class [argument...]
java_hras [options] -jar file.jar [argument...]

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

このコマンドは、単体Javaプログラム実行機能を有効にした状態でJava VMを起動し、Javaアプリケーションを実行します。単体Javaプログラム実行機能が有効な場合は、トラブルシュートに必要な独自機能が有効となります。

java_hrasコマンド実行時のオプション指定として、トラブルシュートに必要な独自機能のON/OFFをオプションで指定した場合は、その指定が優先されます。同じオプションを複数指定した場合は、最後に指定したオプションの値が有効になります。

単体Javaプログラム実行機能有効時に切り替わるオプションを次に示します。

項番

カテゴリ

オプション

Java VMデフォルト値

単体Javaプログラム実行機能有効時

1

Java VMログ出力

HitachiVerboseGC

OFF

ON

2

HitachiOutputMilliTime

OFF

ON

3

HitachiOutOfMemoryStackTrace

OFF

ON

4

HitachiJavaClassLibTrace

OFF

ON

5

スレッドダンプ出力

HitachiLocalsInStackTrace

OFF

ON

6

HitachiLocalsSimpleFormat

OFF

ON

7

HitachiOutOfMemoryAbort

OFF

ON

8

メモリーダンプ

HitachiFullCore

OFF

ON

単体Javaプログラム実行機能が有効になると、単体Javaプログラム実行機能未使用時のjavaコマンド実行時と比べ、次に示す違いがあります。

スタックトレース

単体Javaプログラム実行機能使用時、Javaプログラムのメインスレッドのスタックトレース情報は、単体Javaプログラム実行機能未使用時のJavaプログラム実行時と異なります。

java_hrasコマンドは-Xhrasオプションを指定できません。

これら以外の機能は、単体Javaプログラム実行機能未使用時のjavaコマンドと同じです。

引数

指定できるオプションなどは、javaコマンドと同じです。ただし、-Xhrasオプションだけは指定できません。

options

コマンド行オプションを指定します。

class

呼び出されるクラスの名称を指定します。

-jar file.jar

呼び出されるJARファイルの名称を指定します。

argument

main関数に渡される引数を指定します。

出力例

出力例1

スレッドダンプ出力によってメインスレッドのスタックトレース情報を取得した場合。

単体Javaプログラム実行機能：使用時

main #1 prio=5 os_prio=0 jid=<N/A> tid=0x000000000230a800 nid=0x1988 waiting on condition [0x000000000282e000..0x000000000282fbc0]
   java.lang.Thread.State: TIMED_WAITING (sleeping)

stack=[0x0000000002830000..0x0000000002734000..0x0000000002731000..0x0000000002730000]
  [user cpu time=218ms, kernel cpu time=46ms] [blocked count=0, waited count=0]
	at java.lang.Thread.sleep(Native Method)
	at Hoge.main(Hoge.java:5)
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:483)
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.execJava(Java_hras.java:52)
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.main(Java_hras.java:39)

単体Javaプログラム実行機能：未使用時

"main" #1 prio=5 os_prio=0 jid=<N/A> tid=0x00000000002b7800 nid=0x1fa0 waiting on condition [0x000000000278f000..0x000000000278f9c0]
   java.lang.Thread.State: TIMED_WAITING (sleeping)

stack=[0x0000000002790000..0x0000000002694000..0x0000000002691000..0x0000000002690000]
  [user cpu time=171ms, kernel cpu time=46ms] [blocked count=0, waited count=0]
	at java.lang.Thread.sleep(Native Method)
	at Hoge.main(Hoge.java:5)

出力例2

起動時に指定したメインクラスのmainメソッド実行中に、mainメソッド内でキャッチされないjava.lang.Exception例外が発生した場合。

単体Javaプログラム実行機能：使用時

Exception in thread "main" java.lang.reflect.InvocationTargetException
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.
java:57)
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAcces
sorImpl.java:43)
	at java.lang.reflect.Method.invoke(Method.java:606)
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.execJava(Java_hras.java:51)
	at JP.co.Hitachi.soft.jvm.tools.Java_hras.main(Java_hras.java:38)
Caused by: java.lang.Exception: java.lang.Throwable
	at Test.main(Test.java:6)
	... 6 more
Caused by: java.lang.Throwable
	... 7 more

単体Javaプログラム実行機能：未使用時

Exception in thread "main" java.lang.Exception: java.lang.Throwable
	at Test.main(Test.java:6)
Caused by: java.lang.Throwable
	... 1 more

戻り値

javaコマンドと同じです。

注意事項

javaコマンドを実行するには、次に示す方法があります。

Application Serverインストールディレクトリー/jdk/jre/bin/java_hrasコマンドを使用する。

-Xhrasオプションを指定したjavaコマンドを使用する。

javaコマンド実行時、環境変数JAVA_HRASを設定する。

ほかの方法で実行した場合、コマンドの実行に失敗し、次のメッセージが出力されます。

Java command cannot be used except in some special cases. When starting a Java program, use the java_hras command, etc.

Depending on the Java program executed, it might be necessary to purchase the other product.

javawコマンドを実行するには、次に示す方法があります。

-Xhrasオプションを指定したjavawコマンドを使用する。

javawコマンド実行時、環境変数JAVAW_HRASを設定する。

ほかの方法で実行した場合、コマンドの実行に失敗し、次のメッセージが出力されます。

Javaw command cannot be used except in some special cases. When starting a Java program, use the java_hras command, etc.

Depending on the Java program executed, it might be necessary to purchase the other product.

4.2.5　javacore

coreファイルとスレッドダンプの取得

書式

javacore [-i|-f] [-force] -p プロセスID

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

コマンド実行時のcoreファイルとスレッドダンプを同時に取得します。

実行権限

引数のプロセスIDで指定するjavaプロセスと同一のユーザーで実行してください。

引数

-i

coreファイルおよびスレッドダンプの出力処理の実行を確認するメッセージが表示されます。表示されたメッセージに対してyまたはnを入力します。このとき、yを入力するとスレッドダンプが出力されます。nを入力すると、何も出力しないで処理を終了します。省略した場合、-fオプションが指定されないかぎり、このオプションは有効です。

-f

-iオプションを無効にします。省略した場合、-iオプションが有効になります。

-force

javaプロセスが作成する/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対してcoreを出力させます。

-p プロセスID

プロセスIDには、coreファイルとスレッドダンプを取得するjavaプログラムのプロセスIDを指定します。

型：Integer

指定できる値を次に示します。

0〜4294967295

出力形式

ヘッダー

EEE MMM dd hh:mm:ss yyyy※

Full thread dump Java HotSpot(TM) Client VM (1.5.0_05-b05-CDK0850-ビルド日
 mixed mode)
起動コマンドライン
…

注※

EEEは曜日、MMMは月、ddは日を表します。また、hhは時間、mmは分、ssは秒、yyyyは年（西暦）を表します。

システム設定

System Properties
-----------------
Java Home Dir  : JDK実行環境インストールディレクトリー
Java DLL Dir   : JDKを構成するライブラリーのインストールディレクトリー
Sys Classpath  : システムクラスパス
User Args      :
Javaコマンドオプション1
Javaコマンドオプション2
…

動作環境

Operating Environment
---------------------
Host    : ホスト名:IPアドレス
OS      : OSバージョン
CPU     : CPU種別, 利用可能CPU数/システム全体のCPU数

Resource Limits -
         RLIMIT_CPU     :プロセスで使用可能な秒数
         RLIMIT_FSIZE   :最大ファイルサイズ(単位：バイト)
         RLIMIT_DATA    :malloc可能なサイズ(単位：バイト)
         RLIMIT_STACK   :スタックの最大サイズ(単位：バイト)
         RLIMIT_CORE    :coreの最大サイズ(単位：バイト)
         RLIMIT_RSS     :プロセスの常駐サイズ(単位：バイト)
         RLIMIT_AS      :プロセストータルの利用可能メモリー(単位：バイト)
         RLIMIT_NOFILE  :最大のファイルディスクリプタ値

Javaヒープ情報

SerialGCの場合

Heap Status
-----------
def new generation   max max size, total capacity, used size (max usage% used/max, total usage% used/total)
                      [bottom, commit addr, reserve addr)
  eden space capacity,  usage% used [bottom, top, reserve addr)
  from space capacity,   usage% used [bottom, top, reserve addr)
  to   space capacity,   usage% used [bottom, top, reserve addr)
tenured generation   max max size, total capacity, used size (max usage% used/max, total usage% used/total)
                      [bottom, commit addr, reserve addr)
   the space capacity,  usage% used [bottom, top, used block, reserve addr)
Metaspace       max max size, capacity capacity words, committed committed size, reserved reserve size, used size (max usage% used/max, total usage% used/committed)
  class space    max max size, capacity capacity words, committed committed size, reserved reserve size, used size (max usage% used/max, total usage% used/committed)
                [bottom, top, commit addr, reserve addr)

max size

最大の容量。単位はキロバイト。

Metaspaceの場合、-XX:MaxMetaspaceSizeが未指定のとき最大値は無制限のため、"unlimited"が出力されます。

capacity

現在の容量。単位はキロバイト。

capacity words

Metaspaceのコミット済みのメモリー領域からフリー領域を除いた合計サイズ。単位はキロバイト。

committed size

Metaspaceのコミット済みの合計メモリーサイズ。単位はキロバイト。

reserve size

予約済みのメモリーサイズ。単位はキロバイト。

size

使用中のメモリーサイズ。単位はキロバイト。

max usage

最大の容量に対する使用率。

Metaspaceの場合、-XX:MaxMetaspaceSizeが未指定のとき最大値は無制限のため、"-%"が出力されます。

total usage

現在の容量に対する使用率。

bottom

領域先頭アドレス。

top

使用中領域の先頭アドレス。

commit addr

コミット済み領域の末尾アドレス。

reserve addr

予約済み領域の末尾アドレス。

usage

使用率。

used block

次の空きブロックの先頭アドレス。

注

class spaceは、64bit版のJava VMで圧縮オブジェクトポインター機能が有効であり、かつCompressed Class Spaceを使用している場合にだけ出力されます。

Metaspaceの値は、class spaceを含んだMetaspace全体の合計値です。

G1GCの場合

Heap Status
-----------
 garbage-first heap   total heap capacity, used heap size [heap bottom, heap commit addr, heap reserve addr)
  region size region size, young region young (young size), survivor region survivors (survivor size)
 Metaspace       max max size, capacity capacity words, committed committed size, reserved reserve size, used size (max usage% used/max, total usage% used/committed)
  class space    max max size, capacity capacity words, committed committed size, reserved reserve size, used size (max usage% used/max, total usage% used/committed)
                [bottom, top, commit addr, reserve addr)

出力項目の詳細フォーマット

出力項目

出力内容

意味

heap capacity

<const>K

Javaヒープ領域の領域サイズ。単位はキロバイト。

(a)の合計サイズ+(b)の合計サイズ+(c)の合計サイズ+(d)の合計サイズ

heap size

<const>K

Javaヒープ領域の使用サイズ。単位はキロバイト。

(a)の合計サイズ+(b)の合計サイズ+(c)の合計サイズ

heap bottom

<ptr64>

Javaヒープ領域の先頭アドレス。

heap commit addr

<ptr64>

Javaヒープ領域のコミット済みの末尾アドレス。

heap reserve addr

<ptr64>

Javaヒープ領域の予約済みの末尾アドレス。

region size

<const>K

1リージョンのサイズ。単位はキロバイト。

young region

<const>

New領域の使用中のリージョン数。

(a)のリージョン数+(b)のリージョン数

young size

<const>K

New領域の使用サイズ。単位はキロバイト。

((a)のリージョン数+(b)のリージョン数)*region_size

survivor region

<const>

Survivor領域の使用中のリージョン数。

(b)のリージョン数

survivor size

<const>K

Survivor領域の使用サイズ。単位はキロバイト。

(b)のリージョン数*region_size

Metaspace、class spaceの出力項目はSerial GCの場合と同じです。「Serial GCの場合」の説明を参照してください。

（凡例）

(a)：Eden領域

(b)：Survivor領域

(c)：Tenured領域

(d)：Free領域

Java VM内部メモリーマップ情報

JVM Internal Memory Map
-----------------------
メモリー確保関数:address = 開始アドレス - 終了アドレス (size:サイズ)

注

メモリー確保関数：mmap()かmalloc()のどちらかが出力されます。

開始アドレス：メモリー領域の開始アドレスが16進で出力されます。

終了アドレス：メモリー領域の終了アドレスが16進で出力されます。

サイズ：確保しているメモリー領域のサイズが出力されます（単位：バイト）。

Java VM内部メモリーサイズ情報

JVM Internal Memory Status
--------------------------
  Heap Size      :確保しているメモリーサイズ※
  Alloc Size     :使用中のメモリーサイズ※
  Free Size      :未使用のメモリーサイズ※

注※

単位：バイト

アプリケーション環境

Application Environment
-----------------------
Signal Handlers -※1
  SIGHUP         :シグナルハンドラー情報
  SIGINT         :シグナルハンドラー情報
…
  SIGSOUND       :シグナルハンドラー情報
  SIGSAK         :シグナルハンドラー情報

Signal Handlers -
シグナル種別： [シグナルハンドラーアドレス], sa_mask[0]=シグナルマスク, sa_flags=特殊フラグ
…

Environment Variables -※2
環境変数=値
…
Current Directory -
  Application Serverインストールディレクトリー/CC/server/…

注※1

次の情報が表示されます。

・シグナルハンドラーがインストールされている場合は、そのアドレス。

・SIG_DFLである場合は、default。

・SIG_IGNである場合は、ignored。

注※2

次の情報が表示されます。

・シグナル種別には、/usr/include/sys/signal.hに定義されているシグナル名。

・シグナルハンドラーアドレスには、シグナルハンドラーのアドレスが16進数で出力されます。ライブラリー名＋オフセットという形式で表示されることもあります。

・シグナルマスクには、sigaction()で取り出せる構造のsa_maskフィールド値が16進数で出力されます。

・特殊フラグには、sigaction()で取り出せる構造のsa_flagsフィールド値が16進数で出力されます。

ライブラリー情報（Linuxの場合）

Loaded Libraries
----------------
Dynamic libraries :
開始アドレス-終了アドレス   コマンド
開始アドレス-終了アドレス   ライブラリー
…

ライブラリー情報（AIXの場合）

Loaded Libraries
----------------
コマンド
        text     :開始アドレス-終了アドレス (サイズ)
        data     :開始アドレス-終了アドレス (サイズ)
ライブラリー
        text     :開始アドレス-終了アドレス (サイズ)
        data     :開始アドレス-終了アドレス (サイズ)
…

スレッド情報

-----------
"スレッド名" daemon prio=優先度 jid=ハッシュ値 tid=スレッドID
    nid=nativeID status [開始アドレス...終了アドレス]
    java.lang.Thread.State: スレッドの現在のステータス※
    stack=[スタック開始アドレス..YellowPageアドレス..RedPageアドレス..
    スタック終了アドレス]
    [user cpu time=ユーザー時間ms, kernel cpu time=カーネル時間ms]
    [blocked count=ブロック回数, waited count=待機回数]
         at クラス名.メソッド名(メソッド情報)
…

注※

スレッドの現在のステータスの情報は、JDK 6がベースの場合で、バージョンが08-10以降のときにだけ出力されます。

出力内容を説明します。

スレッド名

Threadクラスのコンストラクターに指定されたスレッド名称が出力されます。

daemon：デーモンスレッドである場合に、"daemon"と出力されます。

優先度：Thread#setPriorityで設定された優先度が出力されます。

ハッシュ値：System.identityHashCode()を呼び出して得られる値と同一の値が8桁の16進数で出力されます。

スレッドID：スレッドオブジェクトのメモリー上のアドレス。

nativeID：OSレベルのスレッドID。

status：スレッドの状態。

runnable：実行中または実行可能なスレッド

in Object.wait()、waiting for monitor entryまたはwaiting on condition：モニターロック待ちのスレッド

sleeping：中断状態のスレッド

開始アドレス：Javaフレームの最高位スタックアドレスが16進数で出力されます。

終了アドレス：JavaLockのある最高位スタックアドレスが16進数で出力されます。

ユーザー時間：スレッド開始からのユーザー時間がミリ秒単位で出力されます。

カーネル時間：スレッド開始からのカーネル時間がミリ秒単位で出力されます。

ブロック回数：スレッド開始から、処理がブロックされた回数が出力されます。

待機回数：スレッド開始から、処理が待ち状態になった回数が出力されます。

スレッドの現在のステータス

スレッドの現在のステータスを表すメッセージが出力されます。メッセージの内容はjava.lang.Thread.State列挙型に対応します。

スタック開始アドレス

スタック開始アドレスが16進数で出力されます。

YellowPageアドレス

スタックYellowガードページ先頭アドレスが16進数で出力されます。

RedPageアドレス

スタックRedガードページ先頭アドレスが16進数で出力されます。

スタック終了アドレス

スタック終了アドレスが16進数で出力されます。

クラス名

クラス名が出力されます。

メソッド名

メソッド名が出力されます。

メソッド情報

次のメソッド情報が出力されます。

Native Method

ネイティブメソッドの場合に出力されます。

ファイル名：行番号

Javaメソッドで行番号付きでコンパイルされている場合に出力されます。

Unknown Source

Javaメソッドで行番号なしでコンパイルされている場合に出力されます。

Javaモニターダンプ

Java monitor
------------
ロックオブジェクト@ハッシュコード オーナー情報
   待機状態:待機スレッド数
      待機スレッド情報

出力内容を説明します。

ロックオブジェクト

ロック対象オブジェクトのクラス名が出力されます。

ハッシュコード

Object.hashCodeで得られるハッシュコードが出力されます。

オーナー情報

owner "スレッド名"スレッドID：オーナーがある場合に出力されます。

no owner：オーナーがない場合に出力されます。

待機状態

... waiting to enter：メソッド実行待ちの場合に出力されます。

... waiting to be notified：通知待ちの場合に出力されます。

待機スレッド数

スレッド数が出力されます。

待機スレッド情報

「"スレッド名" スレッドID」の形式で出力されます。

JNIグローバル参照数の情報

JNI Information
---------------
JNI global references: JNIグローバル参照数

出力内容を説明します。

JNIグローバル参照数

Java VMが保持しているグローバル参照の数が出力されます。

注

JNIグローバル参照はJava VMの内部でも再利用されるため、JNIがサポートするDeleteGlobalRef関数を発行してJNIグローバル参照を削除しても、数値は減少しません。また、NewGlobalRef関数を発行してJNIグローバル参照を新規作成しても、Java VMが再利用したJNIグローバル参照を割り当てた場合は数値は増加しません。

Explicitヒープ情報およびExplicitメモリーブロック情報

Explicit Heap Status
--------------------
 max EH_MAX, total EH_TOTAL, used EH_USED, garbage EH_GARB (EH_PER1
 used/max, EH_PER2 used/total, EH_PER3 garbage/used), EM_NUMS spaces exist

 Explicit Memories(EM_MGR_PTR)

  "EM_NAME" eid=EID(EM_PTR)/EM_TYPE, total EM_TOTAL, used EM_USED,
 garbage EM_GARB (EM_PER1 used/total, EM_PER2 garbage/used, FL_BLOCKS
 blocks) EM_STAT
...

注意事項を次に示します。

Explicitヒープ情報とExplicitメモリーブロック情報の間には、空行が1行あります。

Explicitメモリーブロック情報の出力順序（どのExplicitメモリーブロックから出力するか）は未定義とします。

"EM_NAME"の前には、半角2文字分のスペースがあります。

最後の行には空行が1行あります。したがって、Explicitメモリーブロックごとの出力の間には空行が1行あります。

フッター

Full thread dump completed.   EEE MMM dd hh:mm:ss yyyy※

注※

EEEは曜日、MMMは月、ddは日を表します。また、hhは時間、mmは分、ssは秒、yyyyは年（西暦）を表します。

拡張スレッドダンプ情報との比較を、次に示します。

出力情報

標準スレッドダンプ

拡張スレッドダンプ

ヘッダー

×

○

システム設定

×

○

動作環境

×

○

メモリー情報（Windowsの場合だけ）

×

○

Javaヒープ情報

×

○

Java VM内部メモリーマップ情報

×

○

Java VM内部メモリーサイズ情報

×

○

アプリケーション環境

×

○

ライブラリー情報

×

○

スレッド情報

○

○※1

Javaモニターダンプ

×

○

フッター

×

○

スレッドダンプ出力先

標準出力

標準出力※2

Java VMログファイル

（凡例）

○：出力されます。

×：出力されません。

注※1

スタックの開始および終了のアドレス情報などが出力されます。

注※2

-XX:+HitachiThreadDumpToStdoutオプションが指定された場合に出力されます。

入力例

-fオプションを省略してjavacoreコマンドを実行します。

javacore -p 8326

coreファイルおよびスレッドダンプの出力処理の実行を確認するメッセージが表示されます。

send SIGQUIT to 8326:?(y/n)

coreファイルおよびスレッドダンプを取得する場合はyを、取得しない場合はnを入力します。

send SIGQUIT to 8326:?(y/n)y

coreファイルおよびスレッドダンプを取得すると、実行中のjavaプログラムでは次のメッセージが出力されます。

Now generating core file (javacore8662.030806215140.core)...
done
(スレッドダンプを出力)
Writing Java core  to javacore8662.030806215140.txt... OK

実行中のjavaプログラムは、カレントディレクトリーに次のファイルを作成し、プログラムを継続します。

coreファイル

javacoreプロセスID.日時.core

スレッドダンプ

javacoreプロセスID.日時.txt

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

2

一定時間内にcore生成処理終了の応答がありませんでした。

出力メッセージ

次のエラーメッセージまたは警告メッセージを出力した場合、coreファイルやスレッドダンプは取得されません。

項番

エラーメッセージ

説明

1

usage: javacore [-f|-i] [-force] -p process-id

コマンドの引数が不正です。

2

javacore: can't create work file at /tmp, this request canceled

/tmpに参照および書き込み権限がありません。

3

javacore: illegal option --オプション

コマンドの引数に指定したオプションが不正です。

4

javacore: unexpected error occurred:エラー原因

コマンド実行中に予期しないエラーが発生しました。

5

javacore: please delete 削除できなかったファイル名 in 削除できなかったファイルの絶対パス

コマンド終了時にjavacoreコマンドの内部処理で作成したファイルを削除できませんでした。削除できなかったファイルの絶対パスにある、削除できなかったファイルを削除してください。

6

プロセスID: No such process

javacoreコマンドの引数に指定したプロセスIDに該当するプロセスがありません。または、javacoreコマンドで指定したプロセスIDに該当するプロセスがjavaプロセス以外でした。

7

プロセスID: Not owner

実行ユーザーは、コマンドの引数に指定したプロセスIDに該当するプロセスのオーナーではありません。

8

プロセスID: Now processing previous request, this request canceled

コマンドの引数に指定したプロセスIDのプロセスが現在coreを生成中です。

9

プロセスID: Timeout occurred. Java process not responding.

コマンドの引数に指定したプロセスIDに該当するプロセスから、一定時間内にcore出力処理終了の応答がありませんでした。

注意事項

javacoreコマンドは、SIGQUITシグナルを指定されたプロセスに送信します。誤ってjavaプログラム以外を指定すると、ほかのプログラムが停止することがあります。

同じJavaプロセスに対して、同時にjavacoreコマンドは実行できません。前回のjavacoreコマンドによるcore出力処理が終了したあとに実行してください。

Java VMプロセスが、スレッドダンプ取得要求に反応しないで無応答状態になっている場合には、javacoreコマンドによるcoreファイルも取得できません。この場合は、kill -6コマンドの実行によって、Java VMプロセスを強制停止させてcoreファイルを取得してください。

AIX（5L V5.1）の場合、coredumpシステムコールでcoreを生成するため、次の環境変数を設定する必要があります。環境変数が設定されていない場合、coreファイルが正常に取得できません。

cshの場合

setenv LDR_CNTRL USERREGS

shまたはkshの場合

export LDR_CNTRL=USERREGS

LDR_CNTRL環境変数に複数指定する場合、@が区切り文字になります。例えば、MAXDATAとUSERREGSの2つを指定する場合は、次のようになります。

cshの場合

setenv LDR_CNTRL MAXDATA=0x40000000@USERREGS

shまたはkshの場合

export LDR_CNTROL=MAXDATA=0x40000000@USERREGS

Linuxの場合、gdbのgcoreコマンドでcoreを生成します。gdbがインストールされていない場合には、次のエラーメッセージが標準出力に出力されます。

Error occurred in generating core file, gdb not found.

また、インストールされているgdbのバージョンが古い場合には、次のエラーメッセージが標準出力に出力されます。

Error occurred in generating core file, gdb version 5.2 or later needed.

javacoreコマンドは、実行時に、/tmp/hsperfdata_ユーザー名/プロセスIDファイルを使用します。該当するファイルが存在しない場合は、javacoreコマンドによるcoreファイルの出力はできません。ただし、-forceオプションを指定した場合、/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのJavaプロセスに対してcoreを出力させます。

4.2.6　javagc

GCの強制発生

書式

javagc [-i|-f] [-v] [-s] [-force] [-ehgc] -p プロセスID

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

メモリーリーク、システム障害およびアプリケーションのデバッグのために、プロセスIDがプロセスIDのjavaプロセスに対して、任意のタイミングでFullGCを発生させます。また、プロセスIDがプロセスIDのjavaプロセスに対して、任意のタイミングでFullGCと、Explicitメモリーブロックの解放を実行します。

javaプロセスとの通信にはSIGQUITシグナルを使用します。コマンドを実行すると、コマンドの処理内容をユーザーに確認します。n（発生させない、実行しない、または送信しない）と回答した場合には、コマンドの処理は実行されません（戻り値が1となります）。この確認動作は、-fオプションを指定することで省略できます。

プロセスIDのjavaプロセスが通常の要因で発生するCopyGCやFullGCを実行中の場合は、その終了を待ってからコマンドを実行します。

実行権限

引数のプロセスIDで指定するjavaプロセスと同一のユーザーで実行してください。

引数

-i

次に示すコマンドの処理内容をユーザーに確認します。

プロセスIDのプロセスに対して、Explicitメモリーブロックの解放を実行するかどうか

GCを発生させるためにSIGQUITシグナルを送信させるかどうか

このオプションより前に指定した、-fオプションを無効にします。

-f

次に示すコマンドの処理内容をユーザーに確認しません。

Explicitメモリーブロックの解放を実行するかどうか

GCを発生させるためにSIGQUITシグナルを送信させるかどうか

このオプションより前に指定した、-iオプションを無効にします。

-v

-XX:+HitachiVerboseGCオプションの指定がなくても、Java VMログファイル作成の規則に従ってJava VMログファイルを作成して、拡張verbosegc情報を出力します。

その際、次のオプション値も反映した内容の拡張verbosegc情報を出力します。

-XX:+HitachiVerboseGCPrintDate

-XX:+HitachiVerboseGCPrintCause

-XX:+HitachiVerboseGCCpuTime

-XX:+HitachiCommaVerboseGC

-s

標準出力に拡張verbosegc情報を出力します。

その際、次のオプション値も反映した内容の拡張verbosegc情報を出力します。

-XX:+HitachiVerboseGCPrintDate

-XX:+HitachiVerboseGCPrintCause

-XX:+HitachiVerboseGCCpuTime

-XX:+HitachiCommaVerboseGC

-force

javaプロセスが作成する/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対してGCやExplicitメモリーブロックの解放を実行します。

-ehgc

プロセスIDがプロセスIDのjavaプロセスに対して、FullGCと、Explicitメモリーブロックの解放を実行します。

自動解放機能が有効な場合の解放処理で解放されなかったExplicitメモリーブロックを、明示的に解放できます。

まず、Java VMによってFullGCが実行され、拡張verbosegc情報にGCの要因として「EMJavaGC Command」が出力されます。そのあと、次に示すExplicitメモリーブロックが解放されます。

明示管理ヒープ機能の自動解放機能が有効な場合に、明示解放予約によって予約されたExplicitメモリーブロック

明示管理ヒープ自動配置設定ファイル、またはJava VMで生成されたExplicitメモリーブロック

前回の解放処理で解放されなかったExplicitメモリーブロック

また、次の場合は、解放処理が実行されません。

最大数の制限を超えてExplicitメモリーブロックを解放しようとした場合

現存するExplicitメモリーブロックの数が1,048,575個の場合が該当します。

明示管理ヒープ機能がオフになっている場合

-XX:-HitachiUseExplicitMemoryオプションが指定されている場合が該当します。

この場合、コンストラクターの実行は成功しますが、無効なExplicitメモリーブロック（ExplicitMemoryインスタンス）として扱われます。

javagcコマンドによるExplicitメモリーブロックの解放処理では、FullGCが実行されます。このため、動作中のアプリケーションに対する処理には適していません。アプリケーションのアンデプロイ時や夜間など、アプリケーションが動作していない時間帯に実行することをお勧めします。

-p プロセスID

FullGCや、Explicitメモリーブロックの解放を実行したいプロセスIDを指定します。

型：Integer

指定できる値を次に示します。

0〜4294967295

出力形式（SerialGCの場合）

オプション"v"または"s"を指定した場合はJava VMログを出力します。

[id] <date> (Skip Full:full_count, Copy:copy_count) [gc_kind gc_info, gc_time secs][Eden: eden_info][Survivor: survivor_info][Tenured: tenured_info][Metaspace: Metaspace_info][class space: class_space_info] [cause:cause_info] [User: user_cpu secs][Sys: system_cpu secs][IM: jvm_alloc_size, mmap_total_size, malloc_total_size][TC: thread_count][DOE: doe_alloc_size, called_count][CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

出力内容を次に説明します。

id

Java VMログファイル識別子。

date

GC開始日時。

-XX:-HitachiVerboseGCPrintDateオプションが指定された場合、出力されません。

full_count

full GC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

copy_count

copy GC情報出力をスキップした回数。

-XX:HitachiVerboseGCIntervalTimeオプションが指定された場合に出力されます。

gc_kind

GC種別。「FullGC」または「GC」が出力されます。

gc_info

GC情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

gc_time

GC経過時間。

Eden

エデンの種別。「DefNew::Eden」が出力されます。

eden_info

Eden情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Survivor

Survivorの種別。「DefNew:: Survivor」が出力されます。

survivor_info

Survivor情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Tenured

Tenuredの種別。「Tenured」が出力されます。

tenured_info

Tenured情報。次の形式で出力されます。

GC前の領域長 -> GC後の領域長 (領域サイズ)

Metaspace_info

Metaspace領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

<const1>K(<const2>K, <const3>K)-><const4>K(<const5>K, <const6>K)]

<const1>: GC前のMetaspace領域の使用サイズ

<const2>: GC前のMetaspace領域のcapacity サイズ

<const3>: GC前のMetaspace領域のcommit サイズ

<const4>: GC後のMetaspace領域の使用サイズ

<const5>: GC後のMetaspace領域のcapacity サイズ

<const6>: GC後のMetaspace領域のcommit サイズ

class_space_info

class space領域のメモリー情報。次の形式で出力されます。単位はキロバイトです。

圧縮オブジェクトポインタ機能が無効の場合、出力されません。

<const1>K(<const2>K, <const3>K)-><const4>K(<const5>K, <const6>K)]

<const1>: GC前のclass space領域の使用サイズ

<const2>: GC前のclass space領域のcapacity サイズ

<const3>: GC前のclass space領域のcommit サイズ

<const4>: GC後のclass space領域の使用サイズ

<const5>: GC後のclass space領域のcapacity サイズ

<const6>: GC後のclass space領域のcommit サイズ

cause_info

GC要因内容。

-XX:-HitachiVerboseGCPrintCauseオプションが指定された場合、出力されません。

user_cpu

GCスレッドがユーザーモードで費やしたCPU時間。単位は秒です。

CPU時間取得に失敗した場合、[User: unknown]のように、「unknown」と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

system_cpu

GCスレッドがカーネルモードで費やしたCPU時間。単位は秒です。

CPU時間取得に失敗した場合、[Sys: unknown]のように、「unknown」と表示されます。

-XX:-HitachiVerboseGCCpuTimeオプションが指定された場合、出力されません。

jvm_alloc_size

Java VM内部で管理している領域のうち、現在使用中の領域のサイズ（mmap_total_sizeとmalloc_total_sizeの合計サイズのうち、現在使用中の領域のサイズ）。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

mmap_total_size

Java VM内部で管理している領域のうち、mmap（Windowsの場合はVirtualAlloc）で割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

malloc_total_size

Java VM内部で管理している領域のうち、mallocで割り当てたCヒープの総サイズ。

-XX:-HitachiVerboseGCPrintJVMInternalMemoryオプションが指定された場合、出力されません。

thread_count

Javaスレッドの数。

-XX:-HitachiVerboseGCPrintThreadCountオプションが指定された場合、出力されません。

doe_alloc_size

java.io.File.deleteOnExit()を呼び出して確保した累積のヒープサイズ。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

called_count

java.io.File.deleteOnExit()の呼び出し回数。

-XX:-HitachiVerboseGCPrintDeleteOnExitオプションが指定された場合、出力されません。

cc_used_size

GC発生時のコードキャッシュ領域の使用サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_max_size

コードキャッシュ領域の最大サイズ。単位はキロバイトです。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

cc_info

保守情報。

-XX:-PrintCodeCacheInfoオプションが指定された場合、出力されません。

出力形式（G1GCの場合）

オプション"v"または"s"を指定した場合はJava VMログを出力します。

G1GCでは、Java VMログファイルにGCに関するログ（以降、VG1ログ）とConcurrent Marking（以降、CM）に関するログ（以降、VCMログ）を出力します。CMはアプリケーションと並行で処理するため、1回のCMのログは複数行に分かれて出力されます。

VG1 ログ、VCMログの出力フォーマットの詳細を次に示します。

VG1 ログ

[id]<date>[gc_kind gc_info, gc_time secs][Status:gc_status][G1GC::Eden: eden_info][G1GC::Survivor: survivor_info][G1GC::Tenured: tenured_info][G1GC::Humongous: humongous_info][G1GC::Free: free_info][Metaspace: Metaspace_info][class space: class_space_info] [cause:cause_info][RegionSize: region_sizeK][Target: target_time secs][Predicted: predicted_time secs][TargetTenured: target_sizeK][Reclaimable: reclaimable_info][User: user_cpu secs][Sys: system_cpu secs][IM: jvm_alloc_sizeK, mmap_total_sizeK, malloc_total_sizeK][TC: thread_count][DOE: doe_alloc_sizeK, called_count][CCI: cc_used_sizeK, cc_max_sizeK, cc_infoK]

注 改行や、項目間のスペースはありません。

出力項目

出力内容

意味

id

VG1

Java VMログファイル識別子。G1GC のGCログでは「[VG1]」が出力されます。

date

<letters>

GCまたはCMが開始された日時。-XX:-HitachiVerboseGCPrintDate指定時は出力されません。

gc_kind

Full GC| Mixed GC|Young GC |Young GC(initial-mark)|CM Remark|CM Cleanup

GCまたはCMの種別。

gc_info

<const1>K/<const2>K(<const3>K)-><const4>K/<const5>K(<const6>K)

Javaヒープ領域のメモリー情報。

<const1>:GC前のJavaヒープ領域の使用サイズ。

<const2>:GC前のJavaヒープ領域の使用サイズ（リージョン換算）※1。

<const3>:GC前のJavaヒープ領域の領域サイズ（リージョン換算）。

<const4>:GC後のJavaヒープ領域の使用サイズ。

<const5>:GC後のJavaヒープ領域の使用サイズ（リージョン換算）。

<const6>:GC後のJavaヒープ領域の領域サイズ（リージョン換算）。

単位はキロバイト。

gc_time

<time>

GCによるアプリケーション停止時間。

単位は秒。

gc_status

-|to exhausted

GCの状態。

To領域あふれが発生した場合、「to exhausted」が出力されます。

上記の状態以外の場合、「-」が出力されます。

各GCで出力される状態を以下に示します。

gc_kindがYoung GCまたはYoung GC(initial-mark)またはMixed GCの場合：「-」または「to exhausted」が出力されます。

gc_kindが上記以外の場合： 「-」が出力されます。

eden_info

<const1>K(<const2>K)-><const3>K(<const4>K)

Eden領域のメモリー情報。

<const1>:GC前のEden領域の使用サイズ（リージョン換算）。

<const2>:GC前のEden領域が取り得る最大の領域サイズ（リージョン換算）※2。

<const3>:GC後のEden領域の使用サイズ（リージョン換算）。

<const4>:GC後のEden領域が取り得る最大の領域サイズ（リージョン換算）※2。

単位はキロバイト。

survivor_info

<const1>K-><const2>K

Survivor領域のメモリー情報。

<const1>:GC前のSurvivor領域の使用サイズ（リージョン換算）。

<const2>:GC後のSurvivor領域の使用サイズ（リージョン換算）。

単位はキロバイト。

tenured_info

<const1>K-><const2>K

Tenured領域のメモリー情報。

<const1>: GC前のTenured領域の使用サイズ（リージョン換算）。

<const2>: GC後のTenured領域の使用サイズ（リージョン換算）。

単位はキロバイト。

humongous_info

<const1>K-><const2>K

Humongous領域のメモリー情報。

<const1>: GC前のHumongous領域の使用サイズ（リージョン換算）。

<const2>: GC後のHumongous領域の使用サイズ（リージョン換算）。

単位はキロバイト。

free_info

<const1>K-><const2>K

Free領域のメモリー情報。

<const1>: GC前のFree領域の使用サイズ（リージョン換算）。

<const2>: GC後のFree領域の使用サイズ（リージョン換算）。

単位はキロバイト。

Metaspace_info

<const1>K(<const2>K, <const3>K)-><const4>K(<const5>K, <const6>K)]

Metaspace領域のメモリー情報。

<const1>: GC前のMetaspace領域の使用サイズ

<const2>: GC前のMetaspace領域のcapacity サイズ

<const3>: GC前のMetaspace領域のcommit サイズ

<const4>: GC後のMetaspace領域の使用サイズ

<const5>: GC後のMetaspace領域のcapacity サイズ

<const6>: GC後のMetaspace領域のcommit サイズ

単位はキロバイト。

class_space_info

<const1>K(<const2>K, <const3>K)-><const4>K(<const5>K, <const6>K)]

class space領域のメモリー情報。

圧縮オブジェクトポインタ機能が無効の場合、出力されません。

<const1>: GC前のclass space領域の使用サイズ

<const2>: GC前のclass space領域のcapacity サイズ

<const3>: GC前のclass space領域のcommit サイズ

<const4>: GC後のclass space領域の使用サイズ

<const5>: GC後のclass space領域のcapacity サイズ

<const6>: GC後のclass space領域のcommit サイズ

単位はキロバイト。

cause_info

<letters>

GC要因内容。

-XX:-HitachiVerboseGCPrintCause指定時は出力されません。

region_size

<const>

1リージョンのサイズ。

単位はキロバイト。

target_time

<time>

GCによるアプリケーション停止時間の目標時間。

単位は秒。

predicted_time

<time>

Java VMが予測したGCによるアプリケーション停止時間。

単位は秒。

GC 種別が「Full GC」、「CM Remark」または「CM Cleanup」の場合、予測を行わないため、0が出力されます。

target_size

<const>

Mixed GCでGC対象となったTenured領域のサイズ。

単位はキロバイト。

GC種別が「Mixed GC」以外の場合は0が出力されます。

reclaimable_info

<const1>K(<const2>.<digit><digit>%)

予測回収サイズ情報。

<const1>:予測回収サイズ。

単位はキロバイト。

<const2>.<digit><digit>:予測回収率（小数第2位まで）

なお、予測回収サイズ情報は、CM終了直後のYoung GCまたはMixed GCだけが出力されます。それ以外の場合、予測を行わないため、0が出力されます。

user_cpu

<time>

全GCスレッドがユーザーモードで費やしたCPU時間の合計。

単位は秒。

-XX:-HitachiVerboseGCCpuTime指定時は出力されません。

CPU 時間取得に失敗した場合には「unknown」と表示します:[User: unknown]

system_cpu

<time>

全GCスレッドがカーネルモードで費やしたCPU時間の合計。

単位は秒。

-XX:-HitachiVerboseGCCpuTime指定時は出力されません。

CPU 時間取得に失敗した場合には「unknown」と表示します:[Sys: unknown]

注※1 リージョン換算は、領域のサイズを1リージョンのサイズで切り上げ、1リージョンのサイズの倍数で表した値です。

注※2 Eden領域が取り得る最大の領域サイズは、(New領域の領域サイズ)-(Survivor領域の使用サイズ)を指します。

VCM ログ

[id]<date> [cm_event][User: user_cpu secs][Sys: sys_cpu secs]

＊改行なし。＊項目間のスペースなし。

出力項目

出力内容

意味

id

VCM

Java VMログファイル識別子。G1GCのCMログでは「[VCM]」が出力されます。

date

<letters>

CMが開始された日時。

-XX:-HitachiVerboseGCPrintDate指定時は出力されません。

cm_event

Concurrent Root Region Scan Start|Concurrent Root Region Scan End|Concurrent Mark Start|Concurrent Mark End|Concurrent Mark Stop|Concurrent Cleanup Start|Concurrent Cleanup End

CMの状態。

Concurrent Root Region Scan Start: Concurrent Root Region Scanが開始された。

Concurrent Root Region Scan End:  Concurrent Root Region Scanが終了した。

Concurrent Mark Start:Concurrent Markが開始された。

Concurrent Mark End:Concurrent Markが終了した。

Concurrent Mark Stop:Concurrent Markを中止した。

Concurrent Cleanup Start：Concurrent Cleanupが開始された。

Concurrent Cleanup End ：Concurrent Cleanupが終了した。

usr_cpu

<time>

全CMスレッドがユーザーモードで費やしたCPU時間の合計。

単位は秒。

-XX:-HitachiVerboseGCCpuTime指定時は出力されません。

CPU時間取得に失敗した場合には「unknown」と表示します:[User: unknown]

CM の状態がStartの場合、0が出力されます。

sys_cpu

<time>

全CMスレッドがカーネルモードで費やしたCPU時間の合計。

単位は秒。

-XX:-HitachiVerboseGCCpuTime指定時は出力されます。

CPU時間取得に失敗した場合には「unknown」と表示します:[Sys: unknown]

CM の状態がStartの場合、0が出力されます。

入力例

-iオプションを指定してjavagcコマンドを実行します。

javagc -i -v -p 8326

プロセスIDの確認メッセージが表示されます。

send SIGQUIT to 8326:?(y/n)

SIGQUITシグナルを送信させる場合はyを、送信させない場合はnを入力します。

send SIGQUIT to 8326:?(y/n)y

出力例

VG1 ログ

[VG1]<Thu Oct 02 10:38:56.193 2014>[Full GC 753K/2048K(8192K)->678K/1024K(8192K), 0.0097901 secs][Status:-][G1GC::Eden: 1024K(2048K)->0K(2048K)][G1GC::Survivor: 0K->0K][G1GC::Tenured: 1024K->1024K][G1GC::Humongous: 0K->0K][G1GC::Free: 6144K->7168K] [Metaspace: 3634K(4492K, 4492K)->3634K(4492K, 4492K)][class space: 356K(388K, 388K)->356K(388K, 388K)] [cause:System.gc][RegionSize: 1024K][Target: 0.2000000 secs][Predicted: 0.0000000 secs][TargetTenured: 0K][Reclaimable: 0K(0.00%)][User: 0.0000000 secs][Sys: 0.0000000 secs][IM: 20459K, 21920K, 0K][TC: 35][DOE: 0K, 0][CCI: 1172K, 245760K, 2496K]

VCM ログ

[VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan Start][User: 0.0000000 secs][Sys: 0.0000000 secs] [VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Root Region Scan End][User: 0.0126134 secs][Sys: 0.0146961 secs] [VCM]<Wed Jul 24 11:45:20 2013>[Concurrent Mark Start][User: 0.0000000 secs][Sys: 0.0000000 secs] [VCM]<Wed Jul 24 11:45:34 2013>[Concurrent Mark End][User: 0.0156250 secs][Sys: 0.2495800 secs]

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

2

一定時間内にGC処理終了の応答がありませんでした。

出力メッセージ

次のエラーメッセージまたは警告メッセージが出力された場合、Explicitヒープ詳細情報付き拡張スレッドダンプは出力されません。

項番

エラーメッセージ

説明

1

javagc [-f|-i][-v][-s] [-force] [-ehgc] -p process-id

javagcコマンドへの引数の指定が間違っています。

2

javagc: illegal option--オプション

javagcコマンドに指定したオプションが不正です。

3

プロセスID: No such process

javagcコマンドの引数に指定したプロセスIDに該当するプロセスがありません。または、javagcコマンドで指定したプロセスIDに該当するプロセスがjavaプロセス以外でした。

4

プロセスID: Not owner

実行ユーザーは、javagcコマンドの引数に指定したプロセスIDに該当するプロセスのオーナーではありません。

5

プロセスID: Now processing previous request, this request canceled

javagcコマンドの引数に指定したプロセスIDに該当するプロセスは、前回のjavagcコマンドによるGCを実行中です。javagcコマンドによるGC実行要求はキャンセルされます。

6

javagc: can't create work file at /tmp, this request canceled

/tmpに参照および書き込み権限がないため、GC要求ファイルが作成できません。javagcコマンドによるGC実行要求はキャンセルされます。

7

javagc: unexpected error occurred:エラー原因

javagcコマンド実行中に予期しないエラーが発生しました。エラー原因には、例えば下記のような表示がされます。

作業用メモリー確保に失敗した場合

malloc systemcall fail (errno=Y)

オブジェクトのクローズに失敗した場合

close systemcall fail (errno=Y)

8

プロセスID: Timeout occurred. Java process not responding.

javagcコマンドの引数に指定したプロセスIDに該当するプロセスから、一定時間内にGC処理終了の応答がありませんでした。

9

javagc : please delete 削除できなかったファイル名 in 削除できなかったファイルの絶対パス

javagcコマンドを終了したときに、内部ファイルを削除できませんでした。削除できなかったファイルの絶対パスにある、削除できなかったファイルを削除してください。

10

プロセスID: Failed to retry GC. Java process is GC locked.

javagcコマンドの引数に指定したプロセスIDのプロセスが、GC実行が抑止される状態のため、GC処理を実行できませんでした。

注意事項

同じjavaプロセスに対して、同時にjavagcコマンドは実行できません。前回のjavagcコマンドによるGC処理が終了してから実行してください。前回のGC処理が終了している場合は、Java VMログファイルに出力される拡張verbosegc機能のGCの要因に"JavaGC Command"が出力されます。

javagcコマンドはSIGQUITシグナルを指定されたプロセスIDに送信します。誤ってjavaプロセス以外のプロセスIDを指定すると、ほかのプログラムが停止することがあります。

javagcコマンド実行時に、/tmp/hsperfdata_ユーザー名/プロセスIDファイルを使用します。該当するファイルが存在しない場合は、javagcコマンドによるGCの要求はできません。ただし、-forceオプションを指定した場合、/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対してGCを発生させます。

4.2.7　javatrace

トレース情報の収集

書式

javatrace coreファイル名 実行ファイル名 [出力ファイル名]
    [-l ライブラリーファイル名 ...]

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

coreファイルからスタックトレース情報を取得します。

このコマンドは、Java VMが異常終了してcoreファイルを生成した場合、その異常終了の原因究明に必要な情報を取得するために実行するコマンドです。プロセスダウン時の詳細要因などが調査できます。

引数

coreファイル名

coreファイル名を指定します。

実行ファイル名

coreファイルを生成した実行ファイル名を指定します。

出力ファイル名

出力ファイル名を指定します。

省略した場合は、カレントディレクトリーの"javatrace.log"に出力されます。

-l ライブラリーファイル名

使用したライブラリーファイルを指定します。

共用ライブラリーが絶対パスで実行ファイルに取り込まれている場合は、自動的に読み込まれるため、指定する必要はありません。

入力例

Java VMが異常終了してcoreファイルを生成した場合、次のメッセージが表示されます。このメッセージ内のjavatraceコマンドの文字列を実行します。

なお、このメッセージは、異常終了時に生成されるエラーリポートファイル（hs_err_pidプロセスID.log）にも出力されます。

        ：
# You can get further information from javatrace.log file generated
# by using javatrace command.
# usage: javatrace core-file-name loadmodule-name [out-file-name]
# [-l(library-name)...]
# Please use javatrace command as follows and submit a bug report
# to Hitachi with javatrace.log file:
# [Application Serverインストールディレクトリー/jdk/jre/bin/javatrace core
# Application Serverインストールディレクトリー/jdk/jre/bin/java]
#

coreファイル名がcoreの場合

Application Serverインストールディレクトリー/jdk/jre/bin/javatrace core Application Serverインストールディレクトリー/jdk/jre/bin/java

OSによっては実際に出力されるcoreファイル名がcore.プロセスIDになる場合があります。その場合は、実際に出力されたcoreファイル名をjavatraceの引数に指定してください。

coreファイル名がcore.プロセスIDの場合

Application Serverインストールディレクトリー/jdk/jre/bin/javatracecore.8326 Application Serverインストールディレクトリー/jdk/jre/bin/java

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

出力メッセージ

次のエラーメッセージまたは警告メッセージを出力した場合、スタックトレース情報は出力されません。

項番

エラーメッセージ

説明

1

usage : javatrace core-filename loadmodule-name [out-filename] [-llibrary-name...]

javatraceコマンドへの引数の指定が間違っています。

2

javatrace: Cannot open file-name :No such file or directory

出力ファイルで指定したファイル以外のファイル（file-name）が見つかりません。

3

javatrace: Cannot open file-name : Permission denied

ファイル（file-name）の読み込みが許可されていません。

4

javatrace : Cannot create file-name : Already exist

出力ファイルに指定したファイル（file-name）がすでに存在しています。

5

* unknown core type(XXXXXXX) ignored.

coreファイル名で指定したファイルは、coreファイルではありません。

6

* ERROR : file-name, unknown magic(0xXXXX)

実行ファイル名で指定したファイルは、実行ファイルではありません。

7

WARNING : core file may not match loadmodule (core file from ‘loadmodule-name')

実行ファイル名で指定した実行ファイルと、coreファイル名で指定したcoreファイルから取り出した実行ファイル（loadmodule-name）が一致していません。

8

javatrace : Bad argument : argument-name is directory

指定したファイル（file-name）はディレクトリーです。

9

* ERROR : library-name open : No such file or directory

実行ファイルが取り込んだ共用ライブラリー（library-name）が見つかりません。共用ライブラリーが相対パスで取り込まれている場合には、-lオプションで共用ライブラリーを明示的に指定する必要があります。

10

javatrace : illegal option -- x

誤ったオプション文字（x）が指定されています。

11

javatrace : Cannot create file-name : Permission denied

出力ファイルで指定したファイル（file-name）の出力先に書き込み権限がありません。

注意事項

javatraceコマンドはcoreファイルが生成されたマシンで実行してください。

Java VMが異常終了した場合に標準出力とエラーリポートファイルに出力されるメッセージで、javatraceコマンドの第2引数が、次のように絶対パスのロードモジュール名になっていないことがあります。

        ：
# You can get further information from javatrace.log file generated
# by using javatrace command.
# usage: javatrace core-file-name loadmodule-name [out-file-name]
# [-l(library-name)...]
# Please use javatrace command as follows and submit a bug report
# to Hitachi with javatrace.log file:
# [Application Serverインストールディレクトリー/jdk/jre/bin/javatrace core
# Application Serverインストールディレクトリー/jdk/jre/bin/java]
#

その場合は、javatraceコマンドの第2引数に指定するロードモジュール名を、絶対パスに変換してから実行してください。

4.2.8　jheapprof

クラス別統計情報付き拡張スレッドダンプの出力

書式

jheapprof [-i|-f] [-class クラス名] [-staticroot|-nostaticroot]
    [-explicit|-noexplicit] [-fullgc|-copygc|-nogc]
    [-garbage|-nogarbage] [-rootobjectinfo|-norootobjectinfo]
    [-rootobjectinfost 値] [-force] -p プロセスID

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

引数に指定したプロセスIDのjavaプロセスについて、クラス別統計情報を含んだ拡張スレッドダンプを出力します。

各クラスのインスタンスが持つメンバーの配下にあるすべてのインスタンスのサイズを、クラスごとに統計情報として拡張スレッドダンプに出力できます。クラス別統計情報を複数回出力すると、Javaオブジェクトのサイズの変化などを確認できます。これらの情報は、メモリーリークの検出などに利用できます。

実行権限

引数のプロセスIDで指定するjavaプロセスと同一のユーザーで実行してください。

引数

-i

クラス別統計情報付き拡張スレッドダンプの出力処理の実行を確認するメッセージが表示されます。表示されたメッセージに対してyまたはnを入力します。このとき、yを入力すると、クラス別統計情報を含んだ拡張スレッドダンプが出力されます。nを入力すると、何も出力しないで処理を終了します。省略した場合、-fオプションが指定されないかぎり、このオプションは有効です。

-f

-iオプションを無効にします。省略した場合、-iオプションが有効になります。

-class クラス名

クラス名に指定したクラス（インスタンス）をメンバーに持つクラスの構造を、一覧にしてスレッドダンプ中に出力します。

-staticroot

staticフィールドを基点とした参照関係情報出力機能を有効にし、staticフィールドを基点とした参照関係情報を出力します。省略した場合、-nostaticrootオプションが有効になります。

このオプションの前提は、-classオプションです。-classオプションの指定がない場合、このオプションは無効になります。

なお、このオプションと-nostaticrootオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-nostaticroot

staticフィールドを基点とした参照関係情報出力機能を無効にします。

なお、このオプションと-staticrootオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-explicit

インスタンス統計機能の統計対象にExplicitヒープを含めます。省略した場合、-noexplicitオプションが指定されないかぎり、このオプションは有効です。なお、このオプションと-noexplicitオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-noexplicit

インスタンス統計機能の統計対象にExplicitヒープを含めません。省略した場合、-explicitオプションが有効になります。なお、このオプションと-explicitオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-fullgc

統計する前に実行するGCにFullGCを設定します。省略した場合、-copygcオプションや-nogcオプションが指定されないかぎり、このオプションは有効です。なお、このオプションと-copygcオプションまたは-nogcオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-copygc

統計する前に実行するGCにCopyGCを設定します。このオプションと-nogcオプションを省略した場合、-fullgcオプションが有効になります。

なお、このオプションと-fullgcオプションまたは-nogcオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-nogc

統計する前にGCを実行しません。このオプションと-copygcオプションを省略した場合、-fullgcオプションが有効になります。なお、このオプションと-fullgcオプションまたは-copygcオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-garbage

Tenured領域内不要オブジェクト統計機能が有効になり、Tenured領域内の不要なオブジェクトを統計対象としたクラス別統計情報を出力します。また、インスタンス統計機能とSTATICメンバー統計機能は無効になります。省略した場合、-nogarbageオプションが有効になります。統計前GC選択機能については、-fullgcオプション、-copygcオプションが無効になり、-nogcオプションは有効になります。このため、統計処理前にGCを実行しません。なお、このオプションと-nogarbageオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-nogarbage

Tenured領域内不要オブジェクト統計機能が無効になります。そのため、Tenured領域内の不要なオブジェクトを統計対象としたクラス別統計情報は出力しません。省略した場合、-garbageオプションが指定されないかぎり、このオプションは有効です。なお、このオプションと-garbageオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-rootobjectinfo

Tenured増加要因の基点オブジェクトリスト出力機能が有効になり、Tenured増加要因の基点オブジェクトリストを出力します。

このオプションは、-garbageオプションが有効であることが前提です。そのため、-nogarbageオプションを有効にすると、このオプションは無効になります。省略した場合、-norootobjectinfoオプションが指定されないかぎり、このオプションは有効です。なお、このオプションと-norootobjectinfoオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-norootobjectinfo

Tenured増加要因の基点オブジェクトリスト出力機能が無効になります。そのため、Tenured増加要因の基点オブジェクトリストは出力しません。省略した場合、-rootobjectinfoオプションが有効になります。なお、このオプションと-rootobjectinfoオプションを同時に指定している場合、最後に指定しているオプションが有効になります。

-rootobjectinfost 値

Tenured増加要因の基点オブジェクトリストの情報量を調節します。インスタンスサイズの合計が、指定した値以上のクラス情報だけが、Tenured増加要因の基点オブジェクトリストに出力されます。

このオプションは、-rootobjectinfoオプションが有効であることが前提です。そのため、-norootobjectinfoオプションを有効にすると、このオプションは無効になります。値には0以上の自然数を指定できます。自然数以外や、文字列を指定した場合は、引数の指定に誤りがあるという内容のエラーメッセージが出力されて終了します。

デフォルト値：0

-force

javaプロセスが作成する/tmp/hsperfdata_ユーザー名/プロセスIDファイルの有無の確認をしないで、-pオプションで指定したプロセスIDのjavaプロセスに対して拡張スレッドダンプの出力を要求します。

-p プロセスID

プロセスIDには、クラス別統計情報を出力するjavaプログラムのプロセスIDを指定します。

型：Integer

指定できる値を次に示します。

0〜4294967295

出力形式

クラス別統計情報を拡張スレッドダンプに出力するには、jheapprofコマンドを利用します。クラス別統計情報を出力したいJavaプロセスや、参照関係情報を出力したいクラスを指定して、jheapprofコマンドを実行します。

jheapprofコマンド実行時には、次の指定ができます。

クラス別統計情報にExplicitヒープの情報を出力するかどうかの指定

クラス別統計情報を取得する前にGCを実行するかどうかの指定

jheapprofコマンドの実行例を次に示します。

ここでは、プロセスIDが2463のJavaプロセスのクラス別統計情報を出力します。

-pオプションに、クラス別統計情報を出力したいJavaプロセスのプロセスIDを指定して、jheapprofコマンドを実行します。

% jheapprof -p 2463

jheapprofコマンドで-fオプションを省略している場合、次の確認メッセージが表示されます。

プロセスIDを確認するメッセージが次の形式で表示されます。

send SIGQUIT to 2463: ? (y/n)

yを入力します。

クラス別統計情報付き拡張スレッドダンプが出力されます。実行中のjavaプログラムでは次のメッセージが出力されます。

Writing Java core to javacore2463.030806215140.txt... OK

実行中のjavaプログラムは、カレントディレクトリーにクラス別統計情報付き拡張スレッドダンプ（javacoreプロセスID.日時.txt）を作成し、プログラムを継続します。

Explicitヒープの情報をクラス別統計情報に出力する場合

次の条件を満たしている場合、Explicitヒープの情報をクラス別統計情報に出力できます。

Java VM起動オプションに-XX:+HitachiUseExplicitMemoryを指定している。

アプリケーションの実装、または実行環境（J2EEサーバ）の設定でExplicitヒープが使用されている。

Explicitヒープの情報をクラス別統計情報に出力する場合は、jheapprofコマンドに-explicitオプションを指定して実行します。

GCの実行有無を指定する場合

クラス別統計情報を出力する前に、GCを実行するかどうかを選択できます。この機能を統計前のGC選択機能といいます。クラス別統計情報を出力する前に、GCを実行するかどうかは、jheapprofコマンドに次のどれかのオプションを指定して実行します。

-fullgc

FullGCを実行してから、クラス別統計情報を出力します。

-copygc

CopyGCを実行してから、クラス別統計情報を出力します。

-nogc

GCを実行しないで、クラス別統計情報を出力します。

入力例

-fオプションを省略してjheapprofコマンドを実行します。

% jheapprof -p 2463

プロセスIDの確認メッセージが表示されます。

send SIGQUIT to 2463: ? (y/n)

SIGQUITシグナルを送信させる場合はyを、送信させない場合はnを入力します。

send SIGQUIT to 2463: ? (y/n)y

クラス別統計情報付き拡張スレッドダンプを出力すると、実行中のjavaプログラムでは次のメッセージが出力されます。

Writing Java core to javacore2463.030806215140.txt... OK

実行中のjavaプログラムは、カレントディレクトリーにクラス別統計情報付き拡張スレッドダンプ（javacoreプロセスID.日時.txt）を作成し、プログラムを継続します。

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

2

一定時間内にクラス別統計情報出力処理終了の応答がありませんでした。

出力メッセージ

次のエラーメッセージまたは警告メッセージが出力された場合、クラス別統計情報付き拡張スレッドダンプは出力されません。

項番

エラーメッセージ

説明

1

usage: jheapprof [-f|-i] [-class classname] [-staticroot|-nostaticroot] [-explicit|-noexplicit] [-fullgc|-copygc|-nogc] [-garbage|-nogarbage] [-rootobjectinfo|-norootobjectinfo] [-rootobjectinfost size] [-force] -p process-id

jheapprofコマンドへの引数の指定が間違っています。

2

jheapprof: illegal option -- オプション

jheapprofコマンドに指定したオプションが不正です。

3

プロセスID: Now processing previous request, this request canceled

jheapprofコマンドの引数に指定したプロセスIDに該当するプロセスが現在クラス別統計情報の出力中です。

4

プロセスID: No such process

jheapprofコマンドの引数に指定したプロセスIDに該当するプロセスがありません。または、jheapprofコマンドで指定したプロセスIDに該当するプロセスがjavaプロセス以外でした。

5

プロセスID: Not owner

jheapprofコマンドの引数に指定したプロセスIDのプロセスのオーナーではありません。

6

jheapprof: can't create work file at /tmp , this request canceled

一時ファイル用ディレクトリーに参照・書き込み権限がない場合、クラス別統計情報付き拡張スレッドダンプを出力できません。クラス別統計情報付き拡張スレッドダンプの出力要求はキャンセルされます。

7

jheapprof: please delete 削除できなかったファイル名 in 削除できなかったファイルの絶対パス

jheapprofコマンドを終了したときに、内部ファイルを削除できませんでした。削除できなかったファイルのフルパスにある、削除できなかったファイルを削除してください。

8

jheapprof: unexpected error occurred: エラー原因

jheapprofコマンド実行中に予期しないエラーが発生しました。

エラー原因には、例えば下記のような表示がされます。

作業用メモリー確保に失敗した場合

malloc systemcall fail (errno=Y)

オブジェクトのクローズに失敗した場合

close systemcall fail (errno=Y)

9

プロセスID: Timeout occurred. Java process not responding

jheapprofコマンドの引数に指定したプロセスIDに該当するプロセスから、一定時間内にクラス別統計情報出力処理終了の応答がありませんでした。

10

プロセスID: Failed to retry GC. Java process is GC locked.

jheapprofコマンドの引数に指定したプロセスIDのプロセスが、GC実行が抑止される状態のため、GC処理を実行できませんでした。

注意事項

jheapprofコマンドはプログラムの開発用ユーティリティーとして提供しているものです。システムの運用では使用しないでください。

同じjavaプロセスに対して、同時にjheapprofコマンドは実行できません。前回のjheapprofコマンドによるクラス別統計情報が拡張スレッドダンプに出力されたあとに実行してください。

jheapprofコマンドは、SIGQUITシグナルを指定されたプロセスに送信します。誤ってjavaプログラム以外を指定すると、ほかのプログラムが停止することがあります。

jheapprofコマンド実行時に、/tmp/hsperfdata_ユーザー名/プロセスIDファイルを使用します。該当するファイルが存在しない場合、jheapprofコマンドによるクラス別統計情報出力はできません。

Explicitヒープをインスタンス統計情報の統計対象に含めるためには、-XX:+HitachiUseExplicitMemoryを指定して、明示管理ヒープ機能を有効にしているjavaプロセスに対して、jheapprofコマンドで-explicitオプションを指定してください。なお、-XX:-HitachiUseExplicitMemoryを指定して、明示管理ヒープ機能を無効にしている場合、-explicitを指定してもExplicitヒープ内のインスタンスはインスタンス統計情報の統計対象になりません。

4.2.9　jheapprofanalyzer

クラス別統計情報解析ファイルのCSV出力

書式

jheapprofanalyzer [-J オプション名] [ファイル名]

格納先

Application Serverインストールディレクトリー/jdk/jre/bin/

機能

クラス別統計情報の付いた複数の拡張スレッドダンプファイルを入力ファイルとして、クラスごとのインスタンスの合計サイズ、およびクラスごとのインスタンス数を時系列に出力します。出力するファイルは、CSV形式です。

クラス別統計情報解析機能では、インスタンスの合計サイズが大きいインスタンスの情報を出力して、そのインスタンスのメモリー使用量だけを確認することもできます。インスタンスの合計サイズが大きいものだけを出力する場合には-DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.thresholdにしきい値を指定し、jheapprofanalyzerコマンドに指定して実行します。

ファイル

クラス別統計情報付き拡張スレッドダンプファイル(javacoreプロセスID.日時.txt)

引数

-J オプション名

オプション名には、次のオプションを指定できます。また、次のオプション以外を指定した場合は、動作保証の対象外となります。

-Xms

メモリー割り当てプールの初期サイズをバイト数で指定します。

-Xmx

メモリー割り当てプールの最大サイズをバイト数で指定します。

-DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.threshold=num

num: インスタンス合計サイズのしきい値を設定します。範囲は0〜2⁶³-1 （Long.MAX_VALUE）です。インスタンス合計サイズがnum以上のクラスだけ出力します。

デフォルト値：1024

ファイル名

クラス別統計情報付き拡張スレッドダンプファイルを指定できます。ファイル名称の規定は、特にありません。また、ファイルの指定は、順不同であり、数に制限はありません。

出力形式

ここでは、クラス別統計情報解析機能の入力ファイル、出力ファイル、および出力形式について説明します。

入力ファイル

クラス別統計情報解析機能で使用する入力ファイルは、クラス別統計情報を出力した拡張スレッドダンプファイルです。

出力ファイル

クラス別統計情報解析機能で出力するファイルは、クラスごとのインスタンスの合計サイズを出力したファイル、およびクラスごとのインスタンス数を出力したファイルの2種類です。出力ファイルはカレントディレクトリーに次のファイル名で作成されます。

出力ファイルの種類

出力ファイルのファイル名の例

インスタンス合計サイズファイル

JheapprofAnalyzer_size_nnn.csv

インスタンス数ファイル

JheapprofAnalyzer_num_nnn.csv

（凡例）

nnn：ファイルの分割番号が出力されます。分割番号の範囲は001〜999です。

列が201列を超える場合は出力ファイルが分割されます。また、999ファイルを超えた場合は、001に戻りファイルは書き換えられます。

分割する列数は、201列（クラス名1列＋値200列）を超えた場合とし、出力形式は分割したファイルも同じになります。

出力形式

クラス別統計情報解析機能で出力されるファイルの出力形式を次の表に示します。なお、インスタンス合計サイズ、およびインスタンス数が出力されたCSVファイルの出力形式は同じです。1列目はクラス名、入力ファイル名は最大200個（列）です。

class name,

入力ファイル名,

入力ファイル名,

・・・

入力ファイル名

クラス名,

値-1-1,

値-1-2,

・・・

値-1-xxx

:

:

:

・・・

:

クラス名,

値-y-1,

値-y-2,

・・・

値-y-xxx

（凡例）

入力ファイル名:処理対象に指定したクラス別統計情報

クラス名:入力ファイルに出力されていたクラス名

値:インスタンスの合計サイズ、またはインスタンス数

クラス名と値、および値と値の間はコンマで区切ります。また、行の最後は値（スペースも含む）で終了します。

クラス名の出力順はランダムです。値は入力ファイルの先頭行にある日付を基に、日付の古いものから横に並びます。同じ日付の入力ファイルがある場合はランダムに連続して横に並びます。

参考

クラス別統計情報解析機能を複数回実行すると、処理途中のクラスが消滅したり追加されたりする場合があります。また、該当するクラスがない場合の値には0が出力されます。クラス情報の例を使用して説明します。

1回目のクラス別統計情報(A.txt)

2回目のクラス別統計情報(B.txt)

3回目のクラス別統計情報(C.txt)

ClassA    100
ClassB    100

ClassA    100
ClassB     30
ClassC     50
ClassD      0

ClassA    100

ClassC     50

上記のようなクラス情報の場合で、-DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.thresholdのしきい値を0にしたときの出力結果は次のようになります。

class name,A.txt,B.txt,C.txt
ClassA, 100,100, 100
ClassB, 100, 30, 0
ClassC, 0, 50, 50
ClassD, 0, 0, 0

インスタンス合計サイズの最大値は0〜2⁶³-1、インスタンス数の最大値は0〜2³¹-1です。1つの入力ファイルに同じクラス名がある場合は、インスタンスサイズの合計が加算されます。また、インスタンス数も加算されます。加算されたことによって、それぞれの最大値を超えた場合は、指定した最大値が出力されます。なお、1つのクラスについて、すべての入力ファイルで該当するクラスの情報がない、またはしきい値未満の場合は、そのクラスの情報は出力されません。

入力例

jheapprofanalyzer -J-Xms1024m -J-Xmx1024m -J-DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.threshold=5000 javacore22356.080523161703.txt javacore22356.080523161711.txt

戻り値

戻り値

説明

0

正常終了しました。

1

異常終了しました。

出力メッセージ

次のエラーメッセージが出力された場合、クラス別統計情報解析ファイルは出力されません。また、次のエラーメッセージ以外が出力された場合は、デフォルトの例外処理となります。

項番

エラーメッセージ

説明

出力後の動作

1

usage: jheapprofanalyzer [options] file...where options include:-J-Xms<size> set initial Java heap size-J-Xmx<size> set maximum Java heap size-J-DJP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.threshold=<num> set instance total size threshold

JheapprofAnalyzerクラスへの引数の指定が間違っています。

(a)

2

JheapprofAnalyzer: Illegal property valuenum. Default is assumed.

JP.co.Hitachi.soft.jvm.tools.jheapprofanalyzer.thresholdのnumに数字以外を指定しました。またはnumが範囲外となっています。

(b)

3

JheapprofAnalyzer: can't open input fileファイル名

ディレクトリーにファイル名がありません。または、別の原因でファイルを開けません。

(c)

4

JheapprofAnalyzer: can't read input fileファイル名

ファイル名の読み込みに失敗しました。

(c)

5

JheapprofAnalyzer: Illegal input file formatファイル名

ファイル名は、クラス別統計情報付き拡張スレッドダンプファイルではありません。

(c)

6

JheapprofAnalyzer: can't open output fileファイル名

出力ファイルが開けません。エラーの原因として、次の状態が考えられます。

出力ファイルがディレクトリーとなっています。

出力ファイルがありません。

別の原因で出力ファイルを開けません。

(a)

7

JheapprofAnalyzer: can't write output fileファイル名

ファイル名の書き込みに失敗しました。

(a)

（凡例）

(a):エラーとなり処理を終了します。

(b):デフォルトを仮定して処理を続行します。

(c):処理を続行し、指定したすべての入力ファイルのエラーチェックをします。

注意事項

クラス別統計情報解析機能では、日付を取得するときと、データを読み込むときにファイルを開きます。そのため、コマンド実行中に入力ファイルの更新および削除の操作をした場合の結果は保証されません。

5　PRFで使用するコマンド

この章では、PRF（性能解析トレース）で使用するコマンドの書式、機能などについて説明します。

5.1　PRFで使用するコマンドの一覧

PRF（性能解析トレース）で使用するコマンドの一覧を次の表に示します。

PRFデーモンの起動や停止で使用するコマンド

コマンド名称

要約

概要説明

cprfgetpid

PRFデーモンプロセスIDの取得

PRFデーモンのプロセスIDを取得します。

cprfstart

PRFデーモンの開始

PRFデーモン（cprfd）を起動します。

cprfstop

PRFデーモンの停止

PRFデーモン（cprfd）を停止します。

トレース情報の出力で使用するコマンド

コマンド名称

要約

概要説明

cprfed

性能解析トレース情報の編集出力

性能解析トレース情報を編集出力します。

cprfflush

バッファー内容の強制ファイル出力

バッファー内のトレース情報を出力します。

cprflevel

PRFトレース取得レベルの表示と変更

PRFトレース取得レベルを表示または変更します。

重要

コマンドの引数には、各コマンドで指定できる値を指定してください。それ以外の値が指定された場合、動作は保証されません。

コマンドが正常に終了しても、エラーが発生している場合があります。メッセージログやスタックトレースログを確認してください。

5.2　PRFデーモンの起動や停止で使用するコマンド

PRFデーモンの起動や停止で使用するコマンドの書式、機能などについて説明します。

5.2.1　cprfgetpid

PRFデーモンプロセスIDの取得

書式

cprfgetpid [-PRFID PRF識別子] [-h]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

指定したPRF識別子のプロセスIDを取得します。また、PRFデーモンの起動確認を表示します。

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

前提条件

PRFデーモンと同じPRFSPOOL環境変数が設定されている必要があります。

PRFデーモンが一度も起動していない、または正常終了したあとにこのコマンドを実行した場合は、エラーになります。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-PRFID PRF識別子

PRF識別子には、asadminのcreate-prfサブコマンドでPRFを構築したときに付けたPRFサーバの名称を指定します。PRF識別子は1〜31文字の英数字、またはアンダースコア（_）で指定します。"TSC"や"tsc"、または"CTM"や"ctm"で始まる文字列は指定しないでください。

デフォルト値：PRF_ID

-h

コマンドの使用方法を表示します。

入力例・出力例

入力例

cprfgetpid

出力例

出力結果は、標準出力に出力されます。

1700

戻り値

戻り値

説明

0

正常終了しました。プロセスは起動していない場合があります。

1

プロセスは起動していません。

2

PRFSPOOL環境変数が設定されていません。

上記以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

5.2.2　cprfstart

PRFデーモンの開始

書式

cprfstart [-h] [-PRFID PRF識別子] [-PrfTraceLevel
    PRFトレース取得レベル[,[PRFトレース取得レベル]...]]
    [-PrfTraceCount PRFトレースファイル数]
    [-PrfTraceFileSize PRFトレースファイルサイズ]
    [-PrfTraceBufferSize PRFトレースバッファーサイズ]
    [-PrfRemakeBuffer] [-PrfNoBackUp [0|1]] [-PrfConsole {0|1}]
    [-PrfLogShiftTime PRFログシフト時刻]
    [-PrfLogFileSize PRFログサイズ] [-PrfLogFileCount PRFログ最大個数]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

PRFデーモン（cprfd）を起動します。なお、PRFデーモンは、ほかのプロセスよりも先に起動してください。

PRFデーモンは開始後にカレントディレクトリーを移動します。移動先は、次のディレクトリーです。

PRFトレース出力ディレクトリー$PRFSPOOL/utt/prf/PRF識別子/

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

前提条件

PRFSPOOL環境変数を設定してください。設定していない場合、コマンドがエラーリターンします。

OSインストール後のデフォルトの設定では、/etc/hostsファイルに127.0.0.1のIPアドレスに対して自ホスト名が設定されます。PRFを使う場合には、ネットワークインターフェースに割り当てられたIPアドレスに対して自ホスト名が設定されている必要があります。そのため、/etc/hostsファイルには、自ホスト名に対してネットワークインターフェースに割り当てられた適切なIPアドレスを設定してください。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-h

コマンドの使用方法を表示します。

-PRFID PRF識別子

PRF識別子には、asadminのcreate-prfサブコマンドでPRFを構築したときに付けたPRFサーバの名称を指定します。PRF識別子は1〜31文字の英数字、またはアンダースコア（_）で指定します。"TSC"や"tsc"、または"CTM"や"ctm"で始まる文字列は指定しないでください。

デフォルト値：PRF_ID

-PrfTraceLevel PRFトレース取得レベル [,[PRFトレース取得レベル]...]

-PrfTraceLevelを省略した場合は標準レベルで情報を出力します。

PRFトレース取得レベルを4バイトの16進数（8桁の値）で指定します。ここで4バイトの16進数の先頭に0xを付けることができますが、0xは無視されます。

各インデックス番号のレベル値をコンマ（,）区切りで左から複数指定できます。レベル値の指定を省略する場合は、値を記述しないでください。また、あるインデックス番号以降の値をすべて指定しない場合は、コンマ（,）の記述を省略してください。インデックス番号1のトレース取得レベルを（1）、インデックス番号2のPRFトレース取得レベルを（2）とした場合、PRFトレース取得レベルは「（1）,（2）,...」と指定します。

PRFトレース取得レベルの指定例を次に示します。

PRFトレース取得レベルの指定例

オプションの指定

インデックス番号1のPRFトレース取得レベルを指定する

-PrfTraceLevel 0x44445555

インデックス番号1とインデックス番号2のPRFトレース取得レベルを指定する

-PrfTraceLevel 0x44445555,0x55554444

インデックス番号2のPRFトレース取得レベルを指定する

-PrfTraceLevel ,0x55554444

各機能レイヤーでのPRFトレース取得レベルの割り当てについて説明します。

PRFトレース取得レベルは、インデックスごとに8桁の16進数で指定します。それぞれの桁には、機能レイヤーが2つずつ割り当てられています。16進数を2進数にした場合の上位2ビットに割り当てられている機能レイヤーを上位レイヤー、下位2ビットに割り当てられている機能レイヤーを下位レイヤーといいます。

桁ごとの上位レイヤー、下位レイヤーに割り当てられている機能レイヤーについて、次の表に示します。

インデックス

桁番号

上位レイヤー

下位レイヤー

インデックス1

1桁目

（なし）

Java EE Server

2桁目

（なし）

Java VM

5桁目

（なし）

uCosminexus TP1 Connector、TP1/Client/J

PRFトレース取得レベルを指定する場合は、桁ごとの上位レイヤー、下位レイヤーのPRFトレース取得レベルを「標準」「詳細」「保守」のどのレベルで取得するかを決め、それを16進数で指定します。上位レイヤーと下位レイヤーのPRFトレース取得レベルの組み合わせと指定値の対応を、次の表に示します。

なお、保守レベルは、障害発生時などの保守情報を取得するためのレベルです。通常は指定しないでください。

表5‒1　詳細レベルまたは保守レベルのトレース情報を取得する場合の指定値（cprfstartコマンド）

上位レイヤー

下位レイヤー

指定値

標準

標準

0

標準

詳細

1

標準

保守

2

詳細

標準

4

詳細

詳細

5

詳細

保守

6

保守

標準

8

保守

詳細

9

保守

保守

a

PRFトレース取得レベルの指定例を、次の表に示します。

インデックス

指定例

説明

インデックス1

00000000

インデックス1の各機能レイヤーの標準レベルのトレース情報を取得します。

10000000

Java EE Serverだけ詳細レベルのトレース情報を取得して、ほかの機能レイヤーは標準レベルのトレース情報を取得します。

11000000

Java EE ServerおよびJava VMの詳細レベルのトレース情報を取得します。

-PrfTraceCount PRFトレースファイル数

PRFトレースファイルの面数を3〜256の範囲で指定します。

正常停止中と前回強制停止後の再起動中に、PRFトレースファイルをバックアップします。PRFトレースファイルサイズの合計値が大きい場合、バックアップ処理でPRFデーモンの起動や停止に時間が掛かることがあります。そのため、ドメイン管理サーバでプロセス監視する場合、デフォルトの監視時間ではタイムアウトが発生する場合があります。タイムアウトが発生した場合には、監視時間を長くしてください。

デフォルト値：4

-PrfTraceFileSize PRFトレースファイルサイズ

PRFトレースファイルの１ファイル当たりの最大容量を1024〜1048576（単位：キロバイト）の範囲で指定します。ファイル容量を1メガバイトとする場合、1024と指定します。実際のファイルサイズは、この値より多少の増減があります。増減の中で増分の幅は、最大で「-PrfTraceBufferSize指定値−32キロバイト」です。

-PrfNoBackUpオプションに0を指定した場合、正常停止中と前回強制停止後の再起動中に、PRFトレースファイルをバックアップします。PRFトレースファイルサイズの合計値が大きい場合、バックアップ処理でPRFデーモンの起動や停止に時間がかかることがあります。そのため、-PrfNoBackUpオプションに0を指定してドメイン管理サーバでプロセス監視する場合、デフォルトの監視時間ではタイムアウトが発生する場合があります。タイムアウトが発生した場合には、監視時間を長くしてください。

デフォルト値：8192

デフォルト値の8192より小さい値を指定する場合は、-PrfTraceBufferSizeもデフォルト値より小さい値を指定してください。

-PrfTraceBufferSize PRFトレースバッファーサイズ

共用メモリーに確保するバッファーサイズを512〜102400（単位：キロバイト）の範囲で指定します。このオプションには、-PrfTraceFileSizeで指定した値よりも大きい値は指定できません。

バッファー領域が不足するとKFCT26999-Wメッセージが出力され、PRFトレースが欠落する場合があります。そのため、メッセージが出力されなくなるまでバッファー領域を拡張してください。

デフォルト値：8192

-PrfRemakeBuffer

共用メモリーを再作成して起動します。再作成できない場合にはエラーとなります。

-PrfNoBackUp [0|1]

PRFデーモンの起動時、および停止時にPRFトレースファイルをバックアップするかを指定します。

値に0を指定した場合、PRFトレースファイルをバックアップします。PRFトレースファイルをコピーするため、PRFデーモンの起動、および停止に時間が掛かることがあります。障害発生後、PRFトレースがラップするまでの間にPRFトレースファイルを採取できない場合は、値に0を指定してください。なお、ドメイン管理サーバを使用している時は、障害発生後にPRFトレースファイルを含むsnapshotログを自動的に収集します。

値に1を指定した場合、PRFトレースファイルをバックアップしません。

PRFトレースファイルをバックアップするタイミング、バックアップの有無、および-PRFNoBackUpオプションの関係は次のようになります。

実行コマンド

前回開始したPRFデーモンの終了状態

PRFトレースファイルのバックアップ

-PrfNoBackUp 0

-PrfNoBackUp 1

cprfstart

正常終了

しない

しない

強制終了または異常終了

する

しない

cprfstop

終了状態に依存しない

する

しない

cprfstop -Force

終了状態に依存しない

しない

しない

デフォルト値：1

-PrfConsole {0|1}

Windowsのデスクトップからcprfstartコマンドを実行した場合、PRFデーモンのDOSプロンプトを表示するかどうかを指定します。このオプションはWindows以外のOSでは効果はありません。

指定できる値を次に示します。

1

DOSプロンプトを表示します。

0

DOSプロンプトを表示しません。

デフォルト値：0

-PrfLogShiftTime PRFログシフト時刻

PRFが出力するログファイルを時刻でシフトさせる場合のシフト時刻を指定します。ログのシフトは、ログファイルにログを出力するタイミングでシフトします。このため、ログの出力がない場合、ログはシフトされません。

指定できる値を次に示します。

000000〜235959

デフォルト値：000000

-PrfLogFileSize PRFログサイズ

PRFが出力するログファイルサイズの上限をメガバイト単位で指定します。

指定できる値を次に示します。

1〜100

デフォルト値：10

-PrfLogFileCount PRFログファイル最大個数

PRFが出力するログファイルの最大個数を指定します。

指定できる値を次に示します。

1〜32

デフォルト値：8

戻り値

戻り値

説明

0

PRFデーモンが正常に起動しました。

1

PRFデーモンの起動に失敗しました。PRFSPOOL環境変数が設定されていません。

上記以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

注意事項

PRFデーモンを再起動する場合、-PrfTraceCountと-PrfTraceFileSizeに前回と同じ値を指定して再起動してください。指定を省略して再起動した場合、PRFトレースファイル数とPRFトレースファイルサイズについては、前回の起動時の値は引き継がれないので、デフォルトの値になります。

PRFデーモンが異常終了して再起動した場合、終了時のトレース取得レベルが引き継がれます。そのため、トレース取得レベルを変更したあとに異常終了した場合、再起動時に指定したトレース取得レベル（前回起動時と同じ値）と異なる値（変更後の値）が設定されます。次に運用例を示します。

PRFデーモン起動：cprfstart -PrfTraceLevel 0x00000001

トレース取得レベル変更（0x00000001 → 0x0000000f）

PRFデーモン異常終了

PRFデーモン再起動：cprfstart -PrfTraceLevel 0x00000001

この場合、再起動後のトレース取得レベルは、0x000000fになります。

PRFデーモンを再起動する場合、前回使用したバッファーを再利用し、トレース取得レベルを引き継ぎます。また、バッファーのサイズが変更になった場合は、前回のバッファーを削除し、再作成します。ほかのプロセスがバッファーにアクセスしている場合、この作成処理に失敗します。

$PRFSPOOL/utt/prf/PRF識別子/spool/save/

PRFデーモンが異常終了した場合、PRFデーモンだけを再起動してください。

PRFデーモンが異常終了してから再起動するまでの間に取得されたトレースは破棄されます。

-PrfTraceCountまたは-PrfTraceFileSizeに大きな値を指定すると、PRFデーモンが異常終了したあとのPRFデーモンの再起動に時間が掛かる場合があります。

5.2.3　cprfstop

PRFデーモンの停止

書式

cprfstop [-PRFID PRF識別子] [-Force] [-h]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

PRFデーモン（cprfd）を停止します。なお、PRFデーモンはほかのプロセスよりもあとに停止してください。

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

前提条件

停止するPRFデーモンと同じPRFSPOOL環境変数が設定されている必要があります。設定されていない場合、コマンドがエラーリターンします。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-PRFID PRF識別子

PRF識別子には、asadminのcreate-prfサブコマンドでPRFを構築したときに付けたPRFサーバの名称を指定します。PRF識別子は1〜31文字の英数字、またはアンダースコア（_）で指定します。"TSC"や"tsc"、または"CTM"や"ctm"で始まる文字列は指定しないでください。

デフォルト値：PRF_ID

-Force

PRFデーモンを強制停止します。

-h

コマンドの使用方法を表示します。

戻り値

戻り値

説明

0

PRFデーモンが正常に停止しました。

1

PRFデーモンが起動していません。PRFSPOOL環境変数が異なっている、または-PRFIDの値が誤っているおそれがあります。

2

PRFSPOOL環境変数が設定されていません。

3

タイムアウトが発生しました。

上記以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

注意事項

コマンドがタイムアウトして、PRFデーモンが正常終了しなかった場合は、-Forceオプションを指定して強制停止してください。

cprfstartコマンドの-PrfTraceCountまたは-PrfTraceFileSizeに大きな値を指定すると、PRFデーモンの正常停止に時間が掛かる場合があります。

5.3　トレース情報の出力で使用するコマンド

トレース情報の出力で使用するコマンドの書式、機能などについて説明します。

5.3.1　cprfed

性能解析トレース情報の編集出力

書式

cprfed [-h]|[-Dump|-CSV] [-Time 開始時刻,終了時刻]
    [-ProcessID プロセスID[,プロセスID...]]
    [-TraceFile PRFトレースファイル名[,PRFトレースファイル名...]
    |-AllTraceFile] [-Compact] [-AscLen ASCII表示文字数]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

PRFトレース情報を入力して、性能解析トレース情報を編集出力します。

PRFデーモンが起動している場合は、先にcprfflushコマンドを実行してバッファー内のトレース情報を書き出してからこのコマンドを実行してください。

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-h

コマンドの使用方法を表示します。

-Dump

詳細情報をダンプ形式で出力します。

-CSV

詳細情報をCSV形式で出力します。

-Time 開始時刻,終了時刻

指定された時刻内に取得されたトレース情報だけを出力します。

開始時刻、終了時刻は、hhmmss[MMdd[yyyy]]形式で指定します。MMdd、yyyyは省略できます。省略した場合は、コマンドを実行した月日年が指定されます。

時刻の文字列の形式：hhmmss[MMdd[yyyy]]

hh：時（00〜23）

mm：分（00〜59）

ss：秒（00〜59）

MM：月（01〜12）

dd：日（01〜31）

yyyy：年（1970〜20xx）

2003年10月11日にコマンドを実行した場合の引数の指定例とその編集範囲の例を次に示します。

引数の指定

編集範囲

-Time 102345,

2003年10月11日10時23分45秒からトレースファイルの最後まで。

-Time ,102345

トレースファイルの最初から2003年10月11日10時23分45秒まで。

-Time 102345,102350

2003年10月11日10時23分45秒から2003年10月11日10時23分50秒まで。

-Time 1023451012,1023501013

2003年10月12日10時23分45秒から2003年10月13日10時23分50秒まで。

-Time 10234510122002,10235010132002

2002年10月12日10時23分45秒から2002年10月13日10時23分50秒まで。

-ProcessID プロセスID

指定されたプロセスIDの情報だけを編集出力します。プロセスIDは10進数で指定してください。

-TraceFile PRFトレースファイル名

PRFトレースファイルを指定します。トレースファイルは最大256個指定できます。このオプションは、-AllTraceFileオプションと同時に指定できません。

PRFトレースファイルは、PRFトレースファイル出力先ディレクトリーに自動的に作成され、ファイル名はprf_???になります。???は、001からトレースファイルの面数を最大値とした整数です。

PRFトレースファイル出力先ディレクトリー

$PRFSPOOL/utt/prf/PRF識別子/dcopltrc/

また、PRFトレースファイル名を指定する場合は、絶対パスを指定するか、PRFトレースファイル出力先ディレクトリーに移動してから、ファイル名だけを指定します。

-AllTraceFile

カレントディレクトリー下のすべてのファイルを入力ファイルとして読み込みます。このオプションは、-TraceFileオプションと同時に指定できません。カレントディレクトリーに256を超える数のファイルがある場合は256ファイルだけ編集します。なお、cprfedコマンドの結果をカレントディレクトリーにリダイレクトする場合は、リダイレクト先のファイルも入力ファイルとして数えます。

-Compact

次の項目のトレース出力を長さ0の文字列にします。

Client AP IP／Client AP PID／Client AP CommNo.／OPT／ASCII

-CSVオプションと組み合わせて使用する必要があります。-CSVオプションを指定しない場合、このオプションは無視されます。

-AscLen ASCII表示文字数

ダンプ情報のうちのASCII出力項目の最大出力文字数を指定します。省略した場合は長さ0の文字列にします。

ASCII出力項目の内容は常にダブルクォーテーションで囲まれます。値1を指定した場合、ダブルクォーテーション分が加算され、3文字出力されます。ただし、ASCII出力項目に出力情報がない場合は長さ0の文字列になります。

-Compactオプションと組み合わせて使用する必要があります。-Compactオプションを指定しない場合、このオプションは無視され、ASCII出力項目の内容はすべて表示されます。

指定できる値を次に示します。

0〜512

デフォルト値：0

指定できるコマンドオプションの組み合わせの一覧を次に示します。

コマンドオプション

-h

-Dump

-CSV

-Time

-ProcessID

-TraceFile

-AllTraceFile

-Compact

-Dump

△-h

−

−

−

−

−

−

−

-CSV

△-h

△-CSV

−

−

−

−

−

−

-Time

△-h

○

○

−

−

−

−

−

-ProcessID

△-h

○

○

○

−

−

−

−

-TraceFile

△-h

○

○

○

○

−

−

−

-AllTraceFile

△-h

○

○

○

○

×

−

−

-Compact

△-h

△-Dump

○

○

○

○

○

−

-AscLen

△-h

△-Dump

○

○

○

○

○

○

（凡例）

○：同時に指定できます。

△：△のあとに続くオプション名のオプションが有効になります。

×：同時に指定できません。

−：該当しません。

戻り値

戻り値

説明

0

正常終了しました。

0以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

出力形式

出力形式1（ダンプ形式）

PRF: aaaaaa Process: bbbbbbbbbb Thread: cccccccccc(CC..CC) Trace: dddddddddd
ProcessName: vv..vv
Event: eeeee Time: ffff/gg/hh ii:jj:kk lll/mmm/nnn
Rc: oo..oo
ClientAP:pp..pp qq..qq - rr..rr RootAP: ss..ss tt..tt - uu..uu
INT: XX..XX OPR: YY..YY
Offset +0 +1 +2 +3 +4 +5 +6 +7 +8 +9 +a +b +c +d +e +f 0123456789abcdef
  AAAA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AAAAAAAAAAAAAAAA
  AAAA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AAAAAAAAAAAAAAAA
         :
  AAAA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AAAAAAAAAAAAAAAA

出力形式2（CSV形式）

PRF,Process,Thread(hashcode),Trace,ProcessName,Event,Date,Time,Time(msec/usec/nsec),Rc,ClientAP IP,ClientAP PID, ClientAP CommNo.,RootAP IP,RootAP PID,RootAP CommNo.,INT,OPR,OPT,ASCII
aaaaaa,bbbbbbbbbb,cccccccccc(CC..CC),dddddddddd,vv.vv,eeeee,ffff/gg/hh,ii:jj:kk,lll/mmm/nnn,oo..oo,pp..pp,qq..qq,rr..rr,ss..ss,tt..tt,uu..uu,XX..XX,YY..YY,AA..AA,BB..BB

（凡例）

記号

説明

aa…aa

レコード状態（6文字以内）

Rec：レコードの状態は正常です。

ErrRec：レコードの状態は異常です。

bb…bb

トレース情報を取得したプロセスのプロセスID（10進数で10桁以内）

cc…cc

トレース情報を取得したプロセス内スレッドのスレッドID（16進数で18桁以内）

dd…dd

該当スレッドでのトレース通番（10進数で10桁以内）

ee…ee

イベントID（16進数で6桁（先頭の0x含む））

ffff

トレースを取得した時刻（年）

gg

トレースを取得した時刻（月）

hh

トレースを取得した時刻（日）

ii

トレースを取得した時刻（時）

jj

トレースを取得した時刻（分）

kk

トレースを取得した時刻（秒）

lll

トレースを取得した時刻（ミリ秒）

mmm

トレースを取得した時刻（マイクロ秒）

nnn

トレースを取得した時刻（ナノ秒）

oo…oo

戻り値（16進数で10桁（先頭の0x含む））

pp…pp

クライアントアプリケーションのIPアドレス（xxx.xxx.xxx.xxxの形式）

qq…qq

クライアントアプリケーションのプロセスID（10進数で10桁以内）

rr…rr

クライアントの通信番号（18桁（先頭の0x含む））

ss…ss

ルートアプリケーションのIPアドレス（xxx.xxx.xxx.xxxの形式）

tt…tt

ルートアプリケーションのプロセスID（10進数で10桁以内）

uu…uu

ルートの通信番号（18桁（先頭の0x含む））

vv…vv

プロセス名称（32文字以内）

XX…XX

インターフェース名（33文字以内）※

YY…YY

オペレーション名（33文字以内）※

AA…AA

各イベントで取得した情報をダンプ形式で出力します（最大514文字）。

ダンプ形式の情報を””で囲んで出力します。

BB…BB

各イベントで取得した情報をASCII文字で出力します（最大 514文字）。

ダンプ形式のASCII文字は、””で囲んで出力します。

ASCII文字で表示できないコード（制御コード）は「.」（ピリオド）で出力し、ASCII文字で"（1文字）は""（2文字）で出力します。

CC…CC

スレッドのハッシュ値（16進数で18桁以内）

注※

インターフェース名、オペレーション名が32文字を超える場合は、次のように編集され33文字で出力されます。

「前16文字」+「＊」＋「後ろ16文字」

「前32文字」+「＊」

「＊」+「後ろ32文字」

出力例

cprfed -TraceFile prf_001を実行した場合

PRF: Rec Process: 26006      Thread: 0x15(0x12345678)    Trace: 1023
ProcessName: tscd
Event: 0x1002 Time: 2000/02/12 13:43:44 363/200/000
Rc: 0
ClientAP: 172.17.113.19   26303      - 00000000000003ff RootAP: 172.17.113.19    26006       - 00000000000003ff
INT : testint                             OPR: test5

cprfed -Dump -TraceFile prf_001を実行した場合

PRF: Rec Process: 26006      Thread: 0x15(0x12345678)    Trace: 1023
ProcessName: tscd
Event: 0x1002 Time: 2000/02/12 13:43:44 363/200/000
Rc: 0
ClientAP: 172.17.113.19   26303        - 00000000000003ff RootAP: 172.17.113.19     26006       - 00000000000003ff
INT : testint                            OPR: test5

Offset  +0 +1 +2 +3 +4 +5 +6 +7 +8 +9 +a +b +c +d +e +f  0123456789abcdef
 +0000  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ................
 +0010  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ................
 +0020  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ................
 +0030  00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00  ............

cprfed -CSV -TraceFile prf_001を実行した場合

PRF,Process,Thread(hashcode),Trace,ProcessName,Event,Date,Time,Time(msec/usec/nsec),Rc,ClientAP IP,ClientAP PID,ClientAP CommNo.,RootAP IP,RootAP PID,RootAP CommNo.,INT,OPR,OPT,ASCII
Rec,1800,0x2e00(0x0e9576fd),1,Client,0x1009,2003/10/12,16:26:52,734/000/000,****,10.209.15.65,1800,0x0000000000000001,10.209.15.65,1800,0x0000000000000001,ABC,****,abcdefg,"31323334"

注意事項

性能解析トレースでは高負荷時に排他によるボトルネックが生じないように、PRFトレース出力時に排他制御をしていません。そのため、一部トレース情報が正しく出力されない場合があります。

CSV形式に編集したファイルにASCII文字以外を含む場合は、Unicodeをサポートしたエディター、またはExcel 2003以降で参照してください。

5.3.2　cprfflush

バッファー内容の強制ファイル出力

書式

cprfflush [-PRFID PRF識別子] [-h]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

PRFデーモンに対して、バッファーに格納されているトレース情報の出力を要求します。

出力する範囲は、前回ファイル出力したトレースの次のトレースから、コマンドが入力された時点までです。

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

前提条件

cprfflushコマンドの実行中は、cprfflushコマンドを実行できません。

要求先のPRFデーモンと同じPRFSPOOL環境変数が設定されている必要があります。設定されていない場合、コマンドがエラーリターンします。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-PRFID PRF識別子

PRF識別子には、asadminのcreate-prfサブコマンドでPRFを構築したときに付けたPRFサーバの名称を指定します。PRF識別子は1〜31文字の英数字、またはアンダースコア（_）で指定します。"TSC"や"tsc"、または"CTM"や"ctm"で始まる文字列は指定しないでください。

デフォルト値：PRF_ID

-h

コマンドの使用方法を表示します。

戻り値

戻り値

説明

0

正常終了しました。

1

PRFデーモンが起動していません。PRFSPOOL環境変数が異なっている、または-PRFIDの値が誤っているおそれがあります。

2

PRFSPOOL環境変数が設定されていません。

上記以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

5.3.3　cprflevel

PRFトレース取得レベルの表示と変更

書式

cprflevel [-PRFID PRF識別子] [-h] [-PrfChangeLevel
    PRFトレース取得レベル[,[PRFトレース取得レベル]...]]
    [-PrfLevelIndex インデックス番号] [-PrfLevelAll]

格納先

Application Serverインストールディレクトリー/common/PRF/bin/

機能

PRFトレース取得レベルを表示または変更します。

-PrfChangeLevelオプションを省略した場合は、指定したPRF識別子に指定されているPRFトレース取得レベルを表示します。-PrfChangeLevelオプションを指定した場合は、指定したPRF識別子に指定されているPRFトレース取得レベルを指定値に変更します。

-PrfLevelIndexオプションを指定した場合は、指定したインデックスのPRFトレース取得レベルの一覧が表示されます。-PrfLevelAllオプションを指定した場合は、すべてのインデックスに対応するPRFトレース取得レベルが表示されます。

実行権限

次の権限を持つユーザー

PRFを取得するプロセスと同じユーザーまたはスーパーユーザー

同じPRFSPOOL環境変数を使用する環境内では、スーパーユーザーとほかのユーザーが混在してPRFコマンドを実行できません。常に同じユーザーでPRFコマンドを実行する必要があります。

前提条件

このコマンドは、PRFデーモンの起動中に実行してください。PRFデーモンが起動していないときにコマンドを実行した場合、エラーメッセージを出力します。

変更するPRFデーモンと同じPRFSPOOL環境変数が設定されている必要があります。

環境変数

PATH

Application Serverインストールディレクトリー/common/PRF/bin、および/binを追加してください。

LD_LIBRARY_PATH(Linux)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

LIBPATH(AIX)

Application Serverインストールディレクトリー/common/PRF/libを指定してください。

PRFSPOOL

PRFデーモンの実行環境ディレクトリーを設定します。

PRFSPOOL環境変数は、ドメイン管理サーバがJavaEEサーバ、クラスターを起動するとき、ドメイン管理サーバによって設定されます。PRFSPOOL環境変数は、JavaEEサーバを関連元とするPRF関連がある場合、関連先のPRF名を基に、次の形式で設定されます。

"JavaEEサーバ構築先ノードのJava EE Serverログ出力先ディレクトリー/nodes/ノード名/PRF名"

TZ(UNIX)

タイムゾーンを設定します。日本標準時の場合はJST-9を指定します。

PSALLOC(AIX)

メモリー確保時に必要なページングスペースをすぐに確保する設定にします。

earlyを設定してください。

NODISCLAIM(AIX)

free()に対するコールの処理方法として、disclaim()の発行を抑止する設定にします。

trueを設定してください。

EXTSHM(AIX)

プロセス空間の共有メモリー領域数の制限をなくす設定にします。

ONを設定してください。

LDR_CNTRL(AIX)

カーネルの従来の区分化より大きいデータエリアを扱えるようにするための設定です。

MAXDATA=0x40000000を指定してください。

引数

-PRFID PRF識別子

PRF識別子には、asadminのcreate-prfサブコマンドでPRFを構築したときに付けたPRFサーバの名称を指定します。PRF識別子は1〜31文字の英数字、またはアンダースコア（_）で指定します。"TSC"や"tsc"、または"CTM"や"ctm"で始まる文字列は指定しないでください。

デフォルト値：PRF_ID

-h

コマンドの使用方法を表示します。

-PrfChangeLevel PRFトレース取得レベル [,[PRFトレース取得レベル]...]

PRFトレース取得レベルを4バイトの16進数（8桁の値）で指定します。ここで4バイトの16進数の先頭に0xを付けることができますが、0xは無視されます。各インデックス番号に対応するレベル値をコンマ（,）区切りで左から複数指定できます。該当するインデックスのレベル値を変更しない場合は、値を指定しないでください。また、あるインデックス番号以降の値をすべて指定しない場合は、コンマ（,）の記述を省略してください。インデックス番号1のトレース取得レベルを（1）、インデックス番号2のPRFトレース取得レベルを（2）とした場合、PRFトレース取得レベルは「（1）,（2）,...」と指定します。

PRFトレース取得レベルの指定例を次に示します。

PRFトレース取得レベルの指定例

オプションの指定

インデックス番号1のPRFトレース取得レベルを指定する

-PrfChangeLevel 0x44445555

インデックス番号1とインデックス番号2のPRFトレース取得レベルを指定する

-PrfChangeLevel 0x44445555,0x55554444

インデックス番号2のPRFトレース取得レベルを指定する

-PrfChangeLevel ,0x55554444

各機能レイヤーでのPRFトレース取得レベルの割り当てについて説明します。

PRFトレース取得レベルは、インデックスごとに8桁の16進数で指定します。それぞれの桁には、機能レイヤーが2つずつ割り当てられています。16進数を2進数にした場合の上位2ビットに割り当てられている機能レイヤーを上位レイヤー、下位2ビットに割り当てられている機能レイヤーを下位レイヤーといいます。

桁ごとの上位レイヤー、下位レイヤーに割り当てられている機能レイヤーについて、次の表に示します。

インデックス

桁番号

上位レイヤー

下位レイヤー

インデックス1

1桁目

（なし）

Java EE Server

2桁目

（なし）

Java VM

5桁目

（なし）

uCosminexus TP1 Connector、TP1/Client/J

PRFトレース取得レベルを指定する場合は、桁ごとの上位レイヤー、下位レイヤーのPRFトレース取得レベルを「標準」「詳細」「保守」のどのレベルで取得するかを決め、それを16進数で指定します。上位レイヤーと下位レイヤーのPRFトレース取得レベルの組み合わせと指定値の対応を、次の表に示します。

なお、保守レベルは、障害発生時などの保守情報を取得するためのレベルです。通常は指定しないでください。

上位レイヤー

下位レイヤー

指定値

標準

標準

0

標準

詳細

1

標準

保守

2

詳細

標準

4

詳細

詳細

5

詳細

保守

6

保守

標準

8

保守

詳細

9

保守

保守

a

PRFトレース取得レベルの指定例を、次の表に示します。

インデックス

指定例

説明

インデックス1

00000000

インデックス1の各機能レイヤーの標準レベルのトレース情報を取得します。

10000000

Java EE Serverだけ詳細レベルのトレース情報を取得して、ほかの機能レイヤーは標準レベルのトレース情報を取得します。

11000000

Java EE ServerおよびJava VMの詳細レベルのトレース情報を取得します。

-PrfLevelIndex インデックス番号

変更または参照するPRFトレース取得レベルのインデックス番号を1〜16の整数で指定します。

デフォルト値：1

この引数と一緒に-PrfChangeLevelを指定した場合は、指定したインデックス番号のPRFトレース取得レベルのレベル値を-PrfChangeLevelで指定した値に変更します。

この引数と一緒に-PrfChangeLevelを指定しなかった場合は、指定したインデックス番号のPRFトレース取得レベルのレベル値が表示されます。この引数と一緒に-PrfChangeLevelを指定する場合は、-PrfChangeLevelには必ず1つの値だけを指定してください。

（例）インデックス番号2番目の値を、0x55554444に変更する場合

cprflevel -PrfChangeLevel 0x55554444 -PrfLevelIndex 2

-PrfChangeLevelに複数の値を指定した場合は、オプションエラーとなります。

（例）-PrfChangeLevelに複数の値を指定した場合

cprflevel -PrfChangeLevel ,0x55554444,0x55554444 -PrfLevelIndex 2

-PrfLevelIndexに2を指定しているにもかかわらず、-PrfChangeLevelに複数の値を指定したためです。なお、-PrfLevelIndexの指定を省略した場合は、1が設定されます。

-PrfLevelAll

すべてのレベル値を表示します。-PrfChangeLevelまたは-PrfLevelIndexと組み合わせた指定はできません。このオプションと-PrfLevelIndexの組み合わせを、次に示します。

cprflevel現在のレベル値の表示方法

-PrfLevelIndex

指定

未指定

-PrfLevelAll

指定

オプションエラー

すべてのレベル値を表示

未指定

指定されたインデックス番号のレベル値だけを表示

インデックス1のレベル値だけを表示

指定できるコマンドオプションの組み合わせの一覧を次に示します。

コマンドオプション

-h

-PRFID

-PrfChangeLevel

-PrfLevelIndex

-PrfLevelAll

-h

−

△-h

△-h

△-h

△-h

-PRFID

△-h

−

○

○

○

-PrfChangeLevel

△-h

○

−

○

×

-PrfLevelIndex

△-h

○

○

−

×

-PrfLevelAll

△-h

○

×

×

−

（凡例）

○：同時に指定できます。

△：△のあとに続くオプション名のオプションが有効になります。

×：同時に指定できません。

−：該当しません。

入力例・出力例

入力例1

cprflevel

出力例1

KFCT73415-I 2661 1: prf trace level is 0x12345678

入力例2

cprflevel -PrfLevelAll

出力例2

KFCT73418-I 2661 1: all prf trace levels are:
[ 1]=0x12345678 [ 2]=0x00000000 [ 3]=0x00000000 [ 4]=0x00000000
[ 5]=0x00000000 [ 6]=0x00000000 [ 7]=0x00000000 [ 8]=0x00000000
[ 9]=0x00000000 [10]=0x00000000 [11]=0x00000000 [12]=0x00000000
[13]=0x00000000 [14]=0x00000000 [15]=0x00000000 [16]=0x00000000

入力例3

cprflevel -PrfLevelIndex 5

出力例3

KFCT73419-I 2661 1: prf trace level of [5] is 0x00000000.

入力例4

cprflevel -PrfChangeLevel 000000001

出力例4

KFCT73416-I 2661 1: prf trace level was changed from 0x00000000 to 0x00000001.

入力例5

cprflevel -PrfChangeLevel 0x00000055,0x55554444

出力例5

KFCT73420-I 2661 1: prf trace level was changed:
[ 1]=0x00000000 -> [ 1]=0x00000055
[ 2]=0x00000000 -> [ 2]=0x55554444

入力例6

cprflevel -PrfChangeLevel 0x44445555 -PrfLevelIndex 2

出力例6

KFCT73420-I 2661 1: prf trace level was changed: [ 2]=0x00000000 -> [ 2]=0x44445555

戻り値

戻り値

説明

0

正常終了しました。

1

PRFデーモンが起動していません。PRFSPOOL環境変数が異なっている、または-PRFIDの値が誤っているおそれがあります。

2

PRFSPOOL環境変数が設定されていません。

上記以外

コマンド処理中にエラーが発生しました。出力されたメッセージに従って対策したあと、再度コマンドを実行してください。エラーメッセージは標準エラー出力、ログファイルに出力します。

注意事項

現在のPRFトレース取得レベルを表示する場合、-PrfLevelIndexと-PrfLevelAllの組み合わせで、出力されるメッセージIDは、「KFCT73415-I」、「KFCT73418-I」、「KFCT73419-I」のどれか1つとなっています。PRFトレース取得レベルを表示する場合の出力されるメッセージIDの対応は、次のとおりです。

PRFトレース取得レベルを表示する場合のメッセージID

-PrfLevelAll

指定

未指定

-PrfLevelIndex

指定

−

KFCT73419-I

未指定

KFCT73418-I

KFCT73415-I

PRFトレース取得レベルを変更する場合、-PrfChangeLevelの指定方法で出力されるメッセージIDは、「KFCT73416-I」または「KFCT73420-I」のどちらかになります。次の条件をすべて満たした場合、「KFCT73416-I」が出力されます。それ以外は、「KFCT73420-I」が出力されます。

-PrfChangeLevel 0x44445555のように値を1つだけ指定し、コンマ（,）を使用していない。

-PrfLevelIndexを指定していない。

このコマンドでレベル変更した場合、次のリクエストから変更が有効になります。

索引

数字

1つ以上のライブラリーJARファイルのJava EE Serverからの除去[1]

1つ以上のライブラリーのアーカイブをJava EE Serverに追加[1]

1つ以上のロガーのロギング属性の設定[1]

A

add-library[1]

add-resources[1]

appclient[1]

Application Serverと連携しないJavaアプリケーションプログラムの実行[1]

asadmin[1]

B

backup-domain[1]

C

car_tar_gz[1]

car_tar_Z[1]

change-admin-password[1]

change-master-password[1]

cleanup-prf[1]

cleanup-webserver[1]

collect-local-snapshot[1]

collect-snapshot[1]

copy-config[1]

coreアーカイブ機能[1], [2]

coreファイルとスレッドダンプの取得[1]

cprfed[1]

cprfflush[1]

cprfgetpid[1]

cprflevel[1]

cprfstart[1]

cprfstop[1]

create-admin-object[1]

create-application-ref[1]

create-auth-realm[1]

create-cluster[1]

create-connector-connection-pool[1]

create-connector-resource[1]

create-connector-security-map[1]

create-connector-work-security-map[1]

create-context-service[1]

create-custom-resource[1]

create-domain[1]

create-event-hook[1]

create-file-user[1]

create-iiop-listener[1]

create-instance[1]

create-jacc-provider[1]

create-javamail-resource[1]

create-jdbc-connection-pool[1]

create-jdbc-resource[1]

create-jms-host[1]

create-jms-resource[1]

create-jmsdest[1]

create-jndi-resource[1]

create-jvm-options[1]

create-managed-executor-service[1]

create-managed-scheduled-executor-service[1]

create-managed-thread-factory[1]

create-message-security-provider[1]

create-node-config[1]

create-node-ssh[1]

create-password-alias[1]

create-prf[1]

create-profiler[1]

create-protocol[1]

create-relation[1]

create-resource-adapter-config[1]

create-resource-ref[1]

create-ssl[1]

create-system-properties[1]

create-threadpool[1]

create-webserver[1]

D

delete-admin-object[1]

delete-application-ref[1]

delete-auth-realm[1]

delete-cluster[1]

delete-config[1]

delete-connector-connection-pool[1]

delete-connector-resource[1]

delete-connector-security-map[1]

delete-connector-work-security-map[1]

delete-context-service[1]

delete-custom-resource[1]

delete-domain[1]

delete-event-hook[1]

delete-file-user[1]

delete-iiop-listener[1]

delete-instance[1]

delete-jacc-provider[1]

delete-javamail-resource[1]

delete-jdbc-connection-pool[1]

delete-jdbc-resource[1]

delete-jms-host[1]

delete-jms-resource[1]

delete-jmsdest[1]

delete-jndi-resource[1]

delete-jvm-options[1]

delete-managed-executor-service[1]

delete-managed-scheduled-executor-service[1]

delete-managed-thread-factory[1]

delete-message-security-provider[1]

delete-node-config[1]

delete-node-ssh[1]

delete-password-alias[1]

delete-prf[1]

delete-profiler[1]

delete-protocol[1]

delete-relation[1]

delete-resource-adapter-config[1]

delete-resource-ref[1]

delete-ssl[1]

delete-system-property[1]

delete-threadpool[1]

delete-webserver[1]

deploy[1]

disable[1]

disable-secure-admin[1]

E

eheapprof[1]

enable[1]

enable-secure-admin[1]

Explicitヒープ詳細情報付き拡張スレッドダンプの出力[1]

export-sync-bundle[1]

F

flush-connection-pool[1]

flush-jmsdest[1]

G

GCの強制発生[1]

get[1]

get-client-stubs[1]

get-health[1]

H

htpasswd[1]

httpsd[1]

httpsdctl[1]

hwscertutil cert -hash[1]

hwscertutil cert -outform[1]

hwscertutil cert -text[1]

hwscertutil req[1]

hwscertutil reqgen[1]

hwskeygen[1]

hwstraceinfo[1]

I

IIOPリスナーの一覧表示[1]

IIOPリスナーの削除[1]

IIOPリスナーの追加[1]

import-sync-bundle[1]

imqcmd list dst[1]

ist-auth-realms[1]

J

JACCプロバイダーの一覧表示[1]

JACCプロバイダーの削除[1]

Java EE Serverクラスターの削除[1]

Java EE Serverクラスターの作成[1]

Java EE Serverで利用できる暗号化方式群の一覧表示[1]

Java EE Serverドメインの作成[1]

Java EE Serverノードの一覧表示[1]

Java EE Serverのクラスターの停止[1]

Java EE Serverのバージョン情報の表示[1]

Java EE Serverモジュールの一覧表示[1]

Java EEサーバで使用するasadminコマンドのサブコマンド一覧[1]

Java EEサーバで使用するコマンドの一覧[1]

java_hras[1]

javacore[1]

javagc[1]

JavaMailセッションリソースの一覧表示[1]

JavaMailセッションリソースの削除[1]

JavaMailセッションリソースの作成[1]

javatrace[1]

Java VMオプションの一覧表示[1]

Java VMオプションの削除[1]

Java VMオプションの作成[1]

Java VMで使用するコマンドの一覧[1]

JavaインターフェースクラスからのWSDL生成、WSDLからサービスエンドポイントインターフェースやスタブなどのJavaクラスの生成[1]

JAX-RPCのWebサービスとしてデプロイできるWARファイルの生成[1]

JAX-WS Webサービスで使用するJAX-WSポータブルのアーティファクトの生成[1]

jax-wsポータブルのアーティファクトの生成[1]

JDBCコネクションプールの一覧表示[1]

JDBCコネクションプールの削除[1]

JDBCコネクションプールの登録[1]

JDBCまたはコネクターコネクションプールの検証[1]

JDBCリソースの一覧表示[1]

JDBCリソースの作成[1]

jheapprof[1]

jheapprofanalyzer[1]

JMS送信先内のメッセージの削除[1]

JMSの物理送信先の作成[1]

JMS物理送信先の一覧表示[1]

JMS物理送信先の削除[1]

JMSホストの一覧表示[1]

JMSホストの削除[1]

JMSホストの作成[1]

JMSリソースの一覧表示[1]

JMSリソースの削除[1]

JMSリソースの作成[1]

JNDI名を持つJDBCリソースの削除[1]

JNDIリソースの一覧表示[1]

JNDIリソースの削除[1]

JNDIリソースの登録[1]

jspc[1]

JSPファイルの事前コンパイル[1]

L

list[1]

list-admin-objects[1]

list-application-refs[1]

list-applications[1]

list-backups[1]

list-batch-job-executions[1]

list-batch-job-steps[1]

list-batch-jobs[1]

list-batch-runtime-configuration[1]

list-clusters[1]

list-commands[1]

list-configs[1]

list-connector-connection-pools[1]

list-connector-resources[1]

list-connector-security-maps[1]

list-connector-work-security-maps[1]

list-containers[1]

list-context-services[1]

list-custom-resources[1]

list-domains[1]

list-event-hooks[1]

list-file-groups[1]

list-file-users[1]

list-iiop-listeners[1]

list-instances[1]

list-jacc-providers[1]

list-javamail-resources[1]

list-jdbc-connection-pools[1]

list-jdbc-resources[1]

list-jms-hosts[1]

list-jms-resources[1]

list-jmsdest[1]

list-jndi-resources[1]

list-jvm-options[1]

list-libraries[1]

list-log-attributes[1]

list-managed-executor-services[1]

list-managed-scheduled-executor-services[1]

list-managed-thread-factories[1]

list-message-security-providers[1]

list-modules[1]

list-network-listeners[1]

list-nodes[1]

list-nodes-config[1]

list-nodes-ssh[1]

list-password-aliases[1]

list-prfs[1]

list-protocols[1]

list-relations[1]

list-resource-adapter-configs[1]

list-resource-refs[1]

list-sub-components[1]

list-supported-cipher-suites[1]

list-system-properties[1]

list-threadpools[1]

list-timers[1]

list-transports[1]

list-virtual-servers[1]

list-web-context-param[1]

list-web-env-entry[1]

list-webservers[1]

login[1]

logresolve[1]

M

ManagedExecutorServiceの一覧表示[1]

ManagedExecutorServiceリソースの削除[1]

ManagedExecutorServiceリソースの作成[1]

ManagedScheduledExecutorServiceリソースの一覧表示[1]

ManagedScheduledExecutorServiceリソースの削除[1]

ManagedScheduledExecutorServiceリソースの作成[1]

ManagedThreadFactoryリソースの一覧表示[1]

ManagedThreadFactoryリソースの削除[1]

ManagedThreadFactoryリソースの作成[1]

P

ping-connection-pool[1]

ping-node-ssh[1]

PRF環境のクリーンアップ[1]

PRFデーモンの開始[1]

PRFデーモンの停止[1]

PRFデーモンプロセスIDの取得[1]

PRFで使用するコマンドの一覧[1]

PRFトレース取得レベルの表示と変更[1]

PRFの一覧表示[1]

PRFの起動[1]

PRFの構築[1]

PRFの削除[1]

PRFの停止[1]

R

recover-transactions[1]

redeploy[1]

remove-library[1]

restart-domain[1]

restore-domain[1]

S

schemagen[1]

secure admin機能の無効化[1]

secure admin機能の有効化[1]

set[1]

set-batch-runtime-configuration[1]

set-log-attributes[1]

set-log-attributesコマンドで使用するパラメーター一覧[1]

set-web-context-param[1]

set-web-env-entry[1]

setup-ssh[1]

setサブコマンドおよびgetサブコマンドで使用するパラメーター一覧[1]

show-component-status[1]

SSHが有効なノードの作成[1]

SSHキーのセットアップ[1]

SSH経由の通信をサポートするドメイン内のJava EE Serverノードの一覧表示[1]

SSH通信が有効なノードの削除[1]

SSH通信によるノード使用のテスト[1]

SSHを使ったノード構成データの更新[1]

sslpasswd[1]

SSL設定の削除[1]

start-cluster[1]

start-domain[1]

start-instance[1]

start-prf[1]

start-servers[1]

start-webserver[1]

stop-cluster[1]

stop-domain[1]

stop-instance[1]

stop-prf[1]

stop-servers[1]

stop-webserver[1]

U

undeploy[1]

unset-web-context-param[1]

unset-web-env-entry[1]

update-connector-security-map[1]

update-connector-work-security-map[1]

update-file-user[1]

update-node-config[1]

update-node-ssh[1]

update-password-alias[1]

V

validate-multicast[1]

version[1]

W

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定[1]

WebアプリケーションまたはモジュールのServletContext初期化パラメーターの設定の解除[1]

Webアプリケーションまたはモジュールの環境エントリーの設定[1]

Webアプリケーションまたはモジュールの環境エントリーの設定の解除[1]

Webサーバ環境のクリーンアップ[1]

Webサーバで使用するコマンドの一覧[1]

Webサーバの一覧表示[1]

Webサーバの起動[1], [2]

Webサーバの起動、再起動および停止[1]

Webサーバの構築[1]

Webサーバの削除[1]

Webサーバの停止[1]

Webサーバの秘密鍵の作成[1]

wscompile[1]

wsdeploy[1]

wsgen[1]

wsimport[1]

X

xjc[1]

XML SchemaからJavaへバインディングするコンパイラー[1]

XMLファイルに指定されたリソースの追加[1]

あ

アクセスログファイル内のIPアドレスのホスト名への変換[1]

アプリケーションコンテナーの一覧表示[1]

アプリケーション参照の削除[1]

アプリケーション参照の作成[1]

い

一般ユーザーによる運用[1]

イベント検知時コマンドの一覧表示[1]

イベント検知時コマンドの登録[1]

イベント検知時コマンドの登録解除[1]

か

カスタムリソースの削除[1]

カスタムリソースの作成[1]

カスタムリソースの取得[1]

仮想サーバの一覧表示[1]

管理された全オブジェクトの取得[1]

管理対象オブジェクトの削除[1]

管理対象オブジェクトの作成[1]

管理タスクの実行[1]

管理ユーザーパスワードの変更[1]

き

既存のアプリケーション参照の一覧表示[1]

既存の名前付き構成をコピーして、別の構成を作成[1]

く

クライアントアプリケーションの起動[1]

クライアントスタブのJARファイルの取得[1]

クラスター化されたインスタンスまたはスタンドアロンサーバインスタンスの構成データのインポート[1]

クラスターの起動[1]

クラスターの状態に関する情報の取得[1]

クラスターまたはスタンドアロンサーバインスタンスの構成データのアーカイブファイルへのエクスポート[1]

クラス別統計情報解析ファイルのCSV出力[1]

クラス別統計情報付き拡張スレッドダンプの出力[1]

け

現在のファイルユーザーの更新[1]

こ

構成属性値の一覧表示[1]

構成属性値の取得[1]

構成属性値の設定[1]

構成のほかの部分から参照できるシステムプロパティーの追加[1]

コネクションプールで確立されたコネクションの再初期化[1]

コネクションプールの追加[1]

コネクターコネクションプールに属するセキュリティーマップの一覧表示[1]

コネクターコネクションプールの一覧表示[1]

コネクターコネクションプールの削除[1]

コネクターコネクションプールのセキュリティーマップの削除[1]

コネクターコネクションプールのセキュリティーマップの作成[1]

コネクターコネクションプールのセキュリティーマップの変更[1]

コネクターリソースの一覧表示[1]

コネクターリソースの削除[1]

コネクターリソースの登録[1]

コマンドの入力方法[1]

コマンドリファレンスの見方[1]

コンテキストサービスのリソースの一覧表示[1]

コンテキストサービスのリソースの削除[1]

コンテキストサービスのリソースの作成[1]

コンポーネントのデプロイ[1]

コンポーネントの無効化[1]

コンポーネントの有効化[1]

コンポーネントのリデプロイ[1]

さ

サーバインスタンスが所有する永続タイマーの一覧表示[1]

サーバインスタンスの一覧表示[1]

サーバインスタンスの起動[1]

サーバインスタンスの削除[1]

サーバインスタンスの作成[1]

サーバ間関連を一覧表示[1]

サーバ間関連を削除[1]

サーバ間関連を作成[1]

サーバの一括起動[1]

サーバの一括停止[1]

し

システムプロパティー（ドメイン／構成／クラスター／サーバインスタンス）の削除[1]

実行中のサーバインスタンスの停止[1]

実行待ちトランザクションの手動での回復[1]

使用できるコマンドの一覧表示[1]

証明書の形式変換[1]

証明書の内容表示[1]

証明書発行要求CSRの作成[1]

証明書発行要求CSRの内容表示[1]

新規プロトコルの追加[1]

す

スキーマジェネレーターの起動[1]

スレッドプールの一覧表示[1]

スレッドプールの削除[1]

スレッドプールの追加[1]

せ

性能解析トレース情報の編集出力[1]

セキュア通信の構成[1]

て

デプロイされたWebアプリケーションまたはモジュールのServletContext初期化パラメーターの一覧表示[1]

デプロイされたWebアプリケーションまたはモジュールの環境エントリーの一覧表示[1]

デプロイされたモジュール内またはデプロイされたアプリケーションモジュール内のEJBまたはサーブレットのコンポーネントの一覧表示[1]

デプロイ済みアプリケーションの一覧表示[1]

デプロイ済みのコンポーネントの削除[1]

デプロイ済みのコンポーネントの状態の表示[1]

と

ドメイン、構成、クラスターまたはサーバインスタンスのシステムプロパティーの一覧表示[1]

ドメイン管理サーバ稼働時のシステム情報の収集[1]

ドメイン管理サーバの起動[1]

ドメイン管理サーバの構成中の、名前付き構成の一覧表示[1]

ドメイン管理サーバの再起動[1]

ドメイン管理サーバの停止[1]

ドメイン管理サーバ非稼働時のシステム情報の収集[1]

ドメインディレクトリー内のドメインの一覧表示[1]

ドメイン内の既存クラスターの一覧表示[1]

ドメインの削除[1]

ドメインのバックアップ[1]

ドメインバックアップの一覧表示[1]

ドメインへのログイン[1]

トランスポートの一覧表示[1]

トレース情報の収集[1]

な

内部トレースの採取[1]

名前付き既存構成の削除[1]

名前付き認証レルムの削除[1]

名前付き認証レルムの追加[1]

に

任意の認証モジュールで使用できるJACCプロバイダーの作成[1]

認証レルムの一覧表示[1]

ね

ネットワークリスナーの一覧表示[1]

の

ノード構成データの更新[1]

は

パスワードエイリアスの一覧表示[1]

パスワードエイリアスの更新[1]

パスワードエイリアスの削除[1]

パスワードエイリアスの作成[1]

パスワード付きサーバ秘密鍵のパスワードファイル作成[1]

バックアップからのファイルの復元[1]

ハッシュリンクの作成[1]

バッチ実行時の構成の表示[1]

バッチジョブ実行の一覧表示[1]

バッチジョブの一覧表示[1]

バッチジョブの実行ステップの一覧表示[1]

バッチランタイムの設定[1]

バッファー内容の強制ファイル出力[1]

ふ

ファイルグループの一覧表示[1]

ファイルユーザーの一覧表示[1]

ファイルユーザーの削除[1]

ファイルユーザーの作成[1]

物理格納先の一覧表示[1]

プロトコルの一覧表示[1]

プロトコルの削除[1]

プロファイラー要素の削除[1]

プロファイラー要素の作成[1]

ま

マスターパスワードの変更[1]

マルチキャストトランスポートの検証[1]

め

メッセージセキュリティープロバイダーの削除[1]

メッセージセキュリティープロバイダーの作成[1]

メッセージレイヤーのメッセージセキュリティープロバイダーの一覧表示[1]

ゆ

ユーザー名とパスワードのパスワードファイルへの登録およびパスワードの変更[1]

ら

ライブラリーのアーカイブの一覧表示[1]

り

リソースアダプターアーカイブ構成情報の削除[1]

リソースアダプターアーカイブ構成情報の作成[1]

リソースアダプターアーカイブ構成の名称の一覧表示[1]

リソースアダプターに属するワークセキュリティーマップの一覧表示[1]

リソースアダプターのワークセキュリティーマップの削除[1]

リソースアダプターのワークセキュリティーマップの作成[1]

リソースアダプターのワークセキュリティーマップの変更[1]

リソース参照の一覧表示[1]

リソース参照の削除[1]

リソースへの参照の作成[1]

リモート通信が無効なノードの削除[1]

リモート通信が有効化されていないノードの作成[1]

リモート通信をサポートしないドメイン内のJava EE Serverノードの一覧表示[1]

ろ

ログ属性の一覧表示[1]

マニュアル発行元

株式会社 日立製作所

〒100-8280　東京都千代田区丸の内一丁目6番6号