65 lines
2.1 KiB
Groff
65 lines
2.1 KiB
Groff
.TH iucv_configure "8" "July 2013" "s390-tools"
|
|
.SH NAME
|
|
iucv_configure \- Configures or deconfigures a z/VM Inter-User Communications Vehicle (IUCV) network adapter
|
|
.SH SYNOPSIS
|
|
.B iucv_configure peer_userid online
|
|
.SH DESCRIPTION
|
|
.B iucv_configure
|
|
is intended to make it easy to persistently add and remove z/VM point-to-point IUCV network adapters. In addition to bringing the adapter online or offline, it will also create or delete the necessary udev rules for the adapter.
|
|
.SH PARAMETERS
|
|
.IP peer_userid
|
|
The z/VM userid of the virtual machine on the other end of the point-to-point connection.
|
|
.IP online
|
|
Either a literal 1 to bring the adapter online or a literal 0 to take it offline
|
|
.SH FILES
|
|
.I /etc/udev/rules.d/51-iucv-<peer_userid>.rules
|
|
.RS
|
|
This file provide the udev rules necessary to activate a specific IUCV adapter.
|
|
.RE
|
|
.SH ENVIRONMENT
|
|
.IP DEBUG
|
|
If set to "yes" some minimal debugging information is output during execution.
|
|
.SH DIAGNOSTICS
|
|
The following messages may be issued on stdout:
|
|
.IP
|
|
.B /sysfs not present
|
|
.RS
|
|
The sysfs file system could not be found in /proc/mounts, so there's nothing the script can
|
|
do. Return code 1 is set.
|
|
.RE
|
|
.IP
|
|
.B No IUCV user name given
|
|
.RS
|
|
You didn't specify the z/VM userid of the virtual machine to which you want to connect. Return code 2 is set.
|
|
.RE
|
|
.IP
|
|
.B Unable to connect to $PEER_USERID
|
|
.RS
|
|
The attempt to connect to the IUCV peer failed. Try "dmesg" to see if there is any indication why. Return code 3 is set.
|
|
.RE
|
|
.IP
|
|
.B Unable to remove device $netdev
|
|
.RS
|
|
The attempt to remove the IUCV adapter failed. Try "dmesg" to see if there is any indication why. Return code 4 is set.
|
|
.RE
|
|
|
|
If environment variable DEBUG is set to "yes," the following messages may be issued on stdout:
|
|
.IP
|
|
.B
|
|
Configuring IUCV device ${PEER_USERID}
|
|
.RS
|
|
Just a little bit of verbosity, since it just indicates that we got past certain error checks and will now try to do something useful.
|
|
.RE
|
|
.IP
|
|
.B Configured device $iucvdev
|
|
.RS
|
|
The attempt to create the IUCV adapter was successful.
|
|
.RE
|
|
.IP
|
|
.B Removed device $iucvdev
|
|
.RS
|
|
The attempt to remove the IUCV adapter was successful.
|
|
.RE
|
|
.SH BUGS
|
|
Gotta be some, I'm sure. If you find one, please open a bug report.
|