1.3.26 Members of a virtual machine

This section explains the Members of a virtual machine (VirtualMachines resource).

Member name	Data type	Description	Whether to change	Whether applicable to filter conditions ($query)	Whether applicable to sort conditions ($order-by)
instanceID	long	ID for identifying instances	N	Y	Y
name	string	Virtual machine name	N	Y	Y
ipAddress	string	IP address of the virtual machine	N	N	N
status	enum	Status of the virtual machine. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.	N	Y (only to eq, ne, in, not in)	N
monitorStatus	enum	Monitoring status of the virtual machine. For details about the specifiable values, see the table ComponentMonitorType in 1.6 List of enumerators.	N	Y (only to eq, ne, in, not in)	N
description	string	Detailed information about the virtual machine	N	Y	Y
componentType	enum	Type of the virtual machine. For details about the specifiable values, see the table ComponentType in 1.6 List of enumerators. The specifiable values are as follows: VIRTUAL_MACHINE GENERIC_VIRTUALMACHINE	N	Y (only to eq, ne, in, not in)	N
collectorID	long	ID for identifying a collector used for detection	N	N	N
collectorName	string	Name of a collector used for detection	N	N	N
autoCollectionType	enum	Settings for periodic executions of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.	N	N	N
clusterName	string	Cluster environment where the virtual machine is registered	N	Y	Y
hypervisorType	enum	Type of hypervisor to which the virtual machine belongs. For details about the specifiable values, see the table ArgusNodeType in 1.6 List of enumerators. The specifiable values are as follows: SERVER_ESX SERVER_HYPERV GENERIC_HYPERVISOR	N	Y (only to eq, ne, in, not in)	N
hypervisorDetailType	string	Type of the hypervisor that is defined by using the plug-in.	N	N	N
hypervisorID	long	ID for identifying the hypervisor to which the virtual machine belongs	N	Y	Y
hypervisorName	string	Name of the hypervisor to which the virtual machine belongs	N	Y	Y
hypervisorMonitorStatus	enum	Monitoring status of the hypervisor. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.	N	Y (only to eq, ne, in, not in)	N
hostName	string	Name of a host running on the virtual machine	N	Y	Y
thresholdProfileID	long	ID for identifying the assigned profile	N	N	N
thresholdProfileName	string	Name of the assigned profile	N	N	N
originalThresholdProfileID	string	ID for identifying the original profile of the assigned profile	N	N	N
groupIDs	long[]	ID for identifying the assigned consumer	N	N	N
groupNames	integer[]	Name of the assigned consumer	N	N	N
gradeNames	string[]	Name of the grade of the consumer assigned to the virtual machine	N	N	N
gradeOrders	integer[]	Priority of the grade of the consumer assigned to the virtual machine	N	N	N
usedCredentialID	long	ID for identifying authentication information used for detection	N	N	N
usedCredentials	string	Name of authentication information used for detection	N	N	N
accessPointType	enum	Type of the protocol or collector for authentication information used for detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators. The specifiable values are as follows: WMI SNMP VCENTER	N	N	N
accessPointSnmpVersion	enum	SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.	N	N	N
accessPointIpAddress	string	IP address or host name used for connections to monitoring targets or management software	N	N	N
accessPointUser	string	User ID used for connections to monitoring targets or management software	N	N	N
pluginId	string	ID for the plug-in applied to the hypervisor that the virtual machine belongs to.	N	Y	Y

(Legend) Y: Applicable, N: Not applicable

To Page Top