csaftpuseradd(FTPアダプタのユーザの登録・更新)
形式
csaftpuseradd [-h] { -userinfofile <ユーザ情報指定ファイルのパス> | -user <ログインユーザID> -pass <ログインパスワード> [-account <課金情報>] } [-r] { -f <FTPアダプタアカウント定義ファイルのパス> | -name <サービスID> }
機能
FTPアダプタアカウント定義ファイルに新規のユーザを登録します。登録できるユーザ数の上限はありません。ユーザがすでに登録されている場合は,パスワードや課金情報を更新します。
コマンドを実行する前の注意事項を次に示します。
-
このコマンドの-passオプションにパスワードを指定した場合,プロセスの引数を確認できるOS機能などによって,パスワードが検知されるおそれがあります。このため,-userinfofileオプションを使用した,ユーザ情報指定ファイルでのパスワードの設定を推奨します。
-
運用コマンドを実行する管理者にだけ,FTPアダプタアカウント定義ファイルに対する更新・参照のアクセス権を設定してください。
-
コマンドにユーザ情報指定ファイルを指定する場合,運用コマンドを実行する管理者にだけ,ユーザ情報指定ファイルに対する更新・参照のアクセス権を設定してください。
このコマンドの使用方法については,マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「5.4.14 FTPアダプタのユーザ情報を確認および変更する」を参照してください。
引数
-h
コマンドの使用方法が表示されます。このオプションを指定している場合は,ほかのオプションを指定しても無視されます。
-userinfofile <ユーザ情報指定ファイルのパス>
ログインユーザID,ログインパスワード,課金情報が記載されているユーザ情報指定ファイルのパスを指定します。絶対パス,またはコマンド実行時のカレントディレクトリからの相対パスで指定してください。パスが空白を含む場合は,パス全体をダブルクォーテーション(")で囲んでください。
指定されたユーザ情報指定ファイルのユーザ情報がすべて正常であれば,その内容がFTPアダプタアカウント定義ファイルに一括で登録または更新されます。ただし,次の場合はエラーとなり,登録・更新は実施されません。
-
指定されたファイルが存在しない場合
-
ファイル内のユーザ情報に1つでも不正があった場合
-
ファイル内にログインユーザIDが重複している場合
なお,実行対象のユーザ情報指定ファイルには,ユーザ情報の登録または更新のどちらかだけを指定できます。
ユーザ情報指定ファイルの記載方法については,「6.21.1 ユーザ情報指定ファイル」を参照してください。
-user <ログインユーザID> 〜<半角英数字および半角記号> ((1−80文字))
登録または更新したいユーザIDを指定します。
使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号を次に示します。
-
感嘆符(!)
-
ダブルクォーテーション(")
-
番号記号(#)
-
ドル記号($)
-
パーセント(%)
-
アンパサンド(&)
-
アポストロフィ(')
-
始め小括弧(()
-
終わり小括弧())
-
アスタリスク(*)
-
正符号(+)
-
コンマ(,)
-
ハイフン(-)
-
ピリオド(.)
-
スラッシュ(/)
-
コロン(:)
-
セミコロン(;)
-
左アングルブラケット(<)
-
右アングルブラケット(>)
-
等号(=)
-
クエスチョンマーク(?)
-
単価記号(@)
-
始め角括弧([)
-
終わり角括弧(])
-
円マーク(\)
-
アクサンシルコンフレックス(^)
-
アンダーバー(_)
-
アクサングラーブ(`)
-
始め波括弧({)
-
終わり波括弧(})
-
パイプライン(|)
-
波ダッシュ(~)
-pass <ログインパスワード> 〜<半角英数字および半角記号> ((1−80文字))
登録または更新したいユーザIDに対するパスワードを指定します。使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号は-userオプションと同じです。
更新したい場合(-rオプションを指定する場合),更新後のパスワードを指定します。
-account <課金情報> 〜<半角英数字および半角記号> ((1文字以上))
登録または更新したいユーザに対する課金情報(アカウントを示す文字列)を指定します。使用できる文字は,半角英数字,半角記号(ASCIIコードの「0x21」〜「0x7E」),および半角スペース(ASCIIコードの「0x20」)です。大文字と小文字は区別されます。使用できる半角記号は-userオプションと同じです。
このオプションを省略,または<課金情報>に空文字を指定した場合,課金情報は設定されません。
なお,課金情報が設定されているユーザのパスワードを変更する場合,このオプションを指定する必要があります。
-r
すでに登録されているユーザIDのパスワードを変更する場合に指定します。
-f <FTPアダプタアカウント定義ファイルのパス>
FTPアダプタアカウント定義ファイルのパスを相対パス,または絶対パスで指定します。空白を含む場合は,オプション引数全体をダブルクォーテーション(")で囲みます。
ファイルが存在しない場合,新規にFTPアダプタアカウント定義ファイルが作成されます。ただし,ディレクトリが存在しない場合は,エラーになります。既存のFTPアダプタアカウント定義ファイルに新規アカウントを追加する場合は,既存のFTPアダプタアカウント定義ファイルを指定してください。
-name <サービスID> 〜<半角英数字およびアンダーバー(_)> ((1−8文字))
製品固定パスでFTPアダプタ単位にユーザを管理する場合に,FTPアダプタのサービスIDを指定します。
製品固定パスにファイルが存在しない場合,新規にFTPアダプタアカウント定義ファイルが作成されます。ただし,ディレクトリが存在しない場合は,エラーになります。製品固定パスの詳細は,「6.8.1 FTPアダプタアカウント定義ファイル」を参照してください。
入力例
●ユーザ情報を任意の単位・任意のパスのアカウント定義ファイルで管理する場合
- (1) 課金情報を設定するユーザを登録する場合
csaftpuseradd -user user1 -pass password1 -account account1 -f account.properties
- (2) 課金情報を設定しないユーザを登録する場合
csaftpuseradd -user user2 -pass password2 -f account.properties
- (3) ユーザ情報指定ファイルのユーザ情報を一括で登録する場合
csaftpuseradd -userinfofile userinfo.txt -f account.properties
- (4) ユーザのパスワードと課金情報を更新する場合
csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -f account.properties
- (5) ユーザ情報指定ファイルのユーザ情報を一括で更新する場合
csaftpuseradd -userinfofile userinfo.txt -r -f account.properties
- (6) 課金情報が設定されていないユーザのパスワードを更新する場合
csaftpuseradd -user user2 -pass passwordnew -r -f account.properties
- (7) すでに登録されているユーザに課金情報を追加する場合
csaftpuseradd -user user2 -pass password2 -account account2 -r -f account.properties
- (8) すでに登録されているユーザの課金情報を削除する場合
csaftpuseradd -user user1 -pass password1 -r -f account.properties
●ユーザ情報をFTPアダプタ単位・製品固定パスのアカウント定義ファイルで管理する場合
- (1) 課金情報を設定するユーザを登録する場合
csaftpuseradd -user user1 -pass password1 -account account1 -name adp1
- (2) 課金情報を設定しないユーザを登録する場合
csaftpuseradd -user user2 -pass password2 -name adp1
- (3) ユーザ情報指定ファイルのユーザ情報を一括で登録する場合
csaftpuseradd -userinfofile userinfo.txt -name adp1
- (4) ユーザのパスワードと課金情報を更新する場合
csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -name adp1
- (5) ユーザ情報指定ファイルのユーザ情報を一括で更新する場合
csaftpuseradd -userinfofile userinfo.txt -r -name adp1
- (6) 課金情報が設定されていないユーザのパスワードを更新する場合
csaftpuseradd -user user2 -pass passwordnew -r -name adp1
- (7) すでに登録されているユーザに課金情報を追加する場合
csaftpuseradd -user user2 -pass password2 -account account2 -r -name adp1
- (8) すでに登録されているユーザの課金情報を削除する場合
csaftpuseradd -user user1 -pass password1 -r -name adp1
戻り値
戻り値 |
意味 |
---|---|
0 |
正常終了しました。 |
1 |
コマンドが異常終了しました。 |
9 |
実行権限のチェックエラーが発生しました。 |
注意事項
-
FTPアダプタアカウント定義ファイルは編集できません。
-
コマンドの実行内容(ユーザの登録・更新)は,FTPアダプタの開始後に有効となります。また,FTPアダプタが開始している状態でコマンドを実行した場合,コマンドの実行内容(ユーザの登録・更新)は,次にFTPアダプタを開始したあとに有効となります。
-
FTPアダプタアカウント定義ファイルは,コマンド実行中のファイルの入出力エラー(ディスクフルなど)によって壊れるおそれがあります。定期的にバックアップを取得してください。
-
-fオプションに「<サービスプラットフォームのインストールディレクトリ>\CSC\config\common\account.properties」を指定しないでください。