Quick File Listing

Prev Next

The Quick File Listing script requests a list of files from host endpoints. This script can be requested for Windows, macOS, and Linux host endpoints.

You cannot copy, edit, reset, import, or delete the Quick File Listing script or use this script in data acquisition scripts you create. This script does not appear on the Data Acquisition Scripts page.

HX_SSType_QuickFileListing_scap.png

The following table describes the fields in this dialog box. Use the default values or enter new values.

Field

Description

Return

Select Files and directories to include both files and directories in the file listing. Select Just files to include only files in the file listing. Select Just directories to include only directories in the file listing.

Filter by path

Specify the path you want included in the file listing. Specify a precise path name or an appropriate path-based Windows environment variable. For example, the default environment variable used in this panel is %systemdrive%, which usually expands to C:\.

The Endpoint Security (HX) appliance does not validate of the path you specify.

Regex path filter

In addition to the initial path, you can filter using a Perl-compatible regular expression (regex) to specify the path you want to include in the file listing.

Include remote locations

(macOS and Linux only)

Select this option to include all directories at remote locations in the file listing.

Include all directory levels

Select this option to include all directory levels in the file listing.

Depth

If you did not select Include all directory levels, specify the folder depth that should be included in the file listing.

Minimum file size

Specify the minimum file size, in bytes, of files that should be included in the file listing.

Maximum file size

Specify the maximum file size, in bytes, of files that should be included in the file listing.

Content Regex

(Windows only)

Specify Perl-compatible regular expressions (regex) to identify required file content for files included in the listing. Specify one regular expression per line.

OR and AND

(Windows only)

Select OR to match any of the regex expressions listed in the Content Regex field. Select AND to match all of the regex expressions listed in the Content Regex field.

Note

The Quick File Listing dialog box also shows the percentage of allotted disk space currently used to store acquisitions and how much free disk space (in GB) remains.

Requesting quick file listing data

To request quick file listing data using the Web UI:
  1. Select Hosts in the Endpoint Security (HX) Web UI.

  2. Select one or more hosts.

  3. From the Actions menu, select Quick File Listing. Alternatively, you can select Quick File Listing from the Acquire menu on a host details page.

  4. Click Go to access the Acquire Quick File Listing dialog box.

  5. Define the following file system settings:

    • Select the file types you want to include in the listing. Options include, files and directories, files only, and directories only.

    • If you want to filter the file listing by path, enter the precise path you want included in the file listing in the Filter by path field. See guidelines in the table above.

    • If you want to filter the file listing by regex, enter a Perl-compatible regular expression in the Regex path filter field.

    • Select Include all directory levels if you want to include all directories in the file listing.

    • If you did not select Include all directory levels, enter the folder depth that should be included in the file listing in the Depth field.

    • In the Minimum file size field, enter the minimum file size (in bytes) for the files that you want included in the file listing.

    • In the Maximum file size field, enter the maximum file size (in bytes) for the files that you want included in the file listing.

  6. To filter the files by their content:

    • In the Regex field, specify Perl-compatible regular expressions (regex) to identify required file content for the files you want included in the file listing. Specify one regular expression per line.

    • Select OR if you want the file listing to match any of the regex expressions listed in the Regex field. Select AND if you want the file listing to match all of the regex expressions listed in the Regex field

  7. In the Comment field, enter the reason you want to acquire the file listing and any details about the data acquisition request that you want to track.

  8. Click Acquire.