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
Text formatting conventions such as boldface, italic, or Courier font may be used in the flow of the text to highlight specific words or phrases.
Format | Description |
|---|---|
bold text | Identifies command names |
| Identifies keywords and operands |
| Identifies the names of user-manipulated GUI elements |
| Identifies text to enter at the GUI |
italic text | Identifies emphasis |
| Identifies variables |
| Identifies document titles |
courier font | Identifies command output |
| Identifies command syntax example |
Command syntax conventions
Bold and italic text identify command syntax components. Delimiters and operators define groupings of parameters and their logical relationships.
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. |
Code Block
Following is an example of Python based code block in the html documentation: defsome_function():interesting=Falseprint'This line is highlighted.'print'This one is not...'print'...but this one is.'
Notes and Warnings
Note, Attention, and Caution statements might be used in this document.
This is an example of a note. A Note provides a tip, guidance, or advice, emphasizes important information, or provides a reference to related information.
Attention
This is an example of an attention statement. An Attention statement indicates a stronger note, for example, to alert you when traffic might be interrupted or the device might reboot.
Requesting Technical Support
Technical product support is available through the support center. If you have a support contract, file a ticket with support.
Product warranties—For product warranty information, visit https://forums.ivanti.com/s/all-products?language=en_US
Self-Help Online Tools and Resources
For quick and easy problem resolution, ivanti provides an online self-service portal called the support that provides you with the following features:
- Find support offerings: https://forums.ivanti.com/s/contactsupport/
- Search for known bugs: https://forums.ivanti.com/
- Find product documentation: https://forums.ivanti.com/s/product-downloads
- Download the latest versions of software and review release notes: https://help.ivanti.com/
- Open a case online in the IMS tool: https://forums.ivanti.com/s/contactsupport/
- To verify service entitlement by product serial number, use our Serial Number Entitlement (SNE) Tool: https://forums.ivanti.com/
Opening a Case with Support
You can open a case with support on the Web or by telephone.
Use the Case Management tool in the support at https://forums.ivanti.com/
For international or direct-dial options in countries without toll-free numbers, see https://forums.ivanti.com/s/contactsupport/
Reporting Documentation Issues
To report any errors or inaccuracies in Ivanti technical documentation, or to make suggestions for future improvement, contact support (https://forums.ivanti.com/s/contactsupport?language=en_US). Include a full description of your issue or suggestion and the document(s) to which it relates.