smbinfo.rst

   1 ============
   2 smbinfo
   3 ============
   4
   5 -----------------------------------------------------------------------------------------------------
   6 Userspace helper to display SMB-specific file information for the Linux SMB client file system (CIFS)
   7 -----------------------------------------------------------------------------------------------------
   8 :Manual section: 1
   9
  10 ********
  11 SYNOPSIS
  12 ********
  13
  14   smbinfo [-v] [-h] [-V] {command} {file system object}
  15
  16 ***********
  17 DESCRIPTION
  18 ***********
  19
  20 This tool is part of the cifs-utils suite.
  21
  22 `smbinfo` is a userspace helper program for the Linux SMB
  23 client file system (CIFS). It is intended to display SMB-specific file
  24 informations such as Security Descriptors and Quota.
  25
  26 This tool works by making an CIFS_QUERY_INFO IOCTL call to the Linux
  27 SMB client which in turn issues a SMB Query Info request and returns
  28 the result. This differs from `getcifsacl` which uses extended file
  29 attributes.
  30
  31 *******
  32 OPTIONS
  33 *******
  34
  35 -v
  36   Print version number and exit.
  37
  38 -V
  39   Verbose output.
  40
  41 -h
  42   Print help explaining the command line options.
  43
  44 *******
  45 COMMAND
  46 *******
  47
  48 `fileaccessinfo`: Prints the FileAccessInformation class
  49
  50 `filealigninfo`: Prints the FileAlignmentInformation class
  51
  52 `fileallinfo`: Prints the FileAllInformation class
  53
  54 `filebasicinfo`: Prints the FileBasicInformation class
  55
  56 `fileeainfo`: Prints the FileEaInformation class
  57
  58 `filefsfullsizeinfo`: Prints the FileFsFullSizeInformation class
  59
  60 `fileinternalinfo`: Prints the FileInternalInformation class
  61
  62 `filemodeinfo`: Prints the FileModeInformation class
  63
  64 `filepositioninfo`: Prints the FilePositionInformation class
  65
  66 `filestandardinfo`: Prints the FileStandardInformation class
  67
  68 `fsctl-getobjid`: Prints the ObjectID
  69
  70 `getcompression`: Prints the compression setting for the file.
  71
  72 `setcompression -c <no|default|lznt1>`: Sets the compression setting for the file.
  73
  74 `list-snapshots`: Lists the previous versions of the volume that backs this file
  75
  76 `quota`: Print the quota for the volume in the form
  77 - SID Length
  78 - Change Time
  79 - Quota Used
  80 - Quota Threshold
  81 - Quota Limit
  82 - SID
  83
  84 `secdesc`: Print the security descriptor in the form
  85 - Revision
  86 - Control
  87 - Owner SID
  88 - Group SID
  89 - ACL
  90 - File types
  91 - File flags
  92
  93 `keys`: Dump session id, encryption keys and decryption keys so that
  94 the SMB3 traffic of this mount can be decryped e.g. via wireshark
  95 (requires root).
  96
  97 *****
  98 NOTES
  99 *****
 100
 101 Kernel support for smbinfo utilities requires the CIFS_QUERY_INFO
 102 IOCTL which was initially introduced in the 4.20 kernel and is only
 103 implemented for mount points using SMB2 or above (see mount.cifs(8)
 104 `vers` option).
 105
 106 ********
 107 SEE ALSO
 108 ********
 109
 110 mount.cifs(8), getcifsacl(1)
 111
 112 ******
 113 AUTHOR
 114 ******
 115
 116 Ronnie Sahlberg wrote the smbinfo program.
 117
 118 The Linux CIFS Mailing list is the preferred place to ask questions
 119 regarding these programs.