endSession command

Use the endSession command to end the IBM® Flex System Manager Web interface session for the selected user.

Synopsis

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

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

smcli endSession [-v] {-f file_name | [-u] user_list}

Description

The endSession command ends the IBM Flex System Manager Web interface session for the selected user. After the session has been terminated, the user must log back in.
Note: Tasks started during the terminated session will continue to run.

Operands

This command takes a user name as a required operand. The list can optionally be preceded by the -u | --users option.

Options

-f | --file {file_name | -}
Retrieves data either from the input file file_name or from input piped from another command.

To retrieve input piped from another command, specify a hyphen (-) instead of a file name (for example, smcli cmd1 | smcli cmd2 -f -). To retrieve input from a file, specify the full path. If the path contains spaces, enclose it in quotation marks.

The input data is the list of user names, separated by commas or line breaks.
-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.
-u | --user user_list
Specifies, by name or ID, one or more valid IBM Flex System Manager users.
Note: Use the smcli lsuser command to see a full list of authorized IBM Flex System Manager users.
-v | --verbose
Writes verbose messages to standard output.

If this option is not specified, this command suppresses noncritical messages.

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.
  • 50: A specified user is not valid.
  • 70: A specified user is not active.

Examples

  1. Log off a user

    This example illustrates how to end the IBM Flex System Manager Web interface session for user UserA.

    smcli endSession -u UserA