Import version 1.8.3
[s390-tools.git] / zconf / chccwdev.8
blob8ba7695dc403a3369b1bc741b805308d1d71a202
1 .TH CHCCWDEV 8 "Apr 2006" "s390-tools"
3 .SH NAME
4 chccwdev \- modify generic attributes of channel attached devices.
6 .SH SYNOPSIS
7 .TP 9
8 .B chccwdev
9 .B -h
10 .TP
11 .B chccwdev
12 .RB "[ (" -a
13 .IB <name> = <value>
14 .RB "| " -e " | " -d " | " -f  ") [...]]"
15 .br
16 .I  <range>
17 .RI "[, " "<range>" " [...]]"
18 .TP
19 .B chccwdev
20 .B -v
22 .SH DESCRIPTION
23 The chccwdev command is used to set generic attributes for devices that
24 are controlled by the common I/O subsystem. Attributes are set in the order
25 they are specified on the commandline except the online attribute which is
26 special.
28 If the same attribute is given more than one time the value that was set
29 last will be used. This is also true (while not that obvious) when mixing
30 the generic
31 .BR -a " and the " -e ", " -d " and " -f " arguments."
33 All attributes will be set in the following order:
34 .RS
35 .TP 4
37 All attributes except online. If the device is offline there will be no
38 error if the attribute doesn't exist.
39 .TP
41 Set the online attribute to the desired value ((forced) online or offline).
42 .TP
44 Set all the attributes that havn't been set, yet. At this point invalid
45 attribute names will always cause an error.
46 .RE
48 If any error occurs the execution is terminated. So if using ranges only
49 devices before the current one have been modified. There is no automatic
50 rollback. All attributes that already have been changed will stay that way.
52 .SH OPTIONS
53 .TP 8
54 .BR -h | --help
55 Print help text.
57 .TP 8
58 .BR -v | --version
59 Print the version of the s390-tools package and the command.
61 .TP
62 .BR -a | --attribute " \fI<name>\fR=\fI<value>\fR"
63 Try to set the attribute named \fIname\fR to the given value. After writing
64 the attribute it will be read to check whether the setting was accepted.
66 .TP
67 .BR -e | --online
68 Try to set the given range of devices online.
70 .TP
71 .BR -f | --forceonline
72 Same as online but for devices that support this (DASD devices), it can
73 be used to bring it online regardless of any reserved states.
75 .TP
76 .BR -d | --offline
77 Try to set the given range of devices offline. The online and offline
78 option are exclusive.
80 .TP
81 \fB<range>\fR = <bus ID>\fB[-\fR<bus ID>\fB]\fR
82 .TP
83 \fB<bus ID>\fR = ([0-9]+\\.[0-9]+\\.)?[0-9a-f]{1,4}
84 Note that bus IDs specified in short form (i.e. without leading "0.<n>.")
85 will be interpreted as "0.0.<bus ID>".
87 Example: "0192" becomes "0.0.0192".
89 .SH EXAMPLES
90 \fBchccwdev --online 0.0.0192,0.0.0195-0.0.0198\fR
91 .RS
92 Will try to set the devices with bus ID 0.0.0192, 0.0.0195, 0.0.0196,
93 0.0.0197 and 0.0.0198 online
94 .RE
96 .B chccwdev --attribute readonly=1 --attribute online=1 0.0.0192
97 .RS
98 This will try to set the device with bus ID 0.0.192 online with readonly
99 attribute set to one (read-only mode).
102 .B chccwdev --attribute cmb_enable=1 0.0.0195-0.0.0198
104 Set the cmb_enable attribute of the devices 0.0.0195, 0.0.0196, 0.0.0197 and
105 0.0.0198 to one. This would for example activate the usage of the channel
106 measurement block facility.
109 .SH AUTHOR
111 This man-page was written by Stefan Bader <shbader@de.ibm.com>.