csahttpuserdel(HTTPアダプタのベーシック認証で使用するアカウント情報の削除)
形式
csahttpuserdel [-h] -user <ユーザ名> -uri <接続先URI> -f <HTTPアダプタアカウント定義ファイルのパス>
機能
HTTPアダプタアカウント定義ファイルに登録されているアカウント情報を削除します。
削除したアカウント情報は,認証情報を使用するHTTPアダプタの開始後に反映されます。また,HTTPアダプタが開始している状態でこのコマンドを実行すると,削除したアカウント情報は,次のHTTPアダプタの開始後に反映されます。
なお,HTTPアダプタアカウント定義ファイルは,アカウント情報数が0個になっても削除されません。
アカウント情報管理コマンドでは,コマンド実行時に排他制御を実行しません。そのため,アカウント情報の更新中にほかにアカウント情報を更新するコマンド(csahttpuseraddコマンドまたはcsahttpuserdelコマンド)を実行した場合はエラーとなり,メッセージKDEC81216-Eを出力します。
コマンドを実行する前の注意事項を次に示します。
-
コマンドを実行する管理者に限定して,HTTPアダプタアカウント定義ファイルに対する更新・参照権限を設定してください。
-
HTTPアダプタアカウント定義ファイルのバックアップファイルの作成をお勧めします。
引数
-h
コマンドの使用方法が表示されます。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。
-user <ユーザ名> 〜<半角英数字および半角記号> ((1〜80文字))
削除したいアカウント情報のユーザ名を指定します。大文字と小文字は区別されます。
指定したユーザ名とHTTPアダプタアカウント定義ファイルのユーザ名が完全一致した場合,同一のユーザ名と判断されます。
-uri <接続先URI>
削除するアカウント情報の接続先URIを指定します。
指定した接続先URIと,HTTPアダプタアカウント定義ファイルの接続先URIを正規化して,それらの値が完全一致した場合,同一の接続先URIと判断されます。
-f <HTTPアダプタアカウント定義ファイルのパス>
削除するアカウント情報が登録されているHTTPアダプタアカウント定義ファイルのパスを相対パスまたは絶対パスで指定します。パスに空白を含む場合は,オプション引数全体をダブルクォーテーション(")で囲みます。
コマンド実行後,ここで指定したHTTPアダプタアカウント定義ファイルは,HTTPアダプタ実行環境プロパティファイルのadphttp.config.account-inf-filepathプロパティに設定することで読み込まれます。HTTPアダプタ実行環境プロパティファイルについては,「6.14.2 HTTPアダプタ実行環境プロパティファイル」を参照してください。
指定したファイルが存在しない場合は,エラーになります。
戻り値
戻り値 |
意味 |
---|---|
0 |
正常終了しました。 |
1 |
コマンドが異常終了しました。 |
9 |
実行権限のチェックエラーが発生しました。 |
注意事項
-
HTTPアダプタアカウント定義ファイルは直接編集しないでください。