GUI and CLI Banner

Version:

Location in GUI: System » System Settings » System Alias and Banners

Diagram

Classes

fabric_policies (apic)

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

banners (apic.fabric_policies)

Name	Type	Constraint	Mandatory	Default Value
apic_gui_alias	String		No
apic_gui_banner_url	String		No
apic_gui_banner_message	String		No
apic_cli_banner	String		No
switch_cli_banner	String		No
apic_app_banner	String		No
apic_app_banner_severity	Choice	`critical`, `info`, `warning`	No	`info`
escape_html	Boolean	`true`, `false`	No	`true`

Examples

Example-1: The following data model configures various banners related to legal usage; apic_gui_banner_message displays a custom informational or legal banner on the APIC GUI login page. The switch_cli_banner and apic_cli_banner are shown when connecting to the fabric switches and controllers respectively using SSH or Telnet (if available). Please note that a new line is represented by \n. Finally, the apic_gui_alias helps identify which APIC controller you are currently viewing in a multi-APIC cluster environment.

apic:
  fabric_policies:
    banners:
      apic_gui_alias: San Francisco DC
      switch_cli_banner: "*************************************************\n*   WARNING: Unauthorized access is prohibited! *\n*   This system is for authorized users only.   *\n*   All activities are monitored and recorded.  *\n*************************************************"
      apic_gui_banner_message: "By logging in, you agree to the terms and conditions of use. Unauthorized access is prohibited."
      apic_cli_banner: "*************************************************\n*   WARNING: Unauthorized access is prohibited! *\n*   This system is for authorized users only.   *\n*   All activities are monitored and recorded.  *\n*************************************************"

Location in GUI: System » System Settings » System Alias and Banners

Diagram

Classes

fabric_policies (apic)

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

banners (apic.fabric_policies)

Name	Type	Constraint	Mandatory	Default Value
apic_gui_alias	String		No
apic_gui_banner_url	String		No
apic_gui_banner_message	String		No
apic_cli_banner	String		No
switch_cli_banner	String		No
apic_app_banner	String		No
apic_app_banner_severity	Choice	`critical`, `info`, `warning`	No	`info`
escape_html	Boolean	`true`, `false`	No	`true`

Examples

apic:
  fabric_policies:
    banners:
      apic_gui_alias: APIC GUI BANNER
      apic_gui_banner_url: APIC GUI BANNER URL
      apic_cli_banner: APIC CLI BANNER
      switch_cli_banner: SWITCH CLI BANNER
      apic_app_banner: APIC APP BANNER
      apic_app_banner_severity: critical
      escape_html: false

Location in GUI: System » System Settings » System Alias and Banners

Diagram

Classes

fabric_policies (apic)

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

banners (apic.fabric_policies)

Name	Type	Constraint	Mandatory	Default Value
apic_gui_alias	String		No
apic_gui_banner_url	String		No
apic_gui_banner_message	String		No
apic_cli_banner	String		No
switch_cli_banner	String		No
apic_app_banner	String		No
apic_app_banner_severity	Choice	`critical`, `info`, `warning`	No	`info`
escape_html	Boolean	`true`, `false`	No	`true`

Examples

apic:
  fabric_policies:
    banners:
      apic_gui_alias: APIC GUI BANNER
      apic_gui_banner_url: APIC GUI BANNER URL
      apic_cli_banner: APIC CLI BANNER
      switch_cli_banner: SWITCH CLI BANNER
      apic_app_banner: APIC APP BANNER
      apic_app_banner_severity: critical
      escape_html: false

Location in GUI: System » System Settings » System Alias and Banners

Diagram

Classes

fabric_policies (apic)

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

banners (apic.fabric_policies)

Name	Type	Constraint	Mandatory	Default Value
apic_gui_alias	String		No
apic_gui_banner_url	String		No
apic_gui_banner_message	String		No
apic_cli_banner	String		No
switch_cli_banner	String		No
escape_html	Boolean	`true`, `false`	No	`true`

Examples

apic:
  fabric_policies:
    banners:
      apic_gui_alias: APIC GUI BANNER
      apic_gui_banner_url: APIC GUI BANNER URL
      apic_cli_banner: APIC CLI BANNER
      switch_cli_banner: SWITCH CLI BANNER
      escape_html: false