2.5.1.3 Getting and Setting the Properties for an Existing SMB Share

Goal

To get or set the properties of an particular shared resource on the server in a ShareList, such as name, type, and permissions of the resource, comments that are associated with the resource, the maximum number of concurrent connections, the number of current connections, the local path for the resource, or a password for the current connection.

Context of Use

The administrator is setting up a file server or is changing the parameters of a shared resource.

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 File Service

    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.

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 an existing share name on a file server. An SMB File Service is present on the file server, as described in [MS-SRVS].

Postcondition

The properties of the shared resource are retrieved and set by the administrator.

Main Success Scenario

Trigger: The admin tool receives a request from the administrator to get and set the information of an SMB share.

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

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

  3. The admin tool contacts SMB File Service by using the NetrShareGetInfo method ([MS-SRVS] section 3.1.4.11) to retrieve the information of a shared resource.

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

  5. The SMB File Service returns the requested information of the shared resource.

  6. The admin tool contacts the SMB File Service by using the NetrShareSetInfo method ([MS-SRVS] section 3.1.4.11) to create the share on the file server.

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

  8. The SMB File Service updates the share.

Postcondition

The properties of the shared resource are retrieved and set by the administrator.

Extensions

If the communication channel for the Server Service Remote Protocol [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.