DirectoryCommand ツール

使用法

サービス層では、コマンドは以下の場所にインストールされる：

• IS_install_path/ASBServer/bin/DirectoryCommand.sh
• IS_install_path\ASBServer\bin\DirectoryCommand.bat

エンジン層とクライアント層では、コマンドは以下の場所にインストールされる：

• IS_install_path/ASBNode/bin/DirectoryCommand.sh
• IS_install_path\ASBNode\bin\DirectoryCommand.bat

このコマンドには、個別の操作をコントロールする多くのオプションがある。 このツールは、複数の操作を同時に指定することができる。 例えば、ツールの同じ実行で-add_userオプションと-add_groupオプションの両方を指定することができる。 操作は、-fileオプションを使ってバッチで実行することも、スクリプトで実行することもできる。 このトピックの一番下にある例を参照してください。

構文

DirectoryCommand
  [-{add_ds_credentials | ds_cred} value]
  [-{add_group | a_grp} value]*
  [-{add_user | a_usr} value]*
  [-{add_users_group | a_usr_grp} value]*
  [-{assign_group_roles | grp_roles} value]* 
  [-{assign_user_roles | usr_roles} value]* 
  [-{assign_project_group_roles | proj_grp_roles} value] 
  [-{assign_project_user_roles | proj_usr_roles} value] 
  [-authfile value] 
  [-{datastage_server | ds_svr} value] 
  [-{delete_group | del_grp} value] 
  [-{delete_user | del_usr} value] 
  [-{details | det}] 
  [-{file | f} value] 
  [-force] 
  [-{get_default_ds_credentials | get_dflt_ds_cred}] 
  [-{help | ?}] 
  [-host value] 
  [-list value] 
  [-{log | l} value] 
  [-{logerror | error} value] 
  [-{loginfo | info} value] 
  [-{loglevel | level} value] 
  [-{password | pwd} value] 
  [-port value] 
  [-primary] 
  [-{remove_group_roles | rm_grp_roles} value] 
  [-{remove_project_group_roles | rm_proj_grp_roles} value] 
  [-{remove_project_user_roles | rm_proj_usr_roles} value] 
  [-{remove_user_roles | rm_usr_roles} value] 
  [-{remove_users_group | rm_usr_grp} value] 
  [-{results | res} value] 
  [-{separator | sep} value] 
  [-{set_default_ds_credentials | set_dflt_ds_cred} value] 
  [-{set_shared_registry | shr_reg} value] 
  [-{sub_list_separator | sub_list_sep} value] 
  [-{update_group | upd_grp} value] 
  [-{update_user | upd_usr} value] 
  [-{user | usr} value] 
  [-{verbose | v}]

パラメーター

コマンド・パラメータの構文

パラメーターの{x | y} という構文は、パラメーターの長い形式（x ）か、ショートカットのパラメーター名（y ）を入力できることを示している。 valueは、値を指定しなければならないことを示す。 以下の各パラメータの説明は、パラメータの構文と関連する値を示している。 指定のアスタリスク（*）は、コマンド・パラメーターが同じコマンド行で複数回繰り返せることを意味する。

値リストとサブリスト

ほとんどのオペレーション・パラメーターは、リストとサブリストで構成される値を持つ。

• 値リストの構文では、[~value]*は、区切り文字（デフォルトではチルダ（〜））で区切られた値のリストをオプションで指定できることを意味します
• リストは、文字（デフォルトではチルダ（~））で区切られた値の集合である。 いくつかのリストでは、実際に割り当てられる値は、-add_groupや-add_userオプションのように、リスト内の値の位置によって決定される。 リスト内の各値について、値間にすべての値が割り当てられていない場合は、位置を決定できるように、少なくとも区切り文字を指定しなければならない。 ただし、末尾のセパレータは省略すること。

  ListValue1~ListValue2~~~ListValue5

  例えば、以下のリストは、新規ユーザーを追加し、ユーザーID、パスワード、姓、名、役職、ビジネス電話番号を割り当てるために使用されます：

  -add_user "jsmith~pa55word~John~Smith~DS Admin~~~~~408-555-0122"

• サブリストは、文字で区切られた値の集合である。 サブリストはリストとは異なり、別の文字（デフォルトではドル記号（$））で区切られた別のサブリストを伴います。 サブリストでは、値は位置決めされない。 各サブリストの値は、付随するサブリストの値に割り当てられる。

  Sublist1Value1~Sublist1Value2$Sublist2Value1$Sublist3Value1~Sublist3Value2

  例えば、以下のサブリストは、右のサブリストのロールを左のサブリストのユーザに割り当てるために使用されます：

  -assign_user_roles adminUser$SuiteUser~DataStageAdmin

  注意: LinuxとUNIXでは、ドル記号($)はバックスラッシュ(˶)でエスケープしなければならない特殊文字です。上記の例は次のように指定します：

  Sublist1Value1~Sublist1Value2\$Sublist2Value1\$Sublist3Value1~Sublist3Value2

  あるいは、リスト全体を引用符（"）で囲んで指定することもできる：

  "Sublist1Value1~Sublist1Value2$Sublist2Value1$Sublist3Value1~Sublist3Value2"

[-{add_ds_credentials | ds_cred} 値 ]

1つ以上のユーザ認証情報を、指定されたエンジンのオペレーティング・システム・ユーザ認証情報にマップします。このオペレーティング・システム・ユーザ認証情報は、-datastage_serverパラメータで指定されます。 以下の構文で、値を1つの文字列として指定する：

userID[~userID]*$credUserID~credPassword

値には、少なくとも1つのサブリスト区切り文字($)を含める必要があります。複数のユーザ ID が指定された場合、それらすべてに指定された資格情報が割り当てられます。 パスワードの値は、プレーン・テキストとして指定することも、暗号化コマンドで暗号化したテキストとして指定することもできる。

クレデンシャルをクリアするには、credUserIdまたはcredPasswordの値として、引用符で囲まれた感嘆符("!")を渡します。

[-{add_group | a_grp} 値]*

グループを作成します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

groupId~name~groupType~webAddress
~location~officePhoneNumber~cellPhoneNumber
~pagerNumber~faxNumber~emailAddress
~businessAddress~organization

値の各エントリには、少なくとも1つの区切り文字（~）が含まれていなければならない。

[-{add_user | a_usr} 値]*

ユーザーを作成します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

userId~password~firstName~lastName
~title~jobTitle~homePhoneNumber~imName
~location~officePhoneNumber~cellPhoneNumber
~pagerNumber~faxNumber~emailAddress
~businessAddress~organization

値の各エントリには、少なくとも1つの区切り文字（~）が含まれていなければならない。パスワードの値は、プレーン・テキストとして指定することも、暗号化コマンドで暗号化したテキストとして指定することもできる。

[-{add_users_group | a_usr_grp} 値]*

ユーザーをグループに追加します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

userId[~userId]*$groupId[~groupId]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければならない。複数のエントリーを含むサブリストでは、一方のサブリストの各エントリーが、他方のサブリストの各エントリーに割り当てられます。

[-{assign_group_roles | grp_roles} 値]*

グループに役割を割り当てる。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

groupId[~groupID]*$roleID[~roleID]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければならない。複数のエントリーを含むサブリストでは、一方のサブリストの各エントリーが、他方のサブリストの各エントリーに割り当てられます。

[-{assign_user_roles | usr_roles} 値]*

ユーザーにロールを割り当てる。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

userId[~userId]*$roleId[~roleId]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければならない。複数のエントリーを含むサブリストでは、一方のサブリストの各エントリーが、他方のサブリストの各エントリーに割り当てられます。

[-{assign_project_group_roles | proj_grp_roles}値]

プロジェクトグループの役割を割り当てる。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

projectName[~projectName]*$groupId[~groupId]*$roleId

値は、2つのサブリスト区切り文字($)を含まなければならない。複数のエントリーを含むサブリストでは、各サブリストの各エントリーは、他のサブリストの各エントリーに割り当てられます。 projectName の値は大文字と小文字を区別し、DSServer/projectID の形式でなければなりません。DSServer は登録されたエンジン名と一致しなければなりません。 この名前は、短いホスト名として登録することも、ドメイン付きの完全修飾ホスト名として登録することもできる。 どちらの方法で登録するにしても、ここではこのように指定しなければならない。 list DSPROJECTSオプションを使えば、プロジェクト名のリストを見ることができる。 roleID は、InfoSphere® DataStage® プロジェクト・ロールでなければなりません。

[-{assign_project_user_roles | proj_usr_roles}値]

プロジェクトユーザーの役割を割り当てる。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

projectName[~projectName]*$userId[~userId]*$roleId

値は、2つのサブリスト区切り文字($)を含まなければならない。複数のエントリーを含むサブリストでは、各サブリストの各エントリーは、他のサブリストの各エントリーに割り当てられます。 projectName の値は大文字と小文字を区別し、DSServer/projectID の形式でなければなりません。DSServer は登録されたエンジン名と一致しなければなりません。 この名前は、短いホスト名として登録することも、ドメイン付きの完全修飾ホスト名として登録することもできる。 どちらの方法で登録するにしても、ここではこのように指定しなければならない。 list DSPROJECTSオプションを使えば、プロジェクト名のリストを見ることができる。 roleID は、InfoSphere DataStage プロジェクト・ロールでなければなりません。

[-authfile 価値] ]

このコマンドを実行する管理者ユーザーIDの資格情報には、指定された資格情報ファイルを使用する。 authfileオプション、または-userと-passwordオプションのどちらかが必要。

[-{datastage_server | ds_svr}値]

共有レジストリの設定時およびエンジン資格情報の設定と取得時に使用する InfoSphere Information Server エンジンのホスト名または構成されたエイリアス名を指定します。 値にスラッシュ（/）を含めることはできません。値は、IBM® InfoSphere Information Server に登録されているエンジンに対して検証されます。

以下のパラメータを使うときは、この-datastage_serverパラメータを指定する必要があります：

• -add_ds_credentialsを追加します
• -get_default_ds_credentials
• -set_default_ds_credentials
• -共有レジストリを設定する

[-{delete_group | del_grp}値]

既存のグループを削除する。 以下の構文で、値を1つの文字列として指定する：

groupID[~groupID]*

forceオプションが指定されていない限り、削除を確認するプロンプトが表示される。 指定したグループが存在しない場合は無視される。

[-{delete_user | del_usr}値]

既存のユーザーを削除します。 以下の構文で、値を1つの文字列として指定する：

userID[~userID]*

forceオプションが指定されていない限り、削除を確認するプロンプトが表示される。 指定したユーザーが存在しない場合は無視される。

[-{details | det}]

USERSとGROUPSの-listオプションと一緒に使用すると、出力に追加情報が表示されます。

ユーザーには以下の情報を提供する：

• 詳細ユーザー情報
• ユーザが所属するグループ
• ユーザーに割り当てられているスイートおよび製品の役割
• このユーザーのマップされたエンジン認証情報

グループについては、以下の情報が提供されている：

• グループ詳細情報
• グループに割り当てられているスイートおよび製品の役割

[-{file | f} 価値]

ファイルからコマンドを読み込む。 fileオプションを指定すると、他のコマンド・オプションは無視される。 fileオプションの使用例については、このトピックの最後を参照のこと。 ファイルオプションで多数のユーザーをロードするつもりなら、サーバーのタイムアウトを避けるために、各ファイルが約100ユーザーを含むように分割してください。

ファイルでは、各コマンドは別々の行に指定し、セミコロン（;）で終わらなければならない。これは、-separator、-sublist_separator、-datastage_server、-details、-forceなど、追加の必須オプションがあるコマンド・オプションでも同じである。 これらのオプションを持つコマンドは、それぞれ別個の行でなければならず、その行はセミコロンで終了しなければならない。 これらに指定された値は、ファイルに含まれるすべてのコマンドに適用される。

[-force]

delete_userおよび-delete_groupオプションの確認プロンプトを表示しない。

[-{get_default_ds_credentials | get_dflt_ds_cred}]

datastage_server オプションで指定した InfoSphere Information Server エンジンの既定の資格情報を取得します。

[-{help | ?}]

使用法を表示する

[ホスト 価値]]

サービス階層コンピュータのホスト名。 デフォルト値は localhost です。

[-リスト 値]

既存のユーザ、グループ、InfoSphere DataStage プロジェクト、またはシステム定義のロールを一覧表示します。 以下の構文で、値を1つの文字列として指定する：

type[~type]*

typeの値にはUSERS、GROUPS、ROLES、DSPROJECTS、ALLのいずれかを指定する。

[-{log | l}値]

すべてのランタイム出力を指定されたファイルにプリントする。

[-{logerror | error} 値]

「エラー」および「致命的」のすべてのランタイム・ロギング・メッセージを指定されたファイルに出力します。

[-{loginfo | info} 値]

「情報」、「警告」、「デバッグ」、および「トレース」のすべてのランタイム・ロギング・メッセージを指定されたファイルに出力します。

[-{loglevel | level} 価値]

ランタイム・ロギング・メッセージが使用可能なレベル。 値はFATAL、ERROR、INFO、WARN、DEBUG、TRACE、ALLのいずれか。

[-{password | pwd} 値]

このコマンドを実行するスイート管理者ユーザーIDのパスワード。

[ポート 価値]]

サービス階層コンピュータの HTTPS ポート。 デフォルト値は9443である。

[-primary]

1 次サービス・ホストが使用可能であれば、それにログインします。 このオプションを使用すると、-hostと-portオプションは無視される。

[-{remove_group_roles | rm_grp_roles} 値]

グループからロールを削除します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

groupId[~groupId]*$roleId[~roleId]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければなりません。複数のエントリを含むサブリストでは、ロールサブリストの各エントリがグループサブリストの各エントリから削除されます。

[-{remove_project_group_roles | rm_proj_grp_roles}値]

プロジェクトのユーザー・ロールを削除します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

projectName[~projectName]*$groupId[~groupId]*$roleId[~roleId]*

複数のエントリーを含むサブリストでは、グループサブリストとロールサブリストの各エントリーは、プロジェクトサブリストの各エントリーから削除されます。 projectName の値は大文字と小文字を区別し、DSServer/projectID の形式でなければなりません。DSServer は登録されたエンジン名と一致しなければなりません。 この名前は、短いホスト名として登録することも、ドメイン付きの完全修飾ホスト名として登録することもできる。 どちらの方法で登録するにしても、ここではこのように指定しなければならない。 list DSPROJECTSオプションを使えば、プロジェクト名のリストを見ることができる。

[-{remove_project_user_roles | rm_proj_usr_roles} 値]

プロジェクトのユーザー・ロールを削除します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

projectName[~projectName]*$userId[~userId]*$roleId[~roleId]*

複数のエントリーを含むサブリストでは、ユーザーサブリストとロールサブリストの各エントリーは、プロジェクトサブリストの各エントリーから削除されます。 projectName の値は大文字と小文字を区別し、DSServer/projectID の形式でなければなりません。DSServer は登録されたエンジン名と一致しなければなりません。 この名前は、短いホスト名として登録することも、ドメイン付きの完全修飾ホスト名として登録することもできる。 どちらの方法で登録するにしても、ここではこのように指定しなければならない。 list DSPROJECTSオプションを使えば、プロジェクト名のリストを見ることができる。

[-{remove_user_roles | rm_usr_roles} 値]

ユーザからロールを削除します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

userId[~userId]*$roleId[~roleId]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければなりません。複数のエントリを含むサブリストでは、ロールサブリストの各エントリはユーザサブリストの各エントリから削除されます。

[-{remove_users_group | rm_usr_grp} 価値]

グループからユーザーを削除します。 このオプションは複数指定できる。 以下の構文で、値を1つの文字列として指定する：

groupId[~groupId]*$userId[~userId]*

この値には、少なくとも1つのサブリスト区切り文字($)が含まれていなければならない。複数のエントリを含むサブリストでは、ユーザ・サブリストの各エントリは、グループ・サブリストの各エントリから削除されます。

[-{results | res} 値]

すべてのランタイム出力を指定されたファイルにプリントする。

[-{separator | sep} 値]

デフォルトのリスト区切り文字 (~) を上書きします。この値には、リストされている以外の任意の1文字を指定することができます：

^ (キャレット)
& (アンパサンド)
* (アスタリスク)
- (ダッシュまたはハイフン)
| (パイプ)
" (クォーテーションマーク)
< (より小さい)
> (より大きい)

コマンドシェルにとって特別な意味を持つ文字値を指定したい場合 (例えば # や !)、 のように、一重引用符で文字を指定する：-セパレーター '#'. 次に、コマンドシェルで使用する場合は、特殊文字が必ずエスケープされるようにする。

[-{set_default_ds_credentials | set_dflt_ds_cred}値]

デフォルトの InfoSphere Information Server エンジン資格情報を設定します。 以下の構文で、値を1つの文字列として指定する：

credUserId~credPassword

値には少なくとも1つの区切り文字（~）を含める必要がある。認証情報は、-datastage_serverオプションで指定されたサーバに対して設定される。 指定されたエンジンは、InfoSphere Information Server に登録されている必要があります。 パスワードの値は、プレーン・テキストとして指定することも、暗号化コマンドで暗号化したテキストとして指定することもできる。

デフォルトのクレデンシャルをクリアするには、credUserIdまたはcredPasswordの値として、引用符付きの感嘆符("!")を渡します。

[-{set_shared_registry | shr_reg} {ON|OFF}]

InfoSphere Information Server と InfoSphere DataStage が同じユーザー・レジストリを共有するかどうかを示すフラグを設定します。 有効な値はONまたはOFFです。

[-{sub_list_separator | sub_list_sep} 値]

デフォルトのリスト区切り文字 ($) を上書きします。この値には、リストされている文字以外の任意の一文字を指定することができます：

^ (キャレット)
& (アンパサンド)
* (アスタリスク)
- (ダッシュまたはハイフン)
| (パイプ)
" (クォーテーションマーク)
< (より小さい)
> (より大きい)

コマンドシェルにとって特別な意味を持つ文字値を指定したい場合 (例えば # や !)、 のように、一重引用符で文字を指定する：-セパレーター '#'. 次に、コマンドシェルで使用する場合は、特殊文字が必ずエスケープされるようにする。

[-{update_group | upd_grp} 値]*

既存のグループを更新する。 このオプションは複数指定できる。 更新されるグループは存在しなければならない。 以下の構文で、値を1つの文字列として指定する：

groupId~name~groupType~webAddress
~location~officePhoneNumber~cellPhoneNumber
~pagerNumber~faxNumber~emailAddress
~businessAddress~organization

値の各エントリには、少なくとも1つの区切り文字(~)が含まれていなければならない。値が'! グループ設定に指定すると、その設定はクリアされる。

[-{update_user | upd_usr}値]

既存のユーザーを更新します。 このオプションは複数指定できる。 更新されるユーザーは存在しなければならない。 以下の構文で、値を1つの文字列として指定する：

userId~password~firstName~lastName
~title~jobTitle~homePhoneNumber~imName
~location~officePhoneNumber~cellPhoneNumber
~pagerNumber~faxNumber~emailAddress
~businessAddress~organization

値の各エントリには、少なくとも1つの区切り文字(~)が含まれていなければならない。値が'! パスワード以外のユーザー設定に指定された場合、その設定はクリアされます。 パスワードの値は、プレーン・テキストとして指定することも、暗号化コマンドで暗号化したテキストとして指定することもできる。

[-{user | usr} 値]

このコマンドを実行するスイート管理者ユーザーID。 authfileオプション、または-userと-passwordオプションのどちらかが必要。

[-{verbose | v}]

ログメッセージ以外の詳細な実行時出力を表示する。