Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


1.3.25 Members of a hypervisor

This section explains the Members of a hypervisor (Hypervisors 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 Name of the hypervisor N Y Y
ipAddress string IP address of the hypervisor N N N
status enum Status of the hypervisor. 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 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
description string Detailed information about the hypervisor N Y Y
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 Name of the cluster where the hypervisor is registered N Y Y
clusterStatus enum Status of the cluster to which the hypervisor belongs. 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
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
hypervisorType string Type of the hypervisor.
  • SERVER_ESX: ESX server
  • SERVER_HYPERV: Hyper-V server
  • GENERIC_HYPERVISOR: Hypervisor defined by plug-in
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
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
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
groupIDs long[] ID of the consumer assigned to the hypervisor N N N
groupNames string[] Name of the consumer assigned to the hypervisor N N N
gradeNames string[] Name of the grade of the consumer assigned to the hypervisor N N N
gradeOrders integer[] Priority of the grade of the consumer assigned to the hypervisor N N N
pluginId string ID for the plug-in applied to the hypervisor N Y Y

(Legend) Y: Applicable, N: Not applicable