rf-clients-srm.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
                         "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % sharedents SYSTEM "shared-entities.xml" >
%sharedents;
]>

  <section id="rf-clients-srm">
    <title>The &srm; Client Suite</title>

    <!-- TODO: This documentation is not complete. -->

    <para>
      An &srm; URL has the form
      <uri>srm://dmx.lbl.gov:6253//srm/DRM/srmv1?SFN=/tmp/try1</uri>
      and the file URL looks like <uri>file:////tmp/aaa</uri>.
    </para>

    <refentry id="cmd-srmcp">
      <refmeta><refentrytitle><command>srmcp</command></refentrytitle></refmeta>
      <refnamediv><refname><command>srmcp</command></refname>
      <refpurpose>Copy a file from or to an &srm; or between two &srm;s.</refpurpose>
      </refnamediv>

      <refsynopsisdiv>
	<cmdsynopsis>
	  <command>srmcp</command>
	  <arg rep="repeat"><option>option</option></arg>
	  <arg choice="plain"><replaceable>sourceUrl</replaceable></arg>
	  <arg choice="plain"><replaceable>destUrl</replaceable></arg>
	</cmdsynopsis>
	<variablelist>
	  <title>Arguments</title>
	  <varlistentry>
	    <term>sourceUrl</term>
	    <listitem>
	      <para>
		The URL of the source file.
	      </para>
	    </listitem>
	  </varlistentry>
	  <varlistentry>
	    <term>destUrl</term>
	    <listitem>
	      <para>
		The URL of the destination file.
	      </para>
	    </listitem>
	  </varlistentry>
	</variablelist>
	<variablelist>
	  <title>Options</title>
	  <varlistentry>
	    <term><option>gss_expected_name</option></term>
	    <listitem>
	      <para>
		To enable the user to specify the gss expected name in
		the DN (Distinguished Name) of the srm server.  The
		default value is <literal>host</literal>.
	      </para>

	      <informalexample>
		<para>
		  If the CN of host where srm server is running is
		  <literal>CN=srm/tam01.fnal.gov</literal>, then
		  <option>gss_expected_name</option> should be
		  <literal>srm</literal>.

		  <screen>&prompt-user; <userinput>srmcp --gss_expected_name=srm <replaceable>sourceUrl</replaceable> <replaceable>destinationUrl</replaceable></userinput></screen>

	      </para>
	    </informalexample>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><option>globus_tcp_port_range</option></term>
	  <listitem>
	    <para>
	      To enable the user to specify a range of ports open for
	      tcp connections as a pair of positive integers separated
	      by <quote><literal>:</literal></quote>, not set by
	      default.
	    </para>

	    <para>
	      This takes care of compute nodes that are behind
	      firewall.
	    </para>

	    <informalexample>
	      <para>
		<literal>globus_tcp_port_range=40000:50000</literal>

		<screen>&prompt-user; <userinput>srmcp --globus_tcp_port_range=<replaceable>minVal</replaceable>:<replaceable>maxVal</replaceable> <replaceable>sourceUrl</replaceable> <replaceable>destinationUrl</replaceable></userinput></screen>

	      </para>
	    </informalexample>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><option>streams_num</option></term>
	  <listitem>
	    <para>
	      To enable the user to specify the number of streams to
	      be used for data transfer.  If set to 1, then stream
	      mode is used, otherwise extended block mode is used.

	      <informalexample>
		<screen>&prompt-user; <userinput>srmcp --streams_num=1 <replaceable>sourceUrl</replaceable> <replaceable>destinationUrl</replaceable></userinput></screen>
	      </informalexample>
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><option>server_mode</option></term>
	  <listitem>
	    <para>
	      To enable the user to set the (gridftp) server mode for
	      data transfer. Can be <literal>active</literal> or
	      <literal>passive</literal>, <literal>passive</literal>
	      by default.
	    </para>

	    <para>
	      This option will have effect only if transfer is
	      performed in a stream mode (see
	      <option>streams_num</option>)
	    </para>

	    <informalexample>
	      <screen>&prompt-user; <userinput>srmcp --streams_num=1 --server_mode=active <replaceable>sourceUrl</replaceable> <replaceable>destinationUrl</replaceable></userinput></screen>

	    </informalexample>
	  </listitem>
	</varlistentry>
      </variablelist>
    </refsynopsisdiv>

    <refsection>
      <title>Description</title>
      <para>
      </para>
    </refsection>
  </refentry>

  <refentry id="cmd-srmstage">
    <refmeta><refentrytitle><command>srmstage</command></refentrytitle></refmeta>
    <refnamediv><refname><command>srmstage</command></refname>
      <refpurpose>Request staging of a file.</refpurpose>
    </refnamediv>

    <refsynopsisdiv>
      <cmdsynopsis>
	<command>srmstage</command>
	<arg rep="repeat"><replaceable>srmUrl</replaceable></arg>
      </cmdsynopsis>
      <variablelist>
        <title>Arguments</title>
        <varlistentry>
          <term>srmUrl</term>
          <listitem>
            <para>
              The URL of the file which should be staged.
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsynopsisdiv>

    <refsection>
      <title>Description</title>

      <para>
	Provides an option to the user to stage files from &hsm; to
	&dcache; and not transfer them to the user right away. This
	case will be useful if files are not needed right away at user
	end, but its good to stage them to dcache for faster access
	later.
      </para>

    </refsection>
  </refentry>
</section>