|
| 1 | +<!DOCTYPE html> |
| 2 | + |
| 3 | +<html lang="en" xmlns="http://www.w3.org/1999/xhtml"> |
| 4 | +<head> |
| 5 | + <meta charset="utf-8" /> |
| 6 | + <title></title> |
| 7 | + <style> |
| 8 | + section{ |
| 9 | + border-bottom: 1px solid #eee; |
| 10 | + margin-bottom: 25px; |
| 11 | + } |
| 12 | + </style> |
| 13 | +</head> |
| 14 | +<body> |
| 15 | + <div class="container"> |
| 16 | + <p> |
| 17 | + FSV CLI is a command-line tool that offers the most features from UI for scanning folders, creating reports, and exporting them with simple commands. |
| 18 | + It primarily consists of these commands - |
| 19 | + <code>pr [args]</code> for permission report, |
| 20 | + <code>fr [args]</code> for forder report, |
| 21 | + <code>or [args]</code> for owner report, |
| 22 | + <code>sr [args]</code> for share report, and |
| 23 | + <code>ur [args]</code> for user permission report. |
| 24 | + FSV CLI exports the reports to Excel, HTML, or CSV files. |
| 25 | + </p> |
| 26 | + <section> |
| 27 | + <h3>fsv</h3> |
| 28 | + <p>Use <code>fsv --help</code> to list all commands.</p> |
| 29 | + <pre> |
| 30 | +> fsv --help |
| 31 | +FolderSecurityViewer CLI (fsv), Version: 2.3.0.0 - Enterprise Edition |
| 32 | + |
| 33 | +Usage: fsv [options] [command] |
| 34 | + |
| 35 | +Options: |
| 36 | + -?|-h|--help Show help information |
| 37 | + |
| 38 | +Commands: |
| 39 | + fr Start folder report |
| 40 | + or Start owner report |
| 41 | + pr Start permission report |
| 42 | + sr Start share report |
| 43 | + ur Start user permissions report |
| 44 | + |
| 45 | +Use "fsv [command] --help" for more information about a command. |
| 46 | + </pre> |
| 47 | + </section> |
| 48 | + |
| 49 | + <section> |
| 50 | + <h3>fsv pr</h3> |
| 51 | + <p>Use <code>fsv pr [path]</code> to start permission report on given directory.</p> |
| 52 | + <pre> |
| 53 | +> fsv pr [arguments] [options] |
| 54 | +Arguments: |
| 55 | + [path] A path of directory to scan. Use quotes if the path has whitespace in it. |
| 56 | +Options: |
| 57 | + -h|-?|--help Show help information |
| 58 | + -e|--export <fileType> [Optional] Export to file - excel, csv, or html. Default is html |
| 59 | + -p|--path <fileName> [Optional] An export file path. |
| 60 | + -d|--db [Optional] Export to database. |
| 61 | + -df|--difference [Optional] Compare sub-directories for difference in permissions, and export to default directory. |
| 62 | + -dp|--difference-path <fileName> [Optional] An export file path for difference of permissions. |
| 63 | + </pre> |
| 64 | + <h4>Description</h4> |
| 65 | + <div> |
| 66 | + <p><code>fsv pr [path]</code> starts permission report to analyze NTFS permissions of given folder in your Windows server environment, and exports the result in specified file format.</p> |
| 67 | + <ul class="list"> |
| 68 | + <li><code>[path]</code> - A local or UNC folder path on which the NTFS permissions analysis has to be performed. This argument is required.</li> |
| 69 | + <li><code>-e</code> or <code>--export</code> - Exports to one of supported file formats - Excel, HTML, or CSV. If this option is omitted, HTML is used.</li> |
| 70 | + <li> |
| 71 | + <code>-p</code> or <code>--path</code> - Use this option to export permission report result to path of your choice. |
| 72 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 73 | + </li> |
| 74 | + <li><code>-d</code> or <code>--db</code> - Use this option to save permission report result in database.</li> |
| 75 | + <li><code>-df</code> or <code>--difference</code> - Use this option to scan the difference in permissions of sub-folders, and exports the file in default location. If omitted, the scan doesn't initiate.</li> |
| 76 | + <li> |
| 77 | + <code>-dp</code> or <code>--difference-path</code> - Use this option to export difference of permissions report result to path of your choice. |
| 78 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 79 | + </li> |
| 80 | + </ul> |
| 81 | + </div> |
| 82 | + </section> |
| 83 | + |
| 84 | + <section> |
| 85 | + <h3>fsv fr</h3> |
| 86 | + <p>Use <code>fsv fr [path]</code> to start folder report on given directory.</p> |
| 87 | + <pre> |
| 88 | +> fsv fr [arguments] [options] |
| 89 | +Arguments: |
| 90 | + [path] A path of directory to scan. Use quotes if the path has whitespace in it. |
| 91 | +Options: |
| 92 | + -h|-?|--help Show help information |
| 93 | + -e|--export <fileType> Export to file - excel, csv, or html. Default is HTML |
| 94 | + -p|--path <fileName> An export file path. |
| 95 | + </pre> |
| 96 | + <h4>Description</h4> |
| 97 | + <div> |
| 98 | + <p><code>fsv fr [path]</code> starts folder report to flatten specific folder, and its subfolders into a single list with details like owner, size of folder, and number of files in it.</p> |
| 99 | + <ul class="list"> |
| 100 | + <li><code>[path]</code> - A local path of folder. This argument is required.</li> |
| 101 | + <li><code>-e</code> or <code>--export</code> - Exports to one of supported file formats - Excel, HTML, or CSV. If this option is omitted, HTML is used.</li> |
| 102 | + <li> |
| 103 | + <code>-p</code> or <code>--path</code> - Use this option to export folder report result to path of your choice. |
| 104 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 105 | + </li> |
| 106 | + </ul> |
| 107 | + </div> |
| 108 | + </section> |
| 109 | + |
| 110 | + <section> |
| 111 | + <h3>fsv or</h3> |
| 112 | + <p>Use <code>fsv or [path] [owner]</code> to start owner report on given directory.</p> |
| 113 | + <pre> |
| 114 | +> fsv or [arguments] [options] |
| 115 | +Arguments: |
| 116 | + [path] A path of directory to scan. Use quotes if the path has whitespace in it. |
| 117 | + [owner] A name of owner |
| 118 | +Options: |
| 119 | + -h|-?|--help Show help information |
| 120 | + -e|--export <fileType> Export to file - excel, csv, or html. Default is HTML |
| 121 | + -p|--path <fileName> An export file path. |
| 122 | + </pre> |
| 123 | + <h4>Description</h4> |
| 124 | + <div> |
| 125 | + <p><code>fsv or [path]</code> starts owner report to scan specific folder, and its subfolders to find out the folders in which specified user is set as an owner.</p> |
| 126 | + <ul class="list"> |
| 127 | + <li><code>[path]</code> - A local path of folder where the scan is started. This argument is required.</li> |
| 128 | + <li><code>[owner]</code> - Name of a user to scan the folder for its ownership. If this argument is not provided, the export file lists all folders with name of their owners.</li> |
| 129 | + <li><code>-e</code> or <code>--export</code> - Exports to one of supported file formats - Excel, HTML, or CSV. If this option is omitted, HTML is used.</li> |
| 130 | + <li> |
| 131 | + <code>-p</code> or <code>--path</code> - Use this option to export folder report result to path of your choice. |
| 132 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 133 | + </li> |
| 134 | + </ul> |
| 135 | + </div> |
| 136 | + </section> |
| 137 | + |
| 138 | + <section> |
| 139 | + <h3>fsv sr</h3> |
| 140 | + <p>Use <code>fsv sr [server]</code> to start share report.</p> |
| 141 | + <pre> |
| 142 | +> fsv fr [arguments] [options] |
| 143 | +Arguments: |
| 144 | + [server] A name of shared server. |
| 145 | +Options: |
| 146 | + -h|-?|--help Show help information |
| 147 | + -e|--export <fileType> Export to file - excel, csv, or html. Default is HTML |
| 148 | + -p|--path <fileName> An export file path. |
| 149 | + </pre> |
| 150 | + <h4>Description</h4> |
| 151 | + <div> |
| 152 | + <p><code>fsv sr [server]</code> starts share report to list shares of given server.</p> |
| 153 | + <ul class="list"> |
| 154 | + <li><code>[path]</code> - A local path of folder. This argument is required.</li> |
| 155 | + <li><code>-e</code> or <code>--export</code> - Exports to one of supported file formats - Excel, HTML, or CSV. If this option is omitted, HTML is used.</li> |
| 156 | + <li> |
| 157 | + <code>-p</code> or <code>--path</code> - Use this option to export folder report result to path of your choice. |
| 158 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 159 | + </li> |
| 160 | + </ul> |
| 161 | + </div> |
| 162 | + </section> |
| 163 | + |
| 164 | + <section> |
| 165 | + <h3>fsv ur</h3> |
| 166 | + <p>Use <code>fsv ur [path] [user]</code> to scan given Active Directory user deep in directory hierarchy.</p> |
| 167 | + <pre> |
| 168 | +> fsv pr [arguments] [options] |
| 169 | +Arguments: |
| 170 | + [path] A path of directory to scan. Use quotes if the path has whitespace in it. |
| 171 | + [user] A name of Active Directory user. |
| 172 | +Options: |
| 173 | + -h|-?|--help Show help information |
| 174 | + -e|--export <fileType> [Optional] Export to file - excel, csv, or html. Default is html |
| 175 | + -p|--path <fileName> [Optional] An export file path. |
| 176 | + </pre> |
| 177 | + <h4>Description</h4> |
| 178 | + <div> |
| 179 | + <p><code>fsv pr [path]</code> starts permission report to analyze NTFS permissions of given folder in your Windows server environment, and exports the result in specified file format.</p> |
| 180 | + <ul class="list"> |
| 181 | + <li><code>[path]</code> - A local or UNC folder path on which the NTFS permissions analysis has to be performed. This argument is required.</li> |
| 182 | + <li><code>[user]</code> - A name of Active Directory user to search in given directory or its sub-directories. This argument is required.</li> |
| 183 | + <li><code>-e</code> or <code>--export</code> - Exports to one of supported file formats - Excel, HTML, or CSV. If this option is omitted, HTML is used.</li> |
| 184 | + <li> |
| 185 | + <code>-p</code> or <code>--path</code> - Use this option to export permission report result to path of your choice. |
| 186 | + Default location of exported file is <code>FolderSecurityViewer\Export</code> in your <code>Documents</code> folder. |
| 187 | + </li> |
| 188 | + </ul> |
| 189 | + </div> |
| 190 | + </section> |
| 191 | + </div> |
| 192 | +</body> |
| 193 | +</html> |
0 commit comments