Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Configuring CLI Messages

    You can configure text banners for the CLI to display to users at different times in the connection process.

    You can use the banner command with the following keywords to configure MOTD, login, or exec banner to be displayed by the CLI:

    • motd—Displays the banner when a console or vty connection is initiated.
    • login—Displays the banner before any user authentication (line or RADIUS authentication). The banner is also displayed if user authentication is not configured.
    • exec—Displays the banner after user authentication (if any) and before the first prompt of a CLI session.

    If you do not specify an option in the banner command, the default behavior is to display the banner as an MOTD. The first character in the banner string must be repeated at the end of the string; these characters delimit the banner. The CLI prompts you if you fail to repeat the opening delimiter. All text following the second occurrence of the delimiter is ignored without warning. The delimiter is case sensitive. Banner text can span multiple lines. It is truncated after 1,024 characters.

    When executing the banner command, you can insert \n where you want the banner text to split and start a new line. Alternatively, you can press Enter on the CLI when you want the text to break. In the second case, you will be prompted for the remainder of the text after you press Enter. To display a backslash as part of the message, it must be immediately preceded by another backslash, like this: \\. Do not use a backslash as a delimiter or end a line with a backslash.

    When executing the banner command, you can insert a ? character inside the text of a banner, you must enter Ctrl+v before entering the ? character. Failure to do so may produce undesired results.

    To configure MOTD, login, or exec banner to be displayed by the CLI:

    • Issue the banner command in Global Configuration mode.
      host1(config)#banner motd x This is an MOTD banner x host1(config)#banner Y This is also an MOTD banner Y host1(config)#banner "Quotes make good delimiters" host1(config)#banner Xno space is required between the delimiter and the real banner textX host1(config)#banner b bad choice for a delimiter; everything after that second b was ignored b host1(config)#banner "This is one way\nto specify a multiple line banner" host1(config)#banner "This is another way to specify a Enter remainder of text message. End with the character '"'. multiple line banner

      You can use the default version to restore the default setting, in which the banner is displayed on all lines. You can configure MOTD or exec banners, but not login banners, for the CLI to display on a per-line basis.

      Use the no version to remove the banner.

    To display an exec banner on a particular line after user authentication (if any) and before the first prompt of a CLI session:

    • Issue the exec-banner command in Line Configuration mode. You can use the default version to restore the default setting, in which the banner is displayed on all lines.
      host1(config-line)#exec-banner

      Banners on the lines are enabled by default; the no version does not reenable banners on the lines.

      Use the no version to disable the exec banner on the line. If both the exec and MOTD banners are enabled on a line, issuing the no exec-banner command disables both the exec banner and the MOTD banner. The no motd-banner command behaves differently from the no exec-banner command.

    To display an MOTD banner on a particular line when a connection is initiated:

    • Issue the motd-banner command in Line Configuration mode. You can use the default version to restore the default setting, in which the banner is displayed on all lines.
      host1(config-line)#motd-banner

      Banners on the lines are enabled by default; the no version does not reenable banners on the lines.

      Use the no version to disable the MOTD banner on the line. If both MOTD and exec banners are enabled on a line, issuing the no motd-banner command disables the MOTD banner and leaves the exec banner enabled. The no motd-banner command behaves differently from the no exec-banner command.

    Published: 2014-08-12