Citrix Xen Hyper-V Discovery

  • Release version: Xanadu
  • Updated August 1, 2024
  • 4 minutes to read

    • ServiceNow Discovery uses the Citrix Xen Hyper-V pattern to find and map instances. Discover these resources by installing the pattern applications from the ServiceNow Store and add Citrix Xen Hyper-V to the Linux Server Pattern’s Extension Section.

    Use the Xen (XE) and (XL) commands to discover Citrix Xen Hyper-V, its components, and respective attributes. Discover information regarding the Hyper-V Server, Associated Pools, VMs, Network and Storage and their relationships with new and existing CIs.

    Request apps on the Store

    Visit the ServiceNow Store website to view all the available apps and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.

    Prerequisites

    Verify the following applications are up to date
    • Discovery and Service Mapping Patterns
    • CMDB CI Class Models
    Verify pool admin RBAC role
    This role is required for SSH access to the Linux server hosting the hypervisor and for executing all the necessary commands to extract information from the hypervisor environment. For more information on RBAC role permissions or adding Citrix users to a domain and assigning roles, see the Citrix documentation.
    Verify MID Server reachability
    Verify MID Server has reachability to the target device.
    Create SSH credentials with access to the target Linux host
    For more information, see SSH credentials
    Create an extension section after the Linux Server pattern
    Create an extension section after the Linux Server pattern and associate the Citrix Xen HyperV pattern to be triggered after the execution of the Linux Server discovery pattern. For more information on creating extension sections, see Enhance patterns without changing their identification sections.

    Data collected by Discovery during horizontal discovery

    Discovery populates the data in the CMDB when running the Citrix Xen HyperV pattern.

    Table 1. Hyper-V Resource Pool [cmdb_ci_hyper_v_resource_pool]
    Field Description
    object_id UUID of the Hyper-V resource pool
    name Name of the Hyper-V resource pool
    default_sr

    Default storage repository is where the VDIs are stored by default
    Table 2. Hyper-V Server [cmdb_ci_hyper_v_server]
    Field Description
    object_id UUID of the Hyper-V Server
    name Name of the Hyper-V Server in format NAME@Hyper-V Server
    serial_number Serial number of the Linux Server where the Citrix Xen Hyper-V server is running, in the format SERIAL-NUMBER_hyper_v_server in order to distinguish from the Linux Server
    manufacturer Vendor of the Hyper-V Server
    model_id Model ID of the Hyper-V Server
    short_description Description of the Hyper-V Server
    os Operating system of the Hyper-V Server
    os_version Version of the operating system of the Hyper-V Server
    host_name Host name of the Hyper-V Server
    ip_address IP address of the Hyper-V Server
    virtual Set to false, as this value is used by calculators to populate the IsVirtual flag on the dashboard (SAM).
    free_memory Available memory of the Hyper-V Server
    total_memory Total memory of the Hyper-V Server
    edition Edition of the Hyper-V Server
    cpu_core_count The number of cores per physical CPU
    cpu_count Count of the total CPUs
    ram Total RAM memory in MB
    cpu_speed

    CPU speed in MHz
    cpu_manufacturer Manufacturer of the CPU
    cpu_type Type of the CPU
    cpu_core_thread The number of threads per CPU core
    Table 3. Hyper-V Virtual Machine Instance [cmdb_ci_hyper_v_instance]
    Field Description
    object_id UUID of the Hyper-V Server
    name Name of the Hyper-V Server
    state State of the Hyper-V instance
    ip_address IP address of the Hyper-V instance
    host_id The UUID of the host where the instance is residing
    baseboard_serial UUID of the Hyper-V instance
    chassis_serial UUID of the Hyper-V instance
    bios_serial UUID of the Hyper-V instance
    Table 4. Hyper-V Virtual Network [cmdb_ci_hyper_v_network]
    Field Description
    object_id UUID of the Hyper-V Virtual Network
    pif_uuid UUID of the physical NIC
    name Name of the Hyper-V Virtual Network
    bridge Type of the network setup: either bridged or not
    Table 5. Hyper-V Virtual Network Component [cmdb_ci_hyper_v_network_comp]
    Field Description
    object_id UUID of the Hyper-V network component
    mac_address MAC address of the Hyper-V network component
    vm UUID of the Hyper-V instance, to which the network component is associated
    name Name of the Hyper-V network component
    Table 6. Hyper-V Storage [cmdb_ci_hyper_v_storage]
    Field Description
    object_id LUN of the Hyper-V storage
    name Name of the Hyper-V storage
    description Description of the Hyper-V storage
    type Type of the storage (SR)
    vm_object_id UUID of the Hyper-V instance, to which the storage is associated
    vm_id UUID of the Hyper-V instance, to which the storage is associated
    Table 7. Hyper-V Storage Component [cmdb_ci_hyper_v_storage_comp]
    Field Description
    object_id UUID of the virtual disk image (VDI)
    name Name of the virtual disk image (VDI)
    description Description of the virtual disk image (VDI)
    type Type of the storage component (VDI)
    capacity Total capacity of the virtual disk image (VDI)
    location_id Location of the virtual disk image (VDI)
    is_a_snapshot Indication if the virtual disk image (VDI) is snapshot or not
    snapshot_of Indication of VDI snapshot of the disks
    snapshot_time Time of the snapshot creation
    sr_object_id UUID of the storage repository to which the virtual disk image (VDI) is associated
    vm_object_id UUID of the virtual machine associated with the virtual disk image (VDI)

    CI Relationships

    Relationships created by Citrix Xen Hyper-V Discovery
    Parent Relationship Child
    cmdb_ci_hyper_v_resource_pool Contains :: Contained by cmdb_ci_hyper_v_server
    cmdb_ci_hyper_v_server Runs on :: Runs cmdb_ci_linux_server
    cmdb_ci_hyper_v_network Provides :: Provided by cmdb_ci_hyper_v_server
    cmdb_ci_hyper_v_network_comp Provides :: Provided by cmdb_ci_hyper_v_server
    cmdb_ci_hyper_v_instance Connected by :: Connects cmdb_ci_hyper_v_network_comp
    cmdb_ci_hyper_v_resource_pool Reference cmdb_ci_hyper_v_storage
    cmdb_ci_hyper_v_instance Contains :: Contained by cmdb_ci_hyper_v_storage
    cmdb_ci_hyper_v_storage_comp Managed by :: Manages cmdb_ci_hyper_v_storage
    cmdb_ci_hyper_v_storage_comp Reference cmdb_ci_hyper_v_instance
    cmdb_ci_hyper_v_server Define resources for :: Gets resources from cmdb_ci_hyper_v_resource_pool
    cmdb_ci_hyper_v_instance Registered on :: Has registered cmdb_ci_hyper_v_server