csaftpuseradd (Registering and updating FTP adapter users)
Format
csaftpuseradd [-h]
-user login-user-ID
-pass login-password
[-account billing-information]
[-r]
-f path-of-FTP-adapter-account-definition-file
Function
Registers a user in the FTP adapter account definition file. If a user is already registered, this command updates the password and the billing information.
For details on how to use this command, see 5.4.14 Checking and changing the user information for an FTP adapter in the Service Platform System Setup and Operation Guide.
Arguments
-h
Displays the usage of commands. When you specify this option, all other options are ignored even if specified.
-user login-user-ID ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))
Specifies the user ID to be registered or updated.
You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are as follows:
-pass login-password ~ <one-byte alphanumeric characters and one-byte symbols> ((1 to 80 characters))
Specifies a password for the user ID to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are the same as those for the -user option.
To change the password (when the -r option is specified), specify the new password.
-account billing-information ~ <one-byte alphanumeric characters and one-byte symbols> ((at least 1 character))
Specifies the billing information (which is a string indicating the account) for the user that is to be registered or updated. You can specify one-byte alphanumeric characters, one-byte symbols (0x21 to 0x7E in ASCII encoding), and one-byte spaces (0x20 in ASCII encoding). The characters are case sensitive. The available one-byte symbols are the same as those for the -user option.
If this option is omitted, or if null is specified in billing-information, the billing information is not set up.
Note that you must specify this option to change the password for a user for whom the billing information is set up.
-r
Specify this option to change the password of the user ID that is already registered.
-f path-of-FTP-adapter-account-definition-file
Specifies the relative or absolute path of the FTP adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").
If the file does not exist already, an FTP adapter account definition file is created. However, an error occurs if the directory does not exist. To add an account to an existing FTP adapter account definition file, specify the existing FTP adapter account definition file.
Examples of input
csaftpuseradd -user user1 -pass password1 -account account1 -f account.properties
csaftpuseradd -user user2 -pass password2 -f account.properties
csaftpuseradd -user user1 -pass passwordnew -account accountnew -r -f account.properties
csaftpuseradd -user user2 -pass passwordnew -r -f account.properties
csaftpuseradd -user user2 -pass password2 -account account2 -r -f account.properties
csaftpuseradd -user user1 -pass password1 -r -f account.properties
Return values
Return value | Meaning |
---|---|
0 | The command terminated normally. |
1 | The command terminated abnormally. |
9 | An error occurred when checking the execution permission. |
Notes