Document Conventions

Table 1 defines notice icons used in this guide.

Table 1: Notice Icons

Icon

Meaning

Description

Informational note

Indicates important features or instructions.

Caution

Indicates a situation that might result in loss of data or hardware damage.

Warning

Alerts you to the risk of personal injury or death.

Laser warning

Alerts you to the risk of personal injury from a laser.

Table 2 defines text conventions used in this guide.

Table 2: Text Conventions

Convention

Description

Examples

Bold typeface like this

  • Represents commands and keywords in text.
  • Represents keywords
  • Represents UI elements

  • Issue the clock source command.
  • Specify the keyword exp-msg.
  • Click User Objects

Bold typeface like this

Represents text that the user must type.

user input

fixed-width font

Represents information as displayed on the terminal screen.

host1# 
show ip ospf
Routing Process OSPF 2 with Router ID 5.5.0.250
Router is an area Border Router (ABR)

Key names linked with a plus (+) sign

Indicates that you must press two or more keys simultaneously.

Ctrl + d

Italics

  • Emphasizes words
  • Identifies variables
  • The product supports two levels of access, user and privileged.
  • clusterID, ipAddress.

The angle bracket (>)

Indicates navigation paths through the UI by clicking menu options and links.

Object Manager > User Objects > Local Objects

Table 3 defines syntax conventions used in this guide.

Table 3: Syntax Conventions

Convention

Description

Examples

Words in plain text

Represent keywords

terminal length

Words in italics

Represent variables

mask, accessListName

Words separated by the pipe ( | ) symbol

Represent a choice to select one keyword or variable to the left or right of this symbol. The keyword or variable can be optional or required.

diagnostic | line

Words enclosed in brackets ( [ ] )

Represent optional keywords or variables.

[ internal | external ]

Words enclosed in brackets followed by and asterisk ( [ ]*)

Represent optional keywords or variables that can be entered more than once.

[ level1 | level2 | 11 ]*

Words enclosed in braces ( { } )

Represent required keywords or variables.

{ permit | deny } { in | out } { clusterId | ipAddress }