Menu
AWS Snowball
User Guide

This guide is for the Snowball (50TB or 80TB of storage space). If you are looking for documentation for the Snowball Edge, see the AWS Snowball Edge Developer Guide.

Options for the snowball cp Command

Following, you can find information about snowball cp command options and also syntax guidelines for using this command. You use this command to transfer data from your workstation to a Snowball.

Note

You must have both the principal and the keytab registered with the Kerberos authentication server used to authenticate the HDFS cluster. If you've recently run the kinit command on your terminal, then you won't need to specify this option.

Command Option Description
--checksum

On and set to false by default.

Calculates a checksum for any source and destination files with the same name, and then compares the checksums. This command option is used when a copy operation is resumed. Using this option adds computational overhead during your copy operation.

Note

When this option isn't used, a faster comparison of just file names and dates occurs when you resume as copy operation.

-f, --force

On and set to false by default. This command option has two uses:

  • When used with a copy command, -f overwrites any existing content on the destination that matches the path and name of the content being transferred.

  • When used after a copy command is run, -f overrides the --resume command option. Instead, your copy operation is performed from the beginning again, overwriting any existing content on the destination with the same path and name.

Note

The preceding use cases are not mutually exclusive. We recommend that you use -f with care to prevent delays in data transfer.

-h, --help

On and set to false by default.

Displays the usage information for the snowball cp command in the terminal.

--hdfsconfig

Used with the hdfs:// import schema, this is the path to a custom XML configuration file on the server running your HDFS cluster. This option must be repeated if you have multiple configuration files. For example, the following specifies two configuration files.

--hdfsconfig src/core/Namenode-site.xml --hdfsconfig /hdfs/corp/conf/hdfs-site.xml

-k

On and set to false by default.

Used with the hdfs:// import schema and the -p option, this is the path to the keytab file used to authenticate the Snowball client's connection to the HDFS cluster before then copying data to a Snowball.

Note

You must have both the principal and the keytab registered with the Kerberos authentication server used to authenticate the HDFS cluster. If you've recently run the kinit command on your terminal, then you won't need to specify this option.

-n

On and set to false by default.

Used with the hdfs:// import schema, copies data from a non-secure HDFS cluster.

-p

On and set to false by default.

Used with the hdfs:// import schema and the -k option, this is the principal used to authenticate the Snowball client's connection to the HDFS cluster before then copying data to a Snowball.

-r, --recursive

On and set to false by default.

Recursively traverses directories during the snowball cp command's operation.

--resume

On and set to true by default.

When this option is set, if the copy command stops unexpectedly you can resume from where you left off by running the snowball cp command again with the same options and paths. Content that was already copied over successfully is skipped, and only the content not yet copied to the Snowball is copied.

-s, --stopOnError

On and set to false by default.

Stops the snowball cp command's operation if it encounters an error.