warren/libiscsi
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add utility to get/set the software write protect flag

Browse Source
This commit is contained in:
Ronnie Sahlberg
2013-07-06 21:59:03 -07:00
parent 7895fb700c
commit 6b93af26a9
3 changed files with 406 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
doc/iscsi-swp.1.xml Normal file
View File

@@ -0,0 +1,146 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
<refentry id="iscsi-swp.1">
<refmeta>
<refentrytitle>iscsi-swp</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">iscsi-swp</refmiscinfo>
<refmiscinfo class="manual">iscsi-swp: get/set software write protect</refmiscinfo>
</refmeta>
<refnamediv>
<refname>iscsi-swp</refname>
<refpurpose>Utility to get/set software write protect on an iSCSI LUN</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>iscsi-swp [ OPTIONS ] &lt;ISCSI-PORTAL&gt;</command>
</cmdsynopsis>
<cmdsynopsis>
<command>iscsi-ls</command>
<arg choice="opt">-i --initiator-name=&lt;IQN&gt;</arg>
<arg choice="opt">-s --swp {on|off}</arg>
<arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
<arg choice="opt">-? --help</arg>
<arg choice="opt">--usage</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1><title>DESCRIPTION</title>
<para>
iscsi-swp is a utility to get or set the software write protect on an iSCSI LUN.
</para>
</refsect1>
<refsect1><title>ISCSI PORTAL URL FORMAT</title>
<para>
iSCSI portal format is 'iscsi://[&lt;username&gt;[%&lt;password&gt;]@]&lt;host&gt;[:&lt;port&gt;]'
</para>
<para>
Username and password are only required if the target requires CHAP
authentication. Optionally you can specify the username and password via
the environment variables LIBISCSI_CHAP_USERNAME and
LIBISCSI_CHAP_PASSWORD.
</para>
<para>
Host can be specified either as a hostname, an IPv4 address or an
IPv6 address.
Examples:
<screen format="linespecific">
iscsi://192.0.2.1
iscsi://[2001:DB8::1]:3261
iscsi://ronnie%password@iscsi.example.com
</screen>
</para>
<para>
Port is the TCP port on the target to connect to. Default is 3260.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry><term>-i --initiator-name=&lt;IQN&gt;</term>
<listitem>
<para>
This specifies the initiator-name that iscsi-ls will use when
logging in to the target.
</para>
<para>
The default name is
'iqn.2007-10.com.github:sahlberg:libiscsi:iscsi-ls' but you can use
this argument to override this. This is mainly needed for cases
where the target is configured with access-control to only
allow discovery logins from known initiator-names.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-s --swp {on|off}</term>
<listitem>
<para>
By default iscsi-swp will only print the current setting of
the software write protect bit. By using this argument
iscsi-swp will also try to set/clear the flag on the target LUN.
</para>
<screen format="linespecific">
iscsi-swp iscsi://127.0.0.1/iqn.ronnie.test/1
SWP:0
iscsi-swp iscsi://127.0.0.1/iqn.ronnie.test/1 --swp on
SWP:0
Turning SWP ON
iscsi-swp iscsi://127.0.0.1/iqn.ronnie.test/1 --swp off
SWP:0
Turning SWP OFF
</screen>
</listitem>
</varlistentry>
<varlistentry><term>-d --debug=&lt;INTEGER&gt;</term>
<listitem>
<para>
Debug level.
</para>
</listitem>
</varlistentry>
<varlistentry><term>-? --help</term>
<listitem>
<para>
Display basic help text.
</para>
</listitem>
</varlistentry>
<varlistentry><term>--usage</term>
<listitem>
<para>
Display basic usage text.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>SEE ALSO</title>
<para>
iscsi-inq(1), iscsi-ls(1)
<ulink url="http://github.com/sahlberg/libiscsi"/>
</para>
</refsect1>
</refentry>