Red Hat Virtualization discovery

  • Release version: Washingtondc
  • Updated August 8, 2024
  • 6 minutes to read

    • The ServiceNow Discovery application uses the Red Hat Virtualization (RHV) discovery pattern to find RHV components. Discovering some of these resources requires updating the Discovery and Service Mapping Patterns application from the ServiceNow Store.

    Discovery uses this pattern to run horizontal discovery.

    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

    MID Server requirements
    Deploy and connect the dedicated MID Server for accessing the Red Hat Virtualization Manager (RHV-M) instance.
    Credentials
    Configure the following credentials:
    1. Navigate to Discovery > Credentials.
    2. Select New.
    3. Select RHV Credentials, fill in the form, and then select Submit.
      Field Description
      Name Credential name.
      User name Name of the user for performing RHV discovery.
      Password Password for this user.
      Active Option for enabling this credential for discovery. Select this check box to enable discovery.
      Bearer Token Option for enabling use of a bearer token. Select this check box to enable using a bearer token.
    Credentials for API elements
    During the discovery, the pattern uses the following API elements. The user that was added to the credentials must have permissions to send these queries.
    • /ovirt-engine/api/
    • /ovirt-engine/api/datacenters
    • /ovirt-engine/api/clusters
    • /ovirt-engine/api/hosts
    • /ovirt-engine/api/vms
    Add CMDB CI class models
    Add class models that extend the CMDB class hierarchy, using the CMDB CI Class Models application. The app is available from the ServiceNow Store. Discovery patterns use these class extensions to populate CIs. For more information, see Red Hat Virtualization (RHV) extension classes.
    Create a cloud service account
    Create an RHV cloud service account on the ServiceNow instance.
    1. Navigate to Cloud Provisioning and Governance > Service Accounts.
    2. Select New and then fill in the form.
      Field Description
      Name Name for the account. For example, RHV Stage.
      Account Id The account ID to which this credential belongs. Specify the API url of the RHV-M instance, including the port. For example, https://my-manager-instance.com:443.
      Discovery credentials The discovery credentials that were created previously.
      Datacenter Type The table from the CMDB that represents the type of datacenter. Select RHV LDC [cmdb_ci_rhv_ldc].
    Create a discovery schedule
    Create a discovery schedule to perform full discovery of RHV components.
    1. Open the RHV cloud service account created previously.
    2. Under Related Links, select Create Discovery Schedule.

      A new schedule is created under the Discovery Schedule menu item​.

    Data collected by Discovery during horizontal discovery

    The pattern discovers data that helps you understand the RHV topology of your organization and the relationships between its components. The discovered data includes the following tables and fields.

    Table 1. RHV LDC [cmdb_ci_rhv_ldc]
    Field Description
    Name [name] Name of the RHV datacenter.
    Object ID [object_id] Unique object identifier.
    Description [short_description] Description of the RHV datacenter that you provide for easy identification.
    Quota Mode [quota_mode] Quota mode policy.
    URL [url] API URL to access the datacenter.
    Href ID [href_id] Href ID.
    Table 2. RHV Cluster [cmdb_ci_rhv_cluster]
    Field Description
    Name [name] Name of the RHV cluster.
    Object ID [object_id] Unique object identifier.
    Description [short_description] Description of the RHV cluster that you provide for easy identification.
    CPU Type [cpu_type] CPU type. For example, x86_64.
    CPU Architecture [cpu_architecture] CPU architecture. For example, Intel Broadwell IBRS SSBD MDS Family.
    KSM [ksm] Enabled state of kernel same-page merging (KSM) memory policy.
    Fencing Policy [fencing_policy] Fencing policy.
    Memory Overcommit [memory_overcommit] Amount of over-commitment memory allowed on the cluster.
    Transparent Huge Pages [thp] Transparent huge memory pages policy.
    Ballooning [ballooning] Memory ballooning for guests.
    Compatability Version [compatibility_version] Compatibility version.
    URL [url] API URL to access the cluster.
    Href ID [href_id] Href ID.
    Table 3. RHV Server [cmdb_ci_rhv_server]
    Field Description
    Name [name] Name of the RHV server.
    Serial number [serial_number] Serial number.
    Object ID [object_id] Unique object identifier.
    CPU core count [cpu_core_count] Total number of cores.
    CPU count [cpu_count] Total number of CPUs.
    CPU type [cpu_type] CPU type.
    CPU speed (MHz) [cpu_speed] CPU speed (MHz).
    Host name [host_name] Hostname.
    IP Address [ip_address] IP address of the RHV server.
    Model ID [model_id] Model ID.
    Operating System [os] OS family.
    OS Version [os_version] OS version.
    RAM (MB) [ram] Amount of RAM (MB).
    URL [url] API URL used access the server.
    Table 4. RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance]
    Field Description
    Name [name] Name of the RHV instance.
    State [state] State of the RHV instance.
    Object ID [object_id] Unique object identifier.
    IP Address [ip_address] IP address of the RHV instance.
    Disks [disks] Number of disks.
    MAC Address [mac_address] MAC address of the RHV instance.
    Management URL [mgmt_url] Management API URL.
    Description [short_description] Description of the RHV instance that you provide for easy identification.
    Fully qualified domain name [fqdn] Fully Qualified Domain Name (FQDN) of the RHV instance.
    CPU Architecture [cpu_architecture] CPU architecture. For example: Intel Broadwell IBRS SSBD MDS Family.
    Delete Protected [delete_protected] Delete protected, possible values: true or false.
    CPUs [cpus] Number of CPUs.
    HA Priority [ha_priority] High availability (HA) priority.
    High Availability [high_availability] High availability, possible values: true or false.
    Memory MAX [memory_policy_max] Maximum memory in the dynamic memory allocation policy for the virtual machine (VM).
    Memory Guarantee (MB) [memory_policy_guaranteed] Amount of memory guaranteed for the VM (MB).
    Multi Queues [multi_queues] Multi queues.
    Placement Policy [placement_policy] Placement policy.
    Stateless [stateless] Stateless, possible values: true or false.
    On Storage Error [storage_error_resume_behaviour] Behavior of a VM that is paused due to storage I/O error. For example: AUTO_RESUME, LEAVE_PAUSED, and KILL.
    Start Time [start_time] Start time of the VM.
    Stop Time [stop_time] Stop time of the VM.
    Threads [threads] Number of threads.
    Time Zone [time_zone] Time zone of the VM.
    USB [usb] USB enabled state.
    Run Once [run_once] Run once.
    RHV Type [rhv_type] RHV type.
    Table 5. Cloud Service Account [cmdb_ci_cloud_service_account]
    Field Description
    Account Id [account_id] Account ID for this cloud service account.
    Object ID [object_id] Account ID for this cloud service account.
    Datacenter Type [datacenter_type] Type of datacenter: RHV LDC [cmdb_ci_rhv_ldc].
    Discovery credentials [discovery_credentials] Credentials for this cloud service account.
    Table 6. IP Address [cmdb_ci_ip_address]
    Field Description
    Name [name] The IP address of the network interface card (NIC) assigned to the VM.
    IP Address [ip_address] The IP address of the NIC assigned to the VM.
    IP version [ip_version] IP version: IPv4 or IPv6.
    Table 7. VNIC Endpoint [cmdb_ci_endpoint_vnic]
    Field Description
    Object ID [object_id] Unique identifier, allocated by RHV for this resource.
    Name [name] Name for the virtual network interface card (vNIC) endpoint.
    IP Address [ip_address] IP address bound to the network interface.
    Table 8. Cloud Mgmt Network Interface [cmdb_ci_nic]
    Field Description
    Object ID [object_id] ID of the network interface.
    Name [name] Name of the network interface.
    IP Address [ip_address] IP address bound to the network interface.
    Public IP [public_ip] Public IP address bound to the network interface.
    Private IP [private_ip] Private IP address bound to the network interface.
    On the Dependency Views map you can see all discovered RHV components in your organization and the relationships between them.
    CIs and connections on a Dependency Views map

    CI relationships

    The following relationships are created to support RHV discovery.
    CI Relationship CI
    Cloud Mgmt Network Interface [cmdb_ci_nic] Hosted on::Hosts RHV LDC [cmdb_ci_rhv_ldc]
    Cloud Mgmt Network Interface [cmdb_ci_nic] Owns::Owned by IP Address [cmdb_ci_ip_address]
    Cloud Mgmt Network Interface [cmdb_ci_nic] Extends from Network Adapter [cmdb_ci_network_adapter]
    Cloud Service Account [cmdb_ci_cloud_service_account] Extends from Virtual Machine Object [cmdb_ci_vm_object]
    IP Address [cmdb_ci_ip_address] Extends from Configuration Item [cmdb_ci]
    RHV Cluster [cmdb_ci_rhv_cluster] Members::Member of RHV Server [cmdb_ci_rhv_server]
    RHV Cluster [cmdb_ci_rhv_cluster] Extends from RHV Object [cmdb_ci_rhv_object]
    RHV LDC [cmdb_ci_rhv_ldc] Contains::Contained by RHV Cluster [cmdb_ci_rhv_cluster]
    RHV LDC [cmdb_ci_rhv_ldc] Hosted on::Hosts Cloud Service Account [cmdb_ci_cloud_service_account]
    RHV LDC [cmdb_ci_rhv_ldc] Extends from Logical Datacenter [cmdb_ci_logical_datacenter]
    RHV Server [cmdb_ci_rhv_server] Runs on::Runs Linux Server [cmdb_ci_linux_server]
    RHV Server [cmdb_ci_rhv_server] Extends from Virtualization Server [cmdb_ci_virtualization_server]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Hosted on::Hosts RHV Cluster [cmdb_ci_rhv_cluster]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Hosted on::Hosts RHV LDC [cmdb_ci_rhv_ldc]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Owns::Owned by IP Address [cmdb_ci_ip_address]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Registered on::Registers RHV Server [cmdb_ci_rhv_server]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Use End Point To::Use End Point From VNIC Endpoint [cmdb_ci_endpoint_vnic]
    RHV Virtual Machine Instance [cmdb_ci_rhv_vm_instance] Extends from Virtual Machine Instance [cmdb_ci_vm_instance]
    VNIC Endpoint [cmdb_ci_endpoint_vnic] Implement End Point To::Implement End Point From Cloud Mgmt Network Interface [cmdb_ci_nic]
    VNIC Endpoint [cmdb_ci_endpoint_vnic] Extends from Endpoint [cmdb_ci_endpoint]