2.5.6.2 Disable a Transport Protocol on an SMB Network Redirector

Goal

To disable a transport protocol on an SMB Network Redirector.

Context of Use

The administrator is configuring the SMB Network Redirector and is required to disable a transport protocol.

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.

  • 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 Network Redirector

    The SMB Network Redirector is a supporting actor that handles requests for remote files and printer operations that use the Server Message Block (SMB) protocol as access protocol. The SMB Network Redirector also implements server-side protocol components that are used to configure it and that are consumed by the admin client.

  • Authentication Services

     Authentication Services is the supporting actor that is used for authentication purposes.

Stakeholders

  • Administrator

    The administrator is the person who administers the SMB Network Redirector. The administrator has administrative rights and uses the File Services Management system to provide the SMB File Service.

Preconditions

The administrator has identified a remote computer to which the administrator can disable a transport protocol. An SMB Network Redirector and the implementation of the Workstation Service Remote Protocol, as described in [MS-WKST], are present on the remote computer.

Main Success Scenario

  1. Trigger: The admin tool receives a request from the administrator to disable a transport protocol on an SMB Network Redirector.

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

  3. The admin tool contacts the Workstation Service by using the NetrWkstaTransportDel method, as described in [MS-WKST] section 3.2.4.6, to disable the SMB Network Redirector to use as transport protocol on a remote computer.

  4. If any open file or printer handles are using the transport protocol that this call tries to disable, the server behavior depends on the value of the ForceLevel parameter that is provided by the admin tool. If the admin tool requested a forced deletion, the server forces all open handles to close, and then disables the transport protocol.

Postcondition

The SMB Network Redirector can use the provided transport protocol.

Extensions

  1. If any open file or printer handles are using the transport protocol that this call tries to disable, and the admin tool has not requested a forceful deletion:

    The call fails, and the transport protocol is not deleted.