SimpliVity virtual_machines API
A virtual_machine represents a single virtual machine created within an HPE SimpliVity datastore.
OpenAPI Specification
swagger: '2.0'
info:
description: "This API enables the programmatic management of key components of an HPE SimpliVity configuration.\n\nTo access the API, request an authentication token by issuing an authentication request in the following form, where the username/password combination is a set of valid management credentials for the applicable hypervisor environment:\n\n curl -k https://simplivity@<host>/api/oauth/token -d grant_type=password -d username=<user> -d password=<pass>\n\nThen, you can pass in the resulting access_token returned in each HTTP header using Authorization: Bearer token. For example:\n\n curl -H \"Authorization: Bearer 0a08c809-17ff-479f-b0a8-aedd4d8305a0\"\n\nThe access_token times out after 10 minutes of inactivity and expires after 24 hours.\n\nMake sure to use TLS version 1.2 or greater.\n\nThere are a wide range of possible return values. Below is a list of the most common return values. \n\n 200 \"OK\" ⁃ This indicates that the request and action has completed with no issues.\n 201 \"Created\" ⁃ This indicates that the request has completed and a new resource has been created.\n 202 \"Accepted\" ⁃ This indicates that the request has been accepted for processing but the processing has not\n completed. This is a typical return when a task is generated.\n 400 \"Bad Request\" ⁃ The request cannot or will not be proccessed. Usually due to a missing required parameter\n or invalid data in the parameter.\n 401 \"Unauthorized\" ⁃ The request has not been applied because it lacks authentication credentials for the\n target resource.\n 404 \"Not Found\" ⁃ The requested target doesn't exist or has been deleted.\n 405 \"Method Not Allowed\" ⁃ The method being requested is not valid for the target it is being performed on.\n 408 \"Request Timeout\" ⁃ The response took too long.\n 500 \"Internal Server Error\" ⁃ Indicates that the server encountered an unexpected condition that prevented it\n from fulfilling the request.\n\n<a href=\"https://developer.hpe.com/platform/hpe-simplivity/home\" class=\"\toggleEndpointList\" data-id=\"errors\">Click here for a complete list of return codes and response formats</a>\n\n"
version: '1.25'
title: HPE OmniStack REST backups virtual_machines API
contact:
name: Hewlett Packard Enterprise
license:
name: HPE OmniStack REST API
host: localhost
basePath: ''
tags:
- name: virtual_machines
description: A virtual_machine represents a single virtual machine created within an HPE SimpliVity datastore.
paths:
/virtual_machines:
get:
tags:
- virtual_machines
summary: Retrieves instances of HPE SimpliVity virtual machines defined on this system
operationId: listVms
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: show_optional_fields
in: query
description: 'An indicator to show or not show the ha_status, ha_resynchronization_progress, hypervisor_virtual_machine_power_state, and hypervisor_is_template
Note: These values are computed from various sources. Consequently, the retrieval of these values may adversely affect the response time of a request.'
required: false
type: boolean
default: false
- name: id
in: query
description: 'The unique identifier (UID) of the virtual_machines to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: name
in: query
description: 'The name of the virtual_machines to return
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: omnistack_cluster_id
in: query
description: 'The unique identifier (UID) of the omnistack_cluster that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: omnistack_cluster_name
in: query
description: 'The name of the omnistack_cluster that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: compute_cluster_parent_hypervisor_object_id
in: query
description: 'The unique identifier (UID) of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: compute_cluster_parent_name
in: query
description: 'The name of the hypervisor-based instance that contains the omnistack_cluster that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: hypervisor_management_system
in: query
description: 'The IP address of the hypervisor-based instance associated with the virtual machine
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: hypervisor_management_system_name
in: query
description: 'The name of the hypervisor-based instance associated with the virtual machine
Accepts: Single value, comma-separated list, pattern using one or more asterisk characters as a wildcard'
required: false
type: string
- name: datastore_id
in: query
description: 'The unique identifier (UID) of the datastore that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: datastore_name
in: query
description: 'The name of the datastore that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: policy_id
in: query
description: 'The unique identifier (UID) of the policy that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: policy_name
in: query
description: 'The name of the policy that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: hypervisor_object_id
in: query
description: 'The unique identifier (UID) of the hypervisor-based instance that is associated with the instances to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: created_after
in: query
description: The earliest creation time after the virtual machines to return were created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
required: false
type: string
- name: created_before
in: query
description: The latest creation time before the virtual machines to return were created, expressed in ISO-8601 form, based on Coordinated Universal Time (UTC)
required: false
type: string
- name: state
in: query
description: 'The state of the virtual_machine that is associated with the instances to return
Accepts: Single value, comma-separated list
Valid values: ALIVE, REMOVED, DELETED
Default: ALIVE'
required: false
type: string
- name: app_aware_vm_status
in: query
description: 'The status of the ability of the virtual machine to take an application-consistent backup that uses Microsoft VSS
Accepts: Single value, comma-separated list'
required: false
type: string
- name: hypervisor_is_template
in: query
description: An indicator that shows if the virtual machine is a template
required: false
type: boolean
- name: host_id
in: query
description: The unique identifier (UID) of the virtual_machine host
required: false
type: string
- name: cluster_group_id
in: query
description: 'The unique identifiers (UIDs) of the cluster_groups associated with the virtual_machines to return
Accepts: Single value, comma-separated list'
required: false
type: string
- name: fields
in: query
description: "A comma-separated list of fields to include in the returned objects\n\n Default: Returns all fields"
required: false
type: string
- name: limit
in: query
description: 'A positive integer that represents the maximum number of results to return
Default: 500'
required: false
type: integer
default: 500
format: int32
- name: offset
in: query
description: 'A positive integer that directs the service to start returning the <offset value> instance, up to the limit
Default: 0'
required: false
type: integer
default: 0
format: int32
- name: case
in: query
description: 'An indicator that specifies if the filter and sort results use a case-sensitive or insensitive manner
Valid values: sensitive or insensitive
Default: sensitive'
required: false
type: string
default: sensitive
enum:
- sensitive
- insensitive
- name: sort
in: query
description: The name of the field where the sort occurs
required: false
type: string
- name: order
in: query
description: 'The sort order preference
Valid values: ascending or descending
Default: descending'
required: false
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/virtual_machine'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/policy_impact_report/apply_policy:
post:
tags:
- virtual_machines
summary: Generate a backup impact reported based on proposed application of a policy to one or more virtual machines
operationId: reportOnProposedVMPolicySetting
consumes:
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- in: body
name: backup policy and virtual machine information
description: 'policy_id: The unique identifier (UID) of the policy that you want to associate with the virtual_machine
virtual_machine_id: The unique identifier (UID) of each virtual_machine that you want to associate with the specified policy'
required: true
schema:
$ref: '#/definitions/vm_set_policy_vms'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/policy_schedule_impact_report'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/set_policy:
post:
tags:
- virtual_machines
summary: Sets the backup policy for virtual machines
operationId: setPolicyForVms
consumes:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- in: body
name: backup policy and virtual machine information
description: 'policy_id: The unique identifier (UID) of the policy that you want to associate with the virtual_machine
virtual_machine_id: The unique identifier (UID) of each virtual_machine that you want to associate with the specified policy'
required: true
schema:
$ref: '#/definitions/vm_set_policy_vms'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TaskMO'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/{vmId}:
get:
tags:
- virtual_machines
summary: Retrieves the specified virtual_machines
operationId: getVm
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: vmId
in: path
description: The unique identifier (UID) of the virtual_machine that you want to retrieve
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/virtual_machine'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/{vmId}/backup:
post:
tags:
- virtual_machines
summary: Backs up a virtual machine
operationId: backupVm
consumes:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: vmId
in: path
description: The unique identifier (UID) of the virtual_machine you want to access
required: true
type: string
- in: body
name: new backup information
description: 'app_consistent: An indicator to show if the backup represents a snapshot of a virtual machine with data that was first flushed to disk
Default: false
backup_name: The name of the new backup created from this action
consistency_type: The consistency type of the backup
Default: NONE
destination_id: The unique identifier (UID) of the omnistack_cluster that stores the new backup
Default: local omnistack_cluster
retention: The number of minutes to keep backups
Default: 0 (indicates that the backup never expires)
external_store_name: The name of the external_store'
required: true
schema:
$ref: '#/definitions/BackupVMMO'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TaskMO'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/{vmId}/backup_parameters:
post:
tags:
- virtual_machines
summary: Set the virtual machine backup parameters used for application consistent backups.
operationId: setBackupParams
consumes:
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: vmId
in: path
description: The unique identifier (UID) of the virtual_machine you want to access
required: true
type: string
- in: body
name: virtual_machine backup parameters
description: "guest_username: The user name of the virtual machine\n\nguest_password: The password of the virtual machine\n\noverride_guest_validation: Set to true to disable virtual machine validation logic.\n\napp_aware_type: Set the application aware backup type: \nVSS - Application-consistent backup using Microsoft VSS, \nDEFAULT - Crash-consistent backup, \nNONE - Application-consistent backup using a VMware snapshot."
required: true
schema:
$ref: '#/definitions/backup_parameters'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/TaskMO'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/virtual_machines/{vmId}/backups:
get:
tags:
- virtual_machines
summary: Retrieves all backups associated with this virtual_machine
description: Deprecated as of version 1.4. Instead use GET /api/backups?virtual_machine_id={vmId}
operationId: listVMBackups
consumes:
- application/json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: vmId
in: path
description: The unique identifier (UID) of the virtual_machine that you want to retrieve
required: true
type: string
responses:
'200':
description: OK
schema:
$ref: '#/definitions/BackupMO'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
deprecated: true
/virtual_machines/{vmId}/clone:
post:
tags:
- virtual_machines
summary: Clones a virtual machine
operationId: cloneVm
consumes:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
produces:
- application/vnd.simplivity.v1.23+json
- application/vnd.simplivity.v1.9+json
- application/vnd.simplivity.v1.18+json
- application/vnd.simplivity.v1.14+json
- application/vnd.simplivity.v1.11+json
- application/vnd.simplivity.v1.17+json
- application/vnd.simplivity.v1.21+json
- application/vnd.simplivity.v1.22+json
- application/vnd.simplivity.v1.3+json
- application/vnd.simplivity.v1.10+json
- application/vnd.simplivity.v1.6+json
- application/vnd.simplivity.v1.25+json
- application/vnd.simplivity.v1.19+json
- application/json
- application/vnd.simplivity.v1.5+json
- application/vnd.simplivity.v1.13+json
- application/vnd.simplivity.v1.16+json
- application/vnd.simplivity.v1.2+json
- application/vnd.simplivity.v1.24+json
- application/vnd.simplivity.v1.7+json
- application/vnd.simplivity.v1.4+json
- application/vnd.simplivity.v1.1+json
- application/vnd.simplivity.v1+json
- application/vnd.simplivity.v1.8+json
- application/vnd.simplivity.v1.15+json
- application/vnd.simplivity.v1.12+json
- application/vnd.simplivity.v1.20+json
parameters:
- name: vmId
in: path
description: The unique identifier (UID) of the virtual_machine you want to access
required: true
type: string
- in: body
name: virtual_machine cloning information
description: 'virtual_machine_name: The name of the virtual_machine created from this action
app_consistent: An indicator to show if the backup represents a snapshot of a virtual machine with data that was first flushed to disk
Default: false
consistency_type: The type of backup used for the clone method (DEFAULT [crash-consistent], VSS [application-consistent using VSS], or NONE [application-consistent using a snapshot]).
NOTE: If the consistency_type and app_consistent values are both set, the
# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/simplivity/refs/heads/main/openapi/simplivity-virtual-machines-api-openapi.yml