System data mapping

This page describes how data retrieved from the source service is mapped into records generated by the connector.

For each record type, the following information is reported:

• the property name exposed by the connector;
• the path from which the value is obtained in the source service;
• any additional note regarding transformations, enrichments or special behaviours.

Each record mapping section is titled {Source Object Name} ({_type}), combining the object name used by the source service with the internal record type produced by the connector.

Common properties

The following property is present in all the records extracted by the connector, except the calculated ones:

Property name	Source path	Notes
_infrastructure	/	The Code of the vCenter instance being read

Notes

• Source paths of the managed objects refer to the properties retrieved with the SOAP RetrievePropertiesEx call (see the developer documentation).
• Sizes and capacities are converted from bytes (or MB for the memory of virtual machines) to GB and rounded; a value equal to 0 is left empty.
• Dates are formatted as yyyy-MM-dd'T'HH:mm:ssX.
• Properties flagged as Record Id contain the identifier of the related record. When the property is a list, the identifiers are separated by a space.

Managed objects common properties

The following properties are present in all the records of the managed objects (datacenter, folder, cluster, physicalserver, virtualserver, datastore, network, switch):

Property name	Source path	Notes
id	/	The managed object reference value of the object (obj tag in the response)
name	name
vim_class	/	The name of the vSphere class of the object (for example ClusterComputeResource or VmfsDatastoreInfo)
parent	parent	Record Id of the parent object
custom_attributes	availableField, value	Combined information of availableField and value, as name and value of each custom attribute
tags	/	Obtained from the tag associations read through the REST API. List of Record Id of the related tag

vCenter instance (infrastructure)

The vCenter instance being read, generated once for each execution.

Property name	Source path	Notes
url	/	The Host of the instance configuration
name	/	The Code of the instance configuration
key	/	The Code of the instance configuration

Inventory

Datacenter (datacenter)

A datacenter of the vCenter inventory.

No additional properties.

Folder (folder)

A folder of the vCenter inventory.

No additional properties.

ComputeResource / ClusterComputeResource (cluster)

A cluster, or a standalone compute resource.

Property name	Source path	Notes
cluster_type	/	Cluster if vim_class is ClusterComputeResource, else Single
effective_cpu	summary/effectiveCpu	Converted in GHz
effective_memory	summary/effectiveMemory	Converted in GB
total_cpu	summary/totalCpu	Converted in GHz
total_memory	summary/totalMemory	Converted in GB
overall_status	summary/overallStatus	The following mapping is used: green -> Ok, red -> Not ok, yellow -> Problems, gray -> Unknown
num_cpu_cores	summary/numCpuCores
datastores	datastore	List of Record Id of the datastore
datacenter	/	The datacenter containing this object, found going up the parent hierarchy (up to 32 levels). Record Id. Not calculated if the Skip datacenter calculation configuration is set

HostSystem (physicalserver)

A physical host (ESXi) managed by the vCenter.

Property name	Source path	Notes
cluster	/	The cluster whose host list contains this host. Record Id of the cluster
cluster_name	/	The name of the cluster
vm_count	vm	Number of elements of the array
uuid	hardware/systemInfo/uuid
serial_number	hardware/systemInfo/otherIdentifyingInfo	The identifierValue of the element of the array with identifierType/key = ServiceTag
cpu_core_number	hardware/cpuInfo/numCpuCores
cpu_threads	hardware/cpuInfo/numCpuThreads
cpu_sockets	hardware/cpuInfo/numCpuPackages
cpu_speed	hardware/cpuInfo/hz	Converted in GHz
cpu_pkg	hardware/cpuPkg	The description of the first element that is not null
memory_size	hardware/memorySize	Converted in GB
vendor	hardware/systemInfo/vendor
model	hardware/systemInfo/model
bios_vendor	hardware/biosInfo/vendor
bios_version	hardware/biosInfo/biosVersion
firmware_major_release	hardware/biosInfo/firmwareMajorRelease
firmware_minor_release	hardware/biosInfo/firmwareMinorRelease
power_state	runtime/powerState	The following mapping is used: poweredOff -> PoweredOff, poweredOn -> PoweredOn, standBy -> Standby, unknown -> Unknown
in_maintenance_mode	runtime/inMaintenanceMode
connection_state	runtime/connectionState	The following mapping is used: connected -> Connected, disconnected -> Disconnected, notResponding -> NotResponding
boot_time	runtime/bootTime
license_product_name	config/product/licenseProductName
os_type	config/product/osType
os_name	config/product/name
os_version	config/product/version
os_full_name	config/product/fullName
datastores	datastore	List of Record Id of the datastore
hd_size	datastore	Sum of the capacity of all datastores, in GB
datacenter	/	Same as for cluster

The physical network interfaces (config/network/pnic) and the virtual network interfaces (config/network/vnic) of the host are extracted as pnetworkinterface and hostvnetworkinterface records.

VirtualMachine (virtualserver)

A virtual machine, including templates and placeholder virtual machines.

Property name	Source path	Notes
host	runtime/host	Record Id of the physicalserver
cluster	runtime/host	The cluster whose host list contains the host of the virtual machine. Record Id of the cluster
cluster_name	runtime/host	The name of the cluster
boot_time	runtime/bootTime
power_state	runtime/powerState	The following mapping is used: poweredOff -> PoweredOff, poweredOn -> PoweredOn, suspended -> Standby
tools_status	guest/toolsRunningStatus
fqdn	guest/hostName	Corresponds to the DNS Name seen on the page of the machine
guest_full_name	guest/guestFullName	If null, config/guestFullName is used
guest_family	guest/guestFamily
ip_address	guest/ipAddress
uuid	config/instanceUuid
smbios_uuid	config/uuid
modified	config/modified
notes	config/annotation
is_template	config/template
is_placeholder	config/managedBy	true if managedBy/type = placeholderVm, else false
num_cpu	config/hardware/numCPU
num_cores_per_socket	config/hardware/numCoresPerSocket
memory_gb	config/hardware/memoryMB	Converted in GB
create_date	config/createDate
provisioned_space	summary/storage	Sum of committed and uncommitted, converted in GB
used_space	summary/storage/committed	Converted in GB
datastores	datastore	List of Record Id of the datastore
toolsRunningStatus	tools_status	Added in the preprocessing: Running if tools_status is guestToolsRunning or guestToolsExecutingScripts, NotRunning if guestToolsNotRunning
datacenter	/	Same as for cluster

The network interfaces (guest/net) and the disks (config/hardware/device) of the virtual machine are extracted as vnetworkinterface and vdisk records.

Storage

Datastore (datastore)

A datastore.

Property name	Source path	Notes
datastore_type	summary/type
capacity	summary/capacity	Converted in GB
free_space	summary/freeSpace	Converted in GB
url	summary/url

For datastores of vim_class VmfsDatastoreInfo, the list info/vmfs/extent is extracted as vmfsdisk records.

HostScsiDiskPartition (vmfsdisk)

A disk partition (extent) of a VMFS datastore.

Property name	Source path	Notes
datastore	/	Record Id of the containing datastore
name	diskName
partition	partition

VirtualDevice (vdisk)

A virtual disk of a virtual machine. Only the devices that are disks are extracted.

Property name	Source path	Notes
vm	/	Record Id of the virtualserver containing this object
is_template	/	Copied from the same property of the virtual machine containing this object
is_placeholder	/	Copied from the same property of the virtual machine containing this object
label	deviceInfo/label
capacity	capacityInBytes	Converted in GB
uuid	backing/uuid
file_name	backing/fileName
datastore	backing/datastore	Record Id of the datastore

Network

Network / DistributedVirtualPortgroup (network)

A standard network or a distributed port group.

Property name	Source path	Notes
hosts	host	List of Record Id of the physicalserver
vms	vm	List of Record Id of the virtualserver
network_type	/	Distributed if vim_class is DistributedVirtualPortgroup, else Standard
vlan	config/defaultPortConfig/vlan	Only if the record is of vim_class DistributedVirtualPortgroup
switch	config/distributedVirtualSwitch	Only if the record is of vim_class DistributedVirtualPortgroup. Record Id of the switch

DistributedVirtualSwitch (switch)

A distributed virtual switch.

Property name	Source path	Notes
uuid	summary/uuid
num_ports	summary/numPorts

PhysicalNic (pnetworkinterface)

A physical network interface of a host.

Property name	Source path	Notes
host	/	Record Id of the containing physicalserver
device	device
key	key
mac	mac
link_speed	linkSpeed/speedMb
driver	driver

HostVirtualNic (hostvnetworkinterface)

A virtual network interface (VMkernel adapter) of a host.

Property name	Source path	Notes
host	/	Record Id of the containing physicalserver
device	device
key	key
port	port
dhcp	spec/ip/dhcp
ip	spec/ip/ipAddress
subnet_mask	spec/ip/subnetMask
mac	spec/mac

GuestNicInfo (vnetworkinterface)

A network interface of a virtual machine. Only the virtual machines for which guest information and configuration are available are considered.

Property name	Source path	Notes
vm	/	Record Id of the virtualserver containing this object
is_template	/	Copied from the same property of the virtual machine containing this object
is_placeholder	/	Copied from the same property of the virtual machine containing this object
mac	macAddress
connected	connected
network_name	network
ipv4_addresses	ipConfig/ipAddress	Join of the distinct IPv4 addresses found, separated by space
ipv6_addresses	ipConfig/ipAddress	Join of the distinct IPv6 addresses found, separated by space
ip	ipConfig/ipAddress	The first IPv4 address
label	device/deviceInfo/label	The device is the virtual device of the virtual machine whose key matches deviceConfigId
portgroup_key	device/backing/port/portgroupKey	Same device as above

Tags

Tags are read only if the REST API of the vCenter is available (vCenter 6.5 and later).

TagCategory (tagcategory)

A tag category.

Property name	Source path	Notes
id	id
name	name
associable_types	associable_types
description	description
used_by	used_by
cardinality	cardinality

Tag (tag)

A tag.

Property name	Source path	Notes
id	id
name	name
category	category_id	Record Id of the tagcategory
description	description
used_by	used_by

Calculated records

The following records are not read from the vCenter: they are generated in the preprocessing of the reader, starting from other records. All of them contain the sourceId property, with the identifier of the instance configuration being read.

IP (ip)

Calculated record, generated for each IPv4 address of the ipv4_addresses of a vnetworkinterface. It is generated only if the virtual machine is neither a template nor a placeholder.

Property name	Source path	Notes
name	vnetworkinterface.label	Value of label prefixed with IP-
ipv4_address	vnetworkinterface.ipv4_addresses	One of the addresses
vnic	/	Record Id of the vnetworkinterface
mac	vnetworkinterface.vnic_mac

Cluster datastore relation (cluster_datastore_rel)

Calculated record, generated for each element of the datastores list of a cluster.

Property name	Source path	Notes
cluster	/	Record Id of the cluster
datastore	cluster.datastores	Record Id of the datastore

Host datastore relation (host_datastore_rel)

Calculated record, generated for each element of the datastores list of a physicalserver.

Property name	Source path	Notes
host	/	Record Id of the physicalserver
datastore	physicalserver.datastores	Record Id of the datastore

Virtual machine datastore relation (vm_datastore_rel)

Calculated record, generated for each element of the datastores list of a virtualserver.

Property name	Source path	Notes
vm	/	Record Id of the virtualserver
templateOrPlaceholderVm	virtualserver.is_template, virtualserver.is_placeholder	true if the virtual machine is a template or a placeholder
datastore	virtualserver.datastores	Record Id of the datastore

Tag association (tag_association)

Calculated record, generated for each element of the tags list of any record.

Property name	Source path	Notes
tag	tags	Record Id of the tag
record	/	Record Id of the tagged record
templateOrPlaceholderVm	virtualserver.is_template, virtualserver.is_placeholder	true only for a virtualserver that is a template or a placeholder