Synopsis

fcli ssc session logout [--no-revoke-token] [[-h] [--env-prefix=<prefix>] [--log-file=<logFile>] [--log-level=<logLevel>] [--log-mask=<level>] [--debug]] [[-o=<type+args>] [--style*=<style>,…​]…​ ] [--to-file=<outputFile>_]] [-u=<user> -p[=<password>]] [[--ssc-session=<sessionName>]]

Description

This command terminates an SSC session previously created through the 'login' command.

If the session was created with user credentials, this command will revoke the automatically generated SSC token unless the --no-revoke-token option is specified. On SSC 24.2 or above, the automatically generated token can be revoked without providing user credentials. For SSC 23.2 or below, user credentials are required to revoke the automatically generated token; in this case, the logout command will throw an error if neither user credentials nor --no-revoke-token option is specified, and the session will not be terminated.

If the session was created with a pre-generated token, the session will always be terminated without revoking the pre-generated token. As such, no user credentials need to be provided, and the --no-revoke-token option will have no effect.

To summarize: No user credentials nor --no-revoke-token option should be specified if the session was created with a pre-generated token or if the session is connected to SSC 24.2 or above. Either user credentials or --no-revoke-token option must be specified if the session was created with user credentials AND the session is connected to SSC 23.2 or below.

Options

-u, --user=<user>

SSC user name.

-p, --password[=<password>]

SSC password.

--no-revoke-token

It is highly recommended to have fcli revoke the token that was automatically generated if the session was created using user credentials to avoid exceeding SSCs maximum token limit. This option is provided for convenience only, to allow the session to be terminated without having to specify user credentials on SSC 23.2 or below. Once most users have upgraded to SSC 24.2 or above, this option will be deprecated or removed.

SSC session name options

--ssc-session=<sessionName>

Name of the SSC session to be terminated. Default value: default.

Output options (also see documentation link below)

-o, --output=<type+args>

Select output type (csv, table, expr, json, xml, yaml) and optional type arguments.

*--style*=<style>,…​

Select output style: header, no-header, pretty, no-pretty, flat, no-flat, array, single, border, no-border, md-border.

--store=<var>[:<prop>]

Store JSON results in an fcli variable for later reference.

--to-file=<outputFile>

Write output to the specified file.

Generic fcli options (also see documentation link below)

-h, --help

Use 'fcli [command] -h' to display help for fcli (sub-)commands.

--env-prefix=<prefix>

Prefix for resolving default option values. Default value: FCLI_DEFAULT.

--log-file=<logFile>

Write log output to file. Default: ./fcli.log if logging is enabled.

--log-level=<logLevel>

Set logging level: TRACE, DEBUG, INFO, WARN, ERROR, NONE.

--log-mask=<level>

Log mask level: high, medium, low, none. Default: medium. Masking is done on a best-effort basis; no guarantee that all sensitive data will be masked.

--debug

Enable collection of debug logs.