chgloginmsg command

Use the chgloginmsg command to change the message that is displayed with the login prompt for all users.

Synopsis

smcli [-c] [-prompt] [-user user_name] [-pw password] chgloginmsg options

smcli chgloginmsg [-h | -? | --help]

smcli chgloginmsg -f file_name | -d directory_name

Description

The chgloginmsg command sets or changes the message that is displayed to all users when logging in using the Web interface. The message is available to be displayed immediately; no server restart is necessary.

Operands

None.

Options

-d | --dir directory_name
Specifies the directory of one or more properties files that contain the login message to be displayed with the login prompt through the Web interface. Use this option when you want to specify multiple properties files, as for login messages for multiple languages.
Use the -f | –file option to specify a single properties file. The file must be named loginMessage.properties. The content of the file can contain HTML formatting and must use this format: 
loginMessage=Your custom message
You must specify the absolute path of the directory where the properties files can be found. For example, you might specify the directory /home/sysadmin/logintext. This directory might include the following properties files, where each file supports a different language:
  • loginMessage.properties
  • loginMessage_en.properties
  • loginMessage_es.properties
  • loginMessage_fr.properties
loginMessage.properties is the default properties file for languages that are not supported. The other files in this example are for English (_en), Spanish (_es), and French (_fr). Supported languages are the same as those available for your Web browser. Check the language settings of your Web browser to determine the suffix to use for the file name for each language.

The contents of the properties files must be the same as described for the -f option.

Note: This option cannot be used with the -f | –file option.
-f | --file file_name
Specifies the file name (including the absolute path) of the properties file that contains the login message to be displayed with the login prompt. Use this option to specify a single properties file. Use the -d | –dir option to specify multiple properties files.

You must specify the absolute path of the directory where the properties file can be found, along with the file name. For example: /home/sysadmin/mydir/loginMessage.properties.

The file must be named loginMessage.properties. The content of the file must use this format: 
loginMessage=Your custom message
Note: This option cannot be used with the -d | –dir option.
-h | -?
Displays the syntax and a brief description of the command.
Tip: If you specify additional options other than -h | -? | --help, the options are ignored.
--help
Displays detailed information about the command, including the syntax, a description of the command, a description of the options and operands, error codes, and examples.
Tips:
  • If you specify additional options other than -h | -? | --help, the options are ignored.
  • You can also display detailed help in the form of man pages using the man command_name command.

Exit status

The following codes are returned by this command.
  • 0: The operation completed.
  • 1: A usage error occurred.
  • 2: The command or bundle was not found.
  • 3: The command was not performed because either authentication failed or you are not authorized to perform the action.
  • 201: The product installation directory could not be determined.
  • 202: The console installation directory does not exist.
  • 203: The login message directory could not be created.
  • 204: A file matching the name of the login message directory exists.
  • 205: The specified file does not exist.
  • 206: The specified file is a directory.
  • 207: The specified directory does not exist.
  • 208: The specified directory is a file.
  • 209: The specified directory is empty.
  • 210: An error occurred copying one or more files.