2.5.3 DFS-R Configuration and Monitoring Use Cases

  • Article

This section describes the configuration and monitoring activity of Distributed File System-Replication (DFS-R) on a server that includes the configuration of the DFS-R objects for the high availability of data that the server contains.

The following diagram shows the DSF-R configuration and monitoring use cases that are described in detail in the following sections.

DFS-R configuration and monitoring use cases

Figure 7: DFS-R configuration and monitoring use cases

Goal

To get the health information for a Distributed File System Replication (DFS-R) Service.

Context of Use

The administrator wants collect various statistics about the DFS-R operation on the DFS-R Service.

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.

  • DFS-R Service

    The DFS-R Service is a supporting actor that provides the interfaces to create, modify, and delete configuration objects in Active Directory by using the server's machine account. It also provides the interface to monitor DFS-R on the computer and to collect various statistics about the DFS-R operation.

  • 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.

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.

Main Success Scenario

  1. Trigger: The admin tool receives a request from the administrator to get the health report for DFS-R Service.

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

  3. The DFS Service authenticates the administrator through the mechanisms of the Authentication Services Protocol Overview, as described in [MS-AUTHSOD].

  4. The admin tool contacts the DFS-R Service to get the health report by using either the IServerHealthReport interface or the IServerHealthReport2 interface, as described in [MS-DFSRH] sections 3.1.5.4 and 3.1.5.5.

  5. The DFS-R Service generates the report and returns it to the admin client.

Postcondition

The health report is generated and is returned to the administrator.

Extensions

If the communication channel for the DFS Replication Helper Protocol, as described in [MS-DFSRH], 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 namespace could or could not have been created.