Supported markup for the user interface customization file
The user interface customization file is an XML file.
You can copy and paste elements from the supplied template file to create the file, (see Template of the custom user interface file). The schema for the XML file supports the following case-sensitive elements:
<User-Interface>
- The <User-Interface> element is the root element of the XML file and defines the required namespace statements. The XML file must contain this element copied and pasted from the template without modification.
<CustomPrompt>
- The <CustomPrompt> element indicates whether to extend the CLI
prompt with the system name. To enable this aspect, add an element of the
form:
The system name is the only customization available for the CLI prompt. The system name can be set using the name command, see name.<CustomPrompt>%s</CustomPrompt>
<MarkupBanner>
- The <MarkupBanner> element identifies the messages to display in
the web UI. The file can contain up to four <MarkupBanner> elements,
based on a combination of the type attribute and
location attribute.
type="message-type"
- The type attribute identifies the type of message. This attribute
supports the following keywords.
pre-login
- Displays the message before users log in to the web UI. You can define one pre-login message.
post-login
- Displays the message in a pop-up window immediately after users log in to the web UI. You can define one post-login message.
system-banner
- Displays the message on each web UI screen. You can define two appliance messages based on the keyword of the location attribute. Use the location attribute to define where on the web UI to display the message.
location="location"
- The location attribute indicates the location on the web UI to
display the message. This attribute is relevant only when used with
type="system-banner". The location
attribute supports the following keywords. The default value is both.
header
- Displays the message at the top. You can define one message with this keyword. You cannot define a message with this keyword and another with the both keyword.
footer
- Displays the message at the bottom. You can define one message with this keyword. You cannot define a message with this keyword and another with the both keyword.
both
- Displays the message at the top and the bottom. You can define one message with this keyword. You cannot define a message with this keyword and another with the header keyword or with the footer keyword.
foreground-color="color"
- The foreground-color attribute identifies the color of the text in
the web UI message. This attribute supports the following keywords. The default value is
none, which display the text in black.
- none
- blue
- green
- orange
- red
- yellow
background-color="color"
- The background-color attribute identifies the color of the
background in the web UI message. This attribute supports the following keywords. The default value
is none, which removes any color from the message background.
- none
- blue
- green
- orange
- red
- yellow
For web UI messages, the contents of the <MarkupBanner> element can include the following standard HTML tags.<p>
- Defines individual paragraphs.
<em>
- Defines text to display in italics.
<strong>
- Defines text to display in bold.
<tt>
- Defines text to display in monospace.
<TextBanner>
- The <TextBanner> element identifies the messages to display to
users in CLI sessions. The file can contain up to three <TextBanner>
elements, one for each keyword that is associated with the type attribute.
type="message-type"
- The type attribute identifies the type of message. This attribute
supports the following keywords.
pre-login
- Displays the message before users log in from the CLI.
post-login
- Displays the message immediately after users log in from the CLI.
system-banner
- Displays the message immediately after the completion of each command invocation from the CLI.