Skip to main content

Cornelis Technical Documentation

1.5. Document Conventions

Omni-Path documentation uses the following standard conventions:

  • Note: Provides additional information.

  • Caution: Indicates the presence of a hazard that has the potential of causing damage to data or equipment.

  • Warning: Indicates the presence of a hazard that has the potential of causing personal injury.

  • Text in blue indicates a hyperlink to a figure, table, or section in this guide. Links to websites are also shown in blue. For example:

  • Text in bold indicates user interface elements such as menu items, buttons, check boxes, key names, keystrokes, or column headings. For example:

    • Click the Start button, point to Programs, point to Accessories, and then click Command Prompt.

    • Press CTRL+P and then press the UP ARROW key.

  • Text in Courier font indicates a file name, directory path, or command line text. For example:

    • Enter the following command: port show

  • Preformatted text in Courier font with a gray background indicates a block of code.

    Welcome to Cornelis Networks shell
Use 'tab' for autocomplete and up/down arrow to see command history.

  • Text in italics indicates terms, emphasis, variables, or document titles. For example:

    • Refer to CN5000 Fabric Installation Guide for details.

  • Both the CN5000 Omni-Path Fabric and standard InfiniBand (IB) can send IP traffic over the fabric, or IPoFabric. In this document, it may also be referred to as IP over IB or IPoIB. From a software point of view, IPoFabric behaves the same way as IPoIB.

  • InfiniBand interfaces follow different naming conventions depending on the operating system distribution. Throughout this document set, the interfaces will be referenced as "ib0" and "ib1" for consistency. Your system may use different naming schemes based on its specific OS implementation.

  • Many of the acronyms in this documentation provide hover text with definitions.

Note

In this document, references to "HFI" refer to the CN5000 SuperNIC.

CLI Syntax Conventions

Command line syntax uses the following conventions:

  • Text not in brackets is required and in the order that it appears.

  • Square brackets [ ] indicate optional parameters. For example, [-noprompt].

  • Angle brackets < > indicate user input. For example, <command>.

    Note

    User input is indicated with italics, such as help <command>.

  • Curly braces { } indicate mutually exclusive arguments. For example, command [option {arg1 | arg2}].

  • Pipe characters | separate choices for options and arguments. For example, command [option1 | option2].