Rudder » Techniques

<!--

Copyright 2011 Normation SAS

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, Version 3.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

-->

<!--

    This is the downloadFile PT.

    Compatibility : Linux Red Hat like, Debian like

It is intended to download a file from a curl

supported source (such as HTTP) and store it on

the given destination.

-->

<TECHNIQUE name="Download a file">

  <DESCRIPTION>This technique downloads a file from a server.

  It takes a cURL compatible source (HTTP/FTP/...) and a destination on the target host.

  </DESCRIPTION>

  <BUNDLES>

    <NAME>execute_file_download</NAME>

  </BUNDLES>

  <TMLS>

    <TML name="downloadFile"/>

  </TMLS>

  <TRACKINGVARIABLE>

    <SAMESIZEAS>DOWNLOADFILE_SOURCE</SAMESIZEAS>

  </TRACKINGVARIABLE>

  <SECTIONS>

    <!-- First Section , index 1 -->

    <SECTION name="Download a file">

      <INPUT>

        <NAME>DOWNLOADFILE_SOURCE</NAME>

        <DESCRIPTION>URL to download file from</DESCRIPTION>

        <LONGDESCRIPTION>cURL compatible URL, for example http://server/file or ftp://server/file. cURL will do its best to use what you pass to it as a URL. It is not trying to validate it as a syntactically correct URL by any means but is instead very liberal with what it accepts.</LONGDESCRIPTION>

      </INPUT>

      <INPUT>

        <NAME>DOWNLOADFILE_DESTINATION</NAME>

        <DESCRIPTION>Absolute path to download file to on a node</DESCRIPTION>

        <LONGDESCRIPTION>This path must be absolute, for example /home/foo/file or C:\foo\file</LONGDESCRIPTION>

      </INPUT>

    </SECTION>

    <!-- Second Section, Linux specific , index 10 -->

    <SECTION name="UNIX specific parameters">

      <INPUT>

        <NAME>DOWNLOADFILE_MODE</NAME>

        <DESCRIPTION>File permissions after download</DESCRIPTION>

        <CONSTRAINT>

          <TYPE>perm</TYPE>

          <DEFAULT>740</DEFAULT>

        </CONSTRAINT>

      </INPUT>

      <INPUT>

        <NAME>DOWNLOADFILE_USER</NAME>

        <DESCRIPTION>File owner (user)</DESCRIPTION>

        <CONSTRAINT>

          <DEFAULT>root</DEFAULT>

        </CONSTRAINT>

      </INPUT>

      <INPUT>

        <NAME>DOWNLOADFILE_GROUP</NAME>

        <DESCRIPTION>File owner (group)</DESCRIPTION>

        <CONSTRAINT>

          <DEFAULT>root</DEFAULT>

        </CONSTRAINT>

      </INPUT>

    </SECTION>

  </SECTIONS>

</TECHNIQUE>