Skip to main content

Managing ThinkEdge Client devices

ThinkEdge Client devices, do not have baseboard management controllers and, therefore, are not discoverable using service discovery protocols. You must install a Universal Device Client (UDC)agent on ThinkEdge Client devices before the devices can be securely discovered and managed by the assigned Lenovo XClarity Management Hub resource manager. Only Lenovo XClarity Management Hub resource managers can discover and manage these devices.

Before you begin

Review the management considerations before managing a device (see Device management considerations).

Ensure that at least one Lenovo XClarity Management Hub resource manager is connected to XClarity Orchestrator (see Connecting resource managers).

To perform this task, you must be a member of a user group to which the predefined Supervisor or Security Administrator role is assigned.

Ensure that the UDS Portal credentials are configured. The credentials are used to sign the policy that is used in the client provisioning package. The UDS Portal is the trusted source for signing this policy for the UDC agent to work correctly. To configure the credentials, click Resources (Resources icon) > New Devices from the menu bar, click UDS Portal Credentials icon UDS Portal Credentials, and then enter the client ID and secret. You must request the client ID and secret from Lenovo by sending an email to uedmcredreq@lenovo.com, using “UDS Portal Credentials” in the email description, and include your company name, contact information (email or phone number), and 10-digit Lenovo Customer Number.

Ensure that a UDC agent is not currently installed on the ThinkEdge Client device. If a UDC agent is installed, you must uninstall it by running the following commands. You must have elevated privileges to install the UDC agent.
  • Linux
    sudo apt purge udc-release
  • Windows
    PUSHD %windir%\System32\drivers\Lenovo\udc\Data\InfBackup\.\UDCInfInstaller.exe -uninstall

    POPD
Ensure that your DNS server is configured to include the following domains, where (hub-domain} is the fully-qualified domain name of the XClarity Management Hub resource manager that you want to use to manage the ThinkEdge Client devices.
  • api.(hub-domain}
  • api-mtls.(hub-domain}
  • auth.(hub-domain}
  • mqtt.(hub-domain}
  • mqtt-mtls.(hub-domain}
  • s3.(hub-domain}
  • s3console.(hub-domain}

About this task

XClarity Orchestrator monitors and manages devices through resource managers. When you connect a resource manager, XClarity Orchestrator manages all devices that are managed by that resource manager.

You can also bring devices into management using XClarity Orchestrator. XClarity Orchestrator lists devices that were already discovered (but not managed) by the resource managers. When you manage discovered devices from XClarity Orchestrator, the devices are managed by resource manager that discovered it. When you manually discover and manage devices using IP addresses, hostnames, or subnets, you choose which resource manager you want to use to manage the devices. XClarity Management Hub can be used be used to manage ThinkEdge Client devices. Lenovo XClarity Administrator can be used to manage servers, storage, switches, and chassis.

You can find a complete list of supported ThinkEdge Client devices from the Lenovo XClarity Support website by clicking the Compatibility tab and then clicking the link for the appropriate device types.
Note
ThinkEdge Servers (such as SE350, SE360, and SE450) have baseboard management controllers and can be discovered using a service discovery protocol. To manage these devices, see Managing servers.

Procedure

To discover and manage ThinkEdge Client devices, complete the following steps.

  1. Install the UDC agent on each ThinkEdge Client device.
    1. From the XClarity Orchestrator menu bar, click Resources (Resources icon) > New Devices to display the Discover and manage new devices card.

    2. Click Manual Input to display the Discover New Devices dialog.
    3. Select Devices that do not respond to service discovery protocol, and then click Next.
    4. Select the IP address of the XClarity Management Hub resource manager that you want to use to manage the ThinkEdge Client devices.

      Only XClarity Management Hub resource managers in a healthy state can be selected.

    5. Select the type of operating system that is installed on the server.
      • Linux ARM
      • Linux x86
      • Windows
    6. Select the number of days before the UDC agent installer becomes unusable after it is downloaded. The default is 30 days.
    7. Select the number of times that you plan to install the UDC agent on a server. This is typically the number of devices on which you need to install the UDC agent. You can specify up to 1,000,000 usages; the default is 10 usages.
    8. Click Download UDC Agent to download the UDC agent installer to your local system.

      A job is created to complete the download process in the background. You can monitor the status of the download process from the dialog or from the jobs log by clicking Monitoring (Monitoring icon) > Jobs (see Monitoring jobs).

    9. Click Close to close the dialog.
    10. Copy the UDC agent installer to each appropriate ThinkEdge Client device, unpack/unzip the package, and then install the UDC agent on those devices using the following command. You must have administrator privileges to install the agent.
      • Linux install.sh
      • Windows setup.cmd

      After the UDC agent is successfully installed on each ThinkEdge Client device, the devices can be discovered automatically by the selected XClarity Management Hub resource manager.

  2. Manage the ThinkEdge Client devices.
    1. From the XClarity Orchestrator menu bar, click Resources (Resources icon) > New Devices to display the Discover and manage new devices card.

      Note
      It might take a while for IP addresses to appear in the table.

      Discover and manage devices card
    2. Click the All Actions > Refresh to discover all manageable devices in the XClarity Orchestrator domain. Discovery might take several minutes.
    3. Select one or more ThinkEdge Client devices that you want to manage.
    4. Click the Manage icon (Add icon) to display the Manage Discovered Devices dialog.
    5. Review the list of selected devices to manage.
    6. Select Manage.

      A job is created to complete the management process in the background. You can monitor the status of the management process from the dialog or from the jobs log by clicking Monitoring (Monitoring icon) > Jobs (see Monitoring jobs).

      If management was not successful due to one of the following error conditions, repeat this procedure using the Force management option.
      • The resource manager failed and cannot be recovered.
        Note
        If the replacement resource manager instance uses the same IP address as the failed resource manager, you can manage the device again using the RECOVERY_ID account and password (if applicable) and the Force management option.
      • The resource manager was taken down before the devices were unmanaged.
      • Devices were not unmanaged successfully.
      • XClarity Orchestrator show a managed device as offline after the device’s IP address was changed.

After you finish

You can perform the following actions on the managed device.

  • Monitor device status and details (see Viewing devices status and Viewing device details).
  • Unmanage and remove a selected device by clicking click Resources (Resources icon) and then click the device type in the left navigation to display a card with a tabular view of all managed devices of that type, select the devices to unmanage, and then click the Unmanage icon (Delete icon).
    Note
    • Ensure that there are no active jobs running on the device.
    • If XClarity Orchestrator cannot connect to the resource manager (for example, if credentials are expired or if there are network issues), select Force unmanage even if the device is not reachable.
    • For most devices, XClarity Orchestrator and the resource manager retain certain information about the device after it is unmanaged. That information is reapplied when you manage the same device again.
    • XClarity Orchestrator automatically unmanage devices that are offline for a 24 hours or more by default (see Configuring global discovery settings).
  • Troubleshoot issues when connecting a resource manager (see Cannot discover a device and Cannot manage a resource).