The client admin tools provide and interface to query Xrootd for certain properties, e.g.: stat of a file, checksum of a file, create directory, move a file etc. Please keep in mind that Xrootd is not a file system and certain tools don't work as expected by the similar file system command.
The next table shows a list of the available commands:
| Command |
Redirection |
Description |
| XrdInitilieze |
|
Initilize a connectio to a Xrootd server |
| XrdTerminate |
|
Terminat a connection |
| XrdStat |
Yes |
stat of a file or directory |
| XrdStatX |
|
|
| XrdExistFiles |
|
|
| XrdExistDirs |
|
|
| XrdIsFileOnline |
|
|
| XrdMv |
Yes |
move a file within an Xrootd server. |
| XrdMkdir |
|
|
| XrdChmod |
|
|
| XrdRm |
Yes |
remove a file from a data server |
| XrdRmdir |
|
|
| XrdPrepare |
|
|
| XrdDirList |
|
|
| XrdGetChecksum |
No |
Get the checksum of a file |
| XrdGetCurrentHost |
|
Return the current host a client is connected to. |
The commands can be used either using the c/c++ api, perl, python or the xrd command line tool.
The c/c++ classes are part of the xrootd release. The perl interface is a wrapper of the
c++ api and is part of a xrootd release.
The python interface is also a wrapper around the c++ api but currently is not part of the release.
—
XrdInitilieze
XrdTerminate
XrdStat
XrdStatX
XrdExistFiles
XrdExistDirs
XrdIsFileOnline
XrdMv
XrdMv src trg
Move a file within a xrootd data server. The target path must exist otherwise the move will fail.
The move command works against a redirector. The redirector can be configured to forward the
the mv meta data operation.
XrdMkdir
XrdChmod
XrdRm
XrdRmdir
XrdPrepare
Use the prepare command to tell the redirector to locate files and , if requested, stage files that are not online to disk.
Notes:
- If a stat command is issues prior to the prepare the redirector assumes the file is on disk and will not stage the file.
For more information check the Xrootd Protocol
specification.
XrdDirList
XrdDirList(path)
Get the content of a directory.
If the Xrootd server is eneabled to access a mass-storage (MSS), it will check the MSS for the directory listing. However, the xrootd is configured with
oss.nodread (Mass Storage directory is not read) an empty directory list will be returned.
XrdGetChecksum
XrdGetCurrentHost