Share via

2.5.1.4 Delete an SMB Share

  • Article

Goal

To delete a share from an SMB server.

Context of Use

The administrator is deleting a share from an existing file server.

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 an 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 that 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 purposes.

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.

Preconditions

The administrator has identified a file server and a share to be deleted on that server. An SMB File Service is present on the file server, as described in [MS-SRVS].

Main Success Scenario

  1. Trigger: The admin tool receives a request from the administrator to delete a share on the file server.

  2. The admin tool establishes a communication channel to the SMB File Service, as described in [MS-SRVS] section 2.1.

  3. The SMB File Service authenticates the administrator through the mechanisms, as described in [MS-AUTHSOD] section 2.1.2.3.1.

  4. The admin tool contacts the SMB File Service by using the NetrShareDel method ([MS-SRVS] section 3.1.4.12) to delete the share from the file server.

  5. The SMB File Service authorizes the administrator through the mechanisms, as described in [MS-SRVS] section 3.1.4.12.

  6. The SMB File Service deleted the requested share.

Postcondition

The named share is deleted from the ShareList on the file server.

Extensions

If the communication channel for [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. Depending on when the connection failed, the share could or could not have been created.

If user authorization or authentication fails:

  • The use case ends with failure.