Sun Java ロゴ     前へ      目次      索引      次へ     

Sun ロゴ
Sun Java System Portal Server 6 2004Q2 管理ガイド 

第 21 章
コマンドラインユーティリティ

Sun JavaTM System Portal Server には、グラフィカルユーザーインタフェースに加えて一連のコマンドラインユーティリティが用意されています。

表 21-1 は、この章で説明するコマンドラインユーティリティを示しています。この章では、管理タスクに限定してコマンドラインユーティリティを説明します。次の表には 2 つの列があります。最初の列はコマンド名、2 番目の列はその説明を示します。ユーティリティは、デスクトップ、リライタ、検索の機能別にグループ化されています。

表 21-1 Sun Java System Portal Server コマンドラインユーティリティ

コマンド

説明

deploy

Web アプリケーションを Web コンテナに配備する

pdeploy

ポートレット Web アプリケーションを Web コンテナに配備する

dpadmin

ディスプレイプロファイルドキュメントからのディスプレイプロファイルオブジェクトの取得、追加、変更、削除を有効にする

par

チャネル、プロバイダ、または両方を移動するための .par ファイルに関係する機能を実行する

rwadmin

管理者によるリライタデータの管理を有効にする

rdmgr

検索サーバーに必要なすべての機能を実行し、リソース記述および検索データベースと連動する

sendrdm

CGI またはコマンドラインベースの検索メカニズムを提供する

StartRobot

ロボットの Web 検索 (クローリング) を開始する

Sun Java System Identity Server の管理用コマンドラインインタフェース amadmin も使用できます。amadmin ツールの第一の目的は、Identity Server 上で実行される管理者によるバッチ管理処理を支援することです。新しいサービスの作成、登録、有効化、および組織、ピープルコンテナ、グループ、ロール、ユーザーの作成、削除、読み取り (取得) を支援します。詳細については、『Sun Java System Identity Server 6 Programmer's Guide』を参照してください。


deploy

説明

deploy コマンドは、Sun Java System Portal Server Web アプリケーションのソースファイルをパッケージ化し、Portal Server ソフトウェアをホスティングする Web コンテナにそのパッケージを配備します。

Sun Java System Portal Server のソースファイルは /opt/SUNWps/web-src ディレクトリに格納されます。WEB-INF/xml サブディレクトリには、web.xml コードファイルが含まれます。このファイルは、deploy コマンドによって結合され、Sun Java System Portal Server Web アプリケーション用の web.xml ファイルとなります。web.xml コードファイル内の対応するセクションは、web.xml コードファイルのアルファベット順で結合されます。最終的な web.xml ファイルが完成すると、opt/SUNWps/web-src ディレクトリ内のファイルは jar コマンドを使用して Web アプリケーションアーカイブ (WAR) ファイルとしてまとめられます。Web コンテナには、deploy コマンドを使用してこの WAR ファイルが配備されます。

構文

/opt/SUNWps/bin/deploy [redeploy]

サブコマンド

deploy コマンドには、redeploy サブコマンドが伴います。redeploy オプションを指定せずに deploy コマンドを呼び出すと、標準入力からの設定情報が求められます。

redeploy

説明

redeploy サブコマンドは、deploy コマンドが URI (Uniform Resource Indicator) と Sun Java System Portal Server Web アプリケーションに関するその他の情報を現在の配備から再利用することを指定します。

構文

deploy redeploy


pdeploy

説明

ポートレット Web アプリケーションを Portal Server に配備する (または配備取り消しする) ときは、pdeploy コマンドラインツールを使用します。

pdeploy コマンドには次の項目が必要です。

ポートレットアプリケーションの配備時に pdeploy コマンドが使用するデフォルト設定の一部は、PDConfig.properties ファイルに指定されます。このファイルは /etc/opt/SUNWps/portlet ディレクトリにインストールされます。

pdeploy コマンドがポートレットアプリケーションを配備するときに、PDConfigure.properties ファイル内の次のパラメータが参照されます。

logger.log.level=SEVERE

デフォルトでは、ログレベルは SEVERE に設定される。有効な値は、ALL、OFF、INFO、WARNING、SEVERE

logger.file.dir=/var/opt/SUNWam/debug

このパラメータは、配備したポートレットアプリケーションのログファイルが格納されるディレクトリを指定する

validate_schema=true

このパラメータは、配備時にスキーマ評価を行うかどうかを指定する

構文

ここでは、pdeploy コマンドの構文について説明します。

短い名前の形式

pdeploy deploy -u uid -w password {-g|-d dn} -p webcontainerpassword -V -r rolesfile -f userinfofile -v -l warfile

pdeploy undeploy -u uid -w password {-g|-d dn} -p webcontainerpassword -V -v -l warfile

長い名前の形式

pdeploy deploy --runasdn uid --password password {--global|--dn dn} --wc_password webcontainerpassword --rolesfile rolesfile --userinfofile userinfofile --verbose --locale warfile

pdeploy deploy --help

pdeploy deploy --version

pdeploy undeploy --runasdn uid --password password {--global|--dn dn} --wc_password password --verbose --locale portletwebapp

pdeploy undeploy --help

pdeploy undeploy --version

サブコマンド

pdeploy コマンドでは次のサブコマンドをとります。

deploy

説明

サブコマンドとして deploy を指定した場合、pdeploy コマンドはポートレット Web アプリケーションを Portal Server に配備します。このコマンドが完了すると、配備したポートレット Web アプリケーションに定義されているポートレットに基づくチャネルを作成できるようになります。

構文

pdeploy deploy -u uid -w password {-g|-d dn} -p webcontainerpassword warfile

pdeploy deploy -h|--help

オプション

表 12-2 は、サポートされるオプションを説明しています。2 つの列から構成されます。最初の列は deploy サブコマンドで使用できるオプション、引数、またはオペランド、2 番目の列は簡単な説明を示します。

表 21-2 deploy サブコマンドのオプション 

オプション

説明

-v または --verbose

デバッグメッセージを生成する

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-f または --userinfofile

ユーザー情報のマッピング情報を含むファイルを指定する

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

--help

stdout にヘルプメッセージを出力する

-l または --locale

ロケール情報を出力する

-p または --wc_password

Web コンテナのパスワードを指定する。このオプションは必須

-r または --rolesfile

Sun Java System Identity Server ソフトウェアとポートレットアプリケーションロールのマッピング情報を含むファイルを指定する

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-V または --version

バージョン情報を生成する

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

表 21-3 deploy サブコマンドのオペランド  

オペランド

説明

warfile

WAR ファイルへのパスを指定する

例 1    

次の例では、pdeploy コマンドは /tmp/SamplePortletApp.war を Portal Server に配備します。

pdeploy deploy -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w admin -p sunone -g /tmp/SamplePortletApp.war

例 2    

ポートレットアプリケーションが portlet.xml ファイルに論理ロールを定義することがあります。配備時に、この論理ロールとシステムに実際に定義されているロールをマッピングする必要があります。このマッピングには、ロールマッピングファイルが使用されます。

ロールマッピングファイルには、ActualRole=LogicalRole という形式でエントリが保存されます。このファイルの形式は、JavaTM プロパティファイルの形式に準拠する必要があります。たとえば、次のようになります。

cn¥=HRManager,dc¥=iplnaet,dc¥=com=Manager

cn¥=Emp,dc¥=iplnaet,dc¥=com=Employee

次の pdeploy コマンドは、SamplePortletApp.war ファイルをポートレットアプリケーションに配備するためのロールマッピングファイルを提供します。

pdeploy deploy -u "uid=amAdmin,ou=People,o=sesta.com,o=isp" -w admin -p sunone -r /tmp/RoleMaps -g /tmp/SamplePortletApp.war

例 3    

ポートレットアプリケーションが各ユーザーに関連する情報にアクセスしなければならないこともあります。配備時に、論理ユーザー情報エントリ名をシステムに定義されている実際のユーザー情報エントリ名にマッピングする必要があります。配備時にマッピングを行えるように、ユーザー情報エントリマップを添付できます。

ユーザー情報ファイルには、ActualEntryName=LogicalEntryName という形式でエントリが格納されます。たとえば、次のようになります。

lastname=lname

firstname=fname

次の pdeploy コマンドは、SamplePortletApp.war ファイルをポートレットアプリケーションに配備するためのユーザー情報ファイルを提供します。

pdeploy deploy -u "uid=amAdmin,ou=People,o=sesta.com,o=isp" -w admin -p sunone -f /tmp/UserInfoMaps -g /tmp/SamplePortletApp.war

undeploy

説明

undeploy サブコマンドは、Portal Server からポートレットアプリケーションを消去します。しかし、ポートレット Web アプリケーションに定義されているポートレット用にすでに作成されているすべてのチャネル定義は消去されません。消去するポートレット Web アプリケーションに関連するすべてのチャネルは、手動で消去する必要があります。

構文

pdeploy undeploy -u uid -w password {-g|-d dn} -p webcontainerpassword -v portletwebapp

pdeploy undeploy -h|--help

オプション

表 21-4表 21-5 は、サポートされるオプションを示しています。これらの表には 2 つの列があります。最初の列は undeploy サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。

表 21-4 undeploy サブコマンドのオプション 

オプション

説明

-v または --verbose

デバッグメッセージを生成する

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

--help

stdout にヘルプメッセージを出力する

-l または --locale

ロケール情報を提供する

-p または --wc_password

Web コンテナのパスワードを指定する。このオプションは必須

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-V または --version

バージョン情報を生成する

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

表 21-5 undeploy サブコマンドのオペランド 

オペランド

説明

portletwebapp

配備されているポートレット Web アプリケーションの名前を指定する。通常は、WAR ファイルの名前から拡張子 .war を除いたものと一致する

   

次の pdeploy コマンドは、Portal Server から SamplePortletApp というポートレット Web アプリケーションを配備解除します。

pdeploy undeploy -u "uid=amAdmin,ou=People,o=sesta.com,o=isp" -w admin -g


dpadmin

説明

dpadmin コマンドとサブコマンドを使用することで、ディスプレイプロファイルオブジェクトをディスプレイプロファイルドキュメントから取得、追加、変更、削除できます。ディスプレイプロファイルオブジェクトとの対話は、すべてネイティブ XML フォーマットにする必要があります。dpadmin コマンドでは、単一のディスプレイプロファイルドキュメントでのみ操作できます。

dpadmin コマンドには次の項目が必要です。

構文

ここでは、dpadmin コマンド構文について説明します。長い名前のオプションと短い名前のオプションを、1 つのコマンドラインで同時に使用することはできません。

短い名前の形式

$ dpadmin list|merge|modify|add|remove [command-specific options] -u uid   
-w password {-g|-d dn}[-l locale] [-r] [-b] [-V] [-h] [file]

$ dpadmin batch [-c] -f batch-script-filename [-l locale] [-b] [-h]

長い名前の形式

$ dpadmin list|merge|modify|add|remove [command-specific options] --runasdn uid --password password {--global|--dn dn} [--locale locale] [--dryrun] [--verbose] [--version] [--help] [file]

$ dpadmin --version

$ dpadmin batch [--continue] --file batch-script-filename [--locale locale] [--verbose] [--help]

サブコマンド

dpadmin コマンドは次のサブコマンドをとります。

list

説明

このサブコマンドを使用して、指定されたディスプレイプロファイルドキュメントから、ディスプレイプロファイルノードオブジェクトを取得します。ディスプレイプロファイルノードオブジェクトが何も指定されていない場合は、ディスプレイプロファイルドキュメント全体が取得されます。ディスプレイプロファイルオブジェクトは、ネイティブ XML フォーマットで表示されます。

list サブコマンドには次のオプションがあります。

構文

$ dpadmin list -u|--runasdn uid -w|--password password {(-g|--global)|(-d|--dn dn)} [-n|--name name]

$ dpadmin list -h|--help

オプション

表 21-6 には 2 つの列があります。最初の列は list サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-6 list サブコマンドのオプション

引数 / オペランド

説明

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

-n または --name

表示するディスプレイプロファイルコンテナ、チャネルまたはプロバイダオブジェクトの完全修飾名を指定する。このオプションは必須ではない

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

例 1

$ dpadmin list -n TemplateTableContainer -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com"

この例は、dc=org,dc=com 組織ノードから、TemplateTableContainer オブジェクトを取得し、標準出力に出力します。

例 2

$ dpadmin list -n mailcheck -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -g

この例は、mailcheck を取得する場合にのみグローバルレベルに入り、取得できた場合に標準出力に出力します。

例 3

$ dpadmin list -n TemplateTableContainer/Bookmark2 -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com"

この例は、コンテナ TemplateTableContainer にある Bookmark2 というチャネルを取得し、標準出力に出力します。

merge

説明

このサブコマンドは、指定した DP ノードオブジェクトのマージ結果を取得し、表示します。オブジェクトはネイティブ XML 形式で表示される。表示されるオブジェクトは、標準出力に送信される。-n または --name オプションを使用しない場合、エラーが出力される

merge コマンドは、次の引数を受け付けます。

--name または -n

name 引数は、表示する DP コンテナ、チャネル、またはプロバイダオブジェクトの完全修飾名を指定します。name 引数が指定されていない場合、DP ドキュメント全体が表示されます。name 引数が DP ノードオブジェクトを指定しない場合、エラーが出力されます。


merge サブコマンドは、オブジェクトのマージ結果を表示するだけで、マージが行われるわけではありません。このサブコマンドを実行しても、対象データが変化することはありません。


$ dpadmin list -n "Bookmark" ¥

-u "uid=amAdmin,ou=People,dc=iplanet,dc=com" -w joshua ¥

-d "dc=iplanet,dc=com"

<Channel name=釘ookmarkprovider=釘ookmarkProvidergt;

         <Properties merge=吐uselock=吐alsename=点propertiesgt;

<String name=鍍itlevalue=溺y Bookmarksmerge=途eplace lock=吐alse>

<String name=途efreshTimevalue=00merge=途eplace lock=吐alse>

<Collection name=鍍argetsmerge=吐uselock=吐alsegt;

<String value="Sun home page|http://www.sun.com" merge="replace" lock=吐alse>

<String value="Everything you want to know about Sun Java System...|http://www.sun.com/software/products/portal_srvr/home_por tal.htmlmerge=途eplacelock=吐alse>

<String value="Sun Java System home page|http://www.sun.com/software" advanced=吐alsemerge=途eplace lock=吐alse>

</Collection>

         </Properties>

</Channel>

$ dpadmin list -n "Bookmark" ¥

         -u "uid=amAdmin,ou=People,dc=iplanet,dc=com" -w joshua ¥

         -d "cn=HR Role,dc=iplanet,dc=com"

<Channel name=釘ookmarkprovider=釘ookmarkProvidergt;

         <Properties merge=吐uselock=吐alsename=点propertiesgt;

<String name="title" value="HR Admin Bookmarks" merge="replace" lock=吐alse>

<Collection name=鍍argetsmerge=吐uselock=吐alsegt;

<String value="HR Admin home page|http://hr.acme.com" merge="replace" lock=吐alse>

</Collection>

         </Properties>

</Channel>

$ dpadminmerge -n "Bookmark" ¥

         -u "uid=amAdmin,ou=People,dc=iplanet,dc=com" -w joshua ¥

         -d "uid=hradmin,ou=people,dc=iplanet,dc=com"

<Channel name=釘ookmarkprovider=釘ookmarkProvidergt;

         <Properties merge=吐uselock=吐alsename=点propertiesgt;

<String name="title" value="HR Admin Bookmarks" merge="replace" lock=吐alse>

<Collection name=鍍argetsmerge=吐uselock=吐alsegt;

<String value="Sun home page|http://www.sun.com" merge="replace" lock=吐alse>

<String value="Everything you want to know about Sun Java System ...|http://www.sun.com/software/products/portal_srvr/home_portal.ht ml" merge=途eplacelock=吐alse>

<String value="Sun Java System home page|http://www.sun.com/software" advanced=吐alsemerge=途eplace lock=吐alse>

<String value="HR Admin home page|http://hr.acme.com" merge="replace" lock=吐alse>

</Collection>

                   <Collection name=敵lobalThemesmerge=吐use lock=吐alsegt;

                             <Collection name=鍍heme1merge=吐use lock=吐alsegt;

                                   <String name="description" value="Sun Java Systemmerge=途eplacelock=吐alse>

                                                         ...

                             </Collection>

                   </Collection>

                   <Collection name="locales" merge="fuse" lock="false" propagate=鍍rueadvanced=吐alsegt;

                             <String name="en_US" value="English (United States)" merge=途eplacelock=吐alse>

                   </Collection>

                   <String name="docroot" value="/docs/" merge="replace" lock=吐alse>

                  <String name="helpURL" value="desktop/usedesk.htm" merge=途eplacelock=吐alse>

         </Properties>

</Channel>

これは、HR Role に割り当てられている hradmin というユーザーの Bookmark チャネルのマージ結果です。


merge サブコマンドからの出力は、結果の総計から構成されます。つまり、使用可能なすべての DP オブジェクトがリストされます。 たとえば、GlobalThemeslocales などのプロパティが Bookmark 定義に定義されていない場合でも、Bookmark チャネルの 1 つまたは複数の親からマージされ、出力に表示されます。


modify

説明

このサブコマンドは、既存のディスプレイプロファイルオブジェクトを変更します。dpadmin modify コマンドへのデータは、1 つまたは複数の入力ファイル、またはコマンドの後に指定される XML コードである標準入力から提供されます。

この XML データには、変更するディスプレイプロファイルオブジェクトを一意に定義する名前と適切な XML ヘッダーが必要になります。適切な XML ヘッダーの例を次に示します。

modify サブコマンドの動作は、変更されているディスプレイプロファイルオブジェクトのタイプに応じて異なります。combine オプションを指定すると、ディスプレイプロファイルオブジェクト内の新しい (プロパティなどの) 要素が既存の要素を置き換えるのではなく、既存の要素と結合されます。modify サブコマンドには次の種類があります。

modify サブコマンドは次のオプションをとります。

構文

$ dpadmin modify -u|--runasdn uid -w|--password password {(-g|--global)|(-d|--dn dn)} [-p|--parent parent] [-m|--combine]  file|EOF

$ dpadmin modify -h|--help

オプション

表 21-7 には 2 つの列があります。最初の列は modify サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-7 modify サブコマンドのオプション 

引数 / オペランド

説明

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

ファイル

file 引数を指定する場合、コマンドラインの最後の引数として指定する必要がある。この引数は、ディスプレイプロファイルの DTD に適合する XML コードを含む XML ファイルへのパスを指定する。modify サブコマンドにfile 引数が指定されていない場合、入力を標準入力から dpadmin にリダイレクトする必要がある

-m または --combine

指定されたディスプレイプロファイルオブジェクトを、新しいディスプレイプロファイルオブジェクトと結合する。combine オプションは次のディスプレイプロファイルオブジェクトで使用できる。Display Profile root、Channel、Container、Properties、Available、Selected、Collection、および Locale。このオプションは省略可能

-p または --parent

変更されるディスプレイプロファイルオブジェクトの親の完全修飾名を指定する。このオプションは省略可能

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

例 1

$ dpadmin modify -p TemplateTableContainer -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com" <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Channel name="NewNews" provider="newsprovider">

    <Properties>

        <String name="title" value="News Channel"/>

        <String name="description" value="This channel is all about news"/>

    </Properties>

</Channel>

EOF

この例は、コンテナ TemplateTableContainer にある NewNews というチャネルを標準入力の XML テキストとして指定された値に変更 (置換) します。

例 2

$ dpadmin modify -p TemplateTableContainer/NewNews -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com" farble.xml

この例は、NewNews チャネルのプロパティのうち、farble.xml ファイルに名前が指定されているプロパティを farble.xml ファイル内の新しいオブジェクトに置き換えます。farble.xml ファイルの内容は次のとおりです。

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<String name="welcome" value="Hi, welcome to farble land!!!!"/>

例 3

$ dpadmin list -n TemplateTableContainer -u "uid=amAdmin,ou=people,dc=org,dc=comp" -w joshua -d "dc=org,dc=com"

...

<Collection name="news">

    <Collection name="bar">

        <String name="msg" value="hi"/>

    </Collection>

</Collection>

...

$ dpadmin modify -p TemplateTableContainer -u "uid=amAdmin,dc=org,dc=com" -w joshua -d "dc=org,dc=com" -m <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Collection name="news">

    <Collection name="bar">

        <String name="msg2" value="woo hoo"/>

    </Collection>

</Collection>

EOF

$ dpadmin list -n TemplateTableContainer -u "uid=amAdmin,dc=org,dc=com" -w joshua -d "dc=org,dc=com"

...

<Collection name="news">

    <Collection name="bar">

        <String name="msg" value="hi"/>

        <String name="msg2" value="woo hoo"/>

    </Collection>

</Collection>

...

この例は、combine オプションを使用して、新しいプロパティ "msg2" を、集合 "bar" に追加します。既存のプロパティ "msg" が結果に残っていることを確認します。

例 4

$ dpadmin list -n test -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com"

<Container name="test" provider="testprovider">

    <Properties>

        <String name="title" value="test"/>

    </Properties>

    <Available />

    <Selected />

    <Channels>

        <Channel name="test1" provider="test1provider">

            <Properties>

                <Collection name="news">

                    <String name="msg1" value="blah"/>

                    <Collection name="bar">

                        <String name="msg2" value="hi"/>

                    </Collection>

                </Collection>

            </Properties>

        </Channel>

    </Channels>

</Container>

$ dpadmin modify -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com" -m <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Container name="test" provider="testprovider">

    <Properties>

        <String name="title" value="Test Container"/>

    </Properties>

    <Available>

        <Reference value="test1"/>

    </Available>

    <Selected>

        <Reference value="test1"/>

    </Selected>

    <Channels>

        <Channel name="test1" provider="test1provider">

            <Properties>

                <Collection name="news">

                    <String name="msg1" value="123"/>

                    <Collection name="bar">

                        <String name="msg3" value="123/>

                    </Collection>

                </Collection>

            </Properties>

        </Channel>

    </Channels>

</Container>

EOF

$ dpadmin list -n test -u "uid=amAdmin,ou=people,dc=org,dc=com" -w joshua -d "dc=org,dc=com"

<Container name="test" provider="testprovider">

    <Properties>

        <String name="title" value="Test Container"/>

    </Properties>

    <Available>

        <Reference value="test1"/>

    </Available>

    <Selected>

        <Reference value="test1"/>

    </Selected>

    <Channels>

        <Channel name="test1" provider="test1provider">

            <Properties>

                <Collection name="news">

                    <String name="msg1" value="123"/>

                    <Collection name="bar">

                        <String name="msg2" value="hi"/>

                        <String name="msg3" value="123"/>

                    </Collection>

                </Collection>

            </Properties>

        </Channel>

    </Channels>

</Container>

この例では、"title" および "msg1" の値が、新しい値で置き換えられます。AvailableSelected の両方に、Reference value が追加されました。"news" 集合が "msg3" を追加しました。この例は、必要に応じて結合および置き換えを行うために、-m または combine オプションを modify サブコマンドとともに使用できることを示しています。

例 5

$ dpadmin list -n test ¥

     -u "uid=amAdmin,ou=People,dc=iplanet,dc=com"  -w joshua ¥

     -d "dc=iplanet,dc=com"

<Channel name="test" provider="testprovider">

    <Properties>

        <Collection name="foo">

              <String name="foo1" value="bar"/>

        </Collection>

    </Properties>

</Channel>

$ dpadmin modify -p test ¥

     -u "uid=amAdmin,ou=People,dc=iplanet,dc=com"  -w joshua ¥

     -d "dc=iplanet,dc=com" -m <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<ConditionalProperties condition="client" value="nokia">

   <Collection name="foo">

         <String name="foo1" value="nokia bar"/>

   </Collection>

</ConditionalProperties>

EOF

$ dpadmin list -n test ¥

     -u "uid=amAdmin,ou=People,dc=iplanet,dc=com" -w joshua ¥

     -d "dc=iplanet,dc=com"

<Channel name="test" provider="testprovider">

    <Properties>

        <Collection name="foo">

              <String name="foo1" value="bar"/>

        </Collection>

        <ConditionalProperties condition="client" value="nokia">

            <Collection name="foo">

                <String name="foo1" value="nokia bar"/>

            </Collection>

        </ConditionalProperties>

   </Properties>

</Channel>

$ dpadmin modify -p test ¥

    -u "uid=amAdmin,ou=People,dc=iplanet,dc=com"  -w joshua ¥

    -d "dc=iplanet,dc=com"  -m <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<ConditionalProperties condition="client" value="nokia">

    <ConditionalProperties condition="locale" value="en">

         <String name="abc" value="nokia en abc"/>

    </ConditionalProperties>

</ConditionalProperties>

EOF

$ dpadmin list -n test ¥

     -u "uid=amAdmin,ou=People,dc=iplanet,dc=com"  -w joshua ¥

    -d "dc=iplanet,dc=com"

<Channel name="test" provider="testprovider">

    <Properties>

        <Collection name="foo">

              <String name="foo1" value="bar"/>

        </Collection>

        <ConditionalProperties condition="client" value="nokia">

            <Collection name="foo">

                <String name="foo1" value="nokia bar"/>

            </Collection>

            <ConditionalProperties condition="locale" value="en">

                <String  name="abc" value="nokia en abc"/>

            </ConditionalProperties>

        </ConditionalProperties>

   </Properties>

</Channel>

この例では、Combine オプションを使用して条件プロパティを追加しています。

add

説明

このサブコマンドは、ディスプレイプロファイルに新しいディスプレイプロファイルオブジェクトを追加します。追加されるオブジェクトが、ディスプレイプロファイルに存在しない必要があります。add サブコマンドは、標準入力またはコマンドへの引数に指定された 1 つまたは複数のファイルから、新しいオブジェクト用のデータを読み取ります。新しいオブジェクト用のデータは、XML であり、Sun Java System Portal Server ディスプレイプロファイル DTD に適合する必要があります。

この XML データには、変更するディスプレイプロファイルオブジェクトを一意に定義する一連の名前と適切な XML ヘッダーが必要になります。適切な XML ヘッダーの例を次に示します。


付録 B には、ディスプレイプロファイル DTD が含まれます。


add サブコマンドの動作は、追加されているディスプレイプロファイルオブジェクトのタイプに応じて異なります。次のように指定します。

add サブコマンドは次のオプションをとります。

構文

$ dpadmin add -u|--runasdn uid -w|--password password {(-g|--global)|(-d|--dn dn)} [-p|--parent parent] file|<<EOF

$ dpadmin add -h|--help

オプション

表 21-8 には 2 つの列があります。最初の列は add サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-8 add サブコマンドのオプション

引数 / オペランド

説明

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

ファイル

file 引数を指定する場合は、コマンドラインの最後の引数として指定する必要がある。この引数は、ディスプレイプロファイルの DTD に適合する XML コードを含む XML ファイルへのパスを指定する。add サブコマンドに file 引数がない場合、入力は、標準入力から dpadmin コマンドにリダイレクトされることが必要

-p または --parent

追加するディスプレイプロファイルオブジェクトの親の完全修飾名を指定する

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

$ dpadmin add -p SampleTabPanelContainer/Postal -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp" <<EOF

<?xml version="1.0" encoding="utf-8" standalone="no"?>

<!DOCTYPE DisplayProfile SYSTEM "jar://resources/psdp.dtd">

<Collection name="zipCodes">

   <Integer value="98012"/>

   <Integer value="98036"/>

   <Integer value="94025"/>

   <Integer value="95112"/>

</Collection>

EOF

この例は、標準入力に指定された "zipCodes" という集合プロパティを、SampleTabPanelContainer というコンテナにある Postal というチャネルに追加します。

remove

説明

このサブコマンドは、既存のディスプレイプロファイルオブジェクトを、ディスプレイプロファイルから消去します。消去するオブジェクトが指定したディスプレイプロファイルドキュメントに存在しない場合、エラーが報告されます。このサブコマンドは、typeparent、および name オプションをとります。

type オプションは、消去するディスプレイプロファイルオブジェクトのタイプを指定します。parent オプションは、消去するディスプレイプロファイルオブジェクトの親ディスプレイプロファイルオブジェクトの完全修飾名を指定します。親ディスプレイプロファイルオブジェクトのタイプは、消去されるディスプレイプロファイルオブジェクトのタイプに応じて異なります。name オプションは、消去するオブジェクトの名前を指定します。

parent オプションと name オプションの動作は、消去するディスプレイプロファイルオブジェクトのタイプに応じて異なります。表 21-9 には 2 つの列があります。最初の列はタイプオプションで使用できる値、2 番目の列は消去されるオブジェクトに関する簡単な説明を示します。

表 21-9 dpadmin remove の parent および name の動作 

type オプションの値

parent および name オプションの動作

root

DN オプションによって、または -g (--global) オプションが指定されている場合はグローバルレベルのディスプレイプロファイルによって指定される LDAP ノードから、ディスプレイプロファイルドキュメント全体を消去する。type=root の場合は、name オプションは必要ない

channel

name オプションは必須。parent オプションがない場合、親コンテナがディスプレイプロファイルのルートノードとみなされる。それ以外の場合は、parent オプションが消去するチャネルの親コンテナ名とみなされる。name オプションは、消去するチャネルまたはコンテナの名前を指定する

provider

プロバイダはディスプレイプロファイルのルートノードの下にあるので、parent オプションを指定してはならない。name オプションは必須。このオプションは消去するプロバイダを指定する

property

parent オプションは、プロパティを消去する親コンテナ、チャネル、またはプロバイダオブジェクトの完全修飾名を指定する。parent オプションがない場合、ディスプレイプロファイルのルートノードが親オブジェクトとみなされる

name オプションは、消去するプロパティの名前を指定する。name オプションがない場合は、エラーが報告される。プロファイルプロパティに名前が付けられていない場合は、値の文字列表記が名前となる

available または selected

parent オプションと name オプションの両方が必須。parent オプションは、使用可能 (選択済み) 参照を消去する親コンテナまたはチャネルオブジェクトの名前を指定するものと想定されている。name オプションは、消去される参照の値を指定する。name オプションがない場合は、エラーが報告される

remove サブコマンドは次のオプションをとります。

構文

$ dpadmin remove -u|--runasdn uid -w|--password password {(-g|--global)|(-d|--dn dn)} [-n|--name name] [-p|--parent parent] -t|--type type

$ dpadmin remove -h|--help

オプション

表 21-10 には 2 つの列があります。最初の列はremove サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-10 remove サブコマンドのオプション

引数 / オペランド

説明

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

-n または --name

消去するディスプレイプロファイルコンテナ、チャネルまたはプロバイダオブジェクトを指定する。type=root の場合以外は、このオプションは必須

-p または --parent

削除するディスプレイプロファイルオブジェクトの親の完全修飾名を指定する

-t または --type

消去するディスプレイプロファイルオブジェクトのタイプを指定する。このオプションは必須

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

例 1

$ dpadmin remove -t property -p Bookmarks -n locations -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp"

この例は、 Bookmarks というチャネルまたはコンテナから locationsというプロパティを消去します。

例 2

$ dpadmin remove -t provider -n "pctest" -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -g

グローバルディスプレイプロファイルから、プロバイダ pctest を消去します。

例 3

$ dpadmin remove --type channel --parent TemplateTableContainer --name "Test" --runasdn "uid=amAdmin,ou=people,o=sesta.com,o=isp" --password joshua --dn "o=sesta.com,o=isp"

この例は、TemplateTableContainer という親コンテナ内に存在する Test というチャネルを消去します。

例 4

$ dpadmin list -n X -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp"

<Container name=店...>

    <Channels>

        <Container name=添...>

            <Channels>

                <Channel name=奴.../>

            </Channels>

        </Container>

    </Channels>

</Container>

チャネル z を消去するには、次のコマンドのいずれかを実行します。

$ dpadmin remove -t channel -p X -n Y/z -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp"

$ dpadmin remove -t channel -p X/Y -n z -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp"

$ dpadmin remove -t channel -n X/Y/z -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua -d "o=sesta.com,o=isp"

batch

説明

batch サブコマンドを使用すると、複数のディスプレイプロファイルコマンドの処理を最適の方法で実行できます。サブコマンドはバッチスクリプトファイル (必須) に一覧表示され、連続して実行されます。エラーが発生すると、デフォルトではエラーを報告し終了します。-c または --continue オプションは、連続処理モードを指定します。このモードでは、エラーが発生すると報告され、dpadmin は次のサブコマンドの処理を開始します。

コマンドバッチスクリプトはテキスト (ASCII) ファイルである必要があり、batch サブコマンドを除き、dpadmin に入力するためのサブコマンドをいくつでも含めることができます。サブコマンドは 1 行で入力する必要があります (改行文字はコマンドの最後を示す)。各サブコマンドには、コマンドラインに管理者の識別名およびパスワードを指定する必要があります。サブコマンドの構文は、dpadmin 部分を除いて、サブコマンドを直接シェルに入力した場合とまったく同じになります。スクリプトには XML を含めることができません。したがって、XML 入力を必要とするサブコマンドではファイルに含める必要があります。識別名 (DN ) が空白文字を含む場合は、前後を二重引用符で囲みます。

次に、バッチスクリプトファイルの例を示します (各コマンドは 1 行)。

add -p PostalMailer -u uid=amAdmin,ou=People,dc=iplanet,dc=com -w joshua -d dc=iplanet,dc=com zipCodes.xml

add -p PostalStamps -u uid=amAdmin,ou=People,dc=iplanet,dc=com -w joshua -d dc=iplanet,dc=com zipCodes.xml stampRates.xml

add -p PostalRates -d "cn=hr role,dc=iplanet,dc=com" zipCodes.xml stampRates.xml

batch サブコマンドは -c または --continue オプションをとり、-f または --file を使用してバッチスクリプトファイルの名前を指定する必要があります。

構文

$ dpadmin batch [-c|--continue] -u|--runasdn uid -w|--password password -f|--file batch-script-file

$ dpadmin batch -h|--help

オプション

表 21-11 には 2 つの列があります。最初の列はbatch サブコマンドで使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-11 batch サブコマンドのオプション

引数 / オペランド

説明

-c または --continue

連続処理モードを示す。このオプションを指定した場合、エラーは報告されるが、dpadmin は次のサブコマンドの処理を継続する。デフォルトでは、エラーを報告した後に dpadmin は終了する

-f または --file

バッチスクリプトファイルを指定する。この引数は必須

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。この引数は、listmodifyadd、および remove サブコマンドでだけ使用される

このオプションは省略可能。指定した場合、バッチ処理全体で指定のパスワードが認証に使用される。また、バッチスクリプトに指定する各サブコマンドに個別に認証を指定することができる。これは、この識別名に優先して適用される

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは省略可能。指定した場合、バッチ処理全体で指定のパスワードが認証に使用される。また、バッチスクリプトに指定する各サブコマンドに個別に認証を指定することができる。これは、このパスワードに優先して適用される

オプション

表 21-12 は、dpadmin コマンドの要約を示しています。この表では、小見出しにサブコマンドが示されます。この表には 2 つの列があります。最初の列は使用できるオプション、引数またはオペランド、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-12 dpadmin コマンドのオプション 

引数 / オペランド

説明

-V または --version

バージョン、通知、その他の情報など、ユーティリティに関する説明を標準出力に出力するときは、dpadmin にこのオプションを指定する。このオプションが指定されている場合、すべてのサブコマンドおよび他のオプションは無視される

すべてのサブコマンドに共通のオプション

-b または --verbose

デバッグメッセージを生成するときは、このオプションを指定する

-h または --help

標準出力に簡単なヘルプページを出力するときは、dpadmin にこのオプションを指定する。サブコマンドが指定されていない場合は、dpadmin の汎用ヘルプページが出力される。dpadmin のいずれかのサブコマンドが指定されている場合は、そのサブコマンドの簡単なヘルプページが出力される

-l または --locale

すべてのデバッグメッセージとエラーメッセージを指定のロケールでローカライズする場合は、このオプションを使用する。指定しない場合、システムロケールがデフォルトとして適用される

listaddmodify、および remove サブコマンドのオプション

-d または --dn

ディスプレイプロファイルドキュメントにアクセスする LDAP ノードの識別名を指定する。-d または -g オプションは必須

-g または --global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する-d または -g オプションは必須

-r または --dryrun

サブコマンドのエラーやサブコマンドが正常に機能していることを sysout に報告する。サブコマンドによる変更結果は LDAP には配置されない

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。この引数は、listmodifyadd、および remove サブコマンドでだけ使用される。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須

list および remove サブコマンドのオプション

-n または --name

表示するまたは削除するディスプレイプロファイルコンテナ、チャネルまたはプロバイダオブジェクトの完全修飾名を指定する。このオプションは必須ではない

addmodify、および remove サブコマンドのオプション

-p または --parent

追加、変更または削除するディスプレイプロファイルオブジェクトの親の完全修飾名を指定する

add および modify サブコマンドのオプション

ファイル

file 引数を指定する場合は、コマンドラインの最後の引数として指定する必要がある。この引数は、ディスプレイプロファイルの DTD に適合する XML コードを含む XML ファイルへのパスを指定し、適切な XML ヘッダーを含む。XML の入力が必要なサブコマンドには、modify および add が含まれる。これらのサブコマンドに file 引数がない場合、入力は、標準入力から dpadmin コマンドにリダイレクトされることが必要

modify サブコマンドのオプション

-m または --combine

指定されたディスプレイプロファイルオブジェクトを、新しいディスプレイプロファイルオブジェクトと結合する。modify サブコマンドでだけ使用できる。combine オプションは次のディスプレイプロファイルオブジェクトで使用できる。Display Profile root、Channel、Container、Properties、Available、Selected、Collection、および Locale

remove サブコマンドのオプション

-t または --type

削除されるディスプレイプロファイルオブジェクトのタイプを指定する。使用できるタイプは、 rootchannelproviderpropertyavailable、または selected

batch サブコマンドのオプション

-c または --continue

連続処理モードを示す。batch サブコマンドでだけ使用できる。このオプションを指定した場合、エラーは報告されるが、dpadmin は次のサブコマンドの処理を継続する。デフォルトでは、エラーを報告した後に dpadmin は終了する

-f または --file

バッチスクリプトファイルを指定する。ASCII ファイルは、batch サブコマンドでだけ使用できる

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定する。この引数は、listmodifyadd、および remove サブコマンドでだけ使用される。このオプションは必須

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定する。このオプションは必須


par

説明

par コマンドは、指定された.par ファイルと関連する機能を実行します。チャネルまたはプロバイダを Sun Java System Portal Server でインポートまたはエクスポートする場合に使用できます。

構文

ここでは、par コマンド構文について説明します。長い名前のオプションと短い名前のオプションを、1 つのコマンドラインで同時に使用しないようにしてください。

短い名前の形式

par containers -r uid -p password [-d] dn|global

par describe [-d] parfile

par export -r uid -p password [-m] [-d] -s staticdir [-v] parfile dn|global {exportfile|from=}...

par import -r uid -p password [-o] [-d] -s staticdir [-v] parfile [dn|global [op...]]

par import -r uid -p password  -a [-d] -s staticdir [-v] parfile [dn|global]

長い名前の形式

par containers --runasdn uid --password password [--debug] dn|global

par describe [--debug] parfile

par export --runasdn uid --password password [--modify] [--debug] --staticdir staticdir [--verbose] parfile dn|global {exportfile|from=}...

par import --runasdn uid --password password [--overwrite] [--debug] --staticdir staticdir [--verbose] parfile [dn|global [op...]]

par import --runasdn uid --password password --auto [--debug] --staticdir staticdir [--verbose] parfile [dn|global]

サブコマンド

次のサブコマンドを使用できます。

containers

説明

指定された Directory Server 名 (またはglobal) で表示された、特定のディスプレイプロファイルドキュメント内のすべての使用可能なコンテナおよびチャネル一覧表示します。ほかのコマンドを構築するための補助として使用できます。

構文

par containers -r|--runasdn uid -p|--password password [-d|--debug] [-v|--verbose] dn|global

par containers -r "uid=amAdmin,ou=people,o=sesta.com,o=isp" -p joshua -d "o=sesta.com,o=isp"

この例は、LDAP ノード"o=sesta.com,o=isp" にあるディスプレイプロファイルドキュメント内の使用可能なコンテナを一覧表示します。

describe

説明

エントリおよびエントリに定義されたすべての組み込みの自動抽出操作を含む、指定された .par ファイルの内容を記述します。

構文

par describe parfile

par describe myfile.par

この例では、コマンド出力または myfile.par の記述内容は次のようになります。

Class Root: /

Property Based File Root:/pbfiles

Display Profile Root:/dp

Static Content Root:/static

Entry:mychannel

AutoExtract:dpnode=o%3Dsesta.com%2Co%3Disp,channel,entry=mychann el

DP Document:this my JSP based channel.

Channel:SampleJSP.a

Includes: Property Based File, root templateBaseDir, path default/mychannel/samplecontent.jsp (channel)

Includes: Property Based File, root templateBaseDir, path default/mychannel/sampledoedit.jsp (channel)

Includes: Property Based File, root templateBaseDir, path default/mychannel/sampleedit.jsp (channel)

Includes: Property Based File, root templateBaseDir, path default_en_US/mychannel/samplecontent.jsp

(channel)

Includes: Property Based File, root templateBaseDir, path default_en_US/mychannel/sampledoedit.jsp

(channel)

Includes: Property Based File, root templateBaseDir, path default_en_US/mychannel/sampleedit.jsp

(channel)

export

説明

Portal Server からプロバイダまたはチャネルをエクスポートすることで、指定された .par ファイルを生成します。このコマンドは、.par ファイル、更新の必要があるディスプレイプロファイルドキュメントに対応する Diretory Server 名引数 (またはキーワード global)、および任意の数 (1 以上) の exportfile、または from 指定をとります。from 指定には、エクスポートと同じ情報が含まれますが、"行" はセミコロンで区切られます。

-m オプションが指定されていない par export コマンドは、.par ファイルを生成します。-m オプションが指定された par export コマンドは、プロバイダ、チャネル、またはコンテナを定義する既存の .par ファイルの更新または追加、あるいはその両方に使用されます。

構文

par export -r|--runasdn uid -p|--password password [-d|--debug] -s|--staticdir staticdir [-v|--verbose] parfile dn|global {exportfile|from=}...

par export -r|--runasdn uid -p|--password password [-d|--debug] -s|--staticdir staticdir [-v|--verbose] -m|--modify parfile dn|global {exportfile|from=}...

par export -r "uid=amAdmin,ou=people,dc=sesta,dc=com" -p joshua mychannel.par "o=sesta.com,o=isp" myexport.txt

myexport.txt コンテナの内容は次のようになります。

from: channel mychannel

directory: templateBaseDir . mychannel

description: this is my JSP based channel

この例は、mychannel のチャネル定義およびテンプレートファイルを "o=sesta.com,o=isp" dn から mychannel.par へエクスポートします。また、JSPProvider チャネルの場合、directory 行は、ロケール固有バージョンを含むすべての .jsp ファイルを移行します。

import

説明

指定された .par ファイルから Portal Sever へオブジェクトをインポートします。このコマンドは、.par ファイル、および Directory Server に示されたディスプレイノードにオブジェクトをインポートするためのディスプレイプロファイルドキュメントのオプションの引数 (またはキーワード global によって示されたルートディスプレイプロファイル)、および実行する操作をとります。指定されていない場合は、これらの情報は par ファイルから取得されます。auto オプションを使用して、.par ファイルにすでに含まれている自動抽出操作を実行することを指定できます。

新しいチャネルを追加する場合は、par import コマンドを使用します。このコマンドは -o オプションとともに使用することもできます。チャネルがすでに存在する場合は、 -o オプションを par import コマンドとともに使用して、古いチャネルを完全に置き換える (上書きする) 必要があります。このサブコマンドを使用すると、チャネルだけでなくプロバイダもインポートできます。

構文

par import -r|--runasdn uid -p|--password password [-o] [-d|--debug] -s|--staticdir staticdir [-v|--verbose] parfile [dn|global [op...]]

par import -r|--runasdn uid -p|--password password -a|--auto [-d|--debug] -s|--staticdir staticdir [-v|--verbose] parfile [dn|global]

例 1

par import -r "uid=amAdmin,ou=people,o=sesta.com,o=isp" -p joshua --auto myfile.par "o=sesta.com,o=isp"

この例は、myfile.par プロファイルに定義された自動操作では、myfile.par ファイルからチャネルを抽出します。

例 2

par import -r "uid=amAdmin,ou=people,o=sesta.com,o=isp" -p joshua myfile.par "o=sesta.com,o=isp" "entry=mychannel,channel=anothername,avail=topcontainer"

この例は、ターゲットの dn 内の異なる名前でコマンドをインストールし、コンテナ topcontainer で使用できるようにして、チャネルを明示的に抽出します。

オプション

表 21-13 には 2 つの列があります。最初の列はpar コマンドで使用できるオプション、2 番目の列は簡単な説明を示します。このコマンドは、次のオプションをサポートします (アルファベット順)。

表 21-13 par コマンドのオプション 

オプション

説明

-a または --auto

import コマンドとともに使用して、.par ファイルに指定されている自動抽出操作を適用する。この場合、コマンドラインに操作を指定してはならない。dn 引数を指定することもできるが、自動抽出操作の dn に置き換えられる。コマンドラインに指定されている操作は無視される

-d または --debug

エラーメッセージに関するその他のデバッグ情報の生成を指定する

-m または --modify

export コマンドとともに使用して、既存の .par ファイルを置換せずに更新する。エントリの追加または古いエントリの置換によって、新しいファイルが追加される。このコマンドでは .par ファイルを使用して、新しいファイルを既存のプロバイダまたはチャネルに追加することもできる

-o または --overwrite

import コマンドとともに使用して、既存のチャネルを置き換える

-p または --password

認証パスワードを指定する。describe を除くすべてのサブコマンドで必須。指定されていない場合、par ユーティリティは指定を要求する

-r または --runasdn

認証のためのユーザーの識別名を指定する。describe を除くすべてのコマンドで必須。指定されていない場合、par ユーティリティは指定を要求する
uid=userName,ou=people,o=organizationName,o=organizationalUnit の形式で指定する

-s または --staticdir

インポートまたはエクスポートに使用されるスタティックコンテンツディレクトリの、ホスト固有のディレクトリを定義する

-v または --verbose

操作が実行されると、その操作が記述される。import および export コマンドとともに使用する

-V または --version

バージョン、通知、その他の情報など、ユーティリティに関する説明を標準出力に出力するときは、par にこのオプションを指定する。このオプションが指定されている場合、すべてのサブコマンドおよび他のオプションは無視される

-?

サブコマンドのヘルプを取得する

引数

表 21-14 には 2 つの列があります。最初の列は par コマンドで使用できる引数、2 番目の列は簡単な説明を示します。このコマンドは、次の引数をとります。

表 21-14 par コマンドの引数

引数

説明

dn

アクセスする Directory Server 内の識別されたノードを指定する。o=organizationName,o=organizationalUnit" の形式で指定する

global

ディスプレイプロファイルドキュメントにアクセスする LDAP のグローバルレベルノードを指定する

exportfile

これらのファイルは、.par ファイル内のそれぞれのエントリ (プロバイダ、チャネル、またはプロバイダとチャネルの組み合わせ) に対応する。また、単に指定された .par ファイルに挿入されるデータを指定する。情報が多すぎてコマンドラインに表示しきれない場合は、小さなファイルである可能性がある。詳細は、「エクスポートファイル」を参照

from

コマンドラインに指定される。等号 ("=") およびセミコロン (";") で区切られた行の前に "from" 行を含むエクスポートファイルと同じ。行プロパティの詳細については、表 21-15 の "from" を参照

op

実行する操作を指定する。詳細については、「操作」を参照

parfile

操作の対象になる par ファイルを指定する。つまり、インポート、エクスポート、または記述を行う par ファイルを指定する

エクスポートファイル

これらのファイルは、.par ファイルに挿入するデータを指定します。このファイルは、キーワード、続いてコロンおよび空白文字で区切られたフィールドで構成されます。ファイルの最初の行は必ず "from:"行にする必要があります。"#" で始まる行はコメントとして扱われます。

表 21-15 には 2 つの列があります。最初の列は使用できるヘッダー、2 番目の列は簡単な説明を示します。

表 21-15 エクスポートファイルの行プロパティ 

説明

from: types name

「from」はエクスポートされるエンティティの内容を表す。types は「channel」、「provider」、または「channel,provider」、および「channel+provider」のいずれかである。name は、チャネル名、またプロバイダがエクスポートされている場合は、プロバイダ名を示す。name が空白文字 (+)、カンマ (%2C)、コロン (%3A)、セミコロン (%3B)、プラス記号 (%2B)、またはパーセント記号 (%25) を含む場合は、name を URL でエンコードする必要がある

auto: none

「auto」は、エントリの自動抽出操作を指定する。op 引数とそれに続く操作をとる。「none」を入力して自動抽出を抑制することもできる。「auto:」行が指定されていない場合、デフォルトの自動抽出が作成される。デフォルトでは、チャネル、プロバイダ、または両方を元の名前で抽出する

auto: op

file: root|. path [types]

「file」は、プロパティ設定に基づいて、ファイルがインクルードされることを示す。このプロパティはデフォルトで /etc/opt/SUNWps/desktop/desktopconfig.properties ファイルに置かれた"desktop properties"、またはエクスポートまたはインポートされる項目の getProperty() 呼び出しに表示されるディスプレイプロファイルから取得できる。root はファイル場所のルートを指定し、path はファイルの残りのパスを指定する。root はディレクトリ (またはその類) に相当するプロパティ名である。root に「.」が入力されている場合は、そのファイルは Web サーバーのドキュメントルートに配置された静的コンテンツとみなされる。ファイルに関連付ける操作のタイプを指定できる。デフォルトは「channel」。types は「channel」、「provider」、または「channel,provider」、および「channel+provider」のいずれかとなる

class: class [types]

「class」はクラスファイルがエントリとパッケージ化されることを示し、オプションとしてクラスファイルに関連付けられる操作のタイプを指定できる。指定されていない場合は「provider」と見なされる。types は、「channel」、「provider」、「channel,provider」、または「channel+provider」であるが、両方を指定する場合は空白文字も使用できる

directory: root|. dir +|.|filter [types]

「directory」は、「file」行として入力された場合のように、ディレクトリ以外のファイルでディレクトリ全体検索を行うことを意味する。「filter」を指定する機能が含まれる。これは、再帰的なディレクトリ検索に必要なディレクトリコンポーネントである。root は、ディレクトリのルートまたは「.」を指定して、スタティックコンテンツであることを示す。dir は、検索の対象になるルートの下にあるディレクトリで「.」で始まる。filter は、フィルタコンポーネントを指定する。このコンポーネントはディレクトリ内にあり、再帰的なディセントである必要がある。フィルタなしの再帰的なディセントには「+」が、再帰的でないディセント (実際のディレクトリの内容) には「.」が付けられる。また、操作の種類を指定することができる。デフォルトは「channel」。types は「channel」、「provider」、「channel,provider」、または「channel+provider」のいずれかとなる

entry: name

「entry」は .par ファイルで使用されるエントリ名を指定する。指定されない場合、デフォルトとして「from」行からの名前が適用される

desc: text

「desc」行は何行でも表示でき、エントリとともにパッケージ化された、ユーザーが閲覧できる記述として連結される

操作

エクスポートファイルまたはコマンドラインの各操作 (op) は、値 (通常はオプション) を持つキーワードのカンマ区切りリストとして指定する必要があります。操作は、空白文字で区切られたリストです。各操作は次の形式で指定されます。

dpnode=dn,entry=name,provider[=name],channel[=name],container=name[,av ail=name,selected]

dpnode

これは、この操作のターゲットであるディスプレイプロファイルドキュメント用の Directory Server 内の識別名 (またはキーワード global) を指定します。指定されているコンテキストが識別名をすでに提供している場合は、適用できない場合があります。たとえば、import サブコマンドが識別名を定義する場合は、ファイル内の識別名は無視されます。

entry

.par ファイル内のエントリ名を指定します。次の場合は、エントリは必要ありません。

par ユーティリティは、エントリが指定されていない場合は最初のエントリをデフォルトにします。

provider

プロバイダの抽出が行われることを示します。名前が指定されていない場合は、.par ファイル内でプロバイダとともにパッケージ化されている名前が適用されます。

channel

チャネルの抽出が行われることを示します。名前が指定されていない場合は、.par ファイル内のチャネルとともに提供される名前が適用されます。

container

チャネルの抽出だけに適用され、チャネルがどのコンテナに挿入されるかを示します。省略されている場合、チャネルは「channel」要素のディスプレイプロファイルドキュメントルートに挿入されます。

avail

チャネルの抽出だけに適用され、「avail」 (または available) リストが新しいチャネルの参照を受け取るコンテナを示します。省略されている場合は、新しいチャネル参照が作成されます。

selected

「avail」が使用されている場合にだけ適用されます。「avail」リストが参照を受け取るコンテナを示し、また「selected」リストに参照を持ちます。

op 情報が、par import コマンドと .par ファイルの両方にある場合は、コマンド情報が優先されます。

par ファイル

ここでは、Par ファイルの形式について補足説明します。この情報は、par コマンドの実行には必要ありません。

par ファイルはチャネル、プロバイダ、およびそれらの関連ファイルのトランスポート用のマニフェストエントリを持つ jar ファイルです。このファイルを使用すると、プロバイダ、チャネルまたはその両方のインストールを柔軟に行えます。.par ファイルには、主に次の 4 つのタイプがあります。

  1. ディスプレイプロファイル用のプロバイダまたはチャネル、あるいはその両方の情報が含まれる XML ドキュメント。このドキュメントは、ディスプレイプロファイル DTD に記述されている「parEntry」である。この parEntry には、チャネルまたはプロバイダ、あるいはその両方の組み合わせが含まれる
  2. プロバイダ、チャネル、またはその両方に関連付けられたクラスファイル
  3. プロパティベースのファイル。これは、チャネル、ポートレット、またはプロバイダ (通常はチャネル) に関連付けられた一般ファイルである。これらのファイルは Portal Server 上の設定可能なルートの下に配置する必要がある
  4. スタティックコンテンツファイル。これは、ドキュメントとして Web サーバー上に配置される

par ファイルのコンテンツ

表 21-16 には 2 つの列があります。最初の列は必要とされるグローバルヘッダー、2 番目の列は簡単な説明を示します。.par ファイルには、次のヘッダーが含まれている必要があります。

表 21-16 グローバルヘッダー 

ヘッダー

説明

PS-Version

.par ファイルの Portal Server の特定のバージョンを指定する。また、これが par ファイルであることを検証する

PS-DefaultEntry

名前が付けられていないエントリを使った操作で、そのエントリに名前を付ける

PS-DPRoot

parEntry ドキュメント、クラス、プロパティベースファイル、およびスタティックコンテンツのそれぞれのアーカイブのルートディレクトリを示す。指定されていない場合は、アーカイブの一番上の対応するファイルがルートディレクトリとなる

PS-ClassRoot

PS-PBFileRoot

PS-StaticRoot

.par ファイルでは、parEntry XML ファイルのそれぞれに、名前がつけられたエントリが必要です。表 21-17 には 2 つの列があります。最初の列は使用できるヘッダー、2 番目の列は簡単な説明を示します。名前付きエントリのセクションには、次のヘッダーを含めることができます。

表 21-17 名前付きエントリのヘッダー

ヘッダー

説明

PS-EntryName

エントリのコマンド可視名を指定する

PS-AutoExtract

エントリが存在する場合に、エントリの自動抽出操作を指定する

PS-Include

実際のアーカイブパスで指定されたアーカイブファイルのカンマ区切りリストを含む。このパスは「root」の指定に基づいてファイルのタイプを示す。このファイルにはカッコ付きの番号が付加される。この番号はファイルに適用される操作のタイプに対応する (プロバイダには 1、チャネルには 2 のマスク)。エントリに関連付けられた XML ドキュメント以外にファイルがない場合は、このファイルは無視される

.par ファイルにエントリだけが含まれる場合は、デフォルトのエントリが使用されるため、ファイルを操作する際にエントリに名前を付ける必要があります。


rwadmin

説明

rwadmin コマンドを使用すると、管理者は Sun Java System Identity Server リライタサービスで使用できるリライタデータを管理できます。

構文

ここでは、rwadmin コマンドの構文について説明します。

短い名前の形式

rwadmin list -u uid -w password [-l locale] [-b] [-h]

rwadmin store -u uid -w password [-l locale] [-b] [-h] filename

rwadmin get -r rulesetname -u uid -w password [-l locale] [-b] [-h] [filename]

rwadmin remove -r rulesetname -u uid -w password [-l locale] [-b] [-h]

長い名前の形式

rwadmin list --runasdn uid --password password [--locale locale] [--verbose] [--version] [--help]

rwadmin list --runasdn uid --password password [--locale locale] [--verbose] [--version] [--help]filename

rwadmin get --rulesetid rulesetname --runasdn uid --password password [--locale locale] [--verbose] [--version] [--help] [filename]

rwadmin get --rulesetid rulesetname --runasdn uid --password password [--locale locale] [--verbose] [--version] [--help]

サブコマンド

次のサブコマンドを使用できます。

list

説明

このコマンドは使用できるルールセット名を一覧表示します。

構文

rwadmin list -u|--runasdn uid -w|--password password

rwadmin list -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua

この例は、使用可能なすべてのルールセットを表示します。

store

説明

このコマンドは、ローカルファイルシステムで使用できるルールを Sun Java System Identity Server に格納します。DefaultRuleSet を格納する場合は、次のコマンドを使用します。

rwadmin store -u uid -w password /resources/DefaultRuleSet.xml

ここで、/resources/DefaultRuleSet.xml は、rewriter.jar ファイルに格納されるルールセットの場所を示します。このコマンドを実行するときに、同じ ID を持つルールセットが存在すると、新しいデータは格納されません。ルールセット ID を削除して再実行してください。

構文

rwadmin store -u|--runasdn uid -w|--password password filename

rwadmin store -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua /opt/data/ExampleRuleSet.xml

この例は、/opt/data/ExampleRuleSet.xml で使用できるルールを Sun Java System Identity Server に格納します。

get

説明

このコマンドは、Sun Java System Identity Server からルールセットを取得します。filename を指定した場合、取得したルールセットは指定のファイルに格納され、指定しない場合、stdout (またはコンソール上) に表示されます。

構文

rwadmin get -r|--rulesetid ruleset -u|--runasdn uid -w|--password password [filename]

例 1

rwadmin get -r "ExampleRuleSet" -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua

この例は、ExampleRuleSet というルールセットを Sun Java System Identity Server から取得し、コンソール上に表示します。

例 2

rwadmin get -r "ExampleRuleSet" -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua /tmp/abc.xml

この例は、ExampleRuleSet という規則セットを Sun ONE Identity Server から取得し、/tmp ディレクトリのファイル abc.xml に格納します。

remove

説明

このコマンドは、Sun Java System Identity Server からルールセットを削除します。このコマンドは、警告メッセージを表示せずにルールセットを削除します。

構文

rwadmin remove -r|--rulesetid ruleset -u|--runasdn uid -w|password password

rwadmin remove -r "ExampleRuleSet" -u "uid=amAdmin,ou=people,o=sesta.com,o=isp" -w joshua

この例は、ExampleRuleSet というルールセットを Sun Java System Identity Server から削除します。

オプション

表 21-18 は、rwadmin コマンドの要約を示しています。この表には 2 つの列があります。最初の列は使用できるオプション、2 番目の列は簡単な説明を示します。このコマンドは、次のオプションをサポートします (アルファベット順)。

表 21-18 rwadmin コマンドのオプション

オプション

説明

-b または --verbose

コマンドの実行時に実行される処理の詳細情報を取得するときは、rwadmin にこの引数を指定する

filename

Sun Java System Identity Server にインポートするときにルールセットデータを取得するファイルを指定するときは、store サブコマンドにこのオプションを指定する。取得したルールセットデータを格納するファイルを指定するときは、get サブコマンドにこのオプションを指定する

-h または --help

標準出力に簡単なヘルプページを出力するときは、rwadmin にこのオプションを指定する。サブコマンドがない場合は、rwadmin の汎用ヘルプページが出力される。rwadmin のいずれかのサブコマンドが指定されている場合は、そのサブコマンドの簡単なヘルプページが出力される

-l または --locale

すべての出力メッセージを指定のロケールでローカライズする場合は、このオプションを使用する。指定しない場合、システムロケールがデフォルトとして適用される

-r または --rulesetid

操作の対象となるルールセットの名前を指定するときは、このオプションを指定する

-u または --runasdn

Directory Server へのバインドに使用するユーザー識別名を指定するときは、このオプションを指定する

--version

バージョン、通知、その他の情報など、ユーティリティに関する説明を標準出力に出力するときは、rwadmin にこのオプションを指定する。このオプションが指定されている場合、すべてのコマンドおよび他の引数は無視される

-w または --password

Directory Server へのバインドに使用するユーザー識別名のパスワードを指定するときは、このオプションを指定する


rdmgr

説明

rdmgr コマンドは、検索サービスを利用するときに中心的に使用されるコマンドです。管理者は、2 種類のサブコマンドを使用できます。一つはリソース記述 (RD) で使用するサブコマンドで、もう一つはデータベースの保守管理に使用するサブコマンドです。rdmgr コマンドは、通常、Portal Server の検索可能なインスタンスディレクトリである /server-instance-directory/deployment_uri ディレクトリで実行されます。これは、インストール時に選択する配備 URI パスです。デフォルトの Portal Server のインストールを選択した場合は、/var/opt/SUNWps/https-servername/portal ディレクトリとなります。servername の値は、Portal Server の完全修飾名であるデフォルトの Portal Server インスタンス名です。

構文

rdmgr コマンドの一般的な構文は次のとおりです。

RD サブコマンドはより厳密にこの構文に従います。

データベース保守サブコマンドはより厳密にこの構文に従います。

-l number を使用すると、任意の RD またはデータベースサブコマンドにログレベル番号を設定できます。値が 1 (デフォルト) に設定されている場合は、rdmgr コマンドのすべてのログが記録される。値が大きくなるほど、ログファイルに記録される情報の詳細度が増加します。レベルは 1 〜 100 です。このオプションが指定されていない場合、search.conf ファイルの debug-loglevel で定義された設定が適用されます。ログファイル名は、search.conf ファイルの rdmgr-logfile を使用して定義します。

ここで、-c search.conf オプションは、search.conf ファイルの場所を示します。このオプションを使用しない場合、デフォルト値は現在のディレクトリの config/search.conf となります。search.conf ファイルには、設定したすべての検索値が一覧表示されます。

-p progress を使用して、すべての RD またはデータベースサブコマンドの進捗状況を表示できます。-p だけを入力すると、進捗状況は stdout に出力されます。

サブコマンド

次のサブコマンドを使用できます。

リソース記述サブコマンド

説明

RD サブコマンドを使用すると、RD の挿入または置換、ビューによってフィルタリングされた RD のマージ、ビューによってフィルタリングされる RD の取得、RD の削除、および RD のカウントをバッチ処理で実行できます。表 21-19 には 2 つの列があります。最初の列はサブコマンド、2 番目の列は簡単な説明を示します。

表 21-19 rdmgr の RD サブコマンド 

サブコマンド

説明

-u

RD を挿入または置換する。何も指定されていない場合、このサブコマンドがデフォルトとなる

-m

ビューによってフィルタリングされた RD をマージする

-g

ビューによってフィルタリングされた RD を取得する

-d

RD を削除する

-n

RD をカウントする

-U

SOIF のデータベースを stdout にダンプする

-L

データベースから選択したフィールドを、stdout に一覧表示する。-a att オプションを指定する必要がある

構文

#  rdmgr   [-umgdnUL]  [-ACSTNPq]   [-a att,att,...] [-b number

[-c search.conf] [-i charset]  [-o charset] [-j number] [-l number

[-p progress] [-r number] [-s schema] [-y dbname] [filename|-Q query]

オプション

表 21-20 には、2 つの列があります。最初の列はオプションまたは引数、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-20 rdmgr の RD サブコマンドのオプション 

引数 / オペランド

説明

-A

デフォルト検索ディレクトリ内の config/schema.rdm ファイルにスキーマのエイリアスを使用しないように指定する。u および m サブコマンドで使用する

-C

データベースが見つからない場合にデータベースを作成しない。u および m サブコマンドで使用する

-S

スキーマ検査を無効にする。u および m サブコマンドで使用する

-T

分類に基づいて実行する。分類はデータベースの内容を参照および分類するために使用され、デフォルト検索ディレクトリの config/taxonomy.rdm ファイルに配置される。任意のリソース記述コマンドとともに使用する

-N

コマンドに指定した機能を、リソース記述の非永続的データだけに適用する。データベースの RD は、永続データと非永続データをマージしたものである

-P

コマンドに指定した機能を、リソース記述の永続的データだけに適用する。データベースの RD は、永続データと非永続データをマージしたものである

-q

終了時に SOIF 入力ファイルを削除する。umg 、および d のサブコマンドとともに使用する

-a att,att...

属性ビューリストを指定する。att 名は大文字と小文字が区別されず、スキーマに定義されているかどうかにかかわらず作成者またはタイトルなどの任意の属性を指定できる。class-1class-2class-3 などの複数の値を持つ att の場合、att 名として class だけを入力する

-b number

インデックス作成バッチのサイズをこの RD 数に設定する。u および m サブコマンドで使用する

-c search.conf

search.conf ファイルの場所を指定する。このオプションを使用しない場合は、デフォルト検索ディレクトリの config/search.conf ファイルとなる。デフォルト以外のファイルを使用する場合は、使用するファイルへの完全パスを指定する必要がある

-i charset|-o charset

-i オプションは、入力 SOIF ストリームの文字セットを指定する。-o オプションは、出力 SOIF ストリームの文字セットを指定する。たとえば、ISO8859-1、UTF-8、UTF-16 など。ISO8859-1 から ISO8859-15 までの文字セットを使用できる-iは、um、および d サブコマンドとともに使用する。-oは、g U 、および L サブコマンドとともに使用する

-j number

取得結果数を制限する。u サブコマンドとともに使用する。指定されていない場合 Q オプションを除き (デフォルト値は 20) デフォルト値は無制限となる

-l number

ログレベルの番号を設定する。値が 1 (デフォルト) に設定されている場合は、rdmgr コマンドのすべてのログが記録される。値が大きくなるほど、ログファイルに記録される情報の詳細度が増加します。レベルの範囲は 1 〜 100。これはすべてのサブコマンドに適用される

-p {stdout|stderr|

filename}

進捗状況を stdoutstderr、または filename ファイルに出力または表示する。これはすべてのサブコマンドに適用されるタイミング情報は数秒で報告される

-r number

進捗状況オプションとともに使用する。レポートは、number に指定される値のすべての RD について生成される。デフォルトは 500。umgd、および U サブコマンドとともに使用する

-s schema

スキーマ定義ファイルを指定する。このオプションを使用しない場合は、デフォルトで検索サーバーインスタンスディレクトリの config/schema.rdm ファイルとなる

-y dbname

検索データベース名を指定する。このコマンドをデフォルト以外のデータベースに対して使用する場合は、このオプションが必要となる。デフォルトデータベースは、datbase-name=logicaldbname というラベルが付けられた、config/search.conf ファイルに定義されたデータベースである

filename|-Q query

この入力オプションは、umg、および d サブコマンドとともに使用する

filename は、SOIF 形式のデフォルトスキーマ (他のスキーマには -s オプションを使用) を使用する RD のファイル

query は通常の検索クエリー


サブコマンドを使用せずに rdmgr を入力すると、コマンドは -u サブコマンドが指定されたものとして動作します。サブコマンドおよびクエリー (-Q) を指定せずに rdmgr を入力すると、コマンドは-g サブコマンドが指定されたものとして動作します。


例 1

環境変数LD_LIBRARY_PATH/opt/SUNWps/lib に設定します。

/var/opt/SUNWps/https-sesta.com/portal ディレクトリで次のように入力します。

# /opt/SUNWps/bin/rdmgr -U

この例は、リソース記述のデフォルトデータベース全体を UTF-8 SOIF 形式で stdout に出力します。

例 2

/var/opt/SUNWps/https-sesta.com/portal のデフォルト検索ディレクトリで、次のように指定します。

# /opt/SUNWps/bin/rdmgr -d -Q java

この例は、「java」を含むすべてのリソース記述を削除します。

データベース保守サブコマンド

説明

データベースサブコマンドを使用すると、管理者は検索データベースを最適化して、データベースの切り取り、クリア、再インデックス作成ができ、また期限切れの RD を削除したり、データベースを復元したりすることができます。表 21-21 には、2 つの列があります。最初の列はサブコマンド、2 番目の列は簡単な説明を示します。

表 21-21 rdmgr データベース保守サブコマンド 

サブコマンド

説明

-O

データベースを最適化する。デフォルト以外のデータベースに対してこのサブコマンドを実行する場合は、-y オプションを使用する必要がある。デフォルトデータベースは、datbase-name=logicaldbname というラベルが付けられた、config/search.conf ファイルに定義されたデータベースである。たとえば、デフォルト値は datbase-name=default 、デフォルトデータベースディレクトリはdb/default である

通常は、データベースを最適化する必要はない

-X

データベースを切り取る、またはクリアする。デフォルト以外のデータベースに対してこのサブコマンドを実行する場合は、-y オプションを使用する必要があるインデックスに使用されるディスクスペースは回復するが、メインデータベースに使用されるディスクスペースは回復しない。このスペースは、新規のデータが追加されるごとに再利用される

-I

データベースのインデックスを再作成する。デフォルト以外のデータベースに対してこのサブコマンドを実行する場合は、-y オプションを使用する必要がある

-E

期限が切れた RD をデータベースから削除する。デフォルト以外のデータベースに対してこのサブコマンドを実行する場合は、-y オプションを使用する必要がある

-R

すべてのデータベースを復元する。これはグローバルコマンドであり、オプションをとらない。このコマンドを実行する前に、その他の rdmgr インスタンスおよび主な検索サーバーを含むすべてのデータベース処理を停止する必要がある

-G

データベースのパーティションを再作成する。このコマンドはオプションをとらない。パーティションは config/search.conf ファイルで、datbase-partitions=p1,p2,p3,... のラベルで定義される。この p1p2p3 はパーティションのファイル名である。このコマンド実行後にサーバーを再起動する必要はない

-B

データベースを完全に削除する。すべてのディスクスペースが回復される。このサブコマンドを実行するときは、インデックス作成を行わないようにし、Portal Server を停止する必要がある

-L

データベースから選択したフィールドを、stdout に一覧表示する。-a att オプションを指定する必要がある。デフォルト以外のデータベースに対してこのサブコマンドを実行する場合は、-y オプションを使用する必要がある

構文

#  rdmgr   [-OXIERGBL]  [-ASTDVNP]   [-a att,att,...] [-b number

[-c search.conf] [-j number] [-l number] [-p progress]   [-r number 

[-s schema] [-y dbname

オプション

表 21-22 には、2 つの列があります。最初の列はオプションまたは引数、2 番目の列は簡単な説明を示します。次のオプションがサポートされます。

表 21-22 rdmgr のデータベース保守サブコマンドのオプション 

引数 / オペランド

説明

-A

デフォルト検索ディレクトリ内の config/schema.rdm ファイルにスキーマのエイリアスを使用しないように指定する。I サブコマンドとともに使用する

-S

スキーマ検査を無効にする。I サブコマンドとともに使用する

-T

分類に基づいて実行する。デフォルト検索ディレクトリの config/taxonomy.rdm ファイルにある分類は、データベースの内容の参照と分類に使用される。OXIEBUL サブコマンドとともに使用する

-D

データベースだけを更新し、インデックスを更新しない。E および X コマンドとともに使用する

-V

インデックスだけを更新し、データベースを更新しない。E および X コマンドとともに使用する

-N

コマンドに指定した機能をリソース記述の非永続的データだけに適用する。データベースの RD は、永続データと非永続データをマージしたものである。IEUL コマンドとともに使用する

-P

コマンドに指定した機能をリソース記述の永続的データだけに適用する。データベースの RD は、永続データと非永続データをマージしたものである。IEUL コマンドとともに使用する

-a att,att...

属性ビューリストを指定する。att 名は大文字と小文字が区別されず、スキーマに定義されているかどうかにかかわらず作成者またはタイトルなどの任意の属性を指定できる。class-1class-2class-3 などの複数の値を持つ att の場合、att 名として class だけを入力する

-b number

インデックス作成バッチのサイズをこの RD 数に設定する。I コマンドとともに使用する

-c search.conf

search.conf ファイルの場所を指定する。このオプションを使用しない場合は、デフォルト検索ディレクトリの config/search.conf ファイルとなる。デフォルト以外のファイルを使用する場合は、使用するファイルへの完全パスを指定する必要がある

-j number

取得結果数を制限する。E サブコマンドとともに使用する。指定されていない場合、デフォルト値は無制限となる

-l number

ログレベルの番号を設定する。値が 1 (デフォルト) に設定されている場合は、rdmgr コマンドのすべてのログが記録される。値が大きくなるほど、ログファイルに記録される情報の詳細度は増加する。レベルの範囲は 1 〜 100。これはすべてのサブコマンドに適用される

-p {stdout|stderr|
filename}

進捗状況を stdoutstderr 、または filename に出力または表示する。これはすべてのサブコマンドに適用される

-r number

進捗状況オプションとともに使用する。レポートは、number に指定される値のすべての RD について生成される。デフォルトは 500。umgd、および U サブコマンドとともに使用する

-s schema

スキーマ定義ファイルを指定する。デフォルトでは、デフォルトディレクトリ内の config/schema.rdm ファイルとなる

-y dbname

検索データベース名を指定する。このコマンドをデフォルト以外のデータベースに対して使用する場合は、このオプションが必要となる。デフォルトデータベースにこのオプションを使用する必要はない。デフォルトデータベースは、datbase-name=filename というラベルが付けられた、config/search.conf ファイルに定義されたデータベースである

例 1

デフォルト検索ディレクトリ内で次のように指定します。

# /opt/SUNWps/bin/rdmgr -E -j 13 -p stdout -r 5

この例は、有効期限切れとなっている最大 13 個の RD をデータベースから削除します。stdout への進捗状況レポートには、秒単位の経過時間と、5 つのリソース記述ごとに処理された RD の数が出力されます。

例 2

検索エンジンがハングアップし、応答しません。デフォルト検索ディレクトリ内で次のように指定します。

# /opt/SUNWps/bin/rdmgr -R

これによりすべての検索データベースが復元され、検索エンジンが再び使用可能になります。このコマンドを使用して、データベース内の無効なロックを解除し、未処理のトランザクションを処理します。無効なロックおよび未処理のトランザクションは、異常終了されているデータベースプロセスの結果です。

使用に関するメッセージとバージョンのサブコマンド

表 21-23 の最初の列は、使用に関するメッセージやバージョン情報を表示するためのサブコマンド、2 番目の列は簡単な説明を示しています。

表 21-23 rdmgr の使用に関するメッセージとバージョンのサブコマンド

引数 / オペランド

説明

-h または -?

使用に関するメッセージを表示する

-v

バージョン情報を表示する

リターンコード

rdmgr コマンドはリターンコードをシェルに戻します。

0: 成功

1: 失敗


sendrdm

説明

sendrdm コマンドは、CGI またはコマンドラインベースの検索メカニズムを提供します。rdm (リソース記述マネージャ) 要求は SOIF 形式で検索サーバーに送信されます。このコマンドは、通常、Portal Server の検索可能なインスタンスディレクトリである /server-instance-directory/deployment_uri 上で実行されます。これは、インストール時に選択する配備 URI パスです。デフォルトの Portal Server のインストールを選択した場合は、/var/opt/SUNWps/https-servername/portal ディレクトリとなります。servername の値は、Portal Server の完全修飾名であるデフォルトの Portal Server インスタンス名です。


デフォルトインストールでは、環境変数 LD_LIBRARY_PATH/opt/SUNWps/lib に設定されます。


構文

sendrdm コマンドの構文は次のとおりです。

オプション

表 21-24 は、sendrdm コマンドの要約を示しています。この表には 2 つの列があります。最初の列は使用できるオプション、2 番目の列は簡単な説明を示します。このコマンドは、次のオプションをサポートします (アルファベット順)。

表 21-24 sendrdm コマンドのオプション

引数 / オペランド

説明

-d

デバッグモード。デフォルトでは無効。このオプションを使用すると有効になる

-t n

時間を秒単位で指定する。コマンドは n 秒後にタイムアウトとなる。デフォルトは 300 秒

-u uri

インポート元サーバーの URI ディレクトリを指定する (完全パスを入力する)

-v

バージョン

RDM-in

RDM 要求ファイル名。この引数は必須

RDM-out

RDM 結果ファイル名。デフォルトは標準出力

root として /var/opt/SUNWps/https-servername/portal ディレクトリで次のように指定します。

この例は、/rdm/incoming を URI として使用して、1 時間の制限時間で Compass Server 3.01x からインポートします。rdmquery.soif の内容は次のようになります。

コード例 21-1

@RDMHEADER { -

catalog-service-id{48}:x-catalog://frankie.sesta.com:89/Compass-2

rdm-type{10}:rd-request

rdm-version{3}: 1.0

rdm-query-language{8}:  gatherer

}

@RDMQUERY { -

scope{3}:all

}


StartRobot

管理者がロボットを手動で起動するときは、StartRobot スクリプトを使用できます。通常、このスクリプトは設定された時間にロボットを起動するためにスケジューラによって使用されます (cron ジョブ)。StartRobot コマンドは /var/opt/SUNWps/https-servername/portal ディレクトリにあります。

構文

#  StartRobot

オプション

オプションはありません。


StopRobot

管理者がロボットを手動で停止するときは、StopRobot スクリプトを使用できます。通常、このスクリプトは設定された時間にロボットを停止するためにスケジューラによって使用されます (cron ジョブ)。StartRobot コマンドは /var/opt/SUNWps/https-servername/portal ディレクトリにあります。

構文

# StopRobot

オプション

オプションはありません。



前へ      目次      索引      次へ     


Copyright 2004 Sun Microsystems, Inc. All rights reserved.