Information Note

Provides information about important features or instructions.

Caution

Alerts you of potential damage to a program, device, or system.

Warning

Alerts you of potential personal injury or fatality. May also alert you of potential electrical hazards.

Text represented as a screen display

This typeface represents displays that appear on your terminal screen, for example:

Login:

Text represented as commands

This typeface represents commands that you enter, for example:

show ip access-list

This document always gives the full form of a command in lowercase letters. Commands are not case sensitive.

Text represented as a command variable

This typeface represents a variable that is part of a command, for example:

show card slot_number

slot_number is a variable representing the desired chassis slot number.

Text represented as menu or sub-menu names

This typeface represents menus and sub-menus that you access within a software application, for example:

Click the File menu, then click New

Required keyword options and variables are those components that are required to be entered as part of the command syntax.

Required keyword options and variables are surrounded by grouped braces { }. For example:

sctp-max-data-chunks { limit max_chunks | mtu-limit } 

If a keyword or variable is not enclosed in braces or brackets, it is mandatory. For example:

snmp trap link-status 

Optional keywords or variables, or those that a user may or may not choose to use, are surrounded by brackets.

|

Some commands support multiple options. These are documented within braces or brackets by separating each option with a vertical bar.

These options can be used in conjunction with required or optional keywords or variables. For example:

action activate-flow-detection { intitiation | termination }  

ip address [ count number_of_packets | size number_of_bytes ]