cp

Copies files and directories within a file system or between two file systems. Downloads contents to the client from the source file system and uploads contents to the target filesystem. Copying multiple files is done sequentially.

Copies are created with default attributes. Source file and directory attributes like permissions, ownership, block size, and redundancy are not preserved.

Synopsis

cp [-b <size_in_bytes>]
[--force-sync] [--no-force-sync]
[-o] [-r]
<source_path> [<source_path> ...] <destination_path>
Syntax legend
Syntax conventions Description

Italic, bold, or < >

Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value.

In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple. Separate the data types with a comma. For example: <datatype2

In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and solrconfig files, such as @<xml_entity>='<xml_entity_type>'.

[ ]

Square brackets surround optional command arguments. Do not type the square brackets.

( )

Parentheses identify a group to choose from. Do not type the parentheses.

|

A pipe separates alternative elements. Type any one of the elements. Do not type the pipe.

...

Indicates that you can repeat the syntax element as often as required.

'

Single quotation marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case. + For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as '<<schema> ... </schema>>'

{ }

Map collection. Curly braces enclose maps ({ <key_datatype>:<value_datatype> }) or key value pairs ({ <key>:<value> }). A colon separates the key and the value.

;

Ends a CQL statement.

--

Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options.

Options

If an option has a short and long form, both forms are given, separated by a comma.

-b, --block-size size_in_bytes

Preferred block size in bytes for files. Ignored when the destination path is a file system other than DSEFS.

destination_path

Explicit path.

  • If more than one source entry is copied, this path must point to an existing directory and end with a backslash (/).

  • Supports explicit file system prefixes:

    • dsefs: - path to a remote file on the DSEFS file system dsefs://ip_address/path/to/a/remote/file

    • file: - path to a local file file:path/to/a/local/file

  • Wildcard characters are supported.

--force-sync

Synchronize files in this directory with the storage device when closed. Files created in the directory inherit the option.

--no-force-sync

Do not synchronize files in this directory with the storage device when closed. Files created in the directory inherit the option.

-n, --redundancy-factor num_nodes

Set the number of replicas of file data, similar to the replication factor in the database keyspaces, but more granular.

  • Set this to one number greater than the number of nodes that are allowed to fail before data loss occurs. For example, set this value to 3 to allow 2 nodes to fail.

  • For simple replication, use a value that is equivalent to the replication factor.

  • Default value is inherited from the parent directory if set, otherwise it is 3.

* -o, --overwrite

If destination file exists, overwrite it.

-R, --recursive

Perform the operation on directories and their contents recursively.

-r is also accepted.

source_filepath

Explicit or relative filepath.

Wildcard characters are supported. Explicit file system prefixes dsefs: and file: are supported. .. is the parent directory.

Examples

Copy file from source to overwrite file in destination:

dsefs file:/home/user1/test > cp -o dsefs:archive.tgz another-archive-copy.tgz

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2025 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM