Preface
Document conventions
The document conventions describe text formatting conventions, command syntax conventions, and important notice formats used in Ivanti technical documentation.
Text formatting conventions
Convention |
Description |
bold text |
Identifies command names Identifies keywords and operands Identifies the names of user-manipulated GUI elements Identifies the names of user-manipulated GUI elements |
italic text |
Identifies emphasis Identifies variables Identifies document titles |
Courier Font |
Identifies command output Identifies command syntax examples |
Command syntax conventions
Convention |
Description |
bold text |
Identifies command names, keywords, and command options. |
italic text |
Identifies a variable. |
[ ] |
Syntax components displayed within square brackets are optional. Default responses to system prompts are enclosed in square brackets. |
{ x | y | z } |
A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select one of the options. |
x | y |
A vertical bar separates mutually exclusive elements. |
< > |
Non-printing characters, for example, passwords, are enclosed in angle brackets. |
... |
Repeat the previous element, for example, member[member...]. |
\ |
Indicates a “soft” line break in command examples. If a backslash separates two lines of a command input, enter the entire command at the prompt without the backslash. |
bold text |
Identifies command names, keywords, and command options. |
Notes and Warnings
Note, Attention, and Caution statements might be used in this document.
A Note provides a tip, guidance, or advice, emphasizes important information, or provides a reference to related information.
ATTENTION
An Attention statement indicates a stronger note, for example, to alert you when traffic might be interrupted or the device might reboot.
CAUTION
A Caution statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware, software, or data.