HPE Developer Community Portal

Feature and function support by REST API version

The tables in this section list the features and functions that each version of the REST API supports for the following object types:

  • backup
  • security/certificates
  • datastore
  • host
  • omnistack_cluster
  • policy
  • task
  • virtual_machine

backup

The REST API supports the following features and functions for the backup object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
Additional returned properties:
compute_cluster_parent_hypervisor_object_idXXXXXXXXX
compute_cluster_parent_nameXXXXXXXXX
consistency_typeXXXXXXXXXX
hypervisor_typeXXXXXXXX
sent_completion_timeXXXXX
sent_durationXXXXX
unique_size_bytesXXXXXXXXX
unique_size_timestampXXXXXXXXX
virtual_machine_stateXXXXXXXXXXX
virtual_machine_typeXXXXXXXXX
GET virtual_disksXXXX
GET virtual_disk_partitionsXXXX
GET virtual_disk_partition_filesXXXX
DELETEXXXXXXXXXXXXX
POST calculate_unique_sizeXXXXXX
POST cancelXXXXXX
POST copyXXXXXXXXXXXX
POST deleteXXXXXXXXX
POST lockXXXXXXXXXXXX
POST renameXXXXXXXXXXXXX
POST restoreXXXXXXXXXXXXX
POST restore_fileXXXX
POST restore_filesXXXX
POST set_retentionXXXXXXXXXX

security/certificates

The REST API supports the following features and functions for the certificates object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXX
Additional returned properties:
hashXXX
certificateXXX
subjectXXX
issuerXXX
serialnoXXX
DELETEXXX
POSTXXX

cluster_groups

The REST API supports the following features and functions for the cluster_groups object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETX
POST renameX

datastore

The REST API supports the following features and functions for the datastore object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
Additional returned properties:
compute_cluster_parent_hypervisor_object_idXXXXXXXXX
compute_cluster_parent_nameXXXXXXXXX
hypervisor_management_systemXXXXXXXXX
hypervisor_management_system_nameXXXXX
hypervisor_object_idXXXXXXXXXXXXX
hypervisor_typeXXXXXXXX
DELETEXXXXXXXXXXXXX
GET standard_hostsXXXXX
POSTXXXXXXXXXXXXX
POST resizeXXXXXXXXXXXX
POST set_policyXXXXXXXXXXX
POST shareXXXXX
Post unshareXXXXX

host

The REST API supports the following features and functions for the host object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
Additional returned properties:
can_rollbackXXXXXXXXX
compute_cluster_hypervisor_object_idXXXXXXXXXXX
compute_cluster_nameXXXXXXXXXXX
compute_cluster_parent_hypervisor_object_idXXXXXXXXX
compute_cluster_parent_nameXXXXXXXXX
current_feature_levelXXXXXXXXX
dateXXXXXXXXXXX
federation_ipXXXXXXXXXX
federation_maskXXXXXXX
federation_mtuXXXXXXX
hypervisor_management_systemXXXXX
hypervisor_management_system_nameXXXXX
infosight_configurationXX
life_remainingXXXXXXXXXX
management_maskXXXXXXX
management_mtuXXXXXXX
omnistack_cluster_idXXXX
policy_enabledXXXXXXXXX
potential_feature_levelXXXXXXXXX
storage_ipXXXXXXXXXX
storage_maskXXXXXXX
storage_maskXXXXXXX
upgrade_stateXXXXXXXXX
virtual_controller_nameXXXXXXXXXX
GET capacityXXXXXXXXXXX
GET hardwareXXXXXXXXXXXX
GET metricsXXXXXXXXXXX
GET virtual_controller_shutdown_statusXXXX
POST cancel_virtual_controller_shutdownXXXX
POST remove_from_federationXXXX
POST shutdown_virtual_controllerXXXX

omnistack_cluster

The REST API supports the following features and functions for the omnistack_cluster object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
Additional returned properties:
arbiter_addressXXXXXXXXXXXX
arbiter_connectedXXXXXXXXXXXX
cluster_feature_levelX
connected_clusterXXXX
hypervisor_management_systemXXXXXXX
hypervisor_management_system_nameXXXXX
hypervisor_object_idXXXXXXXXXXX
hypervisor_object_parent_idXXXXXXXXXX
hypervisor_object_parent_nameXXXXXXXXXX
hypervisor_typeXXXXXXXX
infosight_configurationXX
time_zoneXXXXXXXXXXX
upgrade_stateXXXXXXXXXX
upgrade_task_idXXXXXXXXXX
versionXXXXXXXXX
GET connected_clustersXXXXXXXXXX
GET metricsXXXXXXXXXXXX
GET throughputXXXXXXXXXX
GET time_zone_listXXXXXXXXXX
POST set_time_zoneXXXXXXXXXX

policy

The REST API supports the following features and functions for the policy object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
GET datastoresXXXXXXXXXX
GET virtual_machinesXXXXXXXXXX
DELETEXXXXXXXXXXXXX
POST policiesXXXXXXXXXXXXX
POST renameXXXXXXXXXXXX
POST resumeXXXXXXXXX
POST rulesX (one rule)X (multiple rules)XXXXXXXXXXX
POST suspendXXXXXXXXX
POST impact_report/create_rulesXXXX
POST impact_report/edit_rulesXXXX
POST impact_report/delete_ruleXXXX
PUT ruleXXXXXXXXXXXXX

task

The REST API supports the following features and functions for the task object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX

virtual_machine

The REST API supports the following features and functions for the virtual_machine object type:

Operation11.11.21.31.41.51.61.71.81.91.101.111.12
GETXXXXXXXXXXXXX
Additional returned properties:
adapter_type
app_aware_vm_statusXXXXXXXXXX
compute_cluster_parent_hypervisor_object_idXXXXXXXXX
compute_cluster_parent_nameXXXXXXXXX
device_numberXXXXXXXX
network_interfacesXXXXX
network_labelXXXXX
ha_resynchronization_progressXXXXXXXXXXXX
host_idXXXXXXXXXXXX
hypervisor_allocated_capacityXXXXXXXXX
hypervisor_allocated_cpuXXXXX
hypervisor_consumed_cpuXXXXX
hypervisor_consumed_memoryXXXXX
hypervisor_cpu_countXXXXXXXXX
hypervisor_free_spaceXXXXXXXXX
hypervisor_folder_nameXXXXX
hypervisor_is_templateXXXXXXXXX
hypervisor_management_systemXXXXXX
hypervisor_management_system_nameXXXXX
hypervisor_total_memoryXXXXXXXXX
hypervisor_typeXXXXXXXX
hypervisor_virtual_disk_countXXXXXXXXX
hypervisor_virtual_machine_power_stateXXXXXXXXXXX
modified_atXXXXX
ipv4_addressesXXXXX
mac_addressXXXXX
mac_generationXXXXX
network_interfacesXXXXX
replica_setXXXXXXXXXXXX
GET backupsXXXXXXXXXX
GET metricsXXXXXXXXXXXX
POST backupXXXXXXXXXXXXX
POST backup_parametersXXXXX
POST cloneXXXXXXXXXXXXX
POST moveXXXXXXXXXXXXX
POST set_policyXXXXXXXXXXXXX
POST validate_backup_credentialsXXXXX
POST policy_impact_report/apply_policyXXXX

Blog feed