configure banner

configure banner {after-login | { before-login } { acknowledge } | before-login {acknowledge} save-to-configuration}

Description

Configures the banner string to be displayed for CLI screens.

Syntax Description

after-login Specifies that a banner be displayed after login.
before-login Specifies that a banner be displayed before login.
acknowledge Require acknowledgement of the banner before login.
save-to-configuration Save the before login banner to the configuration file as well as non-volatile memory.

Default

N/A.

Usage Guidelines

Use this command to configure two types of banners:
  • A banner for a CLI session that displays before login.

  • A banner for a CLI session that displays after login.

If no optional parameters are specified, the command defaults to configuring a banner that is displayed before the CLI session login prompt.

For each CLI session banner, you can enter up to 24 rows of 79-column text.

Press [Return] at the beginning of a line to terminate the command and apply the banner. To clear the banner, press [Return] at the beginning of the first line.

Note

Note

The system does not wait for a keypress when you use SSH for access; this only applies to the serial console login sessions and Telnet sessions.

To disable the acknowledgement feature, use the configure banner command omitting the acknowledge parameter.

To display any configured banners, use the show banner command.

To unconfigure one or more configured banners, use the unconfigure banner command.

Example

The following example add the text "test" before the pre-login prompt:

# configure banner before-login
test

# logout
Do you wish to save your configuration changes to primary.cfg? (y/N)
Y
test

login:
# show banner

Before-Login banner:
test

Acknowledge: Disabled
Save to    : Non-volatile memory only

After-Login banner:

History

This command was first available in ExtremeXOS 10.1.

The acknowledge parameter was added in ExtremeXOS 11.5.

The after-login option was added in ExtremeXOS 12.5.

Platform Availability