Import version 1.8.3
[s390-tools.git] / zconf / lszfcp.8
blob497b6540c9fe71e34885949b6bedbf317685d499
1 .\"  Copyright IBM Corp. 2006, 2008
2 .TH LSZFCP 8 "Mar 2008" "s390-tools"
3 .SH NAME
4 lszfcp \- list information about zfcp adapters, ports, and units
6 .SH SYNOPSIS
7 .B lszfcp
8 .RB [ \-hvVaHDP ]
9 .RB [ \-b
10 .IR busid ]
11 .RB [ \-l
12 .IR lun ]
13 .RB [ \-p
14 .IR wwpn ]
15 .RB [ \-s
16 .IR /path/to/sys ]
18 .SH DESCRIPTION
19 .PP
20 .B lszfcp
21 provides information contained in sysfs about zfcp adapters, ports and
22 units and its associated scsi_hosts, fc_hosts, fc_remote_ports and
23 scsi_devices.
25 The default is to list busids of all zfcp adapters and their corresponding
26 SCSI host names.
28 There are three output variants. Default (without options "-a" or
29 "-V") is one line for each object.  For adapters the busid and their
30 corresponding SCSI host names are listed.  For ports the pair
31 "busid"/"wwpn" and their corresponding FC-remote-port names are listed.
32 For units the triple "busid"/"wwpn"/"lun" and their corresponding SCSI
33 device names are listed.
35 Option "-V" additionally shows the sysfs paths of interest for the
36 listed object.
38 Option "-a" additionally shows all attributes of interest found in
39 sysfs for the listed object.
41 .SH OPTIONS
42 .TP
43 .B -a, --attributes
44 Show all attributes of the specified objects.
45 .TP
46 .B -D, --devices
47 List zfcp units and  SCSI devices.
48 .TP
49 .B -H, --hosts
50 List zfcp adapters and fc-hosts (default). Information is given only
51 for adapters that are online (registered at the SCSI stack).
52 .TP
53 .B -P, --ports
54 List zfcp ports and FC remote ports.
55 .TP
56 .B -b busid, --busid busid
57 Show zfcp adapter, fc-host selected by busid.
58 .TP
59 .B -l lun, --lun lun
60 List zfcp unit(s) and SCSI device(s) selected by lun. (Information for
61 several units might be shown if devices with equivalent LUNs are
62 configured for different adapters or ports.)
63 .TP
64 .B -p wwpn, --wwpn wwpn
65 List zfcp port(s) and FC remote port(s) selected by wwpn. (Information
66 for several ports might be shown if a remote port is configured for
67 different adapters.)
68 .TP
69 .B -V, --verbose
70 Generate verbose output. Display sysfs path names of class and bus
71 devices that are of interest for this object.
72 .TP
73 .B -s, --sysfs /path/to/sys
74 Use path as sysfs (for dbginfo archives).
75 .TP
76 .B -h, --help
77 Print help message and exit.
78 .TP
79 .B -v, --version
80 Display version info and exit.
82 .SH NOTE
83 .PP
84 Options "-b", "-p" or "-l" are of restricting nature. They limit the output
85 to those adapters, ports or units that match the specified busid, wwpn and lun.
86 If none of the options "-H", "-P" and "-D" are specified, "-b" implies "-H",
87 "-p" implies "-P" and "-l" implies "-D".
89 .SH EXAMPLES
90 .PP
91 .IP "lszfcp -P -H -D -V"
92 Show all device paths of all zfcp adapters, ports, units and its
93 associated SCSI devices, SCSI hosts, FC hosts and FC remote ports
94 .PP
95 .IP "lszfcp -b 0.0.0815 -a"
96 Show all attributes of ccw_device, scsi_host and fc_host which belong
97 to the adapter with busid "0.0.0815".
98 .IP "lszfcp -D -b 0.0.0815 -p 0x5005123456789000 -l 0x0000000000000000"
99 Show the device which matches the given busid, wwpn and lun.
100 .IP "lszfcp -b 0.0.0815 -p 0x5005123456789000 -l 0x0000000000000000"
101 Show all adapters that match the given busid, all ports that match the given
102 busid and wwpnn and show all units that match the given busid, wwpn and lun.
103 .IP "lszfcp -b 0.0.0815 -p 0x5005123456789000 -l 0x0000000000000000 -H -P -D"
104 Generates same output as previous example.