Descriptions and usage of all Jindo CLI commands - E-MapReduce

Jindo CLI provides command-line tools for managing files and configurations on Object Storage Service (OSS) and OSS-Hadoop Distributed File System (OSS-HDFS), and for administering JindoFSx storage acceleration clusters.

Usage

Run jindo fs to list all supported subcommands and their usage.

Jindo CLI includes three tools:

Tool	Purpose
`jindo fs`	File system operations on OSS and OSS-HDFS paths
`jindo admin`	Administration commands for JindoFSx storage acceleration and OSS-HDFS
`jindo dlsadmin`	Advanced metadata and storage inspection for OSS-HDFS

jindo fs commands

Command	Synopsis	Description	Storage
`archive`	`jindo fs -archive [-i \| -c] oss://<bucket>/<dir>`	Sets the storage class of OSS objects. Default target class is Archive. Use `-i` for Infrequent Access (IA) or `-c` for Cold Archive.	OSS
`cat`	`jindo fs -cat oss://<bucket>/<path>`	Displays the text content of a file.	OSS and OSS-HDFS
`checkStoragePolicy`	`jindo fs -checkStoragePolicy -path oss://<bucket>/<dir>`	Queries the storage policy applied to a path.	OSS-HDFS
`checksum`	`jindo fs -checksum oss://<bucket>/<path>`	Calculates the CRC32 checksum of a file. OSS-HDFS only, because OSS-HDFS stores POSIX-compatible file metadata.	OSS-HDFS
`chgrp`	`jindo fs -chgrp <groupname> oss://<bucket>/<dir>`	Changes the group ownership of a file or directory. OSS-HDFS only, because OSS does not have a POSIX permission model.	OSS-HDFS
`chmod`	`jindo fs -chmod <mode> oss://<bucket>/<dir>`	Changes the access permissions of a file or directory. OSS-HDFS only, because OSS does not have a POSIX permission model.	OSS-HDFS
`chown`	`jindo fs -chown <username> oss://<bucket>/<dir>`	Changes the owner of a file or directory. OSS-HDFS only, because OSS does not have a POSIX permission model.	OSS-HDFS
`copyFromLocal`	`jindo fs -copyFromLocal [-f] <localdir> oss://<bucket>/<targetdir>`	Copies files from your local machine to an OSS bucket. Use `-f` to overwrite existing files at the destination. Without `-f`, the command fails if a file with the same name already exists.	OSS and OSS-HDFS
`copyToLocal`	`jindo fs -copyToLocal [-f] oss://<bucket>/<dir> <localdir>`	Copies files from an OSS bucket to your local machine. Use `-f` to overwrite existing local files. Without `-f`, the command fails if a local file with the same name already exists.	OSS and OSS-HDFS
`count`	`jindo fs -count [-h] oss://<bucket>/<dir>`	Displays the file count and total size of a directory. Use `-h` to show sizes in human-readable units (KB, MB, GB).	OSS and OSS-HDFS
`cp`	`jindo fs -cp [-f] oss://<bucket>/<sourcedir> oss://<bucket>/<targetdir>`	Copies files between OSS paths. Use `-f` to overwrite existing files at the destination. Without `-f`, the command fails if a file with the same name already exists.	OSS and OSS-HDFS
`createSnapshot`	`jindo fs -createSnapShot <snapshotDir> [<snapshotName>]`	Creates a snapshot of a directory. You must be authorized to use snapshots before you can run this command.	OSS and OSS-HDFS
`deleteSnapshot`	`jindo fs -deleteSnapshot oss://<bucket>/<dir> <snapshotName>`	Deletes a named snapshot from a directory.	OSS-HDFS
`du`	`jindo fs -du [-s] [-h] oss://<bucket>/<dir>`	Displays the size of each file in a directory. Use `-s` to show the aggregate total instead of individual file sizes. Use `-h` for human-readable units.	OSS and OSS-HDFS
`get`	`jindo fs -get [-f] oss://<bucket>/<dir> <localdst>`	Downloads files from OSS to your local machine. Use `-f` to overwrite existing local files. Without `-f`, the command fails if a local file with the same name already exists.	OSS and OSS-HDFS
`getfacl`	`jindo fs -getfacl [-R] oss://<bucket>/<dir>`	Queries the access control list (ACL) of a file or directory. Use `-R` to recursively display ACL entries for all files in a directory tree.	OSS-HDFS
`getfattr`	`jindo fs -getfattr [-R] {-n user.<attrName> \| -d} oss://<bucket>/<dir>`	Queries extended attributes of a file or directory. Use `-n` to retrieve a specific attribute by name, or `-d` to display all extended attributes. Use `-R` for recursive display.	OSS-HDFS
`getStoragePolicy`	`jindo fs -getStoragePolicy -path oss://<bucket>/<dir>`	Queries the storage policy assigned to a path.	OSS-HDFS
`listPolicies`	`jindo fs -listPolicies`	Lists all storage policies supported by OSS-HDFS.	OSS-HDFS
`load`	`jindo fs -load [-meta] [-data] [-s] [-m] [-R] [-replica <count>] oss://<bucket>/<dir>`	Caches data from OSS to the local disks of a JindoFSx cluster so subsequent reads are served from local disk instead of OSS. Use `-s` to run in synchronous mode and display progress. Use `-R` when the target path is a directory. Use `-replica <count>` to cache multiple replicas (default: 1).	JindoFSx
`ls`	`jindo fs -ls [-R] oss://<bucket>/<dir>`	Lists files in a directory. Use `-R` to recursively list all files in subdirectories.	OSS and OSS-HDFS
`metaDiff`	`jindo fs -metaDiff oss://<bucket>/<srcdir>`	Queries the synchronization status between local metadata and remote metadata in a cache-based acceleration setup.	OSS and OSS-HDFS
`mkdir`	`jindo fs -mkdir oss://<bucket>/<dir>`	Creates a directory.	OSS and OSS-HDFS
`moveFromLocal`	`jindo fs -moveFromLocal <localsrc> oss://<bucket>/<dstdir>`	Moves a file from your local machine to a remote path. The local file is deleted after the transfer completes.	OSS and OSS-HDFS
`moveToLocal`	`jindo fs -moveToLocal oss://<bucket>/<srcdir> <localdst>`	Moves a file from a remote path to your local machine. The remote file is deleted after the transfer completes.	OSS and OSS-HDFS
`mv`	`jindo fs -mv oss://<bucket>/<srcdir> oss://<bucket>/<dstdir>`	Moves a file between OSS paths.	OSS and OSS-HDFS
`put`	`jindo fs -put [-f] <localsrc> oss://<bucket>/<targetdir>`	Copies a file from your local machine to a remote directory. Use `-f` to overwrite existing files at the destination. Without `-f`, the command fails if a file with the same name already exists.	OSS and OSS-HDFS
`renameSnapshot`	`jindo fs -renameSnapshot oss://<bucket>/<dir> <newName>`	Renames a snapshot.	OSS-HDFS
`restore`	`jindo fs -restore -days <count> oss://<bucket>/<dir>`	Restores files from Archive or Cold Archive storage. You must restore files in the Cold Archive or Archive state before you unarchive the files. Use `-days` to specify the number of days during which files are restored.	OSS
`rm`	`jindo fs -rm [-f] [-r \| -R \| -rmr] oss://<bucket>/<dir>`	Deletes files or directories. Use `-f` to suppress error messages if the path does not exist. Use `-r`, `-R`, or `-rmr` for recursive deletion of directories.	OSS and OSS-HDFS
`rmdir`	`jindo fs -rmdir oss://<bucket>/<dir>`	Deletes a directory.	OSS and OSS-HDFS
`setfacl`	`jindo fs -setfacl {-b \| -k \| -m <acl-spec> \| -x <acl-spec> \| -set <acl-spec>} oss://<bucket>/<dir>`	Configures the ACL of a file or directory. Available to users on the allowlist only. Options: `-b` deletes all ACL entries, `-k` deletes default ACL entries, `-m` adds or modifies entries by name, `-x` deletes entries by name, `-set` replaces the full ACL.	OSS-HDFS
`setfattr`	`jindo fs -setfattr {-n <name> [-v <value>] \| -x <name>} oss://<bucket>/<dir>`	Sets or removes extended attributes on a file or directory. Use `-n` with `-v` to set an attribute value, or `-x` to delete an attribute by name.	OSS-HDFS
`setStoragePolicy`	`jindo fs -setStoragePolicy -path oss://<bucket>/<dir> -policy <policy>`	Assigns a storage policy to a path. If no policy is set on a file or subdirectory, it inherits the policy of its parent directory. Valid values for `-policy`: `CLOUD_STD` (Standard), `CLOUD_IA` (Infrequent Access), `CLOUD_AR` (Archive), `CLOUD_COLD_AR` (Cold Archive).	OSS-HDFS
`stat`	`jindo fs -stat oss://<bucket>/<dir>`	Queries the file status.	OSS and OSS-HDFS
`sync`	`jindo fs -sync [-update] [-thread <thread_num>] <localsrc> oss://<bucket>/<dir>`	Uploads files from your local machine to a remote path. Use `-update` to skip files that already exist at the destination and have not changed (resumable upload). Without `-update`, all files are uploaded unconditionally. Use `-thread` to set the number of upload threads.	OSS and OSS-HDFS
`test`	`jindo fs -test {-d \| -e \| -f \| -s \| -z} oss://<bucket>/<dir>`	Tests file or directory properties. Options: `-d` checks if the path is a directory, `-e` checks if the path exists, `-f` checks if the path is a file, `-s` checks if the path is non-empty, `-z` checks if the file length is zero.	OSS and OSS-HDFS
`touchz`	`jindo fs -touchz oss://<bucket>/<path>`	Creates an empty file (0 bytes).	OSS and OSS-HDFS
`truncate`	`jindo fs -truncate <length> oss://<bucket>/<dir>`	Truncates a file to the specified size. OSS-HDFS only.	OSS-HDFS
`unarchive`	`jindo fs -unarchive oss://<bucket>/<dir>`	Restores archived or cold-archived files to the Standard storage class. This operation is dedicated for archived files and cold archived files.	OSS
`uncache`	`jindo fs -uncache oss://<bucket>/<dir>`	Removes cached files from the JindoFSx cache.	OSS and OSS-HDFS
`unsetStoragePolicy`	`jindo fs -unsetStoragePolicy -path oss://<bucket>/<dir>`	Disables a storage policy.	OSS-HDFS

jindo admin commands

Command	Synopsis	Description	Storage
`addProxyUser`	`jindo dlsadmin -addProxyUser -dlsUri oss://<bucket> -proxyUser <value> -users\|-groups <value> -hosts <value>`	Adds a proxy user and specifies which users, groups, or hosts it can impersonate.	OSS-HDFS
`addUserGroupsMapping`	`jindo admin -addUserGroupsMapping -dlsUri oss://<bucket> <path> -user <value> -groups <value>`	Adds a mapping between a user and their user groups.	OSS-HDFS
`allowSnapshot`	`jindo admin -allowSnapshot -dlsUri oss://<bucket>/<dir>`	Enables snapshot support on a directory. Run this before creating snapshots with `jindo fs -createSnapShot`.	OSS-HDFS
`deleteProxyUser`	`jindo admin -deleteProxyUser -dlsUri oss://<bucket>/<dir> -proxyUser <value> -users\|-groups <value> -hosts <value>`	Removes a proxy user configuration.	OSS-HDFS
`deleteUserGroupsMapping`	`jindo admin -deleteUserGroupsMapping -dlsUri oss://<bucket> -user <value>`	Removes the user-group mapping for a specified user.	OSS-HDFS
`disallowSnapshot`	`jindo admin -disallowSnapshot -dlsUri oss://<bucket>/<dir>`	Disables snapshot support on a directory.	OSS-HDFS
`listAccessPolicies`	`jindo admin -listAccessPolicies <dlsRootPath>`	Lists all access paths configured for a bucket.	OSS-HDFS
`listProxyUsers`	`jindo admin -listProxyUsers -dlsUri oss://<bucket> [-maxKeys <value>] [-marker <value>]`	Lists proxy users for a bucket. Use `-maxKeys` to limit the number of results. Use `-marker` to paginate through results.	OSS-HDFS
`listUserGroupsMappings`	`jindo admin -listUserGroupsMappings -dlsUri oss://<bucket> [-maxKeys <value>] [-marker <value>]`	Lists all user-group mappings for a bucket. Use `-maxKeys` to limit the number of results. Use `-marker` to paginate through results.	OSS-HDFS
`mount`	`jindo admin -mount <localdir> oss://<bucket>/<dir>`	Mounts an OSS or OSS-HDFS path to a local directory.	OSS and OSS-HDFS
`report`	`jindo admin -report`	Displays JindoFSx storage acceleration system information, including cache size and cache capacity.	OSS and OSS-HDFS
`reportMetrics`	`jindo admin -reportMetrics`	Displays metrics for the JindoFSx storage acceleration system.	OSS and OSS-HDFS
`setRootPolicy`	`jindo admin -setRootPolicy <dlsRootPath> <accessRootPath>`	Configures a custom access path prefix for a bucket.	OSS-HDFS
`snapshotDiff`	`jindo admin -snapshotDiff -dlsUri oss://<bucket>/<dir> -fromSnapshot <value> -toSnapshot <value>`	Shows the differences between two snapshots of a directory.	OSS-HDFS
`umount`	`jindo fsxadmin -unmount <localdir>`	Unmounts a previously mounted local directory.	OSS and OSS-HDFS
`unsetRootPolicy`	`jindo admin -unsetRootPolicy <dlsRootPath> <accessRootPath>`	Removes a custom access path prefix from a bucket.	OSS-HDFS

jindo dlsadmin commands

Command	Synopsis	Description	Storage
`dumpBlockFiles`	`jindo dlsadmin -dumpBlockFiles -in oss://<bucket>/<dir> -out <localdir>`	Downloads all files in a specified OSS-HDFS directory to a local directory.	OSS-HDFS
`dumpFile`	`jindo dlsadmin -dumpFile -dlsUri oss://<bucket>/<dir>`	Displays detailed storage information about a file, including block layout and metadata.	OSS-HDFS
`dumpInventory`	`jindo dlsadmin -dumpInventory -dlsUri oss://<bucket>/<dir>`	Exports file metadata for a directory as an inventory file.	OSS-HDFS