xref: /NextBSD/contrib/ofed/management/opensm/doc/partition-config.txt (revision eb1a5f8de9f7ea602c373a710f531abbf81141c4)
1OpenSM Partition configuration
2===============================
3
4The default name of OpenSM partitions configuration file is
5'/etc/opensm/partitions.conf'. The default may be changed by
6using --Pconfig (-P) option with OpenSM.
7
8The default partition will be created by OpenSM unconditionally even
9when partition configuration file does not exist or cannot be accessed.
10
11The default partition has P_Key value 0x7fff. OpenSM's port will have
12full membership in default partition. All other end ports will have
13partial membership.
14
15
16File Format
17===========
18
19Comments:
20--------
21
22Line content followed after '#' character is comment and ignored by
23parser.
24
25
26General file format:
27-------------------
28
29<Partition Definition>:<PortGUIDs list> ;
30
31
32Partition Definition:
33--------------------
34
35[PartitionName][=PKey][,flag[=value]]
36
37PartitionName - string, to be used with logging. When omitted
38                empty string will be used.
39PKey          - P_Key value for this partition. Only low 15 bits will
40                be used. When omitted will be autogenerated.
41flag          - used to indicate IPoIB capability of this partition.
42
43Currently recognized flags are:
44
45ipoib       - indicates that this partition may be used for IPoIB, as
46              result IPoIB capable MC group will be created.
47rate=<val>  - specifies rate for this IPoIB MC group (default is 3 (10GBps))
48mtu=<val>   - specifies MTU for this IPoIB MC group (default is 4 (2048))
49sl=<val>    - specifies SL for this IPoIB MC group (default is 0)
50scope=<val> - specifies scope for this IPoIB MC group (default is 2 (link
51local))
52
53Note that values for 'rate', 'mtu'. and 'scope' should be specified as defined
54in the IBTA specification (for example mtu=4 for 2048).
55
56
57PortGUIDs list:
58--------------
59
60[PortGUID[=full|=limited]] [,PortGUID[=full|=limited]] [,PortGUID] ...
61
62PortGUID     - GUID of partition member EndPort. Hexadecimal numbers
63               should start from 0x, decimal numbers are accepted too.
64full or      - indicates full or limited membership for this port. When
65  limited      omitted (or unrecognized) limited membership is assumed.
66
67There are two useful keywords for PortGUID definition:
68
69- 'ALL' means all end ports in this subnet.
70- 'SELF' means subnet manager's port.
71
72Empty list means no ports in this partition.
73
74
75Notes:
76-----
77
78White spaces are permitted between delimiters ('=', ',',':',';').
79
80The Line can be wrapped after ':' followed after Partition Definition and
81between.
82
83PartitionName does not need to be unique, PKey does need to be unique.
84If PKey is repeated then those partition configurations will be merged
85and first PartitionName will be used (see also next note).
86
87It is possible to split partition configuration in more than one
88definition, but then PKey should be explicitly specified (otherwise
89different PKey values will be generated for those definitions).
90
91
92Examples:
93--------
94
95Default=0x7fff : ALL, SELF=full ;
96
97NewPartition , ipoib : 0x123456=full, 0x3456789034=limi, 0x2134af2306 ;
98
99YetAnotherOne = 0x300 : SELF=full ;
100YetAnotherOne = 0x300 : ALL=limited ;
101
102
103Note:
104----
105
106The following rule is equivalent to how OpenSM used to run prior to the
107partition manager:
108
109Default=0x7fff,ipoib:ALL=full;
110
111