1
2opagetvf_env(1)        Master map: IFSFFCLIRG (Man Page)       opagetvf_env(1)
3
4
5

NAME

7       opagetvf_env
8
9
10
11       Provides  opagetvf_func  and  opagetvf2_func shell functions that query
12       the parameters of a vFabric. Also  exports  values  that  indicate  the
13       PKEY,  SL, MTU, and RATE associated with the vFabric. The typical usage
14       of  this  tool  is   to   include   it   in   a   shell   script   as:.
15       /usr/sbin/opagetvf_env
16
17       A usage example is provided in:
18       /usr/src/opa/mpi_apps/openmpi.params
19
20       NOTE:  opagetvf_func  and opagetvf2_func have a similar usage. The dif‐
21       ference is whether the MTU and RATE are returned as absolute values  or
22       enum values, respectively.
23
24

Function Syntax

26       opagetvf_func "arguments to opagetvf" pkey_env_var_name sl_env_var_name
27       [ mtu_env_var_name[ rate_env_var_name]]
28
29       or
30       opagetvf2_func "arguments to opagetvf" pkey_env_var_name
31       sl_env_var_name[ mtu_env_var_name[ rate_env_var_name]]
32
33

Function Options

35       "arguments to opagetvf"
36                 Specifies  a set of arguments to pass to opagetvf to select a
37                 virtual fabric.See opagetvf for more information.
38
39
40       pkey_env_var_name
41                 Specifies the environment variable to fill in with  pkey  for
42                 the  selected  virtual  fabric.  The  variable  given will be
43                 exported with the hex numeric value for the pkey.If  a  vari‐
44                 able name of "" is provided, pkey is not saved.
45
46
47       sl_env_var_name
48                 Specifies  the  environment  variable to fill in with service
49                 level (sl) for the  selected  virtual  fabric.  The  variable
50                 given will be exported with the numeric value for the sl.If a
51                 variable name of "" is provided, sl is not saved.
52
53
54       mtu_env_var_name
55                 Specifies the environment variable to fill  in  with  maximum
56                 MTU  for the selected virtual fabric. The variable given will
57                 be exported with the value for the MTU.If a variable name  of
58                 "" is provided, MTU is not saved.
59
60
61                 For  opagetvf_func,  MTU  is returned as an absolute value of
62                 2048, 4096, 8192, or 10240.
63
64                 For opagetvf2_func, MTU is returned as an enumerated value of
65                 4,  5,  6,  or  7 corresponding to the absolute values above,
66                 respectively.
67
68                 If the selected virtual fabric does  not  have  a  limitation
69                 specified for MTU, the variable will be unaltered.
70
71       rate_env_var_name
72                 Specifies  the  environment  variable to fill in with maximum
73                 static rate for the selected  virtual  fabric.  The  variable
74                 given will be exported with the value for the rate.If a vari‐
75                 able name of "" is provided, rate is not saved.
76
77
78                 For opagetvf_func, rate is returned as an absolute  value  of
79                 25g, 50g, 75g or 100g.
80
81                 For  opagetvf2_func,  rate is returned as an enumerated value
82                 of 15, 12, 9, or 16  corresponding  to  the  absolute  values
83                 above, respectively.
84
85                 If  the  selected  virtual  fabric does not have a limitation
86                 specified for rate, the variable will be unaltered.
87
88

Function Example

90       # ensure values are empty in case they are not specified for  the  vir‐
91       tual fabric
92       MTU=
93       RATE=
94       opagetvf_func "-d 'Compute'" PKEY SERVICE_LEVEL MTU RATE
95       echo "The Compute Virtual Fabric has pkey: $PKEY SL:$SERVICE_LEVEL MTU:
96       $MTU rate:$RATE"
97
98       NOTE:  Additional  examples may be found in /usr/src/opa/mpi_apps/open‐
99       mpi.params and /usr/src/opa/mpi_apps/mvapich2.params. Those scripts use
100       opagetvf_func  and  opagetvf2_func to get virtual fabric parameters and
101       then pass them into openmpi and mvapich2, respectively.
102
103
104
105Copyright(C) 2015-2018         Intel Corporation               opagetvf_env(1)
Impressum