The new docs.trellix.com features a modernized UI and AI-powered conversational search. Content is currently available in English, with additional languages launching in early November 2026. We hope you enjoy the updated experience.

Scanning Amazon S3 storage in the CLI

Prev Next

Configure and start an Amazon S3 storage listen scan using the CLI.

Prerequisites

  • Administrator access to the File Protect appliance.

  • An Amazon S3 storage.

Follow the steps below to create a scan for Amazon S3 storage:
  1. Enable the CLI configuration mode:

    hostname > enable
    hostname # configure terminal
  2. Create an Amazon S3 listen scan.

    hostname (config) # fmps scan create from share <MyAmazonS3Storage>

    MyAmazonS3Storage is the storage on which the scan will run. The scan is created and a scan ID is displayed.

    The scan is created and a scan ID is displayed

    <scanID> configured.
  3. Save your changes.

    hostname (config) # write memory

To configure an Amazon S3 scan:

  1. Enable the CLI configuration mode:

    hostname > enable
    hostname # configure terminal
  2. Configure the scan name:

    hostname (config) # fmps scan configure <scanId> scan-name <ScanName>
  3. Configure the filetype to scan:

    hostname (config) # fmps scan configure <scanId> filetypes <FileType>
  4. Configure the start from time:

    hostname (config) # fmps scan configure <scanId> start-time <StartFromTime>
  5. Configure the list of subdirectories to scan :

    hostname (config) # fmps scan configure <scanId> subdirectories <ListOfSubdirectories>
  6. Configure the target repositories:

    hostname (config) # fmps scan configure <scanId> target-shares <ListOfTargets>
  7. Save your changes.

    hostname (config) # write memory

To start a scan:

  1. Enable the CLI configuration mode:

  2. hostname > enable
    hostname # configure terminal
  3. Start a scan by specifying its scan ID.

    hostname (config) # fmps scan start <scanID> listen

    <scanID> is the ID of the scan.

  4. Save your changes.

    hostname (config) # write memory