1FCOEADM(8) Open-FCoE Tools FCOEADM(8)
2
6 fcoeadm - The Open-FCoE Administration Tool
7
9 fcoeadm [-m|--mode fabric|vn2vn] -c|--create ethX
10 fcoeadm -d|--destroy ethX
12 fcoeadm -r|--reset ethX
14 fcoeadm -S|--Scan [ethX]
16 fcoeadm -i|--interface [ethX]
18 fcoeadm -f|--fcf [ethX]
20 fcoeadm -t|--target [ethX]
22 fcoeadm -l|--lun [ethX]
24 fcoeadm -s|--stats ethX [interval]
26 fcoeadm -b|--lesb ethX [interval]
28 fcoeadm -h|--help
30 fcoeadm -v|--version
32
34 The fcoeadm utility is the Fibre Channel over Ethernet (FCoE)
35 management tool for the Open-FCoE project. fcoeadm may be used to
36 create, destroy, and reset an FCoE instance on a given network
37 interface. For these operations fcoeadm sends a command to a running
38 fcoemon process, via a socket interface. fcoemon will then perform the
39 requested operation.
40 fcoeadm also provides operations to query information about FCoE
42 instances, including interface information, target information, LUN
43 information, and port statistics. For much of this information, fcoeadm
44 relies on the libhbalinux implementation of the HBA API. Only one
45 operation may be given on a command.
46
48 -m, --mode fabric|vn2vn
49 Used together with the create option to control the FCoE mode of
50 operation. The mode defaults to fabric but this option allows the
51 selection of vn2vn mode.
52
54 -c, --create ethX
55 Creates an FCoE instance based on the specified network interface.
56 Note that if there is not an fcoemon configuration file for the
57 interface (/etc/fcoe/cfg-ethX, see fcoemon), then the created FCoE
58 instance will not require DCB.
59 -d, --destroy ethX
61 Destroys the FCoE instance on the specified network interface. This
62 will not destroy FCoE instances created by fipvlan.
63 -r, --reset ethX
65 Resets the FCoE instance on the specified network interface. This
66 will not reset FCoE instances created by fipvlan.
67 -S, --Scan ethX
69 Rescan for new targets and LUNs on the provided instance. This
70 command will not rescan any NPIV instances created on the same
71 port. This will not rescan any FCoE instance created by fipvlan.
72 -i, --interface [ethX]
74 Show information about the FCoE instance on the specified network
75 interface, or all FCoE instances if no network interface is
76 specified.
77 -f, --fcf [ethX]
79 Show information about the discovered Fibre Channel Forwarders
80 (FCFs) on the specified network interface, or all discovered FCFs
81 if no network interface is specified.
82 -t, --target [ethX]
84 Show information about the discovered targets associated with the
85 FCoE instance on the specified network interface. If no network
86 interface is specified, information about discovered targets from
87 all FCoE instances will be shown.
88 -l, --lun [ethX]
90 Show detailed information about the discovered SCSI LUNs associated
91 with the FCoE instance on the specified network interface. If no
92 network interface is specified, information about SCSI LUNs from
93 all FCoE instances will be shown.
94 -s, --stats ethX [interval]
96 Show the statistics (including FC4 statistics) of the FCoE
97 connection on the specified network interface. The information will
98 be displayed repeatedly until the user cancels the command. The
99 statistics will be printed every specified interval (in seconds).
100 interval should be specified as a whole number greater than 0. If
101 interval is not specified, a default interval of one second is
102 used.
103 -b, --lesb ethX [interval]
105 Show the Link Error Statistics Block (LESB) of the FCoE connection
106 on the specified network interface. The information will be
107 displayed repeatedly until the user cancels the command. The LESB
108 statistics will be printed every specified interval (in seconds).
109 interval should be specified in whole integers greater than 0. If
110 the interval is not specified, a default interval of one second is
111 used.
112 -h, --help
114 Displays the usage message of the fcoeadm command.
115 -v, --version
117 Displays the version of the fcoeadm command.
118
120 The actual name for ethX depends on the AUTO_VLAN setting in the
121 fcoemon interface configuration (/etc/fcoe/cfg-ethX, see fcoemon).
122 If AUTO_VLAN is set to yes, the interface name ethX references the
124 network device itself. If AUTO_VLAN is set to no, the interface name
125 ethX references the VLAN device.
126
128 Creates an FCoE instance on eth2.101
129 fcoeadm -c eth2.101
131 Creates an FCoE VN2VN instance on eth2.101
133 fcoeadm -m vn2vn -c eth2.101
135 Destroys the FCoE instance on eth2.101
137 fcoeadm -d eth2.101
139 Resets the FCoE instance on eth2.101
141 fcoeadm -r eth2.101
143 Show the information of all the adapters and their ports having FCoE
145 instances created
146 fcoeadm -i
148 Show the information of all FCoE instances on interface eth3.
150 fcoeadm -i eth3
152 Show the information of all the discovered targets from all the ports
154 having FCoE instances created (they may be on different adapter cards).
155 A brief listing of discovered LUNs are listed after the target they are
156 associated with, if any
157 fcoeadm -t
159 Show the information of all the discovered targets from a given port
161 (eth3) having FCoE instance created. A brief listing of discovered LUNs
162 are listed after each target they are associated with, if any
163 fcoeadm -t eth3
165 Show the detailed information of all the LUNs discovered on all FCoE
167 connections
168 fcoeadm -l
170 Show the detailed information of all the LUNs associated with a
172 specific interface
173 fcoeadm -l eth3.101
175 Show the statistics information of a specific port eth3 having FCoE
177 instances created. The statistics are displayed one line per time
178 interval. The default interval is one second if an interval is not
179 specified
180 fcoeadm -s eth3
182 fcoeadm -s eth3 3
184
186 fcoemon(8)
187
189 fcoeadm is part of the fcoe-utils package, maintained through the
190 Open-FCoE project. Resources for both developers and users can be found
191 at the Open-FCoE website http://open-fcoe.org/
192Open-FCoE 10/14/2013 FCOEADM(8)