Axonius - Send Email
  • 07 Sep 2023
  • 7 Minutes to read
  • Dark
    Light
  • PDF

Axonius - Send Email

  • Dark
    Light
  • PDF

Article Summary

Axonius - Send Email sends an email with the query results to a predefined list of recipients.

  • Assets that match the results of the selected saved query, and match the Enforcement Action Conditions, if defined or assets selected on the relevant asset page.
NOTE
To use this action, you must enable Send Emails setting and configure the email host and port. For more details, see Configuring Email Settings.

See Creating Enforcement Sets to learn more about adding Enforcement Actions to Enforcement Sets.

Email Template Description

Click to view the Email Template Description

Axonius email templates summarize a query's results and includes:

  • The name of the Enforcement Set that triggered the email, and whether the enforcement was executed automatically or by a user.
  • Query Name - The name of the query used to determine which assets are included in the message.
  • Scheduling - When the Enforcement Action is scheduled to run.
  • Total Runs - How many times the Enforcement Action has actually run.
  • Main Action - The name of the main action in the Enforcement Set.
  • Custom Message - Text of the custom message as provided in the Add Custom message field.
  • Total run results - The number of assets returned by the query and included in the email.
  • Previous run results - The number of assets returned by the previous run of the Enforcement Set.
  • Added assets - Number of assets added, if any, from the previous run.
  • Subtracted assets - Number of assets removed, if any, from the previous run.

The Asset Table
The asset table included in the email message lists the first assets included in the attached CSV file. The number of rows shown is configured in the Number of data rows to include field. The fields included are selected in the Add asset fields field.

NOTE
When the query is created on Activity logs and Fetch History using filters, the email does not include a summary of the top results.

Click See all query results at the bottom of the asset table to see the complete list of assets.

Note:

Some email clients may add extra spaces in emails sent.

If you set Compress email attachments on the Email Settings page, you can send the CSV files as one compressed file. The system will warn you if the compressed file reaches 10 Megabytes.

ECAction-AxoniusSendEmail-Template.png

General Settings

Click to view General Settings

  • Enforcement Set name (required) - The name of the Enforcement Set. A default value is added by Axonius. You can change the name according to your needs.
  • Add description - Click to add a description of the Enforcement Set. It is recommended to describe what the Enforcement Set does.
  • Run action on assets matching following query (required) - Select an asset category and a query. The Enforcement Action will be run on the assets that match the query parameters.
  • Action name (required) - The name of the Main action. A default value is added by Axonius. You can change the name according to your needs.
  • Configure Dynamic Values - Toggle on to enter a Dynamic Value statement. See Creating Enforcement Action Dynamic Value Statements to learn more about Dynamic Value statement syntax.

Required Fields

These fields must be configured to run the Enforcement Set.

Click to view Required Fields
  • Recipients - Add the email address of recipients. Press Enter to add multiple addresses.

Additional Fields

Click to view Additional Fields
  • Add asset fields - Select the fields to include in the email message. Once an asset type is selected for the query (see above in General Settings), common fields are pre-selected. You can remove any of these fields by clicking the X on the field name tile.

    EmailTemplateAddAssetFields-PreSelectedFields.png

    • From the Adapter list, select an adapter.
    • From the fields list, select the fields to include in the email message. Multiple fields can be selected.
    • To add asset fields from a different adapter, click Add fields from a different adapter. A new field selection row is added.
    • To delete a row, click the trashcan icon.
  • Number of data rows to include - Select the number of rows of data to include in the email. By default, 10 rows are included. Additional rows of data can be viewed in Run History. A maximum of 30 rows can be displayed.

  • Email subject (optional, Default: Axonius Enforcement triggered) - Specify the email subject.

    • If supplied, the generated email subject will be the specified subject.
    • If not supplied, the generated email subject will be "Axonius Enforcement Triggered".
  • Recipients CC (optional) - Add list of recipients CC.

    • If supplied, the email will be sent as CC to the specified email list.
    • If not supplied, the email will be sent only to the defined Recipients specified email list.
  • Add Custom message (up to 5000 characters) (optional) - Specify the body of the email message.

    • If supplied, the generated email body will be the specified custom message.
    • If not supplied, the email message will be generated with no body.
  • Email to include custom message only (required, default: False) - Select whether to include the Axonius email template in the sent email.
    • If enabled, the email being sent will not include the Axonius email template. It will only include the specified custom message.
    • If disabled, the email being sent will include the Axonius email template.
  • Attach CSV to email - Toggle on to attach the CSV file to the email and set the CSV parameters.
    • Attach CSV with all query results:
      • If enabled, the email being sent will include an attached CSV file with all query results.
      • If disabled, the email being sent will not include an attached CSV file with the query results.
    • Attach CSV of changes only in query results (required, default: False)
      • If enabled, the email being sent will include an attached CSV file with the changes in the query results (compared to the last run of the Enforcement Set). If no changes were identified in the results, no CSV will be generated.
    * If disabled, the email being sent will not include an attached CSV file.
    • Additional CSV Settings

      1. Split by asset entities - Select to create a CSV file where each asset on a device is shown as a separate row. This separates each asset as the 'expand' option in the application. It separates each asset by its entity. For example, you will be able to know which values were fetched from each adapter connection.
        a. If supplied, each value on a device or user is shown as a separate row.
        b. If not supplied all values on a device are in the same cell on the CSV file.
      2. Split by field values - Choose field value - For complex fields and lists you can create a CSV file where the values of complex fields and lists are represented as separate rows in the file. From the drop-down box select the value that you want to display in the file, 'Tags' for instance. Only fields that have been discovered are available. For example, if you export by Installed Software, you will be able to see each installed Software name and its version.
      3. Don't split complex objects into columns - When selected, complex objects appear in a single column in JSON format. By default, each field in a complex object is split into a separate column in the CSV file.
      4. Export CSV delimiter to use for multi-value fields (default: Export CSV delimiter to use for multi-value fields field under the System Settings section in the GUI Settings) - Specify a delimiter to separate between values within the same field of an exported CSV file, otherwise the delimiter defined in Export CSV delimiter to use for multi-value fields is used.
      5. Maximum rows (default: 1048500) - Specify the maximum number of rows to be included in the CSV file. When you set a value here the generated CSV file will include the top x rows, based on the specified values. Otherwise, the generated CSV file will include the default maximum rows, set as 1048500.
      6. Include associated devices (only for Vulnerabilities and Software) - For Software and Vulnerabilities queries. Select this option to include the associated devices with the preferred hostname as a predefined field for each software or vulnerability. When you create a CSV file with associated devices (for Vulnerabilities or Software), if the exported query results are larger than the value set under Maximum rows (or the default value of 1048500), an appropriate notice is displayed at the end of the CSV file.
  • Send email even if no data is returned in the query (required, default: False) - Select whether to send an email even if the query does not return any results.
  • Tunnel Name - For Axonius-hosted (SaaS) deployments. Select the tunnel through which to connect to perform the action.

For more details about other Enforcement Actions available, see Action Library.


Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.