Hyper-V, XenServer and vCenter inventory attribute mapping

+ More

Table of Contents

Overview Matching VMware vCenter Microsoft Hyper-V Citrix XenServer

Overview

This article contains the attribute mapping for the Inventory of Citrix XenServer, Inventory of Microsoft Hyper-V, and Inventory of VMware vCenter Data Providers. It lists all attributes of the Computer configuration item that are imported or updated by the inventory.

Matching

When a data provider runs, it attempts to match each incoming host or virtual machine with an existing computer record in Matrix42 Enterprise Service Management. The matching is attribute-based and follows a fixed priority order.

The data provider evaluates each attribute independently, starting from the highest priority. If the incoming data contains a value for an attribute and exactly one existing record matches that value, the match succeeds, and the provider updates that record. If the incoming value is missing or null for an attribute, the provider skips that attribute and moves to the next one in the list.

The default matching priority is:

  1. UUID
  2. SerialNumber
  3. ClientIPAddress
  4. Name
  5. DnsName
  6. DomainName
  7. Active status

If a match is found, the existing computer record is updated with the incoming data. If no match is found after all attributes have been evaluated, a new computer record is created.

Multiple matches: If more than one existing record matches the incoming attribute value, the data provider updates a randomly selected record and logs a warning to HostCommon.log. To avoid unintended data changes, resolve duplicate computer records before running the import.

 

If a host or virtual machine is absent from the latest snapshot because it has been deleted, the data provider sets its status in Matrix42 Enterprise Service Management to Unknown, or to another status configured for deleted machines in the data provider settings.

Stock-keeping units (SKUs) are also created or updated during the import. SKUs are matched by the ManufacturerName and Model attributes. If no matching SKU is found, a new one is created. The Configuration Item and Type fields are populated if the corresponding source data is available.

 

You can also switch from the default attribute priority to custom matching and define your own matching keys. For details, see Configuring data providers for virtual infrastructure.

VMware vCenter

Provider Data ESM Data Model  
XML Entity XML Element Data Definition Attribute Note
DataCenter
​Snapshot		 CurrentTime SPSComputerClass​Base LastScanDate  
ScanedHostName     Used in values of the Domain and VCenter attributes.
VCenterServerName SPSComputerClassBase VCenterServerName  
VCenterVersion SPSComputerClassBase VCenterVersion  
Cluster ClusterName SPSComputerClassBase ClusterName  
Host IsStandAlone SPSComputerClassBase IsStandalone True when the host is not part of a cluster; otherwise false.
inMaintenanceMode SPSComputerClassBase inMaintenanceMode  
VmotionEnabled SPSComputerClassBase VmotionEnabled  
DataCenter SPSComputerClassBase DataCenter Name of the VMware datacenter the physical host belongs to.
DataStores SPSComputerClassBase DataStores List of data stores where physical host is connected.
ClusterName SPSComputerClassBase ClusterName  
ConnectionState SPSComputerClassBase ConnectionState State of the connection between a physical host and the vCenter server. Possible values: Connected, Disconnected, NotResponding, Maintenance.
HostName     Used in values of the DNSName and IpAddress
attributes.
Hyperthreading​Active SPSComputerClass​Base Hyperthreading​Active  
VMHostId SPSComputerClass​Base DeviceId  
DnsAddress SPSComputerClass​Base DNSServerList Semicolon-separated list of DNS addresses.
DomainName SPSComputerClass​AD Domain Relation to a domain if a match has been found in the Workspace Management database. It is also used in value of the DNSName attribute.
DomainName SPSComputerClass​Base WindowsDomainName  
HostPowerState SPSComputerClass​Base PowerState  
Version SPSComputerClass​OS Version  
Manufacturer SPSAssetClassBase ManufacturerName  
Model SPSAssetClassBase Model  
Model SPSComputerClass​Base MBModel  
CpuModel SPSComputerClass​Base Processor  
CpuSocketsNumber SPSComputerClass​Base ProcessorCount  
PhysicalThreads SPSComputerClass​Base ThreadsCount  
PhysicalCpuCores​Num SPSComputerClass​Base AmountProcessorCores  
CpuClockRate SPSComputerClass​Base ProcessorClock  
MemoryTotalGb SPSComputerClass​Base Memory Value is converted to megabytes.
VMKernelGateway SPSComputerClass​Base IPGateway  
AppManufacturer SPSComputerClass​OS Manufacturer  
AppName SPSComputerClass​OS Name  
SerialNumber SPSAssetClassBase SerialNumber  
  SPSComputerClass​Base Name HostName
  SPSComputerClass​Base DNSName HostName.DomainName
  SPSComputerClass​Base IpAddress Either IP address parsed from HostName or ManagementServerIp.
  SPSAssetClassBase ManagementType Set to "VirtualInventory" if a computer has been created by the virtual inventory.
  SPSComputerClass​Base VCenter Relation to a vCenter server retrieved from ScanedHostName.
  SPSCommonClass​Base State Computer state is set to "Active" unless another value is specified in the data provider configuration.
  SPSComputerClass​Base Host Relation to the current host machine that is set for all underlying virtual machines.
UUID SPSComputerClassBase VmWareUUID  
UUID(with changed Endianness) SPSAssetClassMobile UUID  
ManagementServerIp SPSComputerClassBase ManagementServerIp  
HostLicenseName SPSInventoryClassApplication Name Appropriate Fingerprint records are created with Detection Type = "vCenter Inventory"
HostLicensePublisher SPSInventoryClassApplication Publisher  
HostLicenseVersion SPSInventoryClassApplication Version  
MigrationHistory
​Items		 DestinationHost SPSComputerClass​HostHistory DestinationHost​Name  
DestinationHost SPSComputerClass​HostHistory DestinationHost Relation to a destination host machine.
FinishDate SPSComputerClass​HostHistory ScanDate  
VirtualMachines VmName SPSComputerClassBase VmName  
OSGuestSystem SPSComputerClassOS Name Operating system installed on the virtual machine as known by vCenter through VMware Tools (when installed on the guest OS).
GuestIp SPSComputerClass​Base IpAddress  
DnsName SPSComputerClass​Base DNSName  
PowerState SPSComputerClass​Base PowerState  
VmId SPSComputerClass​Base VirtualDeviceId  
ProcessorCount SPSComputerClass​Base ProcessorCount  
CoresPerSocket SPSComputerClass​Base AmountProcessorCores  
NumberOfLogicalProcessors SPSComputerClass​Base ThreadsCount  
MemoryAmountGB SPSComputerClass​Base Memory Value is converted to megabytes.
SerialNumber SPSAssetClassBase SerialNumber  
  SPSComputerClass​Base Name Value is retrieved from VmName or DnsName. Otherwise it is set to "Unknown".
  SPSComputerClass​Base IpAddress Value is retrieved from either VmName, DnsName or GuestIps.
  SPSComputerClass​Base Ipv6Address Value is retrieved from GuestIps.
  SPSComputerClass​AD Domain Relation to a domain if a match has been found in the Workspace Management database.
  SPSAssetClassBase ManagementType Set to "VirtualInventory" after a virtual machine has been created by the virtual inventory.
  SPSCommonClass​Base State Virtual machine state is set to "Active" unless another value is specified in the Data Provider configuration.
UUID SPSComputerClassBase VmWareUUID  
  UUID(with changed Endianness) SPSAssetClassMobile UUID  

Microsoft Hyper-V

XML Entity XML Element Data Definition Attribute Note
DataCenter
​Snapshot		 CurrentTime SPSComputerClass​Base LastScanDate  
ScanedHostName     Used in values of the Domain and VCenter
 attributes.
Cluster ClusterName SPSComputerClassBase ClusterName  
Host HostName     Used in values of the DNSName and IpAddress
attributes.
Hyperthreading​Active SPSComputerClass​Base Hyperthreading​Active  
VMHostId SPSComputerClass​Base DeviceId  
DnsAddress SPSComputerClass​Base DNSServerList Semicolon-separated list of DNS addresses.
DomainName SPSComputerClass​AD Domain Relation to a domain if a match has been found in the Workspace Management database. It is also used in value of the DNSName attribute.
DomainName SPSComputerClass​Base WindowsDomainName  
HostPowerState SPSComputerClass​Base PowerState  
Version SPSComputerClass​OS Version  
Manufacturer SPSAssetClassBase ManufacturerName  
Model SPSAssetClassBase Model  
Model SPSComputerClass​Base MBModel  
CpuModel SPSComputerClass​Base Processor  
CpuSocketsNumber SPSComputerClass​Base ProcessorCount  
PhysicalThreads SPSComputerClass​Base ThreadsCount  
PhysicalCpuCores​Num SPSComputerClass​Base AmountProcessorCores  
CpuClockRate SPSComputerClass​Base ProcessorClock  
MemoryTotalGb SPSComputerClass​Base Memory Value is converted to megabytes.
VMKernelGateway SPSComputerClass​Base IPGateway  
AppManufacturer SPSComputerClass​OS Manufacturer  
AppName SPSComputerClass​OS Name  
SerialNumber SPSAssetClassBase SerialNumber  
  SPSComputerClass​Base Name HostName
  SPSComputerClass​Base DNSName HostName.DomainName
  SPSComputerClass​Base IpAddress Either IP address parsed from HostName or ManagementServerIp.
  SPSAssetClassBase ManagementType Set to "VirtualInventory" if a computer has been created by the virtual inventory.
  SPSComputerClass​Base VCenter Relation to a host server retrieved from ScanedHostName.
  SPSCommonClass​Base State Computer state is set to "Active" unless another value is specified in the Data Provider configuration.
  SPSComputerClass​Base Host Relation to the current host machine that is set for all underlying virtual machines.
UUID SPSAssetClassMobile UUID  
MigrationHistory
​Items		 DestinationHost SPSComputerClass​HostHistory DestinationHost​Name  
DestinationHost SPSComputerClass​HostHistory DestinationHost Relation to a destination host machine.
FinishDate SPSComputerClass​HostHistory ScanDate  
VirtualMachines VmName SPSComputerClassBase VmName  
VmPowerState SPSComputerClass​Base PowerState  
GuestIps SPSComputerClass​Base    
DnsName SPSComputerClass​Base DNSName  
VmId SPSComputerClass​Base VirtualDeviceId  
ProcessorCount SPSComputerClass​Base ProcessorCount  
CoresPerSocket SPSComputerClass​Base AmountProcessorCores  
NumberOfLogicalProcessors SPSComputerClass​Base ThreadsCount  
MemoryAmountGB SPSComputerClass​Base Memory Value is converted to megabytes.
SerialNumber SPSAssetClassBase SerialNumber  
  SPSComputerClass​Base Name Value is retrieved from VmName or DnsName. Otherwise it is set to "Unknown".
  SPSComputerClass​Base IpAddress Value is retrieved from either VmName, DnsName or GuestIps.
  SPSComputerClass​Base Ipv6Address Value is retrieved from GuestIps.
  SPSComputerClass​AD Domain Relation to a domain if a match has been found in the Workspace Management database.
  SPSAssetClassBase ManagementType Set to "VirtualInventory" after a virtual machine has been created by the virtual inventory.
  SPSCommonClass​Base State Virtual machine state is set to "Active" unless another value is specified in the Data Provider configuration.
UUID  SPSAssetClassMobile UUID   

Citrix XenServer

API Object Property Data Definition Attribute Note
Host cpu_configuration["threads_per_core"] > 1 SPSComputerClass​Base HyperthreadingActive  
PIF DNS SPSComputerClass​Base DNSServerList  
Host_metrics get_live method SPSComputerClass​Base PowerState  
Host software_version["linux"] SPSComputerClass​OS Version
 		  
Host bios_strings["system-manufacturer"] SPSAssetClassBase ManufacturerName  
Host cpu_info["modelname"] SPSComputerClass​Base Processor  
Host cpu_info["socket_count"] SPSComputerClass​Base ProcessorCount  
Host cpu_configuration["threads_per_core"] SPSComputerClass​Base ThreadsCount Value provided is "per core".
Host cpu_info["cpu_count"] SPSComputerClass​Base AmountProcessorCores  
Host cpu_info["speed"] SPSComputerClass​Base ProcessorClock  
Host_metrics memory_total SPSComputerClass​Base Memory  
PIF gateway SPSComputerClass​Base IPGateway  
Host software_version["platform_name"] SPSComputerClass​OS Manufacturer Can be software_version["product_brand"]
Host software_version["platform_version"] SPSComputerClass​OS Name Can be software_version["product_version"]
Host bios_strings["system-serial-number"] SPSAssetClassBase SerialNumber  
VM vm_name SPSComputerClassBase VmName  
VM power_state SPSComputerClass​Base PowerState  
VM_guest_metrics platform["cores-per-socket"] SPSComputerClass​Base AmountProcessorCores  
VIF memory_dynamic_max SPSComputerClass​Base Memory  
VM bios_strings["system-serial-number"] SPSAssetClassBase SerialNumber By default Citrix XenServer does not provide BIOS serial numbers for its VMs, but they can be configured for XenServer 7.3 and later. For more information, refer to https://support.citrix.com/article/CTX230618 (external link).
VIF ipv4_addresses SPSComputerClass​Base IpAddress  
VIF ipv6_addresses SPSComputerClass​Base Ipv6Address  
Cluster name_label SPSComputerClassBase ClusterName  

Related Articles