Skip to content

Added documentation for nixops scp subcommand #1349

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Added documentation for nixops scp subcommand #1349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d266a89
added documentation for nixops scp subcommand
aiverson May 18, 2020
738986a
added a missing closing tag
aiverson May 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions doc/manual/nixops.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1315,6 +1315,88 @@ $ nixops ssh-for-each -p reboot</screen>

</refsection>

<refsection><title>Command <option>nixops scp</option></title>

<refsection><title>Synopsis</title>

<cmdsynopsis>
<command>nixops scp</command>
<arg>
<group choice='req'>
<arg choice='plain'><option>--to</option></arg>
<arg choice='plain'><option>--from</option></arg>
</group>
</arg>
<arg choice='plain'>
<replaceable>machine</replaceable>
</arg>
<arg choice='plain'>
<replaceable>sourcepath</replaceable>
</arg>
<arg choice='plain'>
<replaceable>destpath</replaceable>
</arg>
</cmdsynopsis>

</refsection>

<refsection><title>Description</title>

<para>This command copies files to or from a specified machine in the deployment</para>

</refsection>

<refsection><title>Options</title>

<variablelist>
<varlistentry><term><option>--to</option> / <option>--from</option></term>

<listitem><para>Choose whether to copy to or from the remote
machine.</para></listitem>
</varlistentry>

<varlistentry><term><replaceable>machine</replaceable></term>

<listitem><para>The name of the machine in the deployment to copy
to/from.</para></listitem>
</varlistentry>

<varlistentry><term><replaceable>sourcepath</replaceable></term>

<listitem><para>The path to the source file on the machine the file is being
copied from. This path may be on the local or remote machine depending on the
direction of the copy.</para></listitem>

</varlistentry>

<varlistentry><term><replaceable>destpath</replaceable></term>

<listitem><para>The path to the destination on the machine the file is being
copied to. This path may be on the local or remote machine depending on the
direction of the copy.</para></listitem>

</varlistentry>
</variablelist>
</refsection>

<refsection><title>Examples</title>

<para>To copy the file app.sqlite to the app server:

<screen>
$ nixops scp --to app app.sqlite /var/app/app.sqlite</screen>

</para>

<para>To retrieve a log file from the web server:

<screen>
$ nixops scp --from web /var/app/logs.txt weblogs.txt</screen>

</para>
</refsection>

</refsection>

<refsection><title>Command <option>nixops mount</option></title>

Expand Down
6 changes: 6 additions & 0 deletions doc/manual/overview.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ backend2...> /dev/xvdb 153899044 192084 145889336 1% /tmp
By default, the command is executed sequentially on each machine. You
can add the flag <option>-p</option> to execute it in parallel.</para>

<para>You can copy extra files to and from individual machines using
<literal>nixops scp --to <replaceable>machine</replaceable>
<replaceable>sourcefile</replaceable>
<replaceable>destfile</replaceable></literal> and the corresponding
<literal>--from</literal> command.</para>

</section>


Expand Down