1FCOEADM(8)                      Open-FCoE Tools                     FCOEADM(8)
2
3
4

NAME

6       fcoeadm - The Open-FCoE Administration Tool
7

SYNOPSIS

9       fcoeadm -c|--create ethX
10
11       fcoeadm -d|--destroy ethX
12
13       fcoeadm -r|--reset ethX
14
15       fcoeadm -i|--interface [ethX]
16
17       fcoeadm -t|--target [ethX]
18
19       fcoeadm -l|--lun [ethX]
20
21       fcoeadm -s|--stats ethX [interval]
22
23       fcoeadm -h|--help
24
25       fcoeadm -v|--version
26

DESCRIPTION

28       The   fcoeadm  utility  is  the  Fibre  Channel  over  Ethernet  (FCoE)
29       management tool for the Open-FCoE  project.  fcoeadm  may  be  used  to
30       create,  destroy,  and  reset  an  FCoE  instance  on  a  given network
31       interface. For these operations fcoeadm sends a command  to  a  running
32       fcoemon  process, via a socket interface. fcoemon will then perform the
33       requested operation.
34
35       fcoeadm  also  provides  options  to  query  information   about   FCoE
36       instances,  including  interface  information,  target information, LUN
37       information, and port statistics. For much of this information, fcoeadm
38       relies on the libhbalinux implementation of the HBA API.
39

OPTIONS

41       -c, --create ethX
42           Creates  an FCoE instance based on the specified network interface.
43           Note that if there is not an fcoemon  configuration  file  for  the
44           interface  (/etc/fcoe/cfg-ethX, see fcoemon), then the created FCoE
45           instance will not require DCB.
46
47       -d, --destroy ethX
48           Destroys the FCoE instance on the specified network interface.
49
50       -r, --reset ethX
51           Resets the FCoE instance on the specified network interface.
52
53       -i, --interface [ethX]
54           Show information about the FCoE instance on the  specified  network
55           interface,  or  all  FCoE  instances  if  no  network  interface is
56           specified.
57
58       -t, --target [ethX]
59           Show information about the discovered targets associated  with  the
60           FCoE  instance  on  the  specified network interface. If no network
61           interface is specified, information about discovered  targets  from
62           all FCoE instances will be shown.
63
64       -l, --lun [ethX]
65           Show detailed information about the discovered SCSI LUNs associated
66           with the FCoE instance on the specified network  interface.  If  no
67           network  interface  is  specified, information about SCSI LUNs from
68           all FCoE instances will be shown.
69
70       -s, --stats ethX [interval]
71           Show  the  statistics  (including  FC4  statistics)  of  the   FCoE
72           interface  on the specified network interface. The information will
73           be display in one line on  the  screen  per  given  time  interval.
74           interval  should  be specified in whole integers greater than 0. It
75           specifies the time interval in the unit of seconds. If interval  is
76           not specified, the default interval is one second.
77
78       -h, --help
79           Displays the usage message of the fcoeadm command.
80
81       -v, --version
82           Displays the version of the fcoeadm command.
83

EXAMPLES

85       Creates an FCoE instance on eth2.101
86
87           fcoeadm -c eth2.101
88
89       Destroys the FCoE instance on eth2.101
90
91           fcoeadm -d eth2.101
92
93       Resets the FCoE instance on eth2.101
94
95           fcoeadm -r eth2.101
96
97       Show  the  information  of all the adapters and their ports having FCoE
98       instances created
99
100           fcoeadm -i
101
102       Show the information of a specific interface eth3. If eth3 has no  FCoE
103       instances  created,  the  command will show the error "No fc_host found
104       for eth3"
105
106           fcoeadm -i eth3
107
108       Show the information of all the discovered targets from all  the  ports
109       having FCoE instances created (they may be on different adapter cards).
110       A brief listing of discovered LUNs are listed after the target they are
111       associated with, if any
112
113           fcoeadm -t
114
115       Show  the  information  of all the discovered targets from a given port
116       (eth3) having FCoE instance created. A brief listing of discovered LUNs
117       are listed after each target they are associated with, if any
118
119           fcoeadm -t eth3
120
121       Show  the  detailed  information of all the LUNs discovered on all FCoE
122       connections
123
124           fcoeadm -l
125
126       Show the detailed  information  of  all  the  LUNs  associated  with  a
127       specific interface
128
129           fcoeadm -l eth3.101
130
131       Show  the  statistics  information  of a specific port eth3 having FCoE
132       instances created. The statistics  are  displayed  one  line  per  time
133       interval.  The  default  interval  is  one second if an interval is not
134       specified
135
136           fcoeadm -s eth3
137
138           fcoeadm -s eth3 3
139

SEE ALSO

141       fcoemon(8)
142

SUPPORT

144       fcoeadm is part of  the  fcoe-utils  package,  maintained  through  the
145       Open-FCoE project. Resources for both developers and users can be found
146       at the Open-FCoE website http://open-fcoe.org/
147
148
149
150Open-FCoE                         04/29/2010                        FCOEADM(8)