Hitachi

uCosminexus Service Platform Reference Guide


csmmailaddusr (Registering and updating the mail adapter user information)

Organization of this page

Format

csmmailaddusr [-h]
 -user login-user-name
 -pass login-password
 [-r]
 -f path-of-mail-adapter-account-definition-file

Function

Registers a user in the mail adapter account definition file. If a user is already registered, this command updates the password.

For details on how to use this command, see 5.5.1 Managing the user information in the uCosminexus Service Platform 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-name ~ <one-byte alphanumeric characters and one-byte symbols>

Specifies the name of the user 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:

  • Exclamation mark (!)

  • Double quotation mark (")

  • Hash mark (#)

  • Dollar sign ($)

  • Percent sign (%)

  • Ampersand (&)

  • Apostrophe mark (')

  • Left parenthesis (()

  • Right parenthesis ())

  • Asterisk (*)

  • Plus sign (+)

  • Comma (,)

  • Hyphen (-)

  • Period (.)

  • Forward slash (/)

  • Colon (:)

  • Semicolon (;)

  • Left angle bracket (<)

  • Right angle bracket (>)

  • Equal sign (=)

  • Question mark (?)

  • At mark (@)

  • Left square bracket ([)

  • Right square bracket (])

  • Yen sign (\)

  • Caret (^)

  • Underscore (_)

  • Grave accent mark (`)

  • Left curly bracket ({)

  • Right curly bracket (})

  • Vertical bar (|)

  • Swung dash (~)

-pass login-password ~ <one-byte alphanumeric characters and one-byte symbols>

Specifies the password for the user name 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.

-r

Specify this option to change the password of an already registered user.

-f path-of-mail-adapter-account-definition-file

Specifies the relative or absolute path of the mail adapter account definition file. To include spaces, enclose the entire option argument in double quotation marks (").

A mail adapter account definition file is created if the file does not exist already. However, if the directory does not exist, an error occurs. To add the user information to an existing mail adapter account definition file, specify the existing mail adapter account definition file.

Examples of input

(1) To register the user name user2 and the password password2 in the mail adapter account definition file account.properties
csmmailaddusr -user user2 -pass password2 -f account.properties
(2) To update the password for the user name user2 registered in the mail adapter account definition file account.properties to passwordnew
csmmailaddusr -user user2 -pass passwordnew -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