del_member(ユーザおよびメンバの一括削除)
機能
ユーザおよびコミュニティメンバを一括して削除します。コミュニティからメンバを削除したり,Collaboration - Online Community Managementの環境からユーザを削除したりできます。
形式
del_member [-o 出力ファイル名] [-q] [-e ログファイル名] { -a { u | m } | -u 削除ユーザ一覧ファイル名 | -m 削除メンバ一覧ファイル名}
オプション
- -o 出力ファイル名
- 指定したファイルに標準出力データを出力します。ただし,出力メッセージのうち,KDCM00071-E~KDCM00076-Eは出力しません。
- 出力ファイル名の指定方法の詳細は,「5.2(3)-oオプションに指定する出力ファイル」を参照してください。
- -q
- 標準出力および標準エラー出力への出力を抑制します。
- -e ログファイル名
- 指定したログファイルに,次の情報を出力します。
- SQLクエリ発行直前および発行直後のSQLクエリ文字列
- SQLクエリ発行時のエラーメッセージ
- ログファイル名の指定方法の詳細は,「5.2(4)-eオプションに指定するログファイル」を参照してください。
- -a { u | m }
- -a uを指定した場合,各コミュニティに所属しているすべてのコミュニティメンバ,各コミュニティメンバに割り当てられているすべてのコミュニティロール,およびすべてのユーザを削除します。
- -a mを指定した場合,各コミュニティに所属しているすべてのコミュニティメンバ,および各コミュニティメンバに割り当てられているすべてのコミュニティロールを削除します。
- -aオプションでユーザおよびメンバを削除した場合,ユーザおよびメンバの削除を通知するインタフェースをコールしません。
- -aオプションを指定しない場合は,-uオプションまたは-mオプションを指定してください。
- -u 削除ユーザ一覧ファイル名
- 削除ユーザ一覧ファイル(del_member.cfg)に指定されているユーザを削除します。指定したユーザのロール情報とメンバ情報を削除し,最後にユーザ情報を削除します。
- なお,-uオプションでユーザを削除した場合,メンバ削除通知をコールしません。
- -uオプションを指定しない場合は,-aオプションまたは-mオプションを指定してください。
- ファイル名の指定方法
- 削除ユーザ一覧ファイルのファイル名は,絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
- ファイルの記述形式
- 削除ユーザ一覧ファイルの記述形式については,「7.2.7 削除ユーザ一覧ファイル(del_member.cfg)」を参照してください。
- サンプルファイルの利用
- 削除ユーザ一覧ファイルに,サンプルファイル(del_member.cfg.sam)を使用する場合は,サンプルファイルの内容を使用する環境に合わせて変更し,ファイル名「del_member.cfg」で保存してください。
- -m 削除メンバ一覧ファイル名
- 削除メンバ一覧ファイルで指定されたすべてのコミュニティメンバについて,各コミュニティメンバに割り当てられたすべてのコミュニティロールを削除します。また,各コミュニティメンバ自体をコミュニティから削除します。
- なお,-mオプションでメンバを削除した場合,メンバ削除通知をコールしません。-mオプションを指定しない場合は,-aオプションまたは-uオプションを指定してください。
- ファイル名の指定方法
- 削除メンバ一覧ファイルのファイル名は,絶対パス,またはコマンドを実行するディレクトリからの相対パスで指定します。ファイル名は,220バイト以内の文字列で指定します。ただし,絶対パスで表したときに220バイト以内の文字列になるように指定してください。
- ファイルの記述形式
- 削除メンバ一覧ファイルの記述形式については,「7.2.8 削除メンバ一覧ファイル」を参照してください。
戻り値
del_memberコマンドの戻り値を次に示します。
表5-8 del_memberコマンドの戻り値
戻り値 | 意味 |
---|
0 | 正常終了しました。 |
1 | ユーザによる強制終了が発生したか,またはコマンド用jarが見つかりません。 |
2 | 指定した削除ユーザ一覧ファイル,削除メンバ一覧ファイル,またはhptl_clb_ccm_cmd.propertiesが見つかりません。 出力ファイル,またはログファイルを生成できません。 |
3 | 必要なオプションが指定されていません。 |
4 | 排他のオプションが重複して指定されています。 |
12 | 出力ファイル名,ログファイル名,削除ユーザ一覧ファイル名,または削除メンバ一覧ファイル名が長過ぎます。 |
13 | 削除ユーザ一覧ファイルまたは削除メンバ一覧ファイルの書式にエラーがあります。 |
14 | 削除ユーザ一覧ファイル,削除メンバ一覧ファイル,またはhptl_clb_ccm_cmd.propertiesの属性値が適切な範囲にありません。 |
21 | データベースからの応答がありません。 |
22 | データベースへの接続に失敗しました。 |
23 | SQLクエリの実行に失敗しました。 |
24 | JDBCドライバがインストールされていません。または,パスが通っていません。 |
25 | 存在しないレコードを指定しました。 |
31 | 入出力処理中にエラーが発生しました。 |
32 | トレース処理中にエラーが発生しました。 |
33 | コマンドの書式が違います。 |
34 | システム情報の取得に失敗しました。 |
35 | nullが指定されました。 |
36 | 内部矛盾が発生しました。 |
39 | 次の意味が考えられます。
- コマンドが実行できる状態ではありません。
- 環境変数が設定されていません。
- システムコールでエラーが発生しました。
|
実行結果
データベースのメンバ情報テーブル(TBL_MEMBER),ユーザ情報テーブル(TBL_USER),およびメンバロールテーブル(TBL_MEMBERROLE)に削除フラグが設定されます。
使用例
del_memberコマンドの使用例を紹介します。ここでは,次のような環境を想定しています。
- ソフトウェア環境
del_memberコマンドを実行できる環境
- コマンドプロンプトのカレントディレクトリ
<Collaboration - Serverインストールディレクトリ>¥community¥command¥bin
- 削除ユーザ一覧ファイル
C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥del_member.cfg
- 削除ユーザ一覧ファイルの内容を基にユーザを削除する場合
- 削除ユーザ一覧ファイルの内容を基にユーザを削除する場合,del_memberコマンドを次のように実行します。
del_member -e "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥log¥del_member.log" -u "C:¥Program Files¥Hitachi¥Collaboration¥community¥command¥sys¥del_member.cfg" |
- この実行例では,del_memberコマンドを実行すると,エラーログがある場合は-eオプションで指定したログファイル(del_member.log)に出力されます。
- 実行例は改行されているように表示されていますが,実際に実行するときは,1行で記述する必要があります。
- 標準出力に何も出力しない場合
- ログをデフォルトのログファイルに出力する場合,del_memberコマンドを次のように実行します。
- この実行例は,あらかじめコマンドプロパティファイル(hptl_clb_ccm_cmd.properties)のhptl_clb_ccm_cmd_logfileキーの設定値に,ログファイルとしてC:¥Program Files¥Hitachi¥Collaboration¥community¥log¥error_del_member.logを指定していることを想定しています。
注意事項
- del_memberコマンドの実行中にエラーが発生した場合,必ず,del_memberコマンドを再実行して,ユーザまたはメンバが削除されていることを[コミュニティ管理]ポートレットで確認してください。
- 存在しないレコードをdel_memberで削除しようとした場合は,メッセージ(KDCM00010-W)を出力して正常終了します。