2.5.4.3 Configure File Screens and Directory Quotas
Goal
To configure a file screen and share directory quota on the file server.
Context of Use
The administrator is setting up a file server and has to configure a file screen and share directory quota.
Actors
Admin tool
The admin tool is the primary actor that triggers this use case. The admin tool is a program that offers management functionality to the administrator through the admin client. Typical admin tools are command-line tools and graphical shells, management utilities, and graphical management programs. The purpose of the admin tool is to correctly interpret, execute, and display the results of the commands that are issued by the administrator.
FSRM Service
The FSRM Service is a supporting actor. It provides the ability to control the amount and type of data that is stored on a file server.
Admin client
The admin client is a supporting actor that implements client-side protocol components and consumes the file server administration services that are offered by the file server. The admin client is internal to the File Services Management system.
Stakeholders
Administrator
The administrator is the person who administers the file server. The administrator has administrative rights and uses the File Services Management system to provide SMB File Services.
Main Success Scenario
Trigger: The admin tool receives a request from the administrator to configure quota and screening.
The admin tool establishes a communication channel to the File Server Resource Manager, a component of the File Service, as described in [MS-FSRM] section 3.1.3.
The admin tool creates a quota on the file server by using the IFsrmQuotaManager::CreateQuota method, as described in [MS-FSRM] section 3.2.4.2.18.3, and provides the folder path on which the quota has to be applied. The admin tool calls the IFsrmQuotaBase::QuotaLimit(put) method ([MS-FSRM] section 3.2.4.2.14.3) with a valid quota limit.
Alternatively, the admin tool creates a file screen on the file server by using the CreateFileScreen method, as described in [MS-FSRM] sections 3.2.4.2.29.3 and 3.2.4.2.27.1. The admin tool then calls the IFsrmFileScreenBase::BlockedFileGroups(put) method ([MS-FSRM] section 3.2.4.2.26.2) with a valid collection of file groups.
Postcondition
The requested quota limits and file screens are instantiated on the file server.
Extensions
If the communication channel for File Server Resource Manager Protocol [MS-FSRM] cannot be established, or it becomes disconnected:
The admin tool might attempt to establish connection multiple times; ultimately, the use case ends with failure. Depending on when the connection failed, the file quota and file screen might or might not have been created.