The Field Information Manager Server can operate in an Active Directory environment which must be prepared according to the instructions in this chapter before starting the Field Information Manager Installer.
Note:
This description includes external links which are not maintained by ABB.
The external websites should be a reference to support in the configuration process.
Note:
Many powershell commands do not provide feedback if they were successful.
Please continue with the instructions if no feedback is displayed after sending a command.
Errors are indicated with a corresponding message.
Introduction:
Some parts of the setup require Active Directory domain administrator privileges and must be executed on the domain controller. Other parts require local administrator privileges on the machine that will run the Field Information Manager Server which can be a Windows Workstation or Windows Server Operating System. Both machines require a powershell console and the powershell module named ActiveDirectory. Use the following command to check if the module is available on the machine:
Get-Module -ListAvailable -Name ActiveDirectory
For Windows Server and Windows Workstation Operating Systems, different steps are necessary to install this module. For Windows 10 and later operating systems, install the Remote Server Administration Tools which can be found on the Microsoft website:
https://www.microsoft.com/en-us/download/details.aspx?id=45520
For Windows Server Operating Systems, the module is installed as a feature via the server
(Remote Administration Tools \ Role Administration Tools \ AD DS and AD LDS Tools \ Active Directory module for Windows PowerShell).
Preparation of Key Distribution Service (KDS)
To support authentication of Active Directory users, Field Information Manager must be configured to operate as a Managed Service Account (MSA) which is described on the Microsoft website:
https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-service-accounts#standalone-managed-service-accounts
Managed Service Accounts synchronize passwords using the Key Distribution Service (KDS). Follow the steps in this chapter on the domain controller with domain admin privileges to ensure that the KDS is running properly.
- Ensure that a KDS Root Key exists.
Official documentation for creating KDS Root Keys is available on the Microsoft website: https://learn.microsoft.com/en-us/windows-server/security/group-managed-service-accounts/create-the-key-distribution-services-kds-root-key
- Use the following powershell command line to check if a root key exists:
Get-KdsRootKey
- If information about a key is displayed, the key has already been created.
If no information is displayed at all, please create a new key with the following command:
Add-KdsRootKey -EffectiveImmediately
- Use the Get-KdsRootKey one more time to verify that the key has been created successfully.
- Make sure the Microsoft Kerberos Key Distribution Service (KdsSvc) is running and configured to start.
- Open the Services control panel (services.msc) and inspect the service mentioned above. If it is not configured to start automatically after the network is on, use the following command to change the configuration:
sc kdssvc start/networkon
Creation of Managed Server Account (MSA)
Once the KDS is set up appropriately, the MSA can be created on any machine in the domain. However, Active Directory Admin privileges are required. Follow the steps below to create an MSA and to ensure its password can be synchronized across computers.
- Determine the DNS host name of the Field Information Manager Server machine to produce the service principal name.
For server side authentication, the client must specify a service principal name (SPN) that is assigned to the user account running Field Information Manager Server. The client user does not need to provide this name; it is calculated from the server's DNS name. To enable this, the server must assign an SPN according to a special pattern that is described here.
- Use the following powershell command from the DnsClient module to determine the DNS Name of the server computer (assuming the server computer name is MyFIMServerComputer - choose an appropriate other name instead):
resolve-dnsname MyFIMServerComputer
- To determine the service principal name, add the postfix /FimServer to the DNS name that is displayed.
Example: If the DNS name displayed by the command is MyFIMServerComputer.MyDomain, the SPN is MyFIMServerComputer.MyDomain/FimServer.
- Create a standalone Managed Service Account (sMSA).
- Choose a name for the Field Information Manager Server user. The following powershell command creates a standalone managed service account named FimServer1 (assuming the SPN determined earlier is MyFIMServerComputer.MyDomain/FimServer):
New-ADServiceAccount -Name FimServer1 -RestrictToSingleComputer -ServicePrincipalNames MyFIMServerComputer.MyDomain/FimServer
- Notice that the argument -ServicePrincipalNames creates a service principal name with the provided name and assigns it to the new MSA.
- Assign the standalone Managed Service Account to the Field Information Manager
Server machine.
- A standalone managed service account can only be used on a single computer in the domain. Use the following command to store the identity of the server computer in a variable (assuming the server machine name is FimServer1):
$FimServerComputer = Get-ADComputer -identity MyFIMServerComputer
- Use the following command to assign the the managed service account to machine with the identity defined above (assuming the service account was named FimServer1):
Add-ADComputerServiceAccount -Identity $FimServerComputer -ServiceAccount FimServer1
Installation of Field Information Manager Server with Service Account
Now that the MSA is created, further steps need to be performed on the machine where Field Information Manager Server shall be installed. Executing these steps requires local administrator privileges on the target machine.
Note:
The powershell module named ActiveDirectory is required on the target machine for the next steps. Please ensure that it is installed and available as described in section "Introduction".
- Make the MSA available on the target machine using the powershell following command (assuming the name of the MSA installed above is FimServer1):
Install-ADServiceAccount -Identity FimServer1
- Check if the service account is installed correctly by executing the following command:
Test-ADServiceAccount FimServer1
If the output of this command is true everything works as expected.
- Start Field Information Manager Installer on the machine which you have assigned to the service account in the previous step.
- Select profile "Server" in the Welcome View.
- Select "Active Directory" in the section "Authentication Method of Field Information Manager Server".
- Enter the domain qualified name of Managed Service Account followed by a dollar character, e.g.: MyDomain\FIMServer1$
Note:
The dollar character "$" at the end is mandatory for a successful installation.