6.21.1 ユーザ情報指定ファイル
- 〈この項の構成〉
(1) 形式
ユーザ情報指定ファイルの指定形式は,コマンドによって次のように異なります。コマンド内でパラメタの指定順序は変更できません。
-
csaftpuseraddコマンドの場合
<ログインユーザID><タブ文字><ログインパスワード><タブ文字>[<課金情報>]
-
csmftpaddusrコマンドの場合
<ユーザ名><タブ文字><パスワード>
-
csmmailaddusrコマンドの場合
<ログインユーザ名><タブ文字><パスワード>
-
csakeyaddコマンドの場合
<秘密鍵のファイルパス><タブ文字><鍵ID><タブ文字>[<秘密鍵のパスフレーズ>]
-
csauseraddコマンドの場合
<ユーザ名><タブ文字><パスワード>
-
csahttpuseraddコマンドの場合
<ユーザ名><タブ文字><パスワード><タブ文字><接続先URI>
(2) 機能
ユーザ情報指定ファイルには,コマンドに応じたユーザ情報を記載します。コマンドのオプション「-userinfofile」にファイルパスを指定して実行することで,設定されたユーザ情報を登録または更新できます。
ユーザ情報指定ファイルを指定できるコマンドを次に示します。これらのコマンドについては,「5.4 サービスプラットフォームの運用環境および実行環境で使用するコマンド」にある,該当するコマンドの説明を参照してください。
-
csaftpuseraddコマンド(FTPアダプタのユーザの登録・更新)
-
csmftpaddusrコマンド(FTPインバウンドアダプタのユーザの登録・更新)
-
csmmailaddusrコマンド(メールアダプタユーザ情報の登録・更新)
-
csakeyaddコマンド(公開鍵認証の秘密鍵情報の登録・更新)
-
csauseraddコマンド(パスワード認証のユーザ情報の登録・更新)
-
csahttpuseraddコマンド(HTTPアダプタのベーシック認証で使用するアカウント情報の登録・更新)
ユーザ情報指定ファイルの指定規則を次に示します。
-
パラメタの間はタブ文字で区切って指定してください。
-
複数のユーザ情報を記載する場合は,改行文字で区切ってください。空行は無視されます。
-
ファイルに使用できる文字コードは,BOMコード無しのUTF-8だけです。それ以外の文字コードを使用した場合の動作は保証しません。
-
ユーザ情報指定ファイルの内容が次の状態である場合は,コマンド実行時にエラーとなります。
-
指定が必要なパラメタが記載されていない
-
指定できないパラメタが記載されている
-
ユーザ情報指定ファイルが空(または改行だけ)である
-
(3) ファイルの格納先
任意のファイル名で任意のディレクトリに保存してください。
(4) 設定できるパラメタ
(a) csaftpuseraddコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
ログインユーザID |
-user |
ログインパスワード |
-pass |
課金情報 |
-account |
設定方法については,「csaftpuseradd(FTPアダプタのユーザの登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内に同じログインユーザIDが重複して記載されている場合,コマンド実行時にエラーとなります。
(b) csmftpaddusrコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
ユーザ名 |
-usr |
パスワード |
-pass |
設定方法については,「csmftpaddusr(FTPインバウンドアダプタのユーザの登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内に同じユーザ名が重複して記載されている場合,コマンド実行時にエラーとなります。
(c) csmmailaddusrコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
ログインユーザ名 |
-user |
ログインパスワード |
-pass |
設定方法については,「csmmailaddusr(メールアダプタユーザ情報の登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内に同じログインユーザ名が重複して記載されている場合,コマンド実行時にエラーとなります。
(d) csakeyaddコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
秘密鍵のファイルパス |
-keyfile |
鍵ID |
-keyid |
秘密鍵のパスフレーズ |
-pass |
設定方法については,「csakeyadd(公開鍵認証の秘密鍵情報の登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内に同じ鍵IDが重複して記載されている場合,コマンド実行時にエラーとなります。
(e) csauseraddコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
ユーザ名 |
-user |
パスワード |
-pass |
設定方法については,「csauseradd(パスワード認証のユーザ情報の登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内に同じユーザ名が重複して記載されている場合,コマンド実行時にエラーとなります。
(f) csahttpuseraddコマンドの場合
設定できるパラメタを次に示します。各パラメタの設定方法は,列「該当するコマンドオプション」に示すオプションと同じです。
パラメタ |
該当するコマンドオプション |
---|---|
ユーザ名 |
-user |
パスワード |
-pass |
接続先URI |
-uri |
設定方法については,「csahttpuseradd(HTTPアダプタのベーシック認証で使用するアカウント情報の登録・更新)」の該当するオプションの記載を参照してください。
なお,ファイル内にユーザ名と接続先URIの同じ組み合わせが重複して記載されている場合,コマンド実行時にエラーとなります。
(5) 記述例
csaftpuseraddコマンドの-userinfofileオプションで指定する,ユーザ情報指定ファイルの記述例を次に示します。
user1<タブ文字>pass1 user2<タブ文字>pass2<タブ文字>account2