5.2 各コマンドに共通の条件および規則

各コマンドに共通の条件や規則などについて説明します。

コマンドごとに異なる機能については,「5.3 各コマンドの詳細」を参照してください。

<この節の構成>
(1) コマンドの実行条件
(2) オプションの指定方法
(3) -oオプションに指定する出力ファイル
(4) -eオプションに指定するログファイル
(5) コマンドの実行方法
(6) コマンドに共通の注意事項

(1) コマンドの実行条件

コマンドを実行するために必要な条件を次に示します。

(2) オプションの指定方法

オプションを指定する際の規則
各コマンドのオプションは,次の規則に従って指定できます。
  • 複数指定できます。複数ある場合,どのような順でも指定できます。
  • 同一オプションを複数指定した場合,最後に指定したオプションが有効になります。
  • 省略できます。
  • オプションの文字列は,大文字と小文字が区別されます。ただし,Windows版の場合,ファイル名の大文字と小文字は区別されません。
  • ディレクトリ名およびファイル名に半角スペースが含まれる場合は,ファイルのパス全体を「"(半角引用符)」で囲みます。
    例:"C:¥¥Program△files・・・"
    注:△は半角スペースを示します。
  • コマンドの引数や定義ファイル中に定義するファイル名に使用できる文字を次に示します。下記以外の文字を指定した場合,動作は保証されません。
    半角英数字
    全角文字
    「¥」(半角円記号)
    「"」(半角引用符)
    「:」(半角コロン)
    半角スペース
    注意
    ファイル名は,使用するOSのファイルシステムの規則に従って指定してください。OSのファイルシステムで許可されていないファイル名を指定した場合,動作は保証されません。
オプションの指定方法の表示
オプションの指定を誤ってコマンドを実行すると,オプションの指定方法が標準エラー出力に出力されます。

(3) -oオプションに指定する出力ファイル

ファイル名の規則
-oオプションには,出力ファイルのファイル名を絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
-oオプションに指定したディレクトリおよび出力ファイルが存在しない場合
指定したディレクトリおよび出力ファイルが新規に作成されます。
-oオプションに指定したファイルがすでに存在する場合
次のファイル名で,出力ファイルが新規に作成されます。
aaa_bbb_yyyyMMdd_HHmmss.ccc
文字列の意味
aaa:-oオプションに指定したファイル名から拡張子を除いた文字列
bbb:コマンド名
yyyy:実行日付(年)
MM:実行日付(月)
dd:実行日付(日)
HH:実行時刻(時)
mm:実行時刻(分)
ss:実行時刻(秒)
ccc:-oオプションに指定したファイル名の拡張子
-oオプションに指定した出力ファイルのファイル名が「output.log」,コマンドの実行日時が「2003年12月31日20:32:10」の場合,新規に作成される出力ファイルのファイル名は,次のようになります。
output_コマンド名_20031231_203210.log
-oオプションに指定した出力ファイルに出力される情報
-oオプションに指定した出力ファイルには,標準出力に出力されるデータおよび標準エラー出力に出力されるデータが出力されます。

(4) -eオプションに指定するログファイル

ファイル名の規則
-eオプションには,ログファイルのファイル名を絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
-eオプションに指定したディレクトリおよびファイルが存在しない場合
指定したディレクトリおよびファイルが新規に作成されます。
-eオプションに指定したログファイルがすでに存在する場合
次のファイル名で,ログファイルが新規に作成されます。
aaa_bbb_yyyyMMdd_HHmmss.ccc
文字列の意味
aaa:-eオプションに指定したファイル名から拡張子を除いた文字列
bbb:コマンド名
yyyy:実行日付(年)
MM:実行日付(月)
dd:実行日付(日)
HH:実行時刻(時)
mm:実行時刻(分)
ss:実行時刻(秒)
ccc:-eオプションに指定したファイル名の拡張子
-eオプションに指定したログファイルのファイル名が「error.log」,コマンドの実行日時が「2003年12月31日20:32:10」の場合,新規に作成されるログファイルのファイル名は,次のようになります。
error_コマンド名_20031231_203210.log
-eオプションを省略した場合
コマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーに指定された値が,ログファイルのファイル名となります。ただし,この値と同じファイル名のファイルがすでに存在するときは,ログファイルのファイル名は,次のようになります。
aaa_bbb_yyyyMMdd_HHmmss.ccc
文字列の意味
aaa:コマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーに指定された値から,拡張子を除いた文字列
bbb:コマンド名
yyyy:実行日付(年)
MM:実行日付(月)
dd:実行日付(日)
HH:実行時刻(時)
mm:実行時刻(分)
ss:実行時刻(秒)
ccc:コマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーに指定された値の拡張子
hptl_clb_ccm_cmd_logfileキーに指定したログファイルのファイル名が「error.log」,コマンドの実行日時が「2003年12月31日20:32:10」の場合,新規に作成されるログファイルのファイル名は,次のようになります。
error_コマンド名_20031231_203210.log
-eオプションが省略されていてhptl_clb_ccm_cmd_logfileキーが指定されていない場合
プログラムのデフォルトである「error.log」がファイル名となります。ただし,カレントディレクトリに「error.log」という名前のファイルがすでに存在する場合は,「error_コマンド名_実行日付_実行時刻.log」となります。
コマンドの実行日時が「2003年12月31日20:32:10」の場合,新規に作成されるログファイルのファイル名は,次のようになります。
error_コマンド名_20031231_203210.log

(5) コマンドの実行方法

コマンドを実行する際は,Collaboration - Online Community Managementをインストールしたマシンで実行します。set_memberコマンドの-sオプションを指定する場合は,Collaboration - Online Community Management,Collaboration - Directory Access,およびCollaboration - Common Utilityをインストールしたマシン上で実行します。

コマンドの実行時にはデータベースと接続するために,ユーザ名およびパスワードを入力する必要があります。Windowsのコマンドプロンプトで入力するユーザ名およびパスワードに使える文字はASCII文字の英大文字,数字および英小文字だけです。

手順

  1. Windowsのコマンドプロンプトでコマンドを実行します。
  2. 「Database User Name:」と表示されるのでユーザ名を入力して,[Enter]キーを押します。
    ユーザ名に「"(半角引用符)」を使用する場合は,エスケープ文字として「¥(半角円記号)」を付けます。例えば,ユーザ名として「"root"」を入力する場合は,「¥"root¥"」と入力します。
  3. 「Password:」と表示されるのでパスワードを入力し,[Enter]キーを押します。
    パスワードは,入力しても画面には表示されません。パスワードの場合もユーザ名と同様に「"(半角引用符)」を使用する場合は,エスケープ文字として「¥」を付けます。

(6) コマンドに共通の注意事項