Skip to main content
XCP

help

Contributors netapp-pcarriga netapp-aoife
PDFs

The SMB help command displays a list of commands, command parameters, and a brief description of each. This command is very useful for beginners who are new to XCP.

Syntax
xcp --help
Show example 
C:\Users\Administrator\Desktop\xcp>xcp --help
usage: xcp [-h] [-version]
            {scan,show,listen,configure,copy,sync,verify,license,activate,help}
            ...
optional arguments:
  -h, --help       show this help message and exit
  -version         show program's version number and exit

XCP commands:
  {scan,show,listen,configure,copy,sync,verify,license,activate,help}
    scan           Read all the files in a file tree
    show           Request information from host about SMB shares
    listen         Run xcp service
    configure      Configure xcp.ini file
    copy           Recursively copy everything from source to target
    sync           Sync target with source
    verify         Verify that the target is the same as the source
    license        Show xcp license info
    activate       Activate a license on the current host
    help           Show help for commands

help <command>

Use <command> with help to display examples and option details for the specified <command>.

Syntax
xcp help <command>

The following example output shows the details, usage, arguments, and optional arguments for the sync command.

Show example 
C:\Users\Administrator\Desktop\xcp>xcp help sync
usage: xcp sync [-h] [-v] [-parallel <n>] [-match <filter>] [-preserve-atime]
[-noatime] [-noctime] [-nomtime] [-noattrs]
[-noownership] [-atimewindow <float>] [-ctimewindow <float>]
[-mtimewindow <float>] [-acl] [-fallback-user FALLBACK_USER]
[-fallback-group FALLBACK_GROUP] [-l]
source target
Note: ONTAP does not let a SMB client modify COMPRESSED or ENCRYPTED attributes.
XCP sync will ignore these file attributes.
positional arguments:
source
target
optional arguments:
-h, --help            show this help message and exit
-v                    increase debug verbosity
-parallel <n>         number of concurrent processes (default: <cpu-count>)
-match <filter>       only process files and directories that match the filter
                      see `xcp help -match` for details)
-preserve-atime       restore last accessed date on source
-noatime              do not check file access time
-noctime              do not check file creation time
-nomtime              do not check file modification time
-noattrs              do not check attributes
-noownership          do not check ownership
-atimewindow <float>  acceptable access time difference in seconds
-ctimewindow <float>  acceptable creation time difference in seconds
-mtimewindow <float>  acceptable modification time difference in seconds
-acl                  copy security information
-fallback-user FALLBACK_USER
                      a user on the target machine to receive the permissions of local
(nondomain)source machine users (eg. domain\administrator)
-fallback-group       FALLBACK_GROUP
                      a group on the target machine to receive the permissions oflocal
(non-domain) source machine groups (eg. domain\administrators)
-l                    increase output
-root                 sync acl for root directory
C:\Users\Administrator\Desktop\xcp>