Banner

Banner messages are displayed to users at various points during device access. Banners are used for security warnings, legal notices, and system information.

Diagram

Classes

iosxr

Name	Type	Constraint	Mandatory	Default Value
devices	List	devices	No
device_groups	List	device_groups	No
global	Class	global	No

devices (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

device_groups (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

global (iosxr)

Name	Type	Constraint	Mandatory	Default Value
configuration	Class	configuration	No

configuration (iosxr.devices)

Name	Type	Constraint	Mandatory	Default Value
banners	List	banners	No

banners (iosxr.devices.configuration)

Name	Type	Constraint	Mandatory	Default Value
type	Choice	exec, incoming, login, motd, prompt-timeout, slip-ppp	Yes
banner	String		Yes

Example YAML Code:

Example-1: Configure login and MOTD banners on a device.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        banners:
          - type: login
            banner: |
              ******************************************
              This is a private computer system and is
              for authorized use only. Users (authorized
              or unauthorized) have no explicit or
              implicit expectation of privacy.
              ******************************************
          - type: motd
            banner: |
              For support please contact support@company.com

Example-2: Configure multiple banner types.

iosxr:
  devices:
    - name: router-1
      host: 10.10.10.1:57400
      configuration:
        banners:
          - type: login
            banner: |
              ******************************************
              This is a private computer system and is
              for authorized use only. Users (authorized
              or unauthorized) have no explicit or
              implicit expectation of privacy.
              ******************************************
          - type: motd
            banner: |
              For support please contact support@company.com
          - type: exec
            banner: |
              You have entered EXEC mode.
              All commands are logged and monitored.
          - type: incoming
            banner: |
              Incoming connection detected.
              Authentication is required to proceed.
          - type: prompt-timeout
            banner: |
              Your session has been idle too long.
              You will be disconnected in 30 seconds.
          - type: slip-ppp
            banner: |
              SLIP/PPP session initiated.
              Data usage is monitored and logged.