The WMI protocol is used to discover and collect performance and health metrics from WMI-enabled devices. Agent-based and agentless WMI-enabled device discovery are supported.

Agent-based Discovery

Agent-based discovery uses an Agent to discover remote WMI-enabled Windows devices.

Agent-based discovery prerequisites

  • Install an agent on a Windows server where it is used to discover other Windows servers.
  • Enable the WMI service on target devices.
  • Allow WMI service through the firewall.

Discover WMI-enabled devices using Agent

  1. Install the agent on one of your network Windows servers.

  2. Go to Setup > Resources > Management profile > Add.

  3. Enter a profile name and select:

    • Select Profile type as Agent
    • Select Device Type as Windows

  4. Click Submit.

    A master agent is a legacy concept and it is recommended that you not use an agent as a master agent.

  5. Go to Setup > Resources > Discovery deployment > Create New and:

    • Select Discovery Type as Agent.
    • Select Discovery Profile Type as WMI.

  6. Select credentials, specify the IPs you want to discover, and click Submit.

  7. Open the Discovery profile and click Scan.

All discovered devices are visible on the same page.

Agentless Discovery

Agentless discovery uses a Windows gateway instead of an agent to discover WMI-enabled devices.

If any of the following are true, the gateway does not discover the device:

  • Port 5985 is not open.
  • An agent is installed on the devices.

Agentless Discovery prerequisites

On gateway devices:

  • Enable WinRM services on the gateway.
  • Allow WinRM service through the firewall.
  • Add the target remote device IP addresses as trusted hosts on the gateway because discovery operates in the given IP range.
  • Enable PS-Remoting on the gateway device.
  • Make sure you can access PowerShell from the command prompt.

On target devices:

  • Enable WinRM service.
  • Allow WinRM service through the firewall.
  • Enable PS-Remoting.

Discover WMI-enabled devices using Windows Gateway

  1. Install the Windows gateway.
  2. Go to Setup > Resources > Management profile > Add.
  3. Enter a profile name and, select Profile type as Gateway.
  4. Click Save.

Configure and install the WMI integration

  1. From All Clients, select a client.

  2. Go to Setup > Integrations and Apps.
    Notes:

    • If there are already installed applications, it will redirect to the Installed Integrations page where all the installed applications are displayed.
    • If there are no installed applications, it will navigate to the Available Integrations and Apps page.

  3. Click +Add on the Installed Integrations page.

  4. From Available Integrations and Apps, search for WMI using the search option available. Also you can use the All Categories option to search.

  5. Click Add on the WMI tile.

  6. From the Configurations page, click + ADD.

    WMI Configuration and Installation Page

    The Add Configuration page appears.

    WMI Configuration

  7. In the Add Configuration, enter the below details in the Basic Information section:

    • Name: Enter the name for the integration.
    • Host Name/IP Address: Host name or the IP address provided from the installation.
    • WMI Credential: Select an existing credential or create a new credential.
    • Click + ADD to create a new credential. In the ADD CREDENTIAL window that appears, enter the following information:
      • Name - Enter the name.
      • Description - Provide a description.
      • Domain Name - Enter the domain name.
      • User Name - Enter the username.
      • Password - Enter the password. To ensure that you have typed the correct password, click the eye icon to view the password that you entered.
      • Confirm Password - Reenter the password. To ensure that you have typed the correct password, click the eye icon to view the password that you entered.
      • Connection Timeout(ms) - Enter a value.
        Click ADD.
    • Discover only WMI enabled devices: If you choose this option, only WMI-enabled devices are discovered.
      • If this option is not selected, the device is ping-able from the gateway, and WMI is not responding or does not exist, the device is onboarded as the Other device.
      • If the device is managed, the device is shown in the Infrastructure > Resources > Desktop/Server screen.
      • If the device is not managed, the device is shown in the Infrastructure > Resources > Discovered screen.

  8. Perform Actions: Select the Manage Device checkbox, to manage the devices. The +Query option is displayed.

    • Use queries to filter the resources you want to manage.
      Note: If you do not select the Manage Device option, the devices will be in the discovered state.

  9. In the Discovery Schedule section, select Recurrence Pattern to add one of the following patterns:

    • None: Select this option, If you do not want to schedule the discovery.
    • Hourly: Select this option, If you want to apply the discovery on hourly basis. You can configure this option by choosing: Every hour.
    • Daily: Select this option, If you want to apply the discovery daily. You can configure this option by choosing: Every Weekday (Mon-Friday) or Everyday.
    • Weekly: Select this option, If you want to apply the discovery on a weekly basis. Configure weekly schedule by selecting: Time preference, Starting date, and Days.
    • Monthly: Select this option if you only want to apply discovery on a monthly basis. Configure this by selecting: Time preference, Starting date, and number of days in a month.

  10. Click ADD.

  11. Now the integration is saved and displayed on the configurations page after you save it. From the same page, you are able to Edit and Remove the created integration.

    WMI Edit and Remove Options

  12. Click Next. The Installation page is displayed.

    WMI Installation Configuration Page

  13. In the Installation page, under the SELECT GATEWAY COLLECTOR PROFILE section:

    • Click +Add to create a new collector by providing a new name or use the pre-populated name, Or
    • Select a collector from the existing list.
      Note: The selected gateway should be up and running.

  14. Click Finish.
    The integration is now installed and displayed on the Installed Integration page. Use the search field to find the installed integration.

Modify an Installed Integration or App

  1. Click the WMI integration or app. A list of installed integrations is displayed with the following information:
    WMI List of Apps and Integrations

    • Name - Displays the name of the integration or app.

    • Collector Profile - Displays the name of the collector profile.

    • Status - Displays the status of the collector profile. The status is a combination of both the gateway and application.
      For example, if the gateway status is up and the application status is installed, then the status is Running.

      Gateway StatusApplication Status
      InstalledEnabled
      UpRunningRunning
      DownStoppedStopped
      Not Installed/ Deployed/RegisteredConfiguredConfigured

    • Added On - Displays the date and time details of the added integration or app. The user icon next to the time indicates the user who added the app.

    • The following options are available in the three dot menu:

      • Edit: To edit an integration, click this button.
      • Copy Id: To copy an integration id, click this button.
      • Uninstall: To uninstall an integration, click this button.

Edit an integration

  1. Click Edit from the three dot menu or click the name of the integration.
    The Configurations window is displayed with a list of available configurations specific to the selected integration.
  2. Click the three dot symbol available for the configuration and click Edit.
  3. In the Edit Configuration window that appears, edit the configuration and click Update.

Copy an integration id

  • Click the three dot menu available for the integration and click Copy Id.
    The integration id is copied.

Uninstall an integration

  1. Click the three dot menu available for the integration and click Uninstall.
  2. In the Uninstall Integration window that appears, mention the reason for uninstalling and click Uninstall.
    The configuration is uninstalled.

Modify a configuration

Configurations are available for each integration. The following actions can be performed on the configurations from the three dot menu next to each configuration:

  • Edit: To edit a configuration, click this button.
  • Remove: To remove a configuration, click this button.
  • Discover: To discover a configuration, click this button.
Edit, Remove, Discover Options

Edit a configuration

  1. Click Edit from the three dot menu of a configuration.

  2. In the Edit Configuration window that appears, edit the configuration and click Update.

    You can also uninstall multiple configurations at the same time. Select configurations from the list in the Edit WMI page and click Uninstall at the top right.
    You can also add a new configuration from the Edit WMI page by clicking the Add button.

    Uninstall wmi

Remove a configuration

  1. Click Remove from the three dot menu of a configuration that you want to remove. A confirmation message appears.

  2. Click Delete to remove the configuration. Click Cancel to go back.

Discover a configuration

  • Click the three dot menu available for the configuration and click Discover.
    A discovery is initiated and the status is displayed under the Discovery status column.

The number of devices that are discovered are displayed in the Devices column.

  • Click the hyperlink to view the discovered devices.

Other Details like Name, Discovery status, Last discovery time, UID and Enabled are displayed.

  • Name: Name of the configuration.
  • Discovery status: Status of the discovery like Completed, Queued and
    In Progress.
  • Last discovery time: The last discovery date and time.
  • UID: Configuration UID.
  • Enabled: Enable or disable the configuration. When it is Disabled, discovery does not happen.

Note: The above columns vary based on the integration.

Assign templates

You can assign templates to the devices.

To assign templates:

  1. Click the hyperlink in the Devices column to view the discovered devices.
  2. Click the resource name.
  3. From the slide-out, click the three dots available at the upper-right corner.
  4. Click View details. The resource details page is displayed.
  5. From the monitors tab, assign the templates.

You can view graphs from the Metrics tab.

The device states are also shown in the resources listing page.

Discovered: The Discovered state is shown if a device is only discovered.

Active: The Active state is shown if a device is managed.

Troubleshooting

How do you view and save discovered devices manually?

If you cannot view the discovered devices, follow these steps to view and save the discovered devices:

  1. Open a PowerShell window and navigate to the default discovery script location: C:\Program Files\OpsRamp\Gateway\scripts\wmi\discovery

  2. Enter the following command:

        .\scriptname <IPAddress> <domain\username> <password>

    Example:

        {{ .\windowsdiscovery.ps1 172.28.110.71 opsramp\admin Pass@123 }}

    This populates the console discovered device list.

  3. Enter the following command if you want to save the result in a file:

        .\windowsdiscovery.ps1 172.28.110.71 opsramp\admin Pass@123 > D:\result.txt

    Example:

        {{ .\windowsdiscovery.ps1 172.28.110.71 opsramp\admin Pass@123 > D:\result.txt }}

    In this example, the discovered device list is saved in the result.txt text file.

How do you troubleshoot remote connections?

To troubleshoot remote connections or debug environment-related permissions and authentication issues, see Microsoft documentation about remote troubleshooting.

External References