Skip to main content

Installing XClarity One as a virtual machine

Follow these steps to install XClarity One as a virtual machine on a local system.

Before you begin

Ensure that you have reviewed the prerequisites, including hardware requirements and recommendations, for XClarity One (see Hardware and software requirements for XClarity One virtual machine).

You can set up XClarity One on any device that meets the requirements, including a managed server. If you use a managed server for the virtual-machine host:
  • When deploying XClarity One v1.4.2 and earlier to an ESXi host that is not connected to vCenter, network settings that are configured in the ESXi deployment wizard are not saved. As a workaround, you can set the network settings from the prompt menu on the VM console by selecting 1.

    When deploying XClarity One v1.5 and later to an ESXi host that is not connected to vCenter, network settings that are configured in the ESXi deployment wizard are saved; however, it takes a couple of minutes for the configured IP address to display in VM console (after the prompt to change network settings times out).

  • Ensure that the host server is set to automatically power on.

  • Do not use the XClarity One portal to apply firmware updates to the host server. Even when only some firmware is applied with immediate activation, XClarity One forces the host server to restart, which would make XClarity One unavailable to complete the updates on the host system.

  • XClarity One uses gateway 192.168.255.1 for its internal network (CNI).

  • By default, XClarity One uses subnet 192.168.255.0/24 for its internal network (CNI).

About this task

You can assign the virtual-appliance IP address using a static IP address on the eth0 port during configuration.

If you do not assign the IP address during configuration, IP settings are assigned using Dynamic Host Configuration Protocol (DHCP) by default when you initially start the virtual appliance. You can configure the XClarity One IP settings when you initially start the virtual appliance. Ensure that you have the required IP information before starting. You have a maximum of 60 seconds to enter settings at each prompt.

  • For static IPv4 settings, you can change the IP address, subnet mask, gateway IP address, DNS 1 IP address (optional), and DNS 2 IP address (optional).
  • For DHCP settings, you can change the primary and loopback interface settings (auto lo, iface lo inet loopback, auto eth0, and iface eth0 inet dhcp).
Attention
Changing the IP address of the XClarity One virtual-appliance after it is up and running will cause connectivity issues with the hubs and managed devices. If you need to change the IP address, disconnect all hubs from the portal before changing the IP address. After the IP address change is complete, reconnect the hubs. For more information about setting IP addresses, see Portal network.

Procedure

To install the XClarity One virtual appliance, complete the following steps.

  1. Download the XClarity One image to a client workstation from the XClarity One downloads webpage.
    Note
    • For Hyper-V, the download image is a zip file that contains two disk images. Extract the vhdx images from the zip file before proceeding.
  2. Install and configure the virtual appliance on the host system.
    • For ESXi using VMware ESXi Host Client
      1. Connect to the host through ESXi Host Client.

      2. Right-click Virtual Machines > Create/Register VM > Deploy a virtual machine from an OVF or OVA file.

      3. Complete each step in the VM creation wizard. Keep the following considerations in mind as you progress through the wizard.

        • OVF and VMDK files. Choose a unique virtual machine name, and select the OVA file.
        • Storage. Choose a datastore that has at least 768 GB storage available.
        • Deployment Options. Specify the resources available to this virtual machine.
          • Specify 8 virtual processor cores.
          • Specify 16 GB memory.
          • Choose the disk format that meets the needs of your organization. Select Thin Provision if you are unsure.
        • Additional Settings. Optionally update the network configuration for the virtual-appliance.
          • For the static IPv4 network, specify the IP address, netmask, gateway, and DNS1/DNS2.
          • For the CNI interface, specify the CNI subnet.
    • For ESXi using VMware vCenter Server
      1. Connect to the host through VMware vCenter Server.
      2. Under Hosts and groups, right-click the host, and click Deploy OVF Template.
      3. Complete each step in the VM creation wizard. Keep the following considerations in mind as you progress through the wizard.
        • OVF template. Select an OVF template from remote URL or local file system.
        • Name and folder. Choose a unique name and select a location for the virtual machine.
        • Compute resource. Select the destination compute resource for this operation. Confirm “Compatibility checks succeeded.”
        • Review details. Verify template information, including publisher, product , vendor, and download size.
        • Configuration
          • Specify 8 virtual processor cores.
          • Specify 16 GB memory.
        • Storage. Choose a datastore that has at least 768 GB storage available.
        • Networks. Select a destination network for each source network.
        • Customize template. Optionally update the network configuration for the virtual-appliance.
          • For the static IPv4 network, specify the IP address, netmask, gateway, and DNS1/DNS2.
          • For the CNI interface, specify the CNI subnet.
      4. If you plan to set a static IPv4 address during the deployment process, do not select the option to power on the virtual machine automatically after deployment. Instead, in the Customize template step, fill in all required IPv4 network information, including the IP address, netmask, gateway, and DNS1/DNS2.

        After the deployment is complete, follow the following steps before powering on the virtual appliance.

        1. Select the VM in the Inventory.
        2. Click Configure > vApp, and then select Enable vApp Options.
        3. After it is enabled, click Edit vApp Options.
        4. On the IP Allocation tab, select OVF environment for the IP allocation scheme.
        5. On the OVF Details tab, select VMware Tools for the OVF environment transport.
    • For Hyper-V
      1. From the Server Manager Dashboard, click Hyper-V.

      2. Right-click the server, and click Hyper-V Manager.

      3. Under Actions, click New > Virtual Machine to start the VM creation wizard.

      4. Complete each step in the virtual-appliance deployment wizard. Keep the following considerations in mind as you progress through the wizard.

        • Specify Name and Location. Enter a name for the new virtual machine (for example, xc1p-v<version>).

        • Specify Generation. Select Generation 1.

        • Assign Memory. Select at least 16 GB of memory to use for this virtual machine.

        • Configure Networking. Choose the virtual switch that you created when you installed and configured the host.

        • Connect Virtual Hard Disk. Click Use an existing virtual hard disk, find the location where you copied the .vhdx disk images, and select both images.

          Attention
          There are two vhdx disk images. Ensure that you import both images.
      5. Right-click on the virtual machine that you just created, and click Settings.

      6. Configure the number of processors to assign to the virtual machine. Select Processor, and specify at least 2 virtual processors to use for this virtual machine. Click Apply, and then click OK.

      7. (Optional) You can optionally set a static MAC address for each network adapter by expanding Network Adapter for the virtual switch, clicking Advanced Features, clicking Static under MAC address, and then specifying the MAC address.

  3. Power on the virtual appliance.

    When the virtual appliance is started, the IPv4 address that was assigned by DHCP is listed for the eth0 network interface, as shown in the example below.

    The eth0 management port uses a DHCP IP address by default. At the end of the boot process, you can choose to set a static IP address for the eth0 management port by entering 1 when prompted. The prompt is available for 150 seconds, until the login prompt is displayed. To exit the prompt menu and use the current settings, enter x at the prompt.

    Important
    • If you specify invalid values when changing an option, an error is returned. You have up to four attempts to enter valid values.

    • When changing the static IP address settings, you have a maximum of 60 seconds to enter the new settings. Ensure that you have the required IP information before continuing (IPv4 address, subnet mask, and gateway IP address).

    • If you change the IP address settings from the VM console, XClarity One is restarted to apply the new settings.

    • XClarity One uses gateway 192.168.255.1 for its internal network (CNI).

    • By default, XClarity One uses subnet 192.168.255.0/24 for its internal network (CNI).

    After powering on the XClarity One virtual appliance, the following console output is displayed.

            VM Information:
    ---------------
    - IPV4: 192.0.2.10
    - Netmask: 255.255.254.0
    - Gateway: 192.0.2.1
    - Internal CNI: 192.168.255.0/25
    - UUID: 76AABB3B901874399E9D238876F93874

    System Information:
    -------------------
    - CPU # Cores: 8
    - CPU Utilization: 18.48 %
    - Memory Utilization: 6.46 % (1034 MB of 16001 MB)
    - Storage Utilization: 51.096 % (138.29 GB of 255 GB)


    ===========================================================================
    ===========================================================================

    You have 150 seconds to change settings. Enter one of the following:
    1. To set a static IP address for Lenovo XClarity virtual appliance eth0 port
    2. To use a DHCP address for Lenovo XClarity virtual appliance eth0 port
    3. To select subnet for Lenovo XClarity virtual appliance internal network (CNI subnet)
    x. To continue without changing actual IP settings
    ... ...
  4. Optional: Configure the virtual-appliance IP settings. If you do not make a selection within the specified time or if you enter x, the initial startup continues using the default or configured IP settings.
    • Assign static IP addresses for the eth0 port. Enter 1, and then follow the prompts to change the settings.
    • Assign new IP addresses for the eth0 port using DHCP. Enter 2, and then follow the prompts to change the settings.
    • Select the subnet for the virtual appliance internal network. Enter 3, and then follow the prompts to change the settings.

    Important
    If you specify invalid values, an error is returned. You have up to four attempts to enter valid values.
  5. Sign in and configure XClarity One (see Configuring essential portal settings).