2.5.5.1 Attach an Alias Name to an Existing Server

  • Article

Goal

To attach an alias name to an existing SMB server.

Context of Use

The administrator is setting up a file server and has to add an alias to 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 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 that implements server-side protocol components and the file services that are consumed by the admin client.

  • Authentication Services

     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 administrator has identified a file server to which he has to create an alias name. The administrator has also determined an alias name to add to the server name. 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 add an alias to the file server.

  2. The admin tool establishes a communication channel to 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].

  4. The admin tool contacts the SMB File Service by using the NetrServerAliasAdd method ([MS-SRVS] section 3.1.4.44), to add an alias to the file server.

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

  6. The SMB File Service adds an alias to attach the existing server name.

Postcondition

The server is accessible with the existing name and with the added alias.

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 alias could or could not have been created.

If user authentication or authorization fails:

  • The use case ends with failure.