1 '\" t |
|
2 .\" Copyright (c) 2011, Oracle and/or its affiliates. All rights reserved. |
|
3 .\" Modified for Solaris to add the Solaris stability classification, |
|
4 .\" and to add a note about source availability. |
|
5 .\" |
|
6 .TH SET_NODEDESC.SH 1M "4 April 2011" "USER COMMANDS" |
|
7 |
|
8 .SH "NAME" |
|
9 set_nodedesc.sh \- Set/View Node Description String for Infiniband Host Controller Adapters (HCA)s |
|
10 .SH "SYNOPSIS" |
|
11 .PP |
|
12 \fBset_nodedesc.sh\fR |
|
13 .sp |
|
14 \fBset_nodedesc.sh\fR -N <\fBCommonString\fR> |
|
15 .sp |
|
16 \fBset_nodedesc.sh\fR -H <\fBHCAString\fR> -G \fBGUID\fR |
|
17 .sp |
|
18 \fBset_nodedesc.sh\fR -H <\fBHCAString\fR> -G \fBGUID\fR -N <\fBCommonString\fR> |
|
19 .sp |
|
20 \fBset_nodedesc.sh\fR -v |
|
21 .sp |
|
22 .SH "DESCRIPTION" |
|
23 The \fBset_nodedesc.sh\fR utility can be used to set or view Node description |
|
24 strings for \fBInfiniBand(IB)\fR Host Controller \fBAdapters(HCA)\fR. The node |
|
25 description string can consist of two parts : |
|
26 |
|
27 1. Node Description String common to all HCAs. |
|
28 .br |
|
29 2. Node Description String specific to an HCA. |
|
30 .sp |
|
31 The complete Node Description string will be : |
|
32 .sp |
|
33 <CommonNodeDescriptionString><HCANodeDescriptionString> |
|
34 .sp |
|
35 The common Node Description String is used if no HCA specific Node descr- |
|
36 iption string is set. The Node Descriptor string from the HCA firmware |
|
37 will be used if common node descriptor is not set. |
|
38 .sp |
|
39 \fBset_nodedesc.sh\fR called without arguments, sets the common node descriptor |
|
40 string to the \fBhostname\fR(1M) of the system. The common Node descriptor string |
|
41 can be set to a string other than the \fBhostname\fR(1M) using the -N option. |
|
42 .sp |
|
43 The HCA specific Node Description String can be set using the -H and -G |
|
44 option. The Global Unique IDentifier (GUID) specified with -G identifies |
|
45 the HCA to set the HCA specific Node Description string. The options |
|
46 -H and -G can be combined together with -N, to specify the common Node |
|
47 description String. |
|
48 .sp |
|
49 The -v option can be used to view the Node descriptors for all HCAs on the |
|
50 system. |
|
51 .sp |
|
52 .SH "EXAMPLES" |
|
53 .TP |
|
54 \fB1. Set Node descriptor string to hostname(1M) for all HCAs:\fR |
|
55 .PP |
|
56 set_nodedesc.sh |
|
57 .PP |
|
58 .nf |
|
59 \fB2. Set Node descriptor string to string "test":\fR |
|
60 .PP |
|
61 #set_nodedesc.sh -N "test" |
|
62 .PP |
|
63 .nf |
|
64 \fB3. Setting the HCA specific Node Description for HCA with\fR |
|
65 \fB GUID 0x0002c903000008d0 to " hca_test" :\fR |
|
66 .PP |
|
67 #set_nodedesc.sh -H " hca_test" -G 0x0002c903000008d0 |
|
68 .PP |
|
69 .nf |
|
70 \fB4. Setting the HCA specific Node Description for HCA with GUID\fR |
|
71 \fB 0x0002c903000008d0 to " hca_test1" and set the common node\fR |
|
72 \fB descriptor to "test1" :\fR |
|
73 .PP |
|
74 #set_nodedesc.sh -H " hca_test" -G 0x0002c903000008d0 -N "test1" |
|
75 .PP |
|
76 .nf |
|
77 \fB5. Read all Node descriptiors :\fR |
|
78 .PP |
|
79 #set_nodedesc.sh -v |
|
80 .PP |
|
81 .nf |
|
82 .sp |
|
83 .SH "See Also" |
|
84 .PP |
|