Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Goal
To list shares on a file server that can be accessed through SMB access protocols.
Context of Use
The administrator has located and selected a file server and is required to discover any file shares on it.
Actors
Admin tool
The admin tool is the primary actor. It 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.
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.
SMB File Service
The SMB File Service is a supporting actor. It implements server-side protocol components and the file services that are consumed by the admin client.
Authentication Services
The Authentication Services is the supporting actor that is used for authentication.
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 the SMB File Service.
Preconditions
The user has identified a file server. An SMB File Service is present on the file server, as described in the Server Service Remote Protocol [MS-SRVS] section 3.1.
Main Success Scenario
Trigger: The admin tool receives a request from the user to retrieve a list of shares that are hosted by the file server.
The admin tool establishes a communication channel to the SMB File Service, as described in [MS-SRVS] section 2.1.
The SMB File Service authenticates the user through the mechanisms, as described in [MS-AUTHSOD] section 2.1.2.3.1.
The admin tool contacts the SMB File Service by using the NetrShareEnum method ([MS-SRVS] section 3.1.4.8) to retrieve the list of shares.
The SMB File Service authorizes the user through the procedure, as described in [MS-SRVS] section 3.1.4.8.
The SMB File Service performs the action and returns the results to the application.
The admin tool displays a list of file shares.
Postcondition
The list of shares that are hosted by the file server is returned to the user.
Extensions
If the communication channel for the Server Service Remote Protocol, as described in [MS-SRVS], cannot be established, or it becomes disconnected:
The admin tool can attempt to establish connection multiple times; ultimately, the use case ends with failure.
If user authorization or authentication fails:
The use case ends with failure.