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:
def some_function():
interesting = False
print '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.
Note
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.
Caution
This is an example of a caution statement.
A Caution statement alerts you to situations that can be potentially hazardous to you or cause damage to hardware, firmware, software, or data.
Requesting Technical Support¶
Technical product support is available through the Pulse Secure Global Support Center (PSGSC). If you have a support contract, file a ticket with PSGSC.
Product warranties—For product warranty information, visit https://support.pulsesecure.net/product-service-policies/
Self-Help Online Tools and Resources¶
For quick and easy problem resolution, Pulse Secure provides an online self-service portal called the Customer Support Center (CSC) that provides you with the following features:
Find CSC offerings: https://support.pulsesecure.net
Search for known bugs: https://support.pulsesecure.net
Find product documentation: https://www.pulsesecure.net/techpubs
Download the latest versions of software and review release notes: https://support.pulsesecure.net
Open a case online in the CSC Case Management tool: https://support.pulsesecure.net
To verify service entitlement by product serial number, use our Serial Number Entitlement (SNE) Tool: https://support.pulsesecure.net
For important product notices, technical articles, and to ask advice:
Search the Pulse Secure Knowledge Center for technical bulletins and security advisories: https://kb.pulsesecure.net
Ask questions and find solutions at the Pulse Community online forum: https://community.pulsesecure.net
Opening a Case with PSGSC¶
You can open a case with PSGSC on the Web or by telephone.
Use the Case Management tool in the PSGSC at https://support.pulsesecure.net.
Call 1-844 751 7629 (Toll Free, US).
For international or direct-dial options in countries without toll-free numbers, see https://support.pulsesecure.net/support/support-contacts/
Reporting Documentation Issues¶
To report any errors or inaccuracies in Pulse Secure technical documentation, or to make suggestions for future improvement, contact Pulse Secure Technical Support (https://support.pulsesecure.net). Include a full description of your issue or suggestion and the document(s) to which it relates.