From 51662af5ba5eb199d889b9f67ec7206eb5b060e9 Mon Sep 17 00:00:00 2001 From: Ronnie Sahlberg Date: Mon, 3 Jan 2011 15:10:15 +1100 Subject: [PATCH] Document the iSCSI URL syntax and how to specify username/password --- README | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README b/README index 0e79515..a12869e 100644 --- a/README +++ b/README @@ -34,3 +34,20 @@ Build RPM To build RPMs run the following script from the libiscsi root directory ./packaging/RPM/makerpms.sh +iSCSI URL Format +================ +iSCSI devices are specified by a URL format on the following form : + iscsi://[[%]@][:]// +Example: + iscsi://server/iqn.ronnie.test/1 +When using CHAP authentication, username and password can be specified as part of the URL + iscsi://ronnie%password@server/iqn.ronnie.test/1 +but this may make the user and password visible in log files as well as in ps aux output. +So it is also possible to provide either just the password or both the password and username +via environment variables. +The username and/or password can be set via +LIBISCSI_CHAP_USERNAME=ronnie +LIBISCSI_CHAP_PASSWORD=password + +Example: + LIBISCSI_CHAP_PASSWORD=password iscsi-inq iscsi://ronnie@10.1.1.27/iqn.ronnie.test/1