Banner

Banner messages are informational displays that present important notices, warnings, or legal disclaimers to users at various points during device access and interaction. These messages serve multiple purposes including security warnings, legal compliance, maintenance notifications, and user guidance during login, EXEC mode entry, or session timeout scenarios. Banners are essential for establishing proper security policies, meeting regulatory requirements, and providing users with critical system information.

Diagram

Classes

configuration (iosxe.devices)

Name	Type	Constraint	Mandatory	Default Value
banner	Class	`[banner]`	No

Name	Type	Mandatory
exec	String	No
login	String	No
prompt_timeout	String	No
motd	String	No

By configuring various banner types, network administrators can effectively communicate critical information to users, enforce security policies, and meet compliance requirements. These banners are crucial for providing immediate feedback and warnings upon device access and during session management.

Login Banner: Text displayed to users before they log in to the device.
Exec Banner: Text displayed to users after they successfully log in and enter EXEC mode.
MOTD (Message of the Day) Banner: General informational message displayed before login, often used for announcements or system status.
Prompt Timeout Banner: Message displayed when a user’s session is about to time out due to inactivity.

You can use these Banner parameters to define precise messages for different stages of user interaction with the network device. Customize the content for each banner type to fit your network’s security, operational, and informational needs. Adjusting these parameters lets you tailor communication for your environment.

Sample Configuration:

Please contact admin@company.com for support
^C
banner login ^C
******************************************
* WARNING: Unauthorized access is        *
* prohibited and will be prosecuted      *
* to the full extent of the law.         *
******************************************
^C
banner motd ^CSystem maintenance scheduled for Sunday 2AM-4AM
All users will be disconnected during this time
^C
banner prompt-timeout ^CSession will timeout in 5 minutes due to inactivity^C

Example Code:

iosxe:
  devices:
    - name: Device1
      configuration:
        banner:
          login: |
            ******************************************
            * WARNING: Unauthorized access is      *
            * prohibited and will be prosecuted    *
            * to the full extent of the law.       *
            ******************************************
          exec: |
            Welcome to Device1
            Please contact admin@company.com for support
          motd: |
            System maintenance scheduled for Sunday 2AM-4AM
            All users will be disconnected during this time
          prompt_timeout: |
            Session will timeout in 5 minutes due to inactivity
    - name: Device2
      configuration:
        banner:
          login: "Access restricted to authorized personnel only"
          motd: "Production environment - Exercise caution"