Skip to main content
Versa Networks

Install and Configure the WMI Agent

Versa-logo-release-icon.png For supported software information, click here.

The Windows Management Instrumentation (WMI) agent receives notifications from Microsoft Active Directory (AD) and passes them on the Versa Messaging Service (VMS) so that the VMS can keep its entries updated and can learn about new events. The WMI agent also publishes incremental updates to a real-time messaging server.

VMS is a message streaming server that handles high volumes of streamed data and disseminates this data to the Versa Operating System™ (VOS™) devices that are deployed in a network. Passive authentication based on VMS checks and confirms user identity without requiring any specific action to authenticate users. For more information, see Configure Passive Authentication for VMS. The VMS server receives user events from WMI agents and shares this data with VOS for policy enforcement.

This article describes how to install the WMI agent and how to perform the initial configuration of the WMI agent.

Install the WMI Agent

You can install the Versa WMI agent as a standalone component or as a software package installed on a Windows server. The standalone installation is supported on the Windows 10 Client or Windows Server 2016. For hardware requirements, see the Windows 10 Client or Windows Server 2016 documentation.

Before you install the WMI agent, ensure the following:

To install the WMI agent:

  1. Double-click the VersaWmiAgentInstaller.exe file.
  2. In the Security Warning popup window, click Run.

    security-warning.PNG
  3. In the User Account Control popup window, click Yes.

    user-account-control.PNG
  4. Click Next in all the windows of the WMI agent installation wizard until you finish the installation. The first window of the installation wizard is shown below.

    wmi-wizard-1.PNG
  5. In the Ready to Install window, click Install, and In the last wizard window, click Finish to complete the installation.

    wmi-wizard-5.PNG

    wmi-wizard-6.PNG

After you click Finish, the WMI agent launches.

Install the WMI Certificate Files

You must install two certificate files on the device running the WMI agent:

  • root-ca-cert.pem—Root certificate file. This file is created on the VMS message-streaming server and is placed in the /opt/versa/vms/certs/ directory. You must install this certificate file on the device running the WMI agent before you install the WMI agent.
  • client-cert.pfx—Client certificate file. This file is located in the /opt/versa/vms/certs/ directory on the VMS message-streaming server. You install this certificate file on the device running the WMI agent after you install the WMI agent.

To install the root-ca-cert.pem certificate file on the device running the WMI agent:

  1. Copy the root-ca-cert.pem certificate file from the /opt/versa/vms/certs/ folder on the VMS message-streaming server. For more information, see Install the Versa Messaging Service.
  2. On your Windows device, open certlm.msc and select Run as Administrator.

    certlm-run-as-admin.PNG
  3. In the certlm popup window, select Trusted Root Certification Authorities > Certificates.

    certlm-certificates.PNG
  4. Right-click Certificates, select All Tasks, and click Import.

    certlm-import.PNG
  5. In the Certificate Import Wizard popup window, click Local Machine (default) under Store Location and click Next.

    certificate-import-local-machine.PNG
  6. In the File to Import window, click Browse and select the root-ca-cert.pem certificate from the location where you saved the file.

    certl-files-to-import.PNG
  7. Click Next.
  8. In the Certificate Store window, click Place All Certificates in the Following Store (Default) and select Trusted Root Certification Authorities (Default).

    certificate-import-certificate-store.PNG
  9. Click Next and then click Finish in the final window of the wizard.

    certificate-import-finish.PNG

To install the client-cert.pfx certificate file on the device running the WMI agent:

  1. Copy the WMI certificates from the /opt/versa/vms/certs/ folder on the VMS message-stream server. For more information, see Install the Versa Messaging Service.
  2. After you install the WMI agent, click the VMS tab.
  3. Click Import Client Certificate and select the client-cert.pfx certificate file that you copied from the VMS message-streaming server. For more information, see Step 4 in Configure a VMS Server, below.

Configure the WMI Agent

After you install the WMI agent, you configure the Active Directory and VMS server details for the WMI agent so that it can receive information from Active Directory and pass it to the VMS server. You can create user groups and user filters to enable or disable monitoring, and you can perform basic troubleshooting from the WMI agent.

Configure the Active Directory Server

To configure an Active Directory server on the WMI agent:

  1. To start the WMI agent, double-click the wmi-agent-shortcut.PNG WMI agent shortcut on the desktop. The Active Directory tab displays.

    wmi-ad-main.PNG
  2. To configure  authentication details for Active Directory, in the Active Directory tab, click Configuration to update the WMI agent Active Directory configuration. Enter information for the following fields.

    ad-configuration.PNG
     
    Field Description

    Domain (Required)

    Enter the name of the organization domain configured on the Active Directory server.

    Username (Required)

    Enter the username to log in to the Active Directory server. If the user has Administrator privileges on the Active Directory server, they can perform all operations. If the user does not have Administrator privileges on the Active Directory server, they can access event logs. For more information, see Create a Non-Administrator User To Access Event Logs, below.

    Password

    Enter the password to log in to the Active Directory server.

    Reconnect Interval (Required)

    Enter the time, in seconds, after which the WMI agent tries to reconnect to the Active Directory server after reconnection failures. The WMI agent attempts reconnections until the connection is re-established.

    Value: 1 through 1800 seconds

    Default: 10 seconds

     
  3. Click OK.
  4. Click Add Server to enter the active directory server details. In the Active Directory Configuration popup window, enter information for the following fields.

    ad-add-server-details.PNG
     
    Field Description

    Server Address (Required)

    Enter the IP address of the Active Directory server to which the WMI agent connects.

    Server ID (Required)

    Enter the identifier of the Active Directory server.

    Monitor Event

    Click On to enable event monitoring of the Active Directory server on the WMI agent. This provides monitoring of connection errors and other debugging. It is recommended that you enable event monitoring.
    Secure LDAP

    Click On to enable secure LDAP query. The WMI agent fetches the principal user name using LDAP query. For more information, see Configure a VMS Server below.

    Default: Off

    Description

    Enter a description for the Active Directory server.
     
  5. Click OK.
  6. To delete an Active Directory server record, click Remove in the Active Directory tab:

    ad-server-remove.PNG

To display information about the Active Directory server, click View Details for the Active Directory server and then select the Server Details tab. For example:

ad-server-details.PNG

To display statistics about the Active Directory server, click View Details for the Active Directory server and then select the Server Statistics tab. For example:

ad-server-statistics.PNG

Create a Non-Administrator User To Access Event Logs

By default, an Administrator user can perform all operations on the Active Directory server. If you want to allow a non-Administrator user to access the event logs on the Active Directory server, you create a user who has access to the built-in Active Director groups and configure security settings to allow the groups to access Active Director server and all name spaces.

To create a new user and add the user to predefined Active Director built-in groups:

  1. On the Active Director Server, add a new user (For example, event-auditor)
  2. In the Active Director domain, click Builtin.
  3. In the right panel, right-click Event Log Readers and then select Add To a Group.
  4. In the Enter the object names to select field, enter the username you created in Step 1.
  5. Click Check Names, and then click OK.
  6. In the Active Director domain, click Builtin.
  7. In the right panel, right click Distributed COM Users and then select Add To a Group.
  8. In the Enter the object names to select field, enter the username you created in Step 1.
  9. Click Check Names, and then click OK.

To configure the Distributed COM security settings to allow the groups to access the system remotely:

  1. Click Start > Run.
  2. Enter dcomcnfg, and then click OK.
  3. Drill down in the Component Services tree until you get to My Computer.
  4. Right-click My Computer, and in the menu, click Properties.
  5. Select the COM Security tab.
  6. In the Launch and Activation Permissions section, click Edit Limits.
  7. Click Add.
  8. In the Enter the object names to select field, enter the string Distributed COM Users.
  9. Click Check Names, and then click OK.
  10. Click Add.
  11. Repeat Steps 5 through 10 for the Performance Monitor Users group.
  12. For each of the permissions (Local Launch, Remote Launch, Local Activation, Remote Activation) for each group, check Allow
  13. Click OK.

Finally, to enable OpManager to fetch the data using WMI, you provide access for all classes under all namespaces for both the user groups. To set the WMI control security settings so that they apply to all namespaces:

  1. Click Start > Run.
  2. Enter wmimgmt.msc, and then click OK.
  3. Right-click WMI Control (Local), and in the menu, click Properties.
  4. Click over to the Security tab, click Root, and then click Security.
  5. Click Add.
  6. In the Enter the object names to select field, enter the string Distributed COM Users.
  7. Click Check Names, and then click OK.
  8. Ensure that the Distributed COM Users group is selected, and then click Advanced.
  9. Highlight the row with Distributed COM Users in it and click Edit.
  10. In the Applies to field, select This namespace and subnamespaces.
  11. In the Allow column, check Execute Methods, Enable Account and Remote Enable.
  12. Click OK.
  13. Repeat Steps 4 through 12 for the Performance Monitor Users group.

Configure a VMS Server

To configure a VMS server for the WMI agent:

  1. In the WMI agent main window, select the VMS tab.

    vms-tab-main.PNG
  2. In the VMS tab, click Configuration to configure VMS server details to send data to VMS. In the VMS Configuration popup window, enter information for the following fields.

    vms-configuration.PNG
     
    Field Description

    VMS Tenant (Required)

    Enter the VMS tenant or organization name. This name must match the tenant or organization name on the VOS devices.

    Duplicate Event Ignore Interval (Required)

    Enter the time, in minutes, after which duplicate user login–related events received from Active Directory servers are ignored.

    Value: 1 through 60 minutes

    Default: 5 minutes

    Users Expiry Interval (Required)

    Enter the time, in hours, after which user records expire. A user–IP address record is valid on a VOS device until either the device receives a new user–IP address record or the expiration time interval occurs, whichever happens first.

    Value: 1 through 168 hours

    Default: 8 hours

    User Principal Name Refresh Interval

    Enter the refresh interval, in minutes, to fetch user principal names in order to update with new users or to modify existing user principal names. The user principal name is the fully qualified username for a domain. For example, if domain is xyz-networks.com and username is "testuser," the user principal name is testuser@xyz-networks.com.

    Value: 5 through 60 minutes

    Default: 5 minutes

    Send User Principal Name

    Click On to send the principal name of the user to the VMS server.

    Default: On

     
  3. Click OK.
  4. Click Add VMS Server. In the Add VMS Server popup window, enter information for the following fields.

    vms-add-vms-server.PNG
     
    Field Description

    FQDN (Required)

    Enter the fully qualified domain name (FQDN) of the VMS server to which to connect the WMI agent.

    Server Port (Required)

    Enter the port number of the VMS server.

    Value: 1 through 65535

    Default: 443 (For WMI Releases 11.4.0 and earlier, the default is 3092)

     

    Secure Connection

    Click On to enable secure connection between WMI Agent and VMS server. A secure connection uses HTTPS and a non-secure connection uses HTTP. Secure connection is usually used if the server is configured for two-way authentication, that is, when server and client use authentication. A client certificate is used for client authentication.

    Default: On

    Description

    Enter a description for the VMS server.
     
  5. Click Ok.
  6. To import a client certificate for client authentication, click Import Client Certificate in the VMS tab. The Import VMS Client Certificate popup window displays.
    1. Click Import to select the client certificate from the Windows device to import, or enter the path in the Certificate Path field.
    2. Enter the certificate key-store password.
    3. Click OK.
    4. Copy the client certificate that you set in Step 6a to the Windows machine on which the WMI agent is running. On the VMS server, the client server certificate is located in the directory /opt/versa/vms/certs/, in the file client-cert.pfx. Note that you can only import PFX certificates (.pfx).

      vms-import-client-certificate.PNG

To delete a VMS server record, click Remove in the VMS tab:

vms-tab-main-remove.PNG

To display information about the VMS server, click View Details for the VMS server and then select the Server Details tab. For example:

vms-server-details.PNG

To display event statistics for the VMS server, click View Details for the VMS server and then select the Event Statistics tab. For example:

vms-event-statistics.PNG

To display bootstrap statistics for the VMS server after connection initiates with the server, click View Details for the VMS server and then select the Bootstrap Statistics tab. For example:

vms-bootstrap-statistics.PNG

To view event history for the VMS server, click View History. For example:

vms-history.PNG

To export the event history records to an Excel (.xls) file, click Export.

Add Group Filters

You can create groups that the WMI agent can monitor or not monitor. For example, you can create group filters for sales staff or system administrators.

To create a group and enable group filtering:

  1. In the WMI agent main window, select the Groups Filter tab.

    groups-filter-main.PNG
  2. In the Groups Filter field, click On to enable filtering for the groups that you are when you click the Add Group field on this tab. When you enable group filtering, only groups that you add on this tab are monitored. If you disable group filtering, all groups are monitored. If you enable group filtering and do not add any groups, no user groups are filtered. So, enable group filtering only if you want to monitor or not monitor specific groups.
  3. Click Add Group.The Add Group popup window displays.

    groups-filter-add-group.PNG
  4. In the Group Name field, enter a name for the group. This is a required field. Note that the group name you enter must be same as the group name in Active Directory.
  5. In the Filter Action field, select Monitor, to allow monitoring of the group, or Ignore, to disable monitoring for the group.
  6. Click OK.

Add User Filters

You can add users (for example, admin), and you can enable or disable filtering for users. You can add specific uses who you want to monitor or do not want to monitor.

To add user filters:

  1. In the WMI agent main window, select the Users Filter tab.

    users-filter-main.PNG
  2. In the Users Filter field, click On to enable filtering for all users, or click Off to disable filtering for all users. If you set User Filter to On and you set Default Filter Action to Monitor, the filter action that you set for each user is used.
  3. In the Default Filter Action field, click Monitor to monitor all users, or click Ignore to not monitor all users. The Default Filter Action also applies to the users that are not added here. For example, if you set Default Filter Action to Ignore, and when a user who is not added here logs in, that user's record is ignored as is not monitored.
  4. If you set the Filter Action for a user to, in the Log Off Old IP field, configure whether to log the user in or out if they use an old IP address. For example, if you set the Filter Action for the user "administrator" to Ignore, the Log Off Old IP field is enabled (On) by default.
  5. Click Add User to add a user filter. The Add User Filter popup window displays.

    add-user-filter.PNG
    1. In the Username file, enter the name of the user. A name is required.
    2. In the Filter Action field, click Monitor to monitor the user and click Ignore to not monitor the user. If you click Ignore, Log Off Old IP is enabled.
    3. If Filter Action is Ignore, in the Log Off Old IP field, select On to log off the user from an old IP address if the user logs in with a new IP address.
    4. Click OK.

To delete a user record, click Remove in the Users Filter tab:

users-filter-main-remove.PNG

View User Details

To view information about the users that you have added to the WMI agent:

  1. In the WMI agent main window, select the Users tab to display the username, the server to which a user is connected, the active and last event IP addresses, the last user action, and the time of the last event.

    users-main.PNG
  2. To export user records to an excel (.xls) file, click Export.
  3. Click View Details to view more information about a user.

    user-details.PNG

Configure Log Parameters

To configure log parameters for the WMI agent:

  1. In the WMI agent main window, select the More tab.
  2. Select Log in the left navigation bar, and enter information for the following fields.

    more-log.PNG
     
    Field Description

    Log Size Limit

    Select maximum size for log files:

    • 10 MB
    • 25 MB
    • 50 MB
    • 100 MB

    Log Active Directory Events

    Click On to create logs for active director events.

    Application Log

    Click On to enable logging for application events.
    Application Log Level

    Select the severity level to apply to application logs:

    • Debug—Application log requires debugging.
    • Error—Log event is an error.
    • Info—Log event is for informational purposes.
    • Verbose—Show additional information during the interaction with the client user interface.
    • Warn—Log event is a warning.

    Default: Debug

Troubleshoot WMI Service Issues

To check WMI service status and to start, stop, or restart the service:

  1. In the WMI agent main window, select the More tab.
  2. Select Troubleshooting in the left navigation bar to view the running status of the WMI service.

    more-troubleshooting.PNG
  • service-running-icon.PNG indicates that the WMI service is running.
  • service-not-running-icon.PNG indicates that the WMI service has stopped. Click Restart Service to try to restart the service.
  1. If the WMI service is not running, click Start Service to start it.
  2. To stop the service, click Stop Service.
  3. To save log records to share with Versa Networks Customer Support, click Export. The log records are saved as a .zip file.
  4. To save a configuration record (.zip file) to your local disk, click Export. All configuration details except the password of the account used for listening to Active Directory events are saved.
  5. To import a saved configuration record (.zip file) from your local disk, click Import and select the file to import.

Supported Software Information

Releases 21.2.1 and later support all content described in this article.

  • Was this article helpful?