| sidebar | permalink | keywords | summary |
|---|---|---|---|
sidebar |
xcp-nfs-reference-scan.html |
netapp, xcp, reference, nfs, command, commands |
XCP NFS command reference |
The XCP NFS scan command recursively scans the entire source NFSv3 exported paths and returns file structure statistics.
NetApp recommends that you put the source NFS export mounts in read-only mode during the scan operation.
xcp scan <source_nfs_export_path>The following table lists the scan parameters and their description.
| Parameter | Description |
|---|---|
Lists files in the long listing output format. |
|
Shows the number of files scanned. |
|
Lists files in the tree statistic report format. |
|
Lists files in the tree statistic CSV report format. |
|
Lists files in the tree statistic HTML report format. |
|
Excludes user and group names from file listings and reports. |
|
Specifies the catalog name for a new index. |
|
Specifies the catalog name of a previous copy or scan index. |
|
Only processes files and directories that match the filter. |
|
Only processes files and directories that match the format. |
|
Summarizes the space usage of each directory, including subdirectories. |
|
Generates checksums on the files and saves the checksums when indexing (default: false). |
|
Limits the search depth. |
|
Specifies the request size when reading directories. |
|
Includes the dedupe estimate in reports. |
|
Specifies the read/write block size for scans that read data using |
|
Specifies the maximum number of concurrent batch processes (default: 7). |
|
Disables the creation of a default index (default: false). |
|
Retrieves the names of the top-level subdirectories in a directory. |
|
Restores all files to the last accessed date on the source. |
|
Provides the option to use HTTP instead of HTTPS for S3 bucket communication. |
|
Overrides the default Amazon Web Services (AWS) endpoint URL with the specified URL for S3 bucket communication. |
|
Specifies a profile from the AWS credential file for S3 bucket communication. |
|
Overrides the default verification of SSL certification for S3 bucket communication. |
Use the -l parameter with the scan command to list files in the long listing output format.
xcp scan -l <ip_address_or_hostname>:/source_volUse the -q parameter with the scan command to show the number of files scanned.
xcp scan -q <ip_address_or_hostname>:/source_volUse the -stats, -csv, and -html parameters with the scan command to list files in the tree statistic report format.
|
Note
|
XCP reports (.csv, .html) are saved in the catalog location specified in the xcp.ini file. The files are stored in the <catalog path>/catalog/indexes/1/reports folder. You can view sample reports in the appendix.
|
xcp scan -stats <ip_address>:/source_volxcp scan -csv <ip_address_or_hostname>:/source_volxcp scan -html <ip_address_or_hostname>:/source_volUse the -nonames parameter with the scan command to exclude user and group names from file listings or reports.
|
Note
|
When used with the scan command, the -nonames parameter only applies to file listings returned using the -l option.
|
xcp scan -nonames <ip_address_or_hostname>:/source_volUse the -newid <name> parameter with the scan command to specify the catalog name for a new index when running a scan.
xcp scan -newid <name> <ip_address_or_hostname>:/source_volUse the -id parameter with the scan command to specify the catalog name of previous copy or scan index.
xcp scan -id <catalog_name>Use the -match <filter> parameter with the scan command to specify that only the files and directories that match a filter are processed.
xcp scan -match <filter> <ip_address_or_hostname>:/source_volUse the -fmt parameter with the scan command to specify that only files and directories that match the specified format are returned.
xcp scan -fmt <string_expression> <ip_address_or_hostname>:/source_volUse the -du parameter with the scan command to summarize the space usage of each directory, including subdirectories.
xcp scan -du <ip_address_or_hostname>:/source_volUse the -md5 parameter with the scan command to generate checksums for the file listings and save the checksums when indexing. The default value is set to false.
|
Note
|
The checksums are not used for file verification; they are only used for file listings during scan operations. |
xcp scan -md5 <ip_address_or_hostname>:/source_volUse the -depth <n> parameter with the scan command to limit the search depth of a scan. The -depth <n> parameter specifies the depth into the subdirectories that XCP can scan files. For example, if the number 2 is specified, XCP will only scan the first two subdirectory levels.
xcp scan -depth <n> <ip_address_or_hostname>:/source_volUse the -dircount <n[k]> parameter with the scan command to specify the request size when reading directories in a scan. The default value is 64k.
xcp scan -dircount <n[k]> <ip_address_or_hostname>:/source_volUse the -edupe parameter with the scan command to include the deduplication estimate in reports.
|
Note
|
Simple Storage Service (S3) does not support sparse files. Therefore, specifying an S3 bucket as the target destination for scan -edupe returns the value "None" for sparse data.
|
xcp scan -edupe <ip_address_or_hostname>:/source_volUse the -bs <n[k]> parameter with the scan command to specify the read/write block size. This applies to scans that read data using the -md5 or -edupe parameters. The default block size is 64k.
xcp scan -bs <n[k]> <ip_address_or_hostname>:/source_volUse the -parallel parameter with the scan command to specify the maximum number of concurrent batch processes. The default value is 7.
xcp scan -parallel <n> <ip_address_or_hostname>:/source_volUse the -noId parameter with the scan command to disable the creation of a default index. The default value is false.
xcp scan -noId <ip_address_or_hostname>:/source_volUse the -subdir-names parameter with the scan command to retrieve the names of the top-level subdirectories in a directory.
xcp scan -subdir-names <ip_address_or_hostname>:/source_volUse the -preserve-atime parameter with the scan command to restore all files to the last accessed date on the source.
When an NFS share is scanned, the access time is modified on the files if the storage system is configured to modify access time on read. XCP does not directly change the access time. XCP reads the files one by one and this triggers an update to the access time. The -preserve-atime option resets the access time to the original value set before the XCP read operation.
xcp scan -preserve-atime <ip_address_or_hostname>:/source_volUse the -s3.insecure parameter with the scan command to use HTTP instead of HTTPS for S3 bucket communication.
xcp scan -s3.insecure s3://<bucket_name>Use the -s3.endpoint <s3_endpoint_url> parameter with the scan command to override the default AWS endpoint URL with a specified URL for S3 bucket communication.
xcp scan -s3.endpoint https://<endpoint_url>: s3://<bucket_name>Use the s3.profile parameter with the scan command to specify a profile from the AWS credential file for S3 bucket communication.
xcp scan -s3.profile <name> -s3.endpoint https://<endpoint_url>: s3://<bucket_name>Use the -s3.noverify parameter with the scan command to override the default verification of SSL certification for S3 bucket communication.
xcp scan -s3.noverify s3://<bucket_name>