This section describes the conventions, abbreviations and acronyms used in this documentation. It also lists resources for additional related information.
Document Conventions
| Description | Convention | Example |
|---|---|---|
| File names | file_name.extension | |
Directory names | directory | |
| Commands and their parameters | command param1 | mts3610-1 > show hosts |
| Required item | < > | |
Optional item | [ ] | |
Mutually exclusive parameters | { p1, p2, p3 } or {p1 | p2 | p3} | |
Optional mutually exclusive parameters | [ p1 | p2 | p3 ] | |
| Variables for which users supply specific values | Italic font | enable |
| Emphasized words | Italic font | These are emphasized words |
Abbreviations and Acronyms
| Abbreviation / Acronym | Whole Word / Description |
|---|---|
| b | (Lower case) ‘b’ is used to indicate size in bits or multiples of bits (e.g., 1Kb = 1024 bits) |
| B | (Capital) ‘B’ is used to indicate size in bytes or multiples of bytes (e.g., 1KB = 1024 bytes, and 1MB = 1048576 bytes) |
| EoIB | Ethernet over InfiniBand |
| FW | Firmware |
| HCA | Host Channel Adapter |
| HW | Hardware |
| IB | InfiniBand |
| IPoIB | IP over InfiniBand |
| lsb | Least significant bit |
| LSB | Least significant byte |
| MPI | Message Passing Interface |
| msb | Most significant bit |
| MSB | Most significant byte |
| NIC | Network Interface Card |
| NVGRE | Network Virtualization using Generic Routing Encapsulation |
| PFC | Priority Flow Control |
| PR | Path Record |
| QoS | Quality of Service |
| RDS | Reliable Datagram Sockets |
| RoCE | RDMA over Converged Ethernet |
| SL | Service Level |
| SW | Software |
| TC | Traffic Class |
| ULP | Upper Level Protocol |
| VL | Virtual Lane |
| VPI | Virtual Protocol Interconnect |
Related Documentation
| Document | Description |
|---|---|
| MFT User Manual | Describes the set of firmware management tools for a single InfiniBand node. MFT can be used for: |
| WinOF Release Notes | For possible software issues, please refer to WinOF Release Notes. |
| MLNX OFED User Manual | For more information on SR-IOV over KVM, please refer to the MLNX_OFED User Manual. |
| InfiniBand™ Architecture Specification, Volume 1, Release 1.2.1 | The InfiniBand Specification by IBTA |
