3.2.4.3.1 Quota Macros

This section specifies the macro variables that are used by notification actions for directory quotas (see the table later in this topic which lists the quota macro variables). They are usable in the following methods:

As defined in section 3.2.7.1, I/O operations happening on a path with a quota can trigger a quota event if the current disk space usage on the path reaches or exceeds the configured threshold for the quota. The path on which the quota event was triggered is called the source path. The source path can have a number of attributes that are used to resolve quota macros, such as the following:

The file or directory object that the path represents: If the path is a file, it is called a source file path. The source path can be formatted in different ways to be accessible from local and remote machines. This includes the following:

The size of the object represented by the path: The size indicates how much space the object occupies on disk.  For files, the size indicates the space occupied by the file on disk.  For directories, the size indicates the space occupied by files and directories residing in the directory.

The owner information of the object represented by the path: The owner is a specific user account associated with the object at the moment of its creation. One or more email addresses can be associated with the owner of the object represented by the path. For more information, see [MSDN-ONO].

The identifier for the process: A process identifier (PID) identifies the process that accessed the object represented by the path.

The name of the process image: The process image name is a string representing the command line associated with the process that accessed the object represented by the path.

The quota settings configured on the path: The settings contain details of quota limits, quota usage (peak, free, and use quota) and notifications configured on the parent directories of the object represented by the path.  See Directory Quotas (section 3.2.1.2.1) for details of quota settings.

The owner attributes of the I/O incurred on the path: The owner represents the user account the application used when incurring I/O to access the source path.  This user account can be associated with one or more email addresses.

If any attributes could not be expanded while resolving a macro, the macro MUST be left unresolved.

Macro variables

Type of resolved macro value

Description

[Quota Path]

Directory Quota.Folder Path (section 3.2.1.2.1)

The drive path of the quota on the source path.  For more details, see the description for the source file path attribute in the source path of a quota notification, earlier in this section.

[Quota Remote Paths]

Directory Quota.Folder Path (section 3.2.1.2.1)

The remote paths of the quota on the source path. For more details, see the description for the source file path attribute in the source path of a quota notification, earlier in this section.

[Quota System Path]

Directory Quota.Folder Path (section 3.2.1.2.1)

The canonical path of the quota on the source path.  For more details, see the description for the source file path attribute in the source path of a quota notification, earlier in this section.

[Quota Limit]

Quota limit (section 3.2.1.2.1)

The quota limit, in bytes, of the quota on the source path.  For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Limit KB]

Quota limit (section 3.2.1.2.1)

The quota limit, in kilobytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Limit MB]

Quota limit (section 3.2.1.2.1)

The quota limit, in megabytes, of the quota on the source path. For more details, see the description for the quota settings attribute in source path of a quota notification, earlier in this section.

[Quota Threshold]

Thresholds (section 3.2.1.2.1)

The quota threshold, as a percentage, of the quota on the source path.  For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Used]

Quota usage (section 3.2.1.2.1)

The used quota, in bytes, of the quota on the source path.  For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Used KB]

Quota usage (section 3.2.1.2.1)

The used quota, in kilobytes, of the quota on the source path.  For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Used MB]

Quota usage (section 3.2.1.2.1)

The used quota, in megabytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Used Percent]

Quota usage,

Quota limit (section 3.2.1.2.1)

The quota used, as a percentage, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Peak]

Peak quota usage (section 3.2.1.2.1)

The peak used quota, in bytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Peak KB]

Peak quota usage (section 3.2.1.2.1)

The peak used quota, in kilobytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Peak MB]

Peak quota usage (section 3.2.1.2.1)

The peak used quota, in megabytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Peak Percent]

Peak quota usage,

Quota limit (section 3.2.1.2.1)

The peak used quota, as a percentage, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Peak Time]

Peak quota usage time stamp (section 3.2.1.2.1)

The time of the highest used quota of the quota in the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Free]

Quota usage (section 3.2.1.2.1)

The free quota, in bytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Free KB]

Quota usage (section 3.2.1.2.1)

The free quota, in kilobytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Free MB]

Quota usage (section 3.2.1.2.1)

The free quota, in megabytes, of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Quota Free Percent]

Quota usage (section 3.2.1.2.1)

The free quota, as a percentage of the quota on the source path. For more details, see the description for the quota settings attribute in the source path of a quota notification, earlier in this section.

[Source File Path]

File path

The source file path of the quota event. For more details, see the description for the source file path attribute in the source path of a quota notification, earlier in this section.

[Source File Remote Paths]

File paths

The remote paths for the quota event source file. For more details, see the description for the source file path attribute in the source path of a quota notification, earlier in this section.

[Source File Owner]

The owner of the file path

The owner of the source file of the quota event. For more details, see the description for the owner attribute in the source path of a quota notification, earlier in this section.

[Source File Owner Email]

The email address of the owner of the file path

The owner email address of the source file of the quota event. For more details, see the description for the owner email address attribute in the source path of a quota notification, earlier in this section.

[Source Process Id]

The Process ID

The process identifier of the source file of the quota event. For more details, see the description for the process identifier attribute in the source path of a quota notification, earlier in this section.

[Source Process Image]

The Process Image name

The process image name of the source file of the quota event. For more details, see the description for the process image name attribute in the source path of a quota notification, earlier in this section.

[Source Io Owner]

The user account that incurred the I/O.

The owner of the I/O incurred on the source path of the quota event. For more details, see the description for the owner attributes of I/O incurred in the source path of a quota notification, earlier in this section.

[Source Io Owner Email]

The email address of user account that incurred the I/O.

The owner email address of the I/O incurred in the source path of the quota event. For more details, see the description for the owner attributes of I/O incurred in the source path of a quota notification, earlier in this section.