Configuring Advanced Rulesets for Email Notifications

Configure advanced rulesets for automated generation of additional email notifications beyond the simple announcement of transfer events. IBM Aspera Console checks configured rulesets whenever a transfer starts, completes successfully, or errors out for the final time (the transfer runs out of retries or Console detects a transfer that was supposed to retry but never did). If the transfer matches the ruleset, Console sends an email notification to the designated recipients.
  1. Go to Notifications > Advanced Rulesets and click Create New Ruleset.
  2. Enter a description of the ruleset.
  3. Optional: Disable the ruleset to control when the ruleset comes into effect.
  4. Select a filter.
    Filter Description
    Address Filter by the IP address of a node machine.
    Cookie Filter by information in a transfer cookie. For more information on transfer cookies, see Creating a Cookie Parsing Rule.
    Contact Filter by the contact assigned by Console. A contact can be a Console user name, a Faspex user name, a SSH account, or a customized value obtained from a transfer cookie. For example, a contact can be "admin console", "aspera ssh", or "aspera faspex" and so on.
    Failover Group Name Filter by the failover group name of the node. For more information about failover groups, see Configure Failover Groups.
    Faspex Metadata Filter by metadata found in a Faspex file package.
    File Path Filter by the file path of the transfer.
    SSH User Filter by the username of the SSH user that started the transfer.
    Tags Filter by the JSON hash used to tag the transfer. For more information on transfer tags, see Working with Tags.
  5. Select the side to apply the filter.
    Side Description
    Either Apply the filter to both sides.
    Source Apply the filter to the source node.
    Destination Apply the filter to the destination node.
    Client Apply the filter to the node initiating the transfer request.
    Server Apply the filter to the node receiving the transfer request.
  6. Select the comparator and enter the value.
    Note: Select NOT to exclude entries matching the value.
    For example, set the following parameters to send an email notification every time a node with the defined IP address participates in a transfer.
    MATCH SIDE NOT COMPARISON VALUE
    Address Either   = 10.0.0.1
  7. Designate email recipients.
    Enter an email address and click Add. Select an email template for each transfer event.
  8. Click Create.
The newly created template appears on the Advanced Rulesets page where you can disable or enable, edit, copy, and delete rules.