About: Configuring Email Addresses for Quota Notifications

Introduction

Northern Storage Suite can send notifications to users and/or administrators when thresholds are reached in storage quotas. The email addresses used are configured and modified in the notification settings page of the Quota Wizard and/or through the quota Properties Pane (accessed via multi-select+double click or alt+double click on a single quota).

Diagram 1: Email address configuration via the Quota Wizard

mailconfig_wizard

Diagram 2: Email address configuration via the Properties Pane

mailconfig_properties

The configuration of these addresses can be either static; where a hardcoded address is entered into the settings field or dynamic through integration with Active Directory; where a combination of variables triggers NSS to build the destination address dynamically when the notification is sent.

Note that this article assumes that the SMTP server is correctly configured.

Static Address Configuration

Static or hard-coded address configuration is very straightforward; simply a matter of entering an email address, such as "adminstrator@northern.net" in the relevant mail address field. Multiple destinations can be added by separating addresses with a comma (,). Static configuration is frequently used for administrative notification of threshold breach, configuring a mail to be sent to an administrative team mailbox when a quota is locked for instance.

Preconfigured Active Directory Queries

By clicking the "var" button in-line with the mail address property box (see diagrams above) it is possible to accesses several pre-configured Active Directory queries that will return email addresses. These are as follows:

%ADGetUserMail
The most commonly used AD query, this setting will cause NSS to search the user classes for an account name that exactly matches the name of the quota target directory, and return the mail attribute of that account. For example %ADGetUserMail used for a quota set on the path "\\NSS-Srv\Users\john.doe" will search Active Directory for an account called "john.doe" and return the mail attribute for this user.

%ADGetAccountMail
For use in account-based quotas only, this query will search Active Directory for a user account where the sAMAccountName property matches the account that is the target of the quota. If it succeeds it will retrieve the mail property of the user and deliver the notification.

%ADGetGroupMails[group]
Used to deliver notifications to all members of a specified group. For example, 'ADGetGroupMails[Administrators]' will notify all members of 'Administrators' group.

%ADGetLoginMail
For use in path-based quotas only, this query will return the mail property of the user account where the sAMAccountName property matches the name of the target directory of the quota. For example, %ADGetLoginMail used for a quota set on the path "\\NSS-Srv\Users\jane.doe" will search Active Directory for an account where the sAMAccountName matches "jane.doe" and return the mail attribute of that account.

%ADGetShareActiveUsersMail
Designed to be used in conjunction with quotas set directly on shares, such as project folders or department shares, this query will return the mail attribute of all users who currently files opened in the share where the quota is set.

%ADGetSharedMappedUsersMail
Designed to be used in conjunction with quotas set directly on shares, such as project folders or department shares, this query will return the mail attribute of any user who has the target share mapped locally.

Custom Active Directory Queries

In order to offer extended flexibility it is possible to enter custom Active Directory lookups in the Mail Address field. The syntax used when configuring mail addresses in this manner is as follows:

%ADProperty[object][attribute]

where object is the container that should be queried and attribute is the information that should be collected.

DEFINING THE 'OBJECT'
The object component is a property of the quota and is retrieved via one of the following NSS variables:

%USER
This variable will look at the last directory in the quota path. In a case where the quota path is "\\NSS-Srv\Users\john.doe" then %USER will return "john.doe".

%USER$
Similar to the variable %USER, but trimming any trailing '$' from the quota path . This variable should be used when the quota path is in the form "\\NSS-Srv\Users\jane.doe$". For the quota path "\\NSS-Srv\Users\jane.doe$" then %USER$ will return "jane.doe".

%ACCOUNT
To be used in the case of account-specific quotas. This variable will be replaced with the value in the Account column specified for the Quota. For example if the quota is set on "\\NSS-Srv\Users\jane.doe$" with the account set to "jane.doe" then the variable %ACCOUNT will return "jane.doe". Note that if the quota has the account 'Everyone' associated to it then "Everyone" will be returned.

%OWNER
To be used when quota targets are owned by the user or share admin who should receive notifications. Where the quota path  "\\NSS-Srv\Projects\projectA" is owned by "john.smith" then %owner will return "john.smith".

DEFINING THE 'ATTRIBUTE'

In the case of email notification configuration the the attribute component should simply be specified as 'mail'. This assumes that the mail address of user accounts is stored in the usual manner.

EXAMPLES OF CUSTOM ACTIVE DIRECTORY QUERIES
%ADProperty[%user][mail] = used for a quota set on the path "\\NSS-Srv\Users\jane.doe" will query Active Directory and return the mail attribute for the user account jane.doe.

%ADProperty[%owner][mail] = used for a quota set on the path "\\NSS-Srv\Projects\projectA" which is owned by "john.smith" will query Active Directory for the mail attribute of the account "john.smith". 

ADDITIONAL RESOURCES

  • KB2848 About: Active Directory Integration - SmartColumns and Quota Notifications
  • KB2805 How to: Configure SMTP Mail Server Settings for Quota Notifications
  • KB Article: 2841

    Updated: 12/8/2016

    • Category
      • Concept
    • Affected versions
      • NSS 9.0
      • NSS 9.5
      • NSS 9.6
      • NSS 9.7
      • NSS 9.8

    North America HQ

    NORTHERN Parklife, Inc.
    301Edgewater Place, Suite 100
    Wakefield, MA 01880
    USA

    Voice: 781.968.5424
    Fax: 781.968.5301

    salesUS@northern.net

     

    Additional Contact Information

    EMEA & APAC HQ

    NORTHERN Parklife AB
    St. Göransgatan 66
    112 33 Stockholm
    Sweden

    Voice: +46 8 457 50 00

    salesHQ@northern.net

    Northern Parklife



    ©2018 northern parklife

    privacy statement 
    terms of use