Search
platform logo

Simplivity

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:

  • backups
  • cluster_groups
  • datastores
  • hosts
  • omnistack_clusters
  • policies
  • security/certificates
  • tasks
  • virtual_machines

backups

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Additional returned properties:
computeclusterparenthypervisorobject_id
X
X
X
X
X
X
X
X
X
X
computeclusterparent_name
X
X
X
X
X
X
X
X
X
X
consistency_type
X
X
X
X
X
X
X
X
X
X
X
hypervisor_type
X
X
X
X
X
X
X
X
X
sentcompletiontime
X
X
X
X
X
X
sent_duration
X
X
X
X
X
X
uniquesizebytes
X
X
X
X
X
X
X
X
X
X
uniquesizetimestamp
X
X
X
X
X
X
X
X
X
X
virtualmachinestate
X
X
X
X
X
X
X
X
X
X
X
X
virtualmachinetype
X
X
X
X
X
X
X
X
X
X
GET virtual_disks
X
X
X
X
X
GET virtualdiskpartitions
X
X
X
X
X
GET virtualdiskpartition_files
X
X
X
X
X
DELETE
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST calculateuniquesize
X
X
X
X
X
X
X
POST cancel
X
X
X
X
X
X
X
POST copy
X
X
X
X
X
X
X
X
X
X
X
X
X
POST delete
X
X
X
X
X
X
X
X
X
X
POST lock
X
X
X
X
X
X
X
X
X
X
X
X
X
POST rename
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST restore
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST restore_file
X
X
X
X
X
POST restore_files
X
X
X
X
X
POST set_retention
X
X
X
X
X
X
X
X
X
X
X

cluster_groups

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
POST rename
X
X
X

datastores

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Additional returned properties:
computeclusterparenthypervisorobject_id
X
X
X
X
X
X
X
X
X
X
computeclusterparent_name
X
X
X
X
X
X
X
X
X
X
hypervisormanagementsystem
X
X
X
X
X
X
X
X
hypervisormanagementsystem_name
X
X
X
X
X
X
hypervisorobjectid
X
X
X
X
X
X
X
X
X
X
X
X
X
hypervisor_type
X
X
X
X
X
X
X
X
X
DELETE
X
X
X
X
X
X
X
X
X
X
X
X
X
X
GET standard_hosts
X
X
X
X
X
X
POST
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST resize
X
X
X
X
X
X
X
X
X
X
X
X
X
POST set_policy
X
X
X
X
X
X
X
X
X
X
X
X
POST share
X
X
X
X
X
X
Post unshare
X
X
X
X
X
X

hosts

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Additional returned properties:
can_rollback
X
X
X
X
X
X
X
X
X
X
computeclusterhypervisorobjectid
X
X
X
X
X
X
X
X
X
X
X
X
computeclustername
X
X
X
X
X
X
X
X
X
X
X
X
computeclusterparenthypervisorobject_id
X
X
X
X
X
X
X
X
X
X
computeclusterparent_name
X
X
X
X
X
X
X
X
X
X
currentfeaturelevel
X
X
X
X
X
X
X
X
X
X
date
X
X
X
X
X
X
X
X
X
X
X
X
federation_ip
X
X
X
X
X
X
X
X
X
X
X
federation_mask
X
X
X
X
X
X
X
X
federation_mtu
X
X
X
X
X
X
X
X
hypervisormanagementsystem
X
X
X
X
X
X
hypervisormanagementsystem_name
X
X
X
X
X
X
infosight_configuration
X
X
X
life_remaining
X
X
X
X
X
X
X
X
X
X
X
management_mask
X
X
X
X
X
X
X
X
management_mtu
X
X
X
X
X
X
X
X
omnistackclusterid
X
X
X
X
X
policy_enabled
X
X
X
X
X
X
X
X
X
X
potentialfeaturelevel
X
X
X
X
X
X
X
X
X
X
storage_ip
X
X
X
X
X
X
X
X
X
X
X
storage_mask
X
X
X
X
X
X
X
X
storage_mtu
X
X
X
X
X
X
X
X
upgrade_state
X
X
X
X
X
X
X
X
X
X
virtualcontrollername
X
X
X
X
X
X
X
X
X
X
X
GET capacity
X
X
X
X
X
X
X
X
X
X
X
X
GET hardware
X
X
X
X
X
X
X
X
X
X
X
X
X
GET metrics
X
X
X
X
X
X
X
X
X
X
X
X
GET virtualcontrollershutdown_status
X
X
X
X
X
POST cancelvirtualcontroller_shutdown
X
X
X
X
X
POST removefromfederation
X
X
X
X
X
POST shutdownvirtualcontroller
X
X
X
X
X

omnistack_clusters

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Additional returned properties:
arbiter_address
X
X
X
X
X
X
X
X
X
X
X
X
X
arbiter_connected
X
X
X
X
X
X
X
X
X
X
X
X
X
clusterfeaturelevel
X
X
connected_cluster
X
X
X
X
X
hypervisormanagementsystem
X
X
X
X
X
X
X
X
hypervisormanagementsystem_name
X
X
X
X
X
X
hypervisorobjectid
X
X
X
X
X
X
X
X
X
X
X
X
hypervisorobjectparent_id
X
X
X
X
X
X
X
X
X
X
X
hypervisorobjectparent_name
X
X
X
X
X
X
X
X
X
X
X
hypervisor_type
X
X
X
X
X
X
X
X
X
infosight_configuration
X
X
X
time_zone
X
X
X
X
X
X
X
X
X
X
X
X
upgrade_state
X
X
X
X
X
X
X
X
X
X
X
upgradetaskid
X
X
X
X
X
X
X
X
X
X
X
version
X
X
X
X
X
X
X
X
X
X
GET connected_clusters
X
X
X
X
X
X
X
X
X
X
X
GET metrics
X
X
X
X
X
X
X
X
X
X
X
X
X
GET throughput
X
X
X
X
X
X
X
X
X
X
X
GET timezonelist
X
X
X
X
X
X
X
X
X
X
X
POST settimezone
X
X
X
X
X
X
X
X
X
X
X
X

policies

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
GET datastores
X
X
X
X
X
X
X
X
X
X
X
X
X
X
GET /policies/policyschedulereport
X
X
X
GET virtual_machines
X
X
X
X
X
X
X
X
X
X
X
X
X
X
DELETE
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST policies
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST rename
X
X
X
X
X
X
X
X
X
X
X
X
X
POST resume
X
X
X
X
X
X
X
X
X
X
POST rules
X
X
X
X
X
X
X
X
X
X
X
X
X (multiple rules)
X (one rule)
POST suspend
X
X
X
X
X
X
X
X
X
X
POST impactreport/createrules
X
X
X
X
X
POST impactreport/editrules
X
X
X
X
X
POST impactreport/deleterule
X
X
X
X
X
PUT rule
X
X
X
X
X
X
X
X
X
X
X
X
X
X

security/certificates

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
Additional returned properties:
hash
X
X
X
X
certificate
X
X
X
X
subject
X
X
X
X
issuer
X
X
X
X
serialno
X
X
X
X
DELETE
X
X
X
X
POST
X
X
X
X

tasks

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X

virtual_machines

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

Operation
1.13
1.12
1.11
1.10
1.9
1.8
1.7
1.6
1.5
1.4
1.3
1.2
1.1
1
GET
X
X
X
X
X
X
X
X
X
X
X
X
X
X
Additional returned properties:
adapter_type
X
X
X
X
X
X
appawarevm_status
X
X
X
X
X
X
X
X
X
X
X
computeclusterparenthypervisorobject_id
X
X
X
X
X
X
X
X
X
X
computeclusterparent_name
X
X
X
X
X
X
X
X
X
X
deleted_at
X
X
X
X
X
X
X
X
X
device_number
X
X
X
X
X
X
X
X
X
network_interfaces
X
X
X
X
X
X
network_label
X
X
X
X
X
X
haresynchronizationprogress
X
X
X
X
X
X
X
X
X
X
X
X
X
host_id
X
X
X
X
X
X
X
X
X
X
X
X
X
hypervisorallocatedcapacity
X
X
X
X
X
X
X
X
X
X
hypervisorallocatedcpu
X
X
X
X
X
X
hypervisorconsumedcpu
X
X
X
X
X
X
hypervisorconsumedmemory
X
X
X
X
X
X
hypervisorcpucount
X
X
X
X
X
X
X
X
X
X
hypervisorfreespace
X
X
X
X
X
X
X
X
X
X
hypervisorfoldername
X
X
X
X
X
X
hypervisoristemplate
X
X
X
X
X
X
X
X
X
X
hypervisormanagementsystem
X
X
X
X
X
X
X
hypervisormanagementsystem_name
X
X
X
X
X
X
hypervisortotalmemory
X
X
X
X
X
X
X
X
X
X
hypervisor_type
X
X
X
X
X
X
X
X
X
hypervisorvirtualdisk_count
X
X
X
X
X
X
X
X
X
X
hypervisorvirtualmachinepowerstate
X
X
X
X
X
X
X
X
X
X
X
X
modified_at
X
X
X
X
X
X
ipv4_addresses
X
X
X
X
X
X
mac_address
X
X
X
X
X
X
mac_generation
X
X
X
X
X
X
network_interfaces
X
X
X
X
X
X
replica_set
X
X
X
X
X
X
X
X
X
X
X
X
X
GET backups
X
X
X
X
X
X
X
X
X
X
X
X
X
X
GET metrics
X
X
X
X
X
X
X
X
X
X
X
X
X
POST backup
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST backup_parameters
X
X
X
X
X
X
POST clone
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST move
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST set_policy
X
X
X
X
X
X
X
X
X
X
X
X
X
X
POST validatebackupcredentials
X
X
X
X
X
X
POST policyimpactreport/apply_policy
X
X
X
X
X
POST power_off
X
X
X

Related Blogs

author logo
Roy Atkins

HPE SimpliVity PowerShell Module

May 16, 2019
author logo
Ron Dharma

Using Postman with HPE SimpliVity

Nov 9, 2018

HPE Developer Newsletter

Stay in the loop.

Sign up for the HPE Developer Newsletter or visit the Newsletter Archive to see past content.

By clicking on “Subscribe Now”, I agree to HPE sending me personalized email communication about HPE and select HPE-Partner products, services, offers and events. I understand that my email address will be used in accordance with HPE Privacy Statement. You may unsubscribe from receiving HPE and HPE-Partner news and offers at any time by clicking on the Unsubscribe button at the bottom of the newsletter.

For more information on how HPE manages, uses, and protects your personal data please refer to HPE Privacy Statement.