Red Hat SummitEste contenido no está disponible en el idioma seleccionado.
Chapter 6. Services
This section enumerates all the services that are available in the API.
6.1. AffinityGroup
This service manages a single affinity group.
| Name | Summary |
|---|---|
|
| Retrieve the affinity group details. |
|
| Remove the affinity group. |
|
| Update the affinity group. |
6.1.1. get GET
Retrieve the affinity group details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The affinity group. |
6.1.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.1.2. remove DELETE
Remove the affinity group.
DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456
DELETE /ovirt-engine/api/clusters/000-000/affinitygroups/123-456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.1.3. update PUT
Update the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The affinity group. |
6.2. AffinityGroupHost
This service manages a single host to affinity group assignment.
| Name | Summary |
|---|---|
|
| Remove host from the affinity group. |
6.2.1. remove DELETE
Remove host from the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.3. AffinityGroupHostLabel
This service manages a single host label assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Remove this label from the affinity group. |
6.3.1. remove DELETE
Remove this label from the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.4. AffinityGroupHostLabels
This service manages a collection of all host labels assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Adds a host label to the affinity group. |
|
| List all host labels assigned to this affinity group. |
6.4.1. add POST
Adds a host label to the affinity group.
For example, to add the label 789 to the affinity group 456 of cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabels
POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostlabelsWith the following body:
<affinity_label id="789"/>
<affinity_label id="789"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The AffinityLabel object to add to the affinity group. |
6.4.2. list GET
List all host labels assigned to this affinity group.
The order of the returned labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Host labels assigned to the affinity group. | |
|
| In | Sets the maximum number of host labels to return. |
6.4.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.4.2.2. max
Sets the maximum number of host labels to return. If not specified, all the labels are returned.
6.5. AffinityGroupHosts
This service manages a collection of all hosts assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Adds a host to the affinity group. |
|
| List all hosts assigned to this affinity group. |
6.5.1. add POST
Adds a host to the affinity group.
For example, to add the host 789 to the affinity group 456 of cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/affinitygroups/456/hosts
POST /ovirt-engine/api/clusters/123/affinitygroups/456/hostsWith the following body:
<host id="789"/>
<host id="789"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The host to be added to the affinity group. |
6.5.2. list GET
List all hosts assigned to this affinity group.
The order of the returned hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of hosts assigned to this affinity group. | |
|
| In | Sets the maximum number of hosts to return. |
6.5.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.5.2.2. max
Sets the maximum number of hosts to return. If not specified, all the hosts are returned.
6.6. AffinityGroupVm
This service manages a single virtual machine to affinity group assignment.
| Name | Summary |
|---|---|
|
| Remove this virtual machine from the affinity group. |
6.6.1. remove DELETE
Remove this virtual machine from the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.7. AffinityGroupVmLabel
This service manages a single virtual machine label assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Remove this label from the affinity group. |
6.7.1. remove DELETE
Remove this label from the affinity group.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.8. AffinityGroupVmLabels
This service manages a collection of all virtual machine labels assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Adds a virtual machine label to the affinity group. |
|
| List all virtual machine labels assigned to this affinity group. |
6.8.1. add POST
Adds a virtual machine label to the affinity group.
For example, to add the label 789 to the affinity group 456 of cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabels
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmlabelsWith the following body:
<affinity_label id="789"/>
<affinity_label id="789"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The AffinityLabel object to add to the affinity group. |
6.8.2. list GET
List all virtual machine labels assigned to this affinity group.
The order of the returned labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Virtual machine labels assigned to the affinity group. | |
|
| In | Sets the maximum number of virtual machine labels to return. |
6.8.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.8.2.2. max
Sets the maximum number of virtual machine labels to return. If not specified, all the labels are returned.
6.9. AffinityGroupVms
This service manages a collection of all the virtual machines assigned to an affinity group.
| Name | Summary |
|---|---|
|
| Adds a virtual machine to the affinity group. |
|
| List all virtual machines assigned to this affinity group. |
6.9.1. add POST
Adds a virtual machine to the affinity group.
For example, to add the virtual machine 789 to the affinity group 456 of cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vms
POST /ovirt-engine/api/clusters/123/affinitygroups/456/vmsWith the following body:
<vm id="789"/>
<vm id="789"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.9.2. list GET
List all virtual machines assigned to this affinity group.
The order of the returned virtual machines isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of virtual machines to return. | |
|
| Vm[] | Out |
6.9.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.9.2.2. max
Sets the maximum number of virtual machines to return. If not specified, all the virtual machines are returned.
6.10. AffinityGroups
The affinity groups service manages virtual machine relationships and dependencies.
| Name | Summary |
|---|---|
|
| Create a new affinity group. |
|
| List existing affinity groups. |
6.10.1. add POST
Create a new affinity group.
Post a request like in the example below to create a new affinity group:
POST /ovirt-engine/api/clusters/000-000/affinitygroups
POST /ovirt-engine/api/clusters/000-000/affinitygroupsAnd use the following example in its body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The affinity group object to create. |
6.10.2. list GET
List existing affinity groups.
The order of the affinity groups results isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of existing affinity groups. | |
|
| In | Sets the maximum number of affinity groups to return. |
6.10.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.10.2.2. max
Sets the maximum number of affinity groups to return. If not specified all the affinity groups are returned.
6.11. AffinityLabel
The details of a single affinity label.
| Name | Summary |
|---|---|
|
| Retrieves the details of a label. |
|
| Removes a label from the system and clears all assignments of the removed label. |
|
| Updates a label. |
6.11.1. get GET
Retrieves the details of a label.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.11.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.11.2. remove DELETE
Removes a label from the system and clears all assignments of the removed label.
6.11.3. update PUT
Updates a label. This call will update all metadata, such as the name or description.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.12. AffinityLabelHost
This service represents a host that has a specific label when accessed through the affinitylabels/hosts subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about a host that has this label assigned. |
|
| Remove a label from a host. |
6.12.1. get GET
Retrieves details about a host that has this label assigned.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.12.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.12.2. remove DELETE
Remove a label from a host.
6.13. AffinityLabelHosts
This service represents list of hosts that have a specific label when accessed through the affinitylabels/hosts subcollection.
| Name | Summary |
|---|---|
|
| Add a label to a host. |
|
| List all hosts with the label. |
6.13.1. add POST
Add a label to a host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.13.2. list GET
List all hosts with the label.
The order of the returned hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.13.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.14. AffinityLabelVm
This service represents a vm that has a specific label when accessed through the affinitylabels/vms subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about a vm that has this label assigned. |
|
| Remove a label from a vm. |
6.14.1. get GET
Retrieves details about a vm that has this label assigned.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.14.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.14.2. remove DELETE
Remove a label from a vm.
6.15. AffinityLabelVms
This service represents list of vms that have a specific label when accessed through the affinitylabels/vms subcollection.
| Name | Summary |
|---|---|
|
| Add a label to a vm. |
|
| List all virtual machines with the label. |
6.15.1. add POST
Add a label to a vm.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.15.2. list GET
List all virtual machines with the label.
The order of the returned virtual machines isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Vm[] | Out |
6.15.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.16. AffinityLabels
Manages the affinity labels available in the system.
| Name | Summary |
|---|---|
|
| Creates a new label. |
|
| Lists all labels present in the system. |
6.16.1. add POST
Creates a new label. The label is automatically attached to all entities mentioned in the vms or hosts lists.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.16.2. list GET
Lists all labels present in the system.
The order of the returned labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of labels to return. |
6.16.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.16.2.2. max
Sets the maximum number of labels to return. If not specified all the labels are returned.
6.17. Area
This annotation is intended to specify what oVirt area is the annotated concept related to. Currently the following areas are in use, and they are closely related to the oVirt teams, but not necessarily the same:
- Infrastructure
- Network
- SLA
- Storage
- Virtualization
A concept may be associated to more than one area, or to no area.
The value of this annotation is intended for reporting only, and it doesn’t affect at all the generated code or the validity of the model
6.18. AssignedAffinityLabel
This service represents one label to entity assignment when accessed using the entities/affinitylabels subcollection.
| Name | Summary |
|---|---|
|
| Retrieves details about the attached label. |
|
| Removes the label from an entity. |
6.18.1. get GET
Retrieves details about the attached label.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.18.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.18.2. remove DELETE
Removes the label from an entity. Does not touch the label itself.
6.19. AssignedAffinityLabels
This service is used to list and manipulate affinity labels that are assigned to supported entities when accessed using entities/affinitylabels.
| Name | Summary |
|---|---|
|
| Attaches a label to an entity. |
|
| Lists all labels that are attached to an entity. |
6.19.1. add POST
Attaches a label to an entity.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.19.2. list GET
Lists all labels that are attached to an entity.
The order of the returned entities isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.19.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.20. AssignedCpuProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.20.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.20.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.20.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.21. AssignedCpuProfiles
| Name | Summary |
|---|---|
|
| Add a new cpu profile for the cluster. |
|
| List the CPU profiles assigned to the cluster. |
6.21.1. add POST
Add a new cpu profile for the cluster.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.21.2. list GET
List the CPU profiles assigned to the cluster.
The order of the returned CPU profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.21.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.21.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.22. AssignedDiskProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.22.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.22.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.22.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.23. AssignedDiskProfiles
| Name | Summary |
|---|---|
|
| Add a new disk profile for the storage domain. |
|
| Returns the list of disk profiles assigned to the storage domain. |
6.23.1. add POST
Add a new disk profile for the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.23.2. list GET
Returns the list of disk profiles assigned to the storage domain.
The order of the returned disk profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.23.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.23.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.24. AssignedPermissions
Represents a permission sub-collection, scoped by user, group or some entity type.
| Name | Summary |
|---|---|
|
| Assign a new permission to a user or group for specific entity. |
|
| List all the permissions of the specific entity. |
6.24.1. add POST
Assign a new permission to a user or group for specific entity.
For example, to assign the UserVmManager role to the virtual machine with id 123 to the user with id 456 send a request like this:
POST /ovirt-engine/api/vms/123/permissions
POST /ovirt-engine/api/vms/123/permissionsWith a request body like this:
To assign the SuperUser role to the system to the user with id 456 send a request like this:
POST /ovirt-engine/api/permissions
POST /ovirt-engine/api/permissionsWith a request body like this:
If you want to assign permission to the group instead of the user please replace the user element with the group element with proper id of the group. For example to assign the UserRole role to the cluster with id 123 to the group with id 789 send a request like this:
POST /ovirt-engine/api/clusters/123/permissions
POST /ovirt-engine/api/clusters/123/permissionsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The permission. |
6.24.2. list GET
List all the permissions of the specific entity.
For example to list all the permissions of the cluster with id 123 send a request like this:
GET /ovirt-engine/api/clusters/123/permissions
GET /ovirt-engine/api/clusters/123/permissionsThe order of the returned permissions isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of permissions. |
6.24.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.25. AssignedRoles
Represents a roles sub-collection, for example scoped by user.
| Name | Summary |
|---|---|
|
| Returns the roles assigned to the permission. |
6.25.1. list GET
Returns the roles assigned to the permission.
The order of the returned roles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of roles to return. | |
|
| Out |
6.25.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.25.1.2. max
Sets the maximum number of roles to return. If not specified all the roles are returned.
6.26. AssignedTag
A service to manage assignment of specific tag to specific entities in system.
| Name | Summary |
|---|---|
|
| Gets the information about the assigned tag. |
|
| Unassign tag from specific entity in the system. |
6.26.1. get GET
Gets the information about the assigned tag.
For example to retrieve the information about the tag with the id 456 which is assigned to virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/tags/456
GET /ovirt-engine/api/vms/123/tags/456<tag href="/ovirt-engine/api/tags/456" id="456"> <name>root</name> <description>root</description> <vm href="/ovirt-engine/api/vms/123" id="123"/> </tag>
<tag href="/ovirt-engine/api/tags/456" id="456">
<name>root</name>
<description>root</description>
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</tag>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The assigned tag. |
6.26.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.26.2. remove DELETE
Unassign tag from specific entity in the system.
For example to unassign the tag with id 456 from virtual machine with id 123 send a request like this:
DELETE /ovirt-engine/api/vms/123/tags/456
DELETE /ovirt-engine/api/vms/123/tags/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.27. AssignedTags
A service to manage collection of assignment of tags to specific entities in system.
| Name | Summary |
|---|---|
|
| Assign tag to specific entity in the system. |
|
| List all tags assigned to the specific entity. |
6.27.1. add POST
Assign tag to specific entity in the system.
For example to assign tag mytag to virtual machine with the id 123 send a request like this:
POST /ovirt-engine/api/vms/123/tags
POST /ovirt-engine/api/vms/123/tagsWith a request body like this:
<tag> <name>mytag</name> </tag>
<tag>
<name>mytag</name>
</tag>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The assigned tag. |
6.27.2. list GET
List all tags assigned to the specific entity.
For example to list all the tags of the virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/tags
GET /ovirt-engine/api/vms/123/tagsThe order of the returned tags isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of tags to return. | |
|
| Tag[] | Out | The list of assigned tags. |
6.27.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.27.2.2. max
Sets the maximum number of tags to return. If not specified all the tags are returned.
6.28. AssignedVnicProfile
| Name | Summary |
|---|---|
|
| |
|
|
6.28.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.28.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.28.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.29. AssignedVnicProfiles
| Name | Summary |
|---|---|
|
| Add a new virtual network interface card profile for the network. |
|
| Returns the list of VNIC profiles assifned to the network. |
6.29.1. add POST
Add a new virtual network interface card profile for the network.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.29.2. list GET
Returns the list of VNIC profiles assifned to the network.
The order of the returned VNIC profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.29.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.29.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.30. AttachedStorageDomain
| Name | Summary |
|---|---|
|
| This operation activates an attached storage domain. |
|
| This operation deactivates an attached storage domain. |
|
| |
|
|
6.30.1. activate POST
This operation activates an attached storage domain. Once the storage domain is activated it is ready for use with the data center.
POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/activate
The activate action does not take any action specific parameters, so the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.30.2. deactivate POST
This operation deactivates an attached storage domain. Once the storage domain is deactivated it will not be used with the data center. For example, to deactivate storage domain 456, send the following request:
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivateWith a request body like this:
<action/>
<action/>
If the force parameter is true then the operation will succeed, even if the OVF update which takes place before the deactivation of the storage domain failed. If the force parameter is false and the OVF update failed, the deactivation of the storage domain will also fail.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if the OVF update for the storage domain failed. |
6.30.2.1. force
Indicates if the operation should succeed and the storage domain should be moved to a deactivated state, even if the OVF update for the storage domain failed. For example, to deactivate storage domain 456 using force flag, send the following request:
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivate
POST /ovirt-engine/api/datacenters/123/storagedomains/456/deactivateWith a request body like this:
<action> <force>true</force> <action>
<action>
<force>true</force>
<action>
This parameter is optional, and the default value is false.
6.30.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.30.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.30.4. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.31. AttachedStorageDomainDisk
Manages a single disk available in a storage domain attached to a data center.
Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations use the service that manages all the disks of the system or the service that manages a specific disk.
| Name | Summary |
|---|---|
|
| Copies a disk to the specified storage domain. |
|
| Exports a disk to an export storage domain. |
|
| Retrieves the description of the disk. |
|
| Moves a disk to another storage domain. |
|
| Registers an unregistered disk. |
|
| Removes a disk. |
|
| Sparsify the disk. |
|
| Updates the disk. |
6.31.1. copy POST
Copies a disk to the specified storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To copy a disk use the copy operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Description of the resulting disk. | |
|
| In | The storage domain where the new disk will be created. |
6.31.2. export POST
Exports a disk to an export storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To export a disk use the export operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The export storage domain where the disk should be exported to. |
6.31.3. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.31.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.31.4. move POST
Moves a disk to another storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To move a disk use the move operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | The storage domain where the disk will be moved to. |
6.31.5. register POST
Registers an unregistered disk.
6.31.6. remove DELETE
Removes a disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.31.7. sparsify POST
Sparsify the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.31.8. update PUT
Updates the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To update a disk use the update operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The update to apply to the disk. |
6.32. AttachedStorageDomainDisks
Manages the collection of disks available inside an storage domain that is attached to a data center.
| Name | Summary |
|---|---|
|
| Adds or registers a disk. |
|
| Retrieve the list of disks that are available in the storage domain. |
6.32.1. add POST
Adds or registers a disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To add a new disk use the add operation of the service that manages the disks of the system. To register an unregistered disk use the register operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk to add or register. | |
|
| In | Indicates if a new disk should be added or if an existing unregistered disk should be registered. |
6.32.1.1. unregistered
Indicates if a new disk should be added or if an existing unregistered disk should be registered. If the value is true then the identifier of the disk to register needs to be provided. For example, to register the disk with id 456 send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=trueWith a request body like this:
<disk id="456"/>
<disk id="456"/>
If the value is false then a new disk will be created in the storage domain. In that case the provisioned_size, format and name attributes are mandatory. For example, to create a new copy on write disk of 1 GiB, send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks
POST /ovirt-engine/api/storagedomains/123/disksWith a request body like this:
<disk> <name>mydisk</name> <format>cow</format> <provisioned_size>1073741824</provisioned_size> </disk>
<disk>
<name>mydisk</name>
<format>cow</format>
<provisioned_size>1073741824</provisioned_size>
</disk>
The default value is false.
6.32.2. list GET
Retrieve the list of disks that are available in the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.32.2.1. disks
List of retrieved disks.
The order of the returned disks isn’t guaranteed.
6.32.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.32.2.3. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.33. AttachedStorageDomains
Manages the storage domains attached to a data center.
| Name | Summary |
|---|---|
|
| Attaches an existing storage domain to the data center. |
|
| Returns the list of storage domains attached to the data center. |
6.33.1. add POST
Attaches an existing storage domain to the data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The storage domain to attach to the data center. |
6.33.2. list GET
Returns the list of storage domains attached to the data center.
The order of the returned storage domains isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of storage domains to return. | |
|
| Out | A list of storage domains that are attached to the data center. |
6.33.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.33.2.2. max
Sets the maximum number of storage domains to return. If not specified all the storage domains are returned.
6.34. Balance
| Name | Summary |
|---|---|
|
| |
|
|
6.34.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.34.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.34.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.35. Balances
| Name | Summary |
|---|---|
|
| Add a balance module to a specified user defined scheduling policy. |
|
| Returns the list of balance modules used by the scheduling policy. |
6.35.1. add POST
Add a balance module to a specified user defined scheduling policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.35.2. list GET
Returns the list of balance modules used by the scheduling policy.
The order of the returned balance modules isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of balances to return. |
6.35.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.35.2.2. max
Sets the maximum number of balances to return. If not specified all the balances are returned.
6.36. Bookmark
A service to manage a bookmark.
| Name | Summary |
|---|---|
|
| Get a bookmark. |
|
| Remove a bookmark. |
|
| Update a bookmark. |
6.36.1. get GET
Get a bookmark.
An example for getting a bookmark:
GET /ovirt-engine/api/bookmarks/123
GET /ovirt-engine/api/bookmarks/123<bookmark href="/ovirt-engine/api/bookmarks/123" id="123"> <name>example_vm</name> <value>vm: name=example*</value> </bookmark>
<bookmark href="/ovirt-engine/api/bookmarks/123" id="123">
<name>example_vm</name>
<value>vm: name=example*</value>
</bookmark>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The requested bookmark. | |
|
| In | Indicates which inner links should be followed. |
6.36.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.36.2. remove DELETE
Remove a bookmark.
An example for removing a bookmark:
DELETE /ovirt-engine/api/bookmarks/123
DELETE /ovirt-engine/api/bookmarks/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.36.3. update PUT
Update a bookmark.
An example for updating a bookmark:
PUT /ovirt-engine/api/bookmarks/123
PUT /ovirt-engine/api/bookmarks/123With the request body:
<bookmark> <name>new_example_vm</name> <value>vm: name=new_example*</value> </bookmark>
<bookmark>
<name>new_example_vm</name>
<value>vm: name=new_example*</value>
</bookmark>6.37. Bookmarks
A service to manage bookmarks.
| Name | Summary |
|---|---|
|
| Adding a new bookmark. |
|
| Listing all the available bookmarks. |
6.37.1. add POST
Adding a new bookmark.
Example of adding a bookmark:
POST /ovirt-engine/api/bookmarks
POST /ovirt-engine/api/bookmarks<bookmark> <name>new_example_vm</name> <value>vm: name=new_example*</value> </bookmark>
<bookmark>
<name>new_example_vm</name>
<value>vm: name=new_example*</value>
</bookmark>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The added bookmark. |
6.37.2. list GET
Listing all the available bookmarks.
Example of listing bookmarks:
GET /ovirt-engine/api/bookmarks
GET /ovirt-engine/api/bookmarksThe order of the returned bookmarks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of available bookmarks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bookmarks to return. |
6.37.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.37.2.2. max
Sets the maximum number of bookmarks to return. If not specified all the bookmarks are returned.
6.38. Cluster
A service to manage a specific cluster.
| Name | Summary |
|---|---|
|
| Gets information about the cluster. |
|
| Refresh the Gluster heal info for all volumes in cluster. |
|
| Removes the cluster from the system. |
|
| |
|
| Synchronizes all networks on the cluster. |
|
| Updates information about the cluster. |
|
| Start, update or finish upgrade process for the cluster based on the action value. |
6.38.1. get GET
Gets information about the cluster.
An example of getting a cluster:
GET /ovirt-engine/api/clusters/123
GET /ovirt-engine/api/clusters/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.38.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.38.2. refreshglusterhealstatus POST
Refresh the Gluster heal info for all volumes in cluster.
For example, Cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus
POST /ovirt-engine/api/clusters/123/refreshglusterhealstatus6.38.3. remove DELETE
Removes the cluster from the system.
DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000
DELETE /ovirt-engine/api/clusters/00000000-0000-0000-0000-000000000000| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.38.4. resetemulatedmachine POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reset should be performed asynchronously. |
6.38.5. syncallnetworks POST
Synchronizes all networks on the cluster.
POST /ovirt-engine/api/clusters/123/syncallnetworks
POST /ovirt-engine/api/clusters/123/syncallnetworksWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.38.6. update PUT
Updates information about the cluster.
Only the specified fields are updated; others remain unchanged.
For example, to update the cluster’s CPU:
PUT /ovirt-engine/api/clusters/123
PUT /ovirt-engine/api/clusters/123With a request body like this:
<cluster>
<cpu>
<type>Intel Haswell-noTSX Family</type>
</cpu>
</cluster>
<cluster>
<cpu>
<type>Intel Haswell-noTSX Family</type>
</cpu>
</cluster>6.38.7. upgrade POST
Start, update or finish upgrade process for the cluster based on the action value. This action marks the cluster for upgrade, updates the progress, or clears the upgrade running flag on the cluster based on the action value which takes values of start, stop or update_progress.
POST /ovirt-engine/api/clusters/123/upgrade
POST /ovirt-engine/api/clusters/123/upgradeWith a request body like this to mark the cluster for upgrade:
<action>
<upgrade_action>
start
</upgrade_action>
</action>
<action>
<upgrade_action>
start
</upgrade_action>
</action>After starting the upgrade, use a request body like this to update the progress to 15%:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Explicitly set the upgrade correlation identifier. | |
|
| In | The action to be performed. | |
|
| In | Update the upgrade’s progress as a percent complete of the total process. |
6.38.7.1. correlation_id
Explicitly set the upgrade correlation identifier. Use to correlate events detailing the cluster upgrade to the upgrade itself. If not specificed, the correlation id from Correlation-Id http header will be used.
6.39. ClusterEnabledFeature
Represents a feature enabled for the cluster.
| Name | Summary |
|---|---|
|
| Provides the information about the cluster feature enabled. |
|
| Disables a cluster feature. |
6.39.1. get GET
Provides the information about the cluster feature enabled.
For example, to find details of the enabled feature 456 for cluster 123, send a request like this:
GET /ovirt-engine/api/clusters/123/enabledfeatures/456
GET /ovirt-engine/api/clusters/123/enabledfeatures/456That will return a ClusterFeature object containing the name:
<cluster_feature id="456"> <name>libgfapi_supported</name> </cluster_feature>
<cluster_feature id="456">
<name>libgfapi_supported</name>
</cluster_feature>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved cluster feature that’s enabled. | |
|
| In | Indicates which inner links should be followed. |
6.39.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.39.2. remove DELETE
Disables a cluster feature.
For example, to disable the feature 456 of cluster 123 send a request like this:
DELETE /ovirt-engine/api/clusters/123/enabledfeatures/456
DELETE /ovirt-engine/api/clusters/123/enabledfeatures/4566.40. ClusterEnabledFeatures
Provides information about the additional features that are enabled for this cluster. The features that are enabled are the available features for the cluster level
| Name | Summary |
|---|---|
|
| Enable an additional feature for a cluster. |
|
| Lists the additional features enabled for the cluster. |
6.40.1. add POST
Enable an additional feature for a cluster.
For example, to enable a feature 456 on cluster 123, send a request like this:
POST /ovirt-engine/api/clusters/123/enabledfeatures
POST /ovirt-engine/api/clusters/123/enabledfeaturesThe request body should look like this:
<cluster_feature id="456"/>
<cluster_feature id="456"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.40.2. list GET
Lists the additional features enabled for the cluster.
For example, to get the features enabled for cluster 123 send a request like this:
GET /ovirt-engine/api/clusters/123/enabledfeatures
GET /ovirt-engine/api/clusters/123/enabledfeaturesThis will return a list of features:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved features. | |
|
| In | Indicates which inner links should be followed. |
6.40.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.41. ClusterExternalProviders
This service lists external providers.
| Name | Summary |
|---|---|
|
| Returns the list of external providers. |
6.41.1. list GET
Returns the list of external providers.
The order of the returned list of providers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.41.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.42. ClusterFeature
Represents a feature enabled for the cluster level
| Name | Summary |
|---|---|
|
| Provides the information about the a cluster feature supported by a cluster level. |
6.42.1. get GET
Provides the information about the a cluster feature supported by a cluster level.
For example, to find details of the cluster feature 456 for cluster level 4.1, send a request like this:
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures/456That will return a ClusterFeature object containing the name:
<cluster_feature id="456"> <name>libgfapi_supported</name> </cluster_feature>
<cluster_feature id="456">
<name>libgfapi_supported</name>
</cluster_feature>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved cluster feature. | |
|
| In | Indicates which inner links should be followed. |
6.42.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.43. ClusterFeatures
Provides information about the cluster features that are supported by a cluster level.
| Name | Summary |
|---|---|
|
| Lists the cluster features supported by the cluster level. |
6.43.1. list GET
Lists the cluster features supported by the cluster level.
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeatures
GET /ovirt-engine/api/clusterlevels/4.1/clusterfeaturesThis will return a list of cluster features supported by the cluster level:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved features. | |
|
| In | Indicates which inner links should be followed. |
6.43.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.44. ClusterLevel
Provides information about a specific cluster level. See the ClusterLevels service for more information.
| Name | Summary |
|---|---|
|
| Provides the information about the capabilities of the specific cluster level managed by this service. |
6.44.1. get GET
Provides the information about the capabilities of the specific cluster level managed by this service.
For example, to find what CPU types are supported by level 3.6 you can send a request like this:
GET /ovirt-engine/api/clusterlevels/3.6
GET /ovirt-engine/api/clusterlevels/3.6That will return a ClusterLevel object containing the supported CPU types, and other information which describes the cluster level:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retreived cluster level. |
6.44.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.45. ClusterLevels
Provides information about the capabilities of different cluster levels supported by the engine. Version 4.0 of the engine supports levels 4.0 and 3.6. Each of these levels support different sets of CPU types, for example. This service provides that information.
| Name | Summary |
|---|---|
|
| Lists the cluster levels supported by the system. |
6.45.1. list GET
Lists the cluster levels supported by the system.
GET /ovirt-engine/api/clusterlevels
GET /ovirt-engine/api/clusterlevelsThis will return a list of available cluster levels.
The order of the returned cluster levels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved cluster levels. |
6.45.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.46. ClusterNetwork
A service to manage a specific cluster network.
| Name | Summary |
|---|---|
|
| Retrieves the cluster network details. |
|
| Unassigns the network from a cluster. |
|
| Updates the network in the cluster. |
6.46.1. get GET
Retrieves the cluster network details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The cluster network. |
6.46.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.46.2. remove DELETE
Unassigns the network from a cluster.
6.46.3. update PUT
Updates the network in the cluster.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The cluster network. |
6.47. ClusterNetworks
A service to manage cluster networks.
| Name | Summary |
|---|---|
|
| Assigns the network to a cluster. |
|
| Lists the networks that are assigned to the cluster. |
6.47.1. add POST
Assigns the network to a cluster.
Post a request like in the example below to assign the network to a cluster:
POST /ovirt-engine/api/clusters/123/networks
POST /ovirt-engine/api/clusters/123/networksUse the following example in its body:
<network id="123" />
<network id="123" />| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network object to be assigned to the cluster. |
6.47.2. list GET
Lists the networks that are assigned to the cluster.
The order of the returned clusters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | The list of networks that are assigned to the cluster. |
6.47.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.47.2.2. max
Sets the maximum number of networks to return. If not specified, all the networks are returned.
6.48. Clusters
A service to manage clusters.
| Name | Summary |
|---|---|
|
| Creates a new cluster. |
|
| Returns the list of clusters of the system. |
6.48.1. add POST
Creates a new cluster.
This requires the name, cpu.type, and data_center attributes. Identify the data center with either the id or name attribute.
POST /ovirt-engine/api/clusters
POST /ovirt-engine/api/clustersWith a request body like this:
To create a cluster with an external network provider to be deployed on every host that is added to the cluster, send a request like this:
POST /ovirt-engine/api/clusters
POST /ovirt-engine/api/clustersWith a request body containing a reference to the desired provider:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.48.2. list GET
Returns the list of clusters of the system.
The order of the returned clusters is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the search should be performed taking case into account. | |
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of clusters to return. | |
|
| In | A query string used to restrict the returned clusters. |
6.48.2.1. case_sensitive
Indicates if the search should be performed taking case into account. The default value is true, which means that case is taken into account. To search ignoring case, set it to false.
6.48.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.48.2.3. max
Sets the maximum number of clusters to return. If not specified, all the clusters are returned.
6.49. Copyable
| Name | Summary |
|---|---|
|
|
6.49.1. copy POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the copy should be performed asynchronously. |
6.50. CpuProfile
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified cpu profile in the system. |
6.50.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.50.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.50.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.50.3. update PUT
Update the specified cpu profile in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.51. CpuProfiles
| Name | Summary |
|---|---|
|
| Add a new cpu profile to the system. |
|
| Returns the list of CPU profiles of the system. |
6.51.1. add POST
Add a new cpu profile to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.51.2. list GET
Returns the list of CPU profiles of the system.
The order of the returned list of CPU profiles is random.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.51.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.51.2.2. max
Sets the maximum number of profiles to return. If not specified, all the profiles are returned.
6.52. DataCenter
A service to manage a data center.
| Name | Summary |
|---|---|
|
| Currently, the storage pool manager (SPM) fails to switch to another host if the SPM has uncleared tasks. |
|
| Get a data center. |
|
| Removes the data center. |
|
| Used for manually setting a storage domain in the data center as a master. |
|
| Updates the data center. |
6.52.1. cleanfinishedtasks POST
Currently, the storage pool manager (SPM) fails to switch to another host if the SPM has uncleared tasks. Clearing all finished tasks enables the SPM switching.
For example, to clean all the finished tasks on a data center with ID 123 send a request like this:
POST /ovirt-engine/api/datacenters/123/cleanfinishedtasks
POST /ovirt-engine/api/datacenters/123/cleanfinishedtasksWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.52.2. get GET
Get a data center.
An example of getting a data center:
GET /ovirt-engine/api/datacenters/123
GET /ovirt-engine/api/datacenters/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.52.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.52.3. remove DELETE
Removes the data center.
DELETE /ovirt-engine/api/datacenters/123
DELETE /ovirt-engine/api/datacenters/123Without any special parameters, the storage domains attached to the data center are detached and then removed from the storage. If something fails when performing this operation, for example if there is no host available to remove the storage domains from the storage, the complete operation will fail.
If the force parameter is true then the operation will always succeed, even if something fails while removing one storage domain, for example. The failure is just ignored and the data center is removed from the database anyway.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation. |
6.52.3.1. force
Indicates if the operation should succeed, and the storage domain removed from the database, even if something fails during the operation.
This parameter is optional, and the default value is false.
6.52.4. setmaster POST
Used for manually setting a storage domain in the data center as a master. For example, for setting a storage domain with ID '456' as a master on a data center with ID '123', send a request like this:
POST /ovirt-engine/api/datacenters/123/setmaster
POST /ovirt-engine/api/datacenters/123/setmasterWith a request body like this:
<action> <storage_domain id="456"/> </action>
<action>
<storage_domain id="456"/>
</action>The new master storage domain can be also specified by its name.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | The new master storage domain for the data center. |
6.52.5. update PUT
Updates the data center.
The name, description, storage_type, version, storage_format and mac_pool elements are updatable post-creation. For example, to change the name and description of data center 123 send a request like this:
PUT /ovirt-engine/api/datacenters/123
PUT /ovirt-engine/api/datacenters/123With a request body like this:
<data_center> <name>myupdatedname</name> <description>An updated description for the data center</description> </data_center>
<data_center>
<name>myupdatedname</name>
<description>An updated description for the data center</description>
</data_center>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The data center that is being updated. |
6.53. DataCenterNetwork
A service to manage a specific data center network.
| Name | Summary |
|---|---|
|
| Retrieves the data center network details. |
|
| Removes the network. |
|
| Updates the network in the data center. |
6.53.1. get GET
Retrieves the data center network details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The data center network. |
6.53.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.53.2. remove DELETE
Removes the network.
6.53.3. update PUT
Updates the network in the data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The data center network. |
6.54. DataCenterNetworks
A service to manage data center networks.
| Name | Summary |
|---|---|
|
| Create a new network in a data center. |
|
| Lists networks in the data center. |
6.54.1. add POST
Create a new network in a data center.
Post a request like in the example below to create a new network in a data center with an ID of 123.
POST /ovirt-engine/api/datacenters/123/networks
POST /ovirt-engine/api/datacenters/123/networksUse the following example in its body:
<network> <name>mynetwork</name> </network>
<network>
<name>mynetwork</name>
</network>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network object to be created in the data center. |
6.54.2. list GET
Lists networks in the data center.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | The list of networks which are in the data center. |
6.54.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.54.2.2. max
Sets the maximum number of networks to return. If not specified, all the networks are returned.
6.55. DataCenters
A service to manage data centers.
| Name | Summary |
|---|---|
|
| Creates a new data center. |
|
| Lists the data centers. |
6.55.1. add POST
Creates a new data center.
Creation of a new data center requires the name and local elements. For example, to create a data center named mydc that uses shared storage (NFS, iSCSI or fibre channel) send a request like this:
POST /ovirt-engine/api/datacenters
POST /ovirt-engine/api/datacentersWith a request body like this:
<data_center> <name>mydc</name> <local>false</local> </data_center>
<data_center>
<name>mydc</name>
<local>false</local>
</data_center>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The data center that is being added. |
6.55.2. list GET
Lists the data centers.
The following request retrieves a representation of the data centers:
GET /ovirt-engine/api/datacenters
GET /ovirt-engine/api/datacenters
The above request performed with curl:
This is what an example response could look like:
Note the id code of your Default data center. This code identifies this data center in relation to other resources of your virtual environment.
The data center also contains a link to the storage domains collection. The data center uses this collection to attach storage domains from the storage domains main collection.
The order of the returned list of data centers is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of data centers to return. | |
|
| In | A query string used to restrict the returned data centers. |
6.55.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.55.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.55.2.3. max
Sets the maximum number of data centers to return. If not specified all the data centers are returned.
6.56. Disk
Manages a single disk.
| Name | Summary |
|---|---|
|
| Converts disk format and/or preallocation mode. |
|
| This operation copies a disk to the specified storage domain. |
|
| Exports a disk to an export storage domain. |
|
| Retrieves the description of the disk. |
|
| Moves a disk to another storage domain. |
|
| Reduces the size of the disk image. |
|
| Refreshes a direct LUN disk with up-to-date information from the storage. |
|
| Removes a disk. |
|
| Sparsify the disk. |
|
| Updates the parameters of the specified disk. |
6.56.1. convert POST
Converts disk format and/or preallocation mode.
For example, to convert the disk format from preallocated-cow to a sparse-raw image, send a request like the following:
POST /ovirt-engine/api/disks/123/convert
POST /ovirt-engine/api/disks/123/convertWith the following request body:
Note: In order to sparsify a disk, two conversions might be needed if the disk is on a Block Storage Domain. For example: If a disk is RAW, converting it to QCOW will result in a larger disk. In order to reduce the size, it is possible to convert the disk again to QCOW and keep the same allocation policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.56.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.56.2. copy POST
This operation copies a disk to the specified storage domain.
For example, a disk can be copied using the following request:
POST /ovirt-engine/api/disks/123/copy
POST /ovirt-engine/api/disks/123/copyWith a request body like this:
If the disk profile or the quota currently used by the disk are not defined for the new storage domain, they can be explicitly specified. If they are not specified, the first available disk profile and the default quota are used.
For example, to specify disk profile 987 and quota 753, send a request body like this:
<action> <storage_domain id="456"/> <disk_profile id="987"/> <quota id="753"/> </action>
<action>
<storage_domain id="456"/>
<disk_profile id="987"/>
<quota id="753"/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the copy should be performed asynchronously. | |
|
| In | ||
|
| In | Disk profile for the disk in the new storage domain. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Quota for the disk in the new storage domain. | |
|
| In | The storage domain where the new disk is created. |
6.56.2.1. disk_profile
Disk profile for the disk in the new storage domain.
Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
6.56.2.2. quota
Quota for the disk in the new storage domain.
This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
6.56.2.3. storage_domain
The storage domain where the new disk is created. This can be specified using the id or name attributes. For example, to copy a disk to the storage domain called mydata, send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks/789
POST /ovirt-engine/api/storagedomains/123/disks/789With a request body like this:
<action>
<storage_domain>
<name>mydata</name>
</storage_domain>
</action>
<action>
<storage_domain>
<name>mydata</name>
</storage_domain>
</action>6.56.3. export POST
Exports a disk to an export storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the export should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | The export storage domain where the disk will be exported to. |
6.56.4. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the disk should be included in the response. | |
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.56.4.1. all_content
Indicates if all of the attributes of the disk should be included in the response.
By default the following disk attributes are excluded:
-
vms
For example, to retrieve the complete representation of disk '123':
GET /ovirt-engine/api/disks/123?all_content=true
GET /ovirt-engine/api/disks/123?all_content=true6.56.4.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.56.5. move POST
Moves a disk to another storage domain.
For example, to move the disk with identifier 123 to a storage domain with identifier 456 send the following request:
POST /ovirt-engine/api/disks/123/move
POST /ovirt-engine/api/disks/123/moveWith the following request body:
<action> <storage_domain id="456"/> </action>
<action>
<storage_domain id="456"/>
</action>If the disk profile or the quota used currently by the disk aren’t defined for the new storage domain, then they can be explicitly specified. If they aren’t then the first available disk profile and the default quota are used.
For example, to explicitly use disk profile 987 and quota 753 send a request body like this:
<action> <storage_domain id="456"/> <disk_profile id="987"/> <quota id="753"/> </action>
<action>
<storage_domain id="456"/>
<disk_profile id="987"/>
<quota id="753"/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. | |
|
| In | Disk profile for the disk in the new storage domain. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Quota for the disk in the new storage domain. | |
|
| In | The storage domain where the disk will be moved to. |
6.56.5.1. disk_profile
Disk profile for the disk in the new storage domain.
Disk profiles are defined for storage domains, so the old disk profile will not exist in the new storage domain. If this parameter is not used, the first disk profile from the new storage domain to which the user has permissions will be assigned to the disk.
6.56.5.2. quota
Quota for the disk in the new storage domain.
This optional parameter can be used to specify new quota for the disk, because the current quota may not be defined for the new storage domain. If this parameter is not used and the old quota is not defined for the new storage domain, the default (unlimited) quota will be assigned to the disk.
6.56.6. reduce POST
Reduces the size of the disk image.
Invokes reduce on the logical volume (i.e. this is only applicable for block storage domains). This is applicable for floating disks and disks attached to non-running virtual machines. There is no need to specify the size as the optimal size is calculated automatically.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.56.7. refreshlun POST
Refreshes a direct LUN disk with up-to-date information from the storage.
Refreshing a direct LUN disk is useful when:
- The LUN was added using the API without the host parameter, and therefore does not contain any information from the storage (see DisksService::add).
- New information about the LUN is available on the storage and you want to update the LUN with it.
To refresh direct LUN disk 123 using host 456, send the following request:
POST /ovirt-engine/api/disks/123/refreshlun
POST /ovirt-engine/api/disks/123/refreshlunWith the following request body:
<action> <host id='456'/> </action>
<action>
<host id='456'/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The host that will be used to refresh the direct LUN disk. |
6.56.8. remove DELETE
Removes a disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.56.9. sparsify POST
Sparsify the disk.
Sparsification frees space in the disk image that is not used by its filesystem. As a result, the image will occupy less space on the storage.
Currently sparsification works only on disks without snapshots. Disks having derived disks are also not allowed.
6.56.10. update PUT
Updates the parameters of the specified disk.
This operation allows updating the following floating disk properties:
-
For Image disks:
provisioned_size,alias,description,wipe_after_delete,shareable,backupanddisk_profile. -
For LUN disks:
alias,descriptionandshareable. - Cinder integration has been replaced by Managed Block Storage.
-
For Managed Block disks:
provisioned_size,aliasanddescription. -
For VM attached disks, the
qcow_versioncan also be updated.
For example, a disk’s update can be done by using the following request:
PUT /ovirt-engine/api/disks/123
PUT /ovirt-engine/api/disks/123With a request body like this:
<disk> <qcow_version>qcow2_v3</qcow_version> <alias>new-alias</alias> <description>new-desc</description> </disk>
<disk>
<qcow_version>qcow2_v3</qcow_version>
<alias>new-alias</alias>
<description>new-desc</description>
</disk>Since the backend operation is asynchronous, the disk element that is returned to the user might not be synced with the changed properties.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The update to apply to the disk. |
6.57. DiskAttachment
This service manages the attachment of a disk to a virtual machine.
| Name | Summary |
|---|---|
|
| Returns the details of the attachment, including the bootable flag and link to the disk. |
|
| Removes the disk attachment. |
|
| Update the disk attachment and the disk properties within it. |
6.57.1. get GET
Returns the details of the attachment, including the bootable flag and link to the disk.
An example of getting a disk attachment:
GET /ovirt-engine/api/vms/123/diskattachments/456
GET /ovirt-engine/api/vms/123/diskattachments/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.57.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.57.2. remove DELETE
Removes the disk attachment.
This will only detach the disk from the virtual machine, but won’t remove it from the system, unless the detach_only parameter is false.
An example of removing a disk attachment:
DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true
DELETE /ovirt-engine/api/vms/123/diskattachments/456?detach_only=true| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the disk should only be detached from the virtual machine, but not removed from the system. |
6.57.2.1. detach_only
Indicates if the disk should only be detached from the virtual machine, but not removed from the system. The default value is true, which won’t remove the disk from the system.
6.57.3. update PUT
Update the disk attachment and the disk properties within it.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.58. DiskAttachments
This service manages the set of disks attached to a virtual machine. Each attached disk is represented by a DiskAttachment, containing the bootable flag, the disk interface and the reference to the disk.
| Name | Summary |
|---|---|
|
| Adds a new disk attachment to the virtual machine. |
|
| List the disk that are attached to the virtual machine. |
6.58.1. add POST
Adds a new disk attachment to the virtual machine. The attachment parameter can contain just a reference, if the disk already exists:
Or it can contain the complete representation of the disk, if the disk doesn’t exist yet:
In this case the disk will be created and then attached to the virtual machine.
In both cases, use the following URL for a virtual machine with an id 345:
POST /ovirt-engine/api/vms/345/diskattachments
POST /ovirt-engine/api/vms/345/diskattachments
The server accepts requests that do not contain the active attribute, but the effect is undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the active attribute with the desired value.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk attachment to add to the virtual machine. |
6.58.2. list GET
List the disk that are attached to the virtual machine.
The order of the returned list of disks attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A list of disk attachments that are attached to the virtual machine. | |
|
| In | Indicates which inner links should be followed. |
6.58.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.59. DiskProfile
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified disk profile in the system. |
6.59.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.59.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.59.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.59.3. update PUT
Update the specified disk profile in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.60. DiskProfiles
| Name | Summary |
|---|---|
|
| Add a new disk profile to the system. |
|
| Returns the list of disk profiles of the system. |
6.60.1. add POST
Add a new disk profile to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.60.2. list GET
Returns the list of disk profiles of the system.
The order of the returned list of disk profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out |
6.60.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.60.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.61. DiskSnapshot
| Name | Summary |
|---|---|
|
| |
|
|
6.61.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.61.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.61.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.62. DiskSnapshots
Manages the collection of disk snapshots available in an storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of disk snapshots of the storage domain. |
6.62.1. list GET
Returns the list of disk snapshots of the storage domain.
The order of the returned list of disk snapshots isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | If true return also active snapshots. | |
|
| In | If true return also template snapshots. | |
|
| In | Sets the maximum number of snapshots to return. | |
|
| Out |
6.62.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.62.1.2. include_active
If true return also active snapshots. If not specified active snapshots are not returned.
6.62.1.3. include_template
If true return also template snapshots. If not specified template snapshots are not returned.
6.62.1.4. max
Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.
6.63. Disks
Manages the collection of disks available in the system.
| Name | Summary |
|---|---|
|
| Adds a new floating disk. |
|
| Get list of disks. |
6.63.1. add POST
Adds a new floating disk.
There are three types of disks that can be added - disk image, direct LUN and Managed Block disk. Cinder integration has been replaced by Managed Block Storage.
Adding a new image disk:
When creating a new floating image Disk, the API requires the storage_domain, provisioned_size and format attributes.
Note that block storage domains (i.e. storage domains with the storage type of iSCSI or FCP) do not support the combination of the raw format with sparse=true, so sparse=false must be stated explicitly.
To create a new floating image disk with specified provisioned_size, format and name on a storage domain with an id 123 and enabled for incremental backup, send a request as follows:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
Adding a new direct LUN disk:
When adding a new floating direct LUN via the API, there are two flavors that can be used:
-
With a
hostelement - in this case, the host is used for sanity checks (e.g., that the LUN is visible) and to retrieve basic information about the LUN (e.g., size and serial). -
Without a
hostelement - in this case, the operation is a database-only operation, and the storage is never accessed.
To create a new floating direct LUN disk with a host element with an id 123, specified alias, type and logical_unit with an id 456 (that has the attributes address, port and target), send a request as follows:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
To create a new floating direct LUN disk without using a host, remove the host element.
Adding a new Cinder disk:
Cinder integration has been replaced by Managed Block Storage.
Adding a floating disks in order to upload disk snapshots:
Since version 4.2 of the engine it is possible to upload disks with snapshots. This request should be used to create the base image of the images chain (The consecutive disk snapshots (images), should be created using disk-attachments element when creating a snapshot).
The disk has to be created with the same disk identifier and image identifier of the uploaded image. I.e. the identifiers should be saved as part of the backup process. The image identifier can be also fetched using the qemu-img info command. For example, if the disk image is stored into a file named b7a4c6c5-443b-47c5-967f-6abc79675e8b/myimage.img:
To create a disk with with the disk identifier and image identifier obtained with the qemu-img info command shown above, send a request like this:
POST /ovirt-engine/api/disks
POST /ovirt-engine/api/disksWith a request body as follows:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk. |
6.63.2. list GET
Get list of disks.
GET /ovirt-engine/api/disks
GET /ovirt-engine/api/disksYou will get a XML response which will look like this one:
The order of the returned list of disks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | List of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. | |
|
| In | A query string used to restrict the returned disks. |
6.63.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.63.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.63.2.3. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.64. Domain
A service to view details of an authentication domain in the system.
| Name | Summary |
|---|---|
|
| Gets the authentication domain information. |
6.64.1. get GET
Gets the authentication domain information.
Usage:
GET /ovirt-engine/api/domains/5678
GET /ovirt-engine/api/domains/5678Will return the domain information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The authentication domain. | |
|
| In | Indicates which inner links should be followed. |
6.64.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.65. DomainGroup
| Name | Summary |
|---|---|
|
|
6.65.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.65.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.66. DomainGroups
| Name | Summary |
|---|---|
|
| Returns the list of groups. |
6.66.1. list GET
Returns the list of groups.
The order of the returned list of groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of groups to return. | |
|
| In | A query string used to restrict the returned groups. |
6.66.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.66.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.66.1.3. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.67. DomainUser
A service to view a domain user in the system.
| Name | Summary |
|---|---|
|
| Gets the domain user information. |
6.67.1. get GET
Gets the domain user information.
Usage:
GET /ovirt-engine/api/domains/5678/users/1234
GET /ovirt-engine/api/domains/5678/users/1234Will return the domain user information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The domain user. |
6.67.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.68. DomainUserGroups
A service that shows a user’s group membership in the AAA extension.
| Name | Summary |
|---|---|
|
| Returns the list of groups that the user is a member of. |
6.68.1. list GET
Returns the list of groups that the user is a member of.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of groups that the user is a member of. |
6.68.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.69. DomainUsers
A service to list all domain users in the system.
| Name | Summary |
|---|---|
|
| List all the users in the domain. |
6.69.1. list GET
List all the users in the domain.
Usage:
GET /ovirt-engine/api/domains/5678/users
GET /ovirt-engine/api/domains/5678/usersWill return the list of users in the domain:
The order of the returned list of users isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of users to return. | |
|
| In | A query string used to restrict the returned users. | |
|
| Out | The list of users in the domain. |
6.69.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.69.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.69.1.3. max
Sets the maximum number of users to return. If not specified all the users are returned.
6.70. Domains
A service to list all authentication domains in the system.
| Name | Summary |
|---|---|
|
| List all the authentication domains in the system. |
6.70.1. list GET
List all the authentication domains in the system.
Usage:
GET /ovirt-engine/api/domains
GET /ovirt-engine/api/domainsWill return the list of domains:
The order of the returned list of domains isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of domains. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of domains to return. |
6.70.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.70.1.2. max
Sets the maximum number of domains to return. If not specified all the domains are returned.
6.71. EngineKatelloErrata
A service to manage Katello errata assigned to the engine. The information is retrieved from Katello.
| Name | Summary |
|---|---|
|
| Retrieves the representation of the Katello errata. |
6.71.1. list GET
Retrieves the representation of the Katello errata.
GET /ovirt-engine/api/katelloerrata
GET /ovirt-engine/api/katelloerrataYou will receive response in XML like this one:
The order of the returned list of erratum isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A representation of Katello errata. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of errata to return. |
6.71.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.71.1.2. max
Sets the maximum number of errata to return. If not specified all the errata are returned.
6.72. Event
A service to manage an event in the system.
| Name | Summary |
|---|---|
|
| Get an event. |
|
| Removes an event from internal audit log. |
6.72.1. get GET
Get an event.
An example of getting an event:
GET /ovirt-engine/api/events/123
GET /ovirt-engine/api/events/123Note that the number of fields changes according to the information that resides on the event. For example, for storage domain related events you will get the storage domain reference, as well as the reference for the data center this storage domain resides in.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.72.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.72.2. remove DELETE
Removes an event from internal audit log.
An event can be removed by sending following request
DELETE /ovirt-engine/api/events/123
DELETE /ovirt-engine/api/events/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.73. EventSubscription
A service to manage a specific event-subscription in the system.
| Name | Summary |
|---|---|
|
| Gets the information about the event-subscription. |
|
| Removes the event-subscription from the system. |
6.73.1. get GET
Gets the information about the event-subscription.
For example to retrieve the information about the subscription of user '123' to the event 'vm_console_detected':
GET /ovirt-engine/api/users/123/vm_console_detected
GET /ovirt-engine/api/users/123/vm_console_detected| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The event-subscription. |
6.73.2. remove DELETE
Removes the event-subscription from the system.
For example to remove user 123’s subscription to vm_console_detected event:
DELETE /ovirt-engine/api/users/123/vm_console_detected
DELETE /ovirt-engine/api/users/123/vm_console_detected| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.74. EventSubscriptions
Represents a service to manage collection of event-subscription of a user.
| Name | Summary |
|---|---|
|
| Add a new event-subscription to the system. |
|
| List the event-subscriptions for the provided user. |
6.74.1. add POST
Add a new event-subscription to the system.
An event-subscription is always added in the context of a user. For example, to add new event-subscription for host_high_cpu_use for user 123, and have the notification sent to the e-mail address: a@b.com, send a request like this:
POST /ovirt-engine/api/users/123/eventsubscriptions
POST /ovirt-engine/api/users/123/eventsubscriptionsWith a request body like this:
<event_subscription>
<event>host_high_cpu_use</event>
<address>a@b.com</address>
</event_subscription>
<event_subscription>
<event>host_high_cpu_use</event>
<address>a@b.com</address>
</event_subscription>The event name will become the ID of the new event-subscription entity: GET …/api/users/123/eventsubscriptions/host_high_cpu_use
Note that no user id is provided in the request body. This is because the user-id (in this case 123) is already known to the API from the context. Note also that event-subscription entity contains notification-method field, but it is not provided either in the request body. This is because currently it’s always set to SMTP as SNMP notifications are still unsupported by the API layer.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The added event-subscription. |
6.74.2. list GET
List the event-subscriptions for the provided user.
For example to list event-subscriptions for user 123:
GET /ovirt-engine/api/users/123/event-subscriptions
GET /ovirt-engine/api/users/123/event-subscriptions| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List of the event-subscriptions for the specified user | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of event-subscriptions to return. |
6.74.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.74.2.2. max
Sets the maximum number of event-subscriptions to return. If not specified all the event-subscriptions are returned.
6.75. Events
A service to manage events in the system.
| Name | Summary |
|---|---|
|
| Adds an external event to the internal audit log. |
|
| Get list of events. |
|
|
6.75.1. add POST
Adds an external event to the internal audit log.
This is intended for integration with external systems that detect or produce events relevant for the administrator of the system. For example, an external monitoring tool may be able to detect that a file system is full inside the guest operating system of a virtual machine. This event can be added to the internal audit log sending a request like this:
Events can also be linked to specific objects. For example, the above event could be linked to the specific virtual machine where it happened, using the vm link:
When using links, like the vm in the previous example, only the id attribute is accepted. The name attribute, if provided, is simply ignored.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.75.2. list GET
Get list of events.
GET /ovirt-engine/api/events
GET /ovirt-engine/api/eventsTo the above request we get following response:
The following events occur:
- id="1" - The API logs in the admin user account.
- id="2" - The API logs out of the admin user account.
The order of the returned list of events is always garanteed. If the sortby clause is included in the search parameter, then the events will be ordered according to that clause. If the sortby clause isn’t included, then the events will be sorted by the numeric value of the id attribute, starting with the highest value. This, combined with the max parameter, simplifies obtaining the most recent event:
GET /ovirt-engine/api/events?max=1
GET /ovirt-engine/api/events?max=1| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates the event index after which events should be returned. | |
|
| In | Sets the maximum number of events to return. | |
|
| In | The events service provides search queries similar to other resource services. |
6.75.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.75.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.75.2.3. from
Indicates the event index after which events should be returned. The indexes of events are strictly increasing, so when this parameter is used only the events with greater indexes will be returned. For example, the following request will return only the events with indexes greater than 123:
GET /ovirt-engine/api/events?from=123
GET /ovirt-engine/api/events?from=123This parameter is optional, and if not specified then the first event returned will be most recently generated.
6.75.2.4. max
Sets the maximum number of events to return. If not specified all the events are returned.
6.75.2.5. search
The events service provides search queries similar to other resource services.
We can search by providing specific severity.
GET /ovirt-engine/api/events?search=severity%3Dnormal
GET /ovirt-engine/api/events?search=severity%3Dnormal
To the above request we get a list of events which severity is equal to normal:
A virtualization environment generates a large amount of events after a period of time. However, the API only displays a default number of events for one search query. To display more than the default, the API separates results into pages with the page command in a search query. The following search query tells the API to paginate results using a page value in combination with the sortby clause:
sortby time asc page 1
sortby time asc page 1Below example paginates event resources. The URL-encoded request is:
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%201Increase the page value to view the next page of results.
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%202
GET /ovirt-engine/api/events?search=sortby%20time%20asc%20page%2026.75.3. undelete POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the un-delete should be performed asynchronously. |
6.76. ExternalComputeResource
Manages a single external compute resource.
Compute resource is a term of host external provider. The external provider also needs to know to where the provisioned host needs to register. The login details of the engine are saved as a compute resource in the external provider side.
| Name | Summary |
|---|---|
|
| Retrieves external compute resource details. |
6.76.1. get GET
Retrieves external compute resource details.
For example, to get the details of compute resource 234 of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/computeresources/234
GET /ovirt-engine/api/externalhostproviders/123/computeresources/234It will return a response like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | External compute resource information |
6.76.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.77. ExternalComputeResources
Manages a collection of external compute resources.
Compute resource is a term of host external provider. The external provider also needs to know to where the provisioned host needs to register. The login details of the engine is saved as a compute resource in the external provider side.
| Name | Summary |
|---|---|
|
| Retrieves a list of external compute resources. |
6.77.1. list GET
Retrieves a list of external compute resources.
For example, to retrieve the compute resources of external host provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/computeresources
GET /ovirt-engine/api/externalhostproviders/123/computeresourcesIt will return a response like this:
The order of the returned list of compute resources isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of resources to return. | |
|
| Out | List of external computer resources. |
6.77.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.77.1.2. max
Sets the maximum number of resources to return. If not specified all the resources are returned.
6.78. ExternalDiscoveredHost
This service manages a single discovered host.
| Name | Summary |
|---|---|
|
| Get discovered host info. |
6.78.1. get GET
Get discovered host info.
Retrieves information about an host that is managed in external provider management system, such as Foreman. The information includes hostname, address, subnet, base image and more.
For example, to get the details of host 234 from provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234
GET /ovirt-engine/api/externalhostproviders/123/discoveredhosts/234The result will be like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Host’s hardware and config information. |
6.78.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.79. ExternalDiscoveredHosts
This service manages external discovered hosts.
| Name | Summary |
|---|---|
|
| Get list of discovered hosts' information. |
6.79.1. list GET
Get list of discovered hosts' information.
Discovered hosts are fetched from third-party providers such as Foreman.
To list all discovered hosts for provider 123 send the following:
GET /ovirt-engine/api/externalhostproviders/123/discoveredhost
GET /ovirt-engine/api/externalhostproviders/123/discoveredhostThe order of the returned list of hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | List of discovered hosts | |
|
| In | Sets the maximum number of hosts to return. |
6.79.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.79.1.2. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.80. ExternalHost
| Name | Summary |
|---|---|
|
|
6.80.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.80.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.81. ExternalHostGroup
This service manages a single host group information.
Host group is a term of host provider - the host group includes provision details that are applied to new discovered host. Information such as subnet, operating system, domain, etc.
| Name | Summary |
|---|---|
|
| Get host group information. |
6.81.1. get GET
Get host group information.
For example, to get the details of hostgroup 234 of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234
GET /ovirt-engine/api/externalhostproviders/123/hostgroups/234It will return a response like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Host group information. |
6.81.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.82. ExternalHostGroups
This service manages hostgroups.
| Name | Summary |
|---|---|
|
| Get host groups list from external host provider. |
6.82.1. list GET
Get host groups list from external host provider.
Host group is a term of host providers - the host group includes provision details. This API returns all possible hostgroups exposed by the external provider.
For example, to get the details of all host groups of provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123/hostgroups
GET /ovirt-engine/api/externalhostproviders/123/hostgroupsThe response will be like this:
The order of the returned list of host groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | List of all hostgroups available for external host provider | |
|
| In | Sets the maximum number of groups to return. |
6.82.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.82.1.2. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.83. ExternalHostProvider
Represents an external host provider, such as Foreman or Satellite.
See Foreman documentation for details. See Satellite documentation for details.
| Name | Summary |
|---|---|
|
| Get external host provider information Host provider, Foreman or Satellite, can be set as an external provider in ovirt. |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified external host provider in the system. |
6.83.1. get GET
Get external host provider information
Host provider, Foreman or Satellite, can be set as an external provider in ovirt. To see details about specific host providers attached to ovirt use this API.
For example, to get the details of host provider 123, send a request like this:
GET /ovirt-engine/api/externalhostproviders/123
GET /ovirt-engine/api/externalhostproviders/123The response will be like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.83.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.83.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.83.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.83.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.83.5. update PUT
Update the specified external host provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.84. ExternalHostProviders
| Name | Summary |
|---|---|
|
| Add a new external host provider to the system. |
|
| Returns the list of external host providers. |
6.84.1. add POST
Add a new external host provider to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.84.2. list GET
Returns the list of external host providers.
The order of the returned list of host providers isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned external host providers. |
6.84.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.84.2.2. max
Sets the maximum number of providers to return. If not specified all the providers are returned.
6.85. ExternalHosts
| Name | Summary |
|---|---|
|
| Return the list of external hosts. |
6.85.1. list GET
Return the list of external hosts.
The order of the returned list of hosts isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hosts to return. |
6.85.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.85.1.2. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.86. ExternalNetworkProviderConfiguration
Describes how an external network provider is provisioned by the system on the host.
| Name | Summary |
|---|---|
|
| Returns the information about an external network provider on the host. |
6.86.1. get GET
Returns the information about an external network provider on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.86.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.87. ExternalNetworkProviderConfigurations
A service to list all external network providers provisioned by the system on the host.
| Name | Summary |
|---|---|
|
| Returns the list of all external network providers on the host. |
6.87.1. list GET
Returns the list of all external network providers on the host.
The order of the returned list of networks is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.87.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.88. ExternalProvider
Provides capability to manage external providers.
| Name | Summary |
|---|---|
|
| Import the SSL certificates of the external host provider. |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
6.88.1. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.88.2. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.89. ExternalProviderCertificate
A service to view specific certificate for external provider.
| Name | Summary |
|---|---|
|
| Get specific certificate. |
6.89.1. get GET
Get specific certificate.
GET /ovirt-engine/api/externalhostproviders/123/certificate/0
GET /ovirt-engine/api/externalhostproviders/123/certificate/0And here is sample response:
<certificate id="0"> <organization>provider.example.com</organization> <subject>CN=provider.example.com</subject> <content>...</content> </certificate>
<certificate id="0">
<organization>provider.example.com</organization>
<subject>CN=provider.example.com</subject>
<content>...</content>
</certificate>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The details of the certificate. | |
|
| In | Indicates which inner links should be followed. |
6.89.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.90. ExternalProviderCertificates
A service to view certificates for external provider.
| Name | Summary |
|---|---|
|
| Returns the chain of certificates presented by the external provider. |
6.90.1. list GET
Returns the chain of certificates presented by the external provider.
GET /ovirt-engine/api/externalhostproviders/123/certificates
GET /ovirt-engine/api/externalhostproviders/123/certificatesAnd here is sample response:
<certificates> <certificate id="789">...</certificate> ... </certificates>
<certificates>
<certificate id="789">...</certificate>
...
</certificates>The order of the returned certificates is always guaranteed to be the sign order: the first is the certificate of the server itself, the second the certificate of the CA that signs the first, so on.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List containing certificate details. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of certificates to return. |
6.90.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.90.1.2. max
Sets the maximum number of certificates to return. If not specified all the certificates are returned.
6.91. ExternalTemplateImports
Provides capability to import external templates. Currently supports OVA only.
| Name | Summary |
|---|---|
|
| This operation is used to import a template from external hypervisor. |
6.91.1. add POST
This operation is used to import a template from external hypervisor.
For example import of a template OVA can be facilitated using the following request:
POST /externaltemplateimports
POST /externaltemplateimportsWith request body of type ExternalTemplateImport, for example:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.92. ExternalVmImports
Provides capability to import external virtual machines.
| Name | Summary |
|---|---|
|
| This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware. |
6.92.1. add POST
This operation is used to import a virtual machine from external hypervisor, such as KVM, XEN or VMware.
For example import of a virtual machine from VMware can be facilitated using the following request:
POST /externalvmimports
POST /externalvmimportsWith request body of type ExternalVmImport, for example:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.93. FenceAgent
A service to manage fence agent for a specific host.
| Name | Summary |
|---|---|
|
| Gets details of this fence agent. |
|
| Removes a fence agent for a specific host. |
|
| Update a fencing-agent. |
6.93.1. get GET
Gets details of this fence agent.
GET /ovirt-engine/api/hosts/123/fenceagents/0
GET /ovirt-engine/api/hosts/123/fenceagents/0And here is sample response:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Fence agent details. | |
|
| In | Indicates which inner links should be followed. |
6.93.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.93.2. remove DELETE
Removes a fence agent for a specific host.
DELETE /ovirt-engine/api/hosts/123/fenceagents/0
DELETE /ovirt-engine/api/hosts/123/fenceagents/0| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.93.3. update PUT
Update a fencing-agent.
6.94. FenceAgents
A service to manage fence agents for a specific host.
| Name | Summary |
|---|---|
|
| Add a new fencing-agent to the host. |
|
| Returns the list of fencing agents configured for the host. |
6.94.1. add POST
Add a new fencing-agent to the host.
apc, bladecenter, wti fencing agent/s sample request:
apc_snmp, hpblade, ilo, ilo2, ilo_ssh, redfish, rsa fencing agent/s sample request:
cisco_ucs, drac5, eps fencing agent/s sample request:
drac7, ilo3, ilo4, ipmilan, rsb fencing agent/s sample request:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.94.2. list GET
Returns the list of fencing agents configured for the host.
GET /ovirt-engine/api/hosts/123/fenceagents
GET /ovirt-engine/api/hosts/123/fenceagentsAnd here is sample response:
The order of the returned list of fencing agents isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | List of fence agent details. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of agents to return. |
6.94.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.94.2.2. max
Sets the maximum number of agents to return. If not specified all the agents are returned.
6.95. File
| Name | Summary |
|---|---|
|
|
6.95.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.95.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.96. Files
Provides a way for clients to list available files.
This service is specifically targeted to ISO storage domains, which contain ISO images and virtual floppy disks (VFDs) that an administrator uploads.
The addition of a CD-ROM device to a virtual machine requires an ISO image from the files of an ISO storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of ISO images and virtual floppy disks available in the storage domain. |
6.96.1. list GET
Returns the list of ISO images and virtual floppy disks available in the storage domain. The order of the returned list is not guaranteed.
If the refresh parameter is false, the returned list may not reflect recent changes to the storage domain; for example, it may not contain a new ISO file that was recently added. This is because the server caches the list of files to improve performance. To get the very latest results, set the refresh parameter to true.
The default value of the refresh parameter is true, but it can be changed using the configuration value ForceRefreshDomainFilesByDefault:
engine-config -s ForceRefreshDomainFilesByDefault=false
# engine-config -s ForceRefreshDomainFilesByDefault=false
Setting the value of the refresh parameter to true has an impact on the performance of the server. Use it only if necessary.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of files to return. | |
|
| In | Indicates whether the list of files should be refreshed from the storage domain, rather than showing cached results that are updated at certain intervals. | |
|
| In | A query string used to restrict the returned files. |
6.96.1.1. case_sensitive
Indicates if the search performed using the search parameter should take case into account. The default value is true.
6.96.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.96.1.3. max
Sets the maximum number of files to return. If not specified, all the files are returned.
6.97. Filter
| Name | Summary |
|---|---|
|
| |
|
|
6.97.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.97.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.97.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.98. Filters
Manages the filters used by an scheduling policy.
| Name | Summary |
|---|---|
|
| Add a filter to a specified user defined scheduling policy. |
|
| Returns the list of filters used by the scheduling policy. |
6.98.1. add POST
Add a filter to a specified user defined scheduling policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.98.2. list GET
Returns the list of filters used by the scheduling policy.
The order of the returned list of filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of filters to return. |
6.98.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.98.2.2. max
Sets the maximum number of filters to return. If not specified all the filters are returned.
6.99. Follow
6.100. GlusterBrick
This service manages a single gluster brick.
| Name | Summary |
|---|---|
|
| Get details of a brick. |
|
| Removes a brick. |
|
| Replaces this brick with a new one. |
6.100.1. get GET
Get details of a brick.
Retrieves status details of brick from underlying gluster volume with header All-Content set to true. This is the equivalent of running gluster volume status <volumename> <brickname> detail.
For example, to get the details of brick 234 of gluster volume 123, send a request like this:
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234Which will return a response body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.100.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.100.2. remove DELETE
Removes a brick.
Removes a brick from the underlying gluster volume and deletes entries from database. This can be used only when removing a single brick without data migration. To remove multiple bricks and with data migration, use migrate instead.
For example, to delete brick 234 from gluster volume 123, send a request like this:
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.100.3. replace POST
Replaces this brick with a new one.
This operation has been deprecated since version 3.5 of the engine and will be removed in the future. Use add brick(s) and migrate brick(s) instead.
6.101. GlusterBricks
This service manages the gluster bricks in a gluster volume
| Name | Summary |
|---|---|
|
| Activate the bricks post data migration of remove brick operation. |
|
| Adds a list of bricks to gluster volume. |
|
| Lists the bricks of a gluster volume. |
|
| Start migration of data prior to removing bricks. |
|
| Removes bricks from gluster volume. |
|
| Stops migration of data from bricks for a remove brick operation. |
6.101.1. activate POST
Activate the bricks post data migration of remove brick operation.
Used to activate brick(s) once the data migration from bricks is complete but user no longer wishes to remove bricks. The bricks that were previously marked for removal will now be used as normal bricks.
For example, to retain the bricks that on glustervolume 123 from which data was migrated, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/activateWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. | |
|
| In | The list of bricks that need to be re-activated. |
6.101.2. add POST
Adds a list of bricks to gluster volume.
Used to expand a gluster volume by adding bricks. For replicated volume types, the parameter replica_count needs to be passed. In case the replica count is being increased, then the number of bricks needs to be equivalent to the number of replica sets.
For example, to add bricks to gluster volume 123, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The list of bricks to be added to the volume | |
|
| In | Replica count of volume post add operation. | |
|
| In | Stripe count of volume post add operation. |
6.101.3. list GET
Lists the bricks of a gluster volume.
For example, to list bricks of gluster volume 123, send a request like this:
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
GET /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksProvides an output as below:
The order of the returned list is based on the brick order provided at gluster volume creation.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bricks to return. |
6.101.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.101.3.2. max
Sets the maximum number of bricks to return. If not specified all the bricks are returned.
6.101.4. migrate POST
Start migration of data prior to removing bricks.
Removing bricks is a two-step process, where the data on bricks to be removed, is first migrated to remaining bricks. Once migration is completed the removal of bricks is confirmed via the API remove. If at any point, the action needs to be cancelled stopmigrate has to be called.
For instance, to delete a brick from a gluster volume with id 123, send a request:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/migrateWith a request body like this:
The migration process can be tracked from the job id returned from the API using job and steps in job using step
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the migration should be performed asynchronously. | |
|
| In | List of bricks for which data migration needs to be started. |
6.101.5. remove DELETE
Removes bricks from gluster volume.
The recommended way to remove bricks without data loss is to first migrate the data using stopmigrate and then removing them. If migrate was not called on bricks prior to remove, the bricks are removed without data migration which may lead to data loss.
For example, to delete the bricks from gluster volume 123, send a request like this:
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks
DELETE /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricksWith a request body like this:
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | The list of bricks to be removed | |
|
| In | Replica count of volume post add operation. |
6.101.6. stopmigrate POST
Stops migration of data from bricks for a remove brick operation.
To cancel data migration that was started as part of the 2-step remove brick process in case the user wishes to continue using the bricks. The bricks that were marked for removal will function as normal bricks post this operation.
For example, to stop migration of data from the bricks of gluster volume 123, send a request like this:
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrate
POST /ovirt-engine/api/clusters/567/glustervolumes/123/glusterbricks/stopmigrateWith a request body like this:
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>
<bricks>
<brick>
<name>host:brick_directory</name>
</brick>
</bricks>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | List of bricks for which data migration needs to be stopped. |
6.101.6.1. bricks
List of bricks for which data migration needs to be stopped. This list should match the arguments passed to migrate.
6.102. GlusterHook
| Name | Summary |
|---|---|
|
| Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. |
|
| Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. |
|
| |
|
| Removes the this Gluster hook from all servers in cluster and deletes it from the database. |
|
| Resolves missing hook conflict depending on the resolution type. |
6.102.1. disable POST
Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. This updates the hook status to DISABLED in database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.102.2. enable POST
Resolves status conflict of hook among servers in cluster by disabling Gluster hook in all servers of the cluster. This updates the hook status to DISABLED in database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.102.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.102.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.102.4. remove DELETE
Removes the this Gluster hook from all servers in cluster and deletes it from the database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.102.5. resolve POST
Resolves missing hook conflict depending on the resolution type.
For ADD resolves by copying hook stored in engine database to all servers where the hook is missing. The engine maintains a list of all servers where hook is missing.
For COPY resolves conflict in hook content by copying hook stored in engine database to all servers where the hook is missing. The engine maintains a list of all servers where the content is conflicting. If a host id is passed as parameter, the hook content from the server is used as the master to copy to other servers in cluster.
6.103. GlusterHooks
| Name | Summary |
|---|---|
|
| Returns the list of hooks. |
6.103.1. list GET
Returns the list of hooks.
The order of the returned list of hooks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hooks to return. |
6.103.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.103.1.2. max
Sets the maximum number of hooks to return. If not specified all the hooks are returned.
6.104. GlusterVolume
This service manages a single gluster volume.
| Name | Summary |
|---|---|
|
| Get the gluster volume details. |
|
| Get gluster volume profile statistics. |
|
| Rebalance the gluster volume. |
|
| Removes the gluster volume. |
|
| Resets all the options set in the gluster volume. |
|
| Resets a particular option in the gluster volume. |
|
| Sets a particular option in the gluster volume. |
|
| Starts the gluster volume. |
|
| Start profiling the gluster volume. |
|
| Stops the gluster volume. |
|
| Stop profiling the gluster volume. |
|
| Stop rebalancing the gluster volume. |
6.104.1. get GET
Get the gluster volume details.
For example, to get details of a gluster volume with identifier 123 in cluster 456, send a request like this:
GET /ovirt-engine/api/clusters/456/glustervolumes/123
GET /ovirt-engine/api/clusters/456/glustervolumes/123This GET request will return the following output:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Representation of the gluster volume. |
6.104.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.104.2. getprofilestatistics POST
Get gluster volume profile statistics.
For example, to get profile statistics for a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics
POST /ovirt-engine/api/clusters/456/glustervolumes/123/getprofilestatistics| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Gluster volume profiling information returned from the action. |
6.104.3. rebalance POST
Rebalance the gluster volume.
Rebalancing a gluster volume helps to distribute the data evenly across all the bricks. After expanding or shrinking a gluster volume (without migrating data), we need to rebalance the data among the bricks. In a non-replicated volume, all bricks should be online to perform the rebalance operation. In a replicated volume, at least one of the bricks in the replica should be online.
For example, to rebalance a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance
POST /ovirt-engine/api/clusters/456/glustervolumes/123/rebalance| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the rebalance should be performed asynchronously. | |
|
| In | If set to true, rebalance will only fix the layout so that new data added to the volume is distributed across all the hosts. | |
|
| In | Indicates if the rebalance should be force started. |
6.104.3.1. fix_layout
If set to true, rebalance will only fix the layout so that new data added to the volume is distributed across all the hosts. But it will not migrate/rebalance the existing data. Default is false.
6.104.3.2. force
Indicates if the rebalance should be force started. The rebalance command can be executed with the force option even when the older clients are connected to the cluster. However, this could lead to a data loss situation. Default is false.
6.104.4. remove DELETE
Removes the gluster volume.
For example, to remove a volume with identifier 123 in cluster 456, send a request like this:
DELETE /ovirt-engine/api/clusters/456/glustervolumes/123
DELETE /ovirt-engine/api/clusters/456/glustervolumes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.104.5. resetalloptions POST
Resets all the options set in the gluster volume.
For example, to reset all options in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetalloptions| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reset should be performed asynchronously. |
6.104.6. resetoption POST
Resets a particular option in the gluster volume.
For example, to reset a particular option option1 in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoption
POST /ovirt-engine/api/clusters/456/glustervolumes/123/resetoptionWith the following request body:
<action> <option name="option1"/> </action>
<action>
<option name="option1"/>
</action>6.104.7. setoption POST
Sets a particular option in the gluster volume.
For example, to set option1 with value value1 in a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoption
POST /ovirt-engine/api/clusters/456/glustervolumes/123/setoptionWith the following request body:
<action> <option name="option1" value="value1"/> </action>
<action>
<option name="option1" value="value1"/>
</action>6.104.8. start POST
Starts the gluster volume.
A Gluster Volume should be started to read/write data. For example, to start a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/start
POST /ovirt-engine/api/clusters/456/glustervolumes/123/start| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the volume should be force started. |
6.104.8.1. force
Indicates if the volume should be force started. If a gluster volume is started already but few/all bricks are down then force start can be used to bring all the bricks up. Default is false.
6.104.9. startprofile POST
Start profiling the gluster volume.
For example, to start profiling a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile
POST /ovirt-engine/api/clusters/456/glustervolumes/123/startprofile| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.104.10. stop POST
Stops the gluster volume.
Stopping a volume will make its data inaccessible.
For example, to stop a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stop6.104.11. stopprofile POST
Stop profiling the gluster volume.
For example, to stop profiling a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stopprofile| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.104.12. stoprebalance POST
Stop rebalancing the gluster volume.
For example, to stop rebalancing a gluster volume with identifier 123 in cluster 456, send a request like this:
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance
POST /ovirt-engine/api/clusters/456/glustervolumes/123/stoprebalance| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.105. GlusterVolumes
This service manages a collection of gluster volumes available in a cluster.
| Name | Summary |
|---|---|
|
| Creates a new gluster volume. |
|
| Lists all gluster volumes in the cluster. |
6.105.1. add POST
Creates a new gluster volume.
The volume is created based on properties of the volume parameter. The properties name, volume_type and bricks are required.
For example, to add a volume with name myvolume to the cluster 123, send the following request:
POST /ovirt-engine/api/clusters/123/glustervolumes
POST /ovirt-engine/api/clusters/123/glustervolumesWith the following request body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The gluster volume definition from which to create the volume is passed as input and the newly created volume is returned. |
6.105.2. list GET
Lists all gluster volumes in the cluster.
For example, to list all Gluster Volumes in cluster 456, send a request like this:
GET /ovirt-engine/api/clusters/456/glustervolumes
GET /ovirt-engine/api/clusters/456/glustervolumesThe order of the returned list of volumes isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of volumes to return. | |
|
| In | A query string used to restrict the returned volumes. | |
|
| Out |
6.105.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.105.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.105.2.3. max
Sets the maximum number of volumes to return. If not specified all the volumes are returned.
6.106. Group
Manages a group of users. Use this service to either get groups details or remove groups. In order to add new groups please use service that manages the collection of groups.
| Name | Summary |
|---|---|
|
| Gets the system group information. |
|
| Removes the system group. |
6.106.1. get GET
Gets the system group information.
Usage:
GET /ovirt-engine/api/groups/123
GET /ovirt-engine/api/groups/123Will return the group information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The system group. |
6.106.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.106.2. remove DELETE
Removes the system group.
Usage:
DELETE /ovirt-engine/api/groups/123
DELETE /ovirt-engine/api/groups/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.107. Groups
Manages the collection of groups of users.
| Name | Summary |
|---|---|
|
| Add group from a directory service. |
|
| List all the groups in the system. |
6.107.1. add POST
Add group from a directory service. Please note that domain name is name of the authorization provider.
For example, to add the Developers group from the internal-authz authorization provider send a request like this:
POST /ovirt-engine/api/groups
POST /ovirt-engine/api/groupsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The group to be added. |
6.107.2. list GET
List all the groups in the system.
Usage:
GET /ovirt-engine/api/groups
GET /ovirt-engine/api/groupsWill return the list of groups:
The order of the returned list of groups isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of groups. | |
|
| In | Sets the maximum number of groups to return. | |
|
| In | A query string used to restrict the returned groups. |
6.107.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.107.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.107.2.3. max
Sets the maximum number of groups to return. If not specified all the groups are returned.
6.108. Host
A service to manage a host.
| Name | Summary |
|---|---|
|
| Activates the host for use, for example to run virtual machines. |
|
| Approve a pre-installed Hypervisor host for usage in the virtualization environment. |
|
| Marks the network configuration as good and persists it inside the host. |
|
| Copy the network configuration of the specified host to current host. |
|
| Deactivates the host to perform maintenance tasks. |
|
| Discovers iSCSI targets on the host, using the initiator details. |
|
| Enrolls the certificate of the host. |
|
| Controls the host’s power management device. |
|
| To manually set a host as the storage pool manager (SPM). |
|
| Gets the host details. |
|
| Installs the latest version of VDSM and related software on the host. |
|
| This method has been deprecated since Engine version 4. |
|
| Login to iSCSI targets on the host, using the target details. |
|
| Refresh the host devices and capabilities. |
|
| Remove the host from the system. |
|
| This method is used to change the configuration of the network interfaces of a host. |
|
| To synchronize all networks on the host, send a request like this: [source] ---- POST /ovirt-engine/api/hosts/123/syncallnetworks ---- With a request body like this: [source,xml] ---- <action/> ---- |
|
| Discovers the block Storage Domains which are candidates to be imported to the setup. |
|
| Update the host properties. |
|
| Upgrades VDSM and selected software on the host. |
|
| Check if there are upgrades available for the host. |
6.108.1. activate POST
Activates the host for use, for example to run virtual machines.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.108.2. approve POST
Approve a pre-installed Hypervisor host for usage in the virtualization environment.
This action also accepts an optional cluster element to define the target cluster for this host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | When set to 'true', this host will be activated after its approval completes. | |
|
| In | Indicates if the approval should be performed asynchronously. | |
|
| In | The cluster where the host will be added after it is approved. | |
|
| In | The host to approve. | |
|
| In | Indicates if the host should be rebooted after successful installation. |
6.108.2.1. activate
When set to 'true', this host will be activated after its approval completes. When set to 'false' the host will remain in 'maintenance' status after its approval. Absence of this parameter will be interpreted as 'true', since the desired default behavior is activating the host after approval.
6.108.2.2. reboot
Indicates if the host should be rebooted after successful installation. The default value is true.
6.108.3. commitnetconfig POST
Marks the network configuration as good and persists it inside the host.
An API user commits the network configuration to persist a host network interface attachment or detachment, or persist the creation and deletion of a bonded interface.
Networking configuration is only committed after the engine has established that host connectivity is not lost as a result of the configuration changes. If host connectivity is lost, the host requires a reboot and automatically reverts to the previous networking configuration.
For example, to commit the network configuration of host with id 123 send a request like this:
POST /ovirt-engine/api/hosts/123/commitnetconfig
POST /ovirt-engine/api/hosts/123/commitnetconfigWith a request body like this:
<action/>
<action/>
Since Red Hat Virtualization Manager 4.3, it is possible to also specify commit_on_success in the setupnetworks request, in which case the new configuration is automatically saved in the {hypervisor-name} upon completing the setup and re-establishing connectivity between the {hypervisor-name} and Red Hat Virtualization Manager, and without waiting for a separate commitnetconfig request.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.108.4. copyhostnetworks POST
Copy the network configuration of the specified host to current host.
Any network attachments that are not present on the source host will be erased from the target host by the copy operation.
To copy networks from another host, send a request like this:
POST /ovirt-engine/api/hosts/123/copyhostnetworks
POST /ovirt-engine/api/hosts/123/copyhostnetworksWith a request body like this:
<action> <source_host id="456"/> </action>
<action>
<source_host id="456"/>
</action>6.108.5. deactivate POST
Deactivates the host to perform maintenance tasks.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. | |
|
| In | ||
|
| In | Indicates if the gluster service should be stopped as part of deactivating the host. |
6.108.5.1. stop_gluster_service
Indicates if the gluster service should be stopped as part of deactivating the host. It can be used while performing maintenance operations on the gluster host. Default value for this variable is false.
6.108.6. discoveriscsi POST
Discovers iSCSI targets on the host, using the initiator details. Returns a list of IscsiDetails objects containing the discovered data.
For example, to discover iSCSI targets available in myiscsi.example.com, from host 123, send a request like this:
POST /ovirt-engine/api/hosts/123/discoveriscsi
POST /ovirt-engine/api/hosts/123/discoveriscsiWith a request body like this:
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>The result will be like this:
When using this method to discover iscsi targets, you can use an FQDN or an IP address, but you must use the iscsi details from the discovered targets results to log in using the iscsilogin method.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the discovery should be performed asynchronously. | |
|
| Out | The discovered targets including all connection information. | |
|
| In | The target iSCSI device. |
6.108.7. enrollcertificate POST
Enrolls the certificate of the host. Useful in case you get a warning that it is about to expire or has already expired.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the enrollment should be performed asynchronously. |
6.108.8. fence POST
Controls the host’s power management device.
For example, to start the host. This can be done via:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the fencing should be performed asynchronously. | |
|
| In | ||
|
| In | Indicates if host should be put into maintenance after restart. | |
|
| Out |
6.108.9. forceselectspm POST
To manually set a host as the storage pool manager (SPM).
POST /ovirt-engine/api/hosts/123/forceselectspm
POST /ovirt-engine/api/hosts/123/forceselectspmWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.108.10. get GET
Gets the host details.
GET /ovirt-engine/api/hosts/123
GET /ovirt-engine/api/hosts/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the host should be included in the response. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The queried host. |
6.108.10.1. all_content
Indicates if all of the attributes of the host should be included in the response.
By default the following attributes are excluded:
-
hosted_engine
For example, to retrieve the complete representation of host '123':
GET /ovirt-engine/api/hosts/123?all_content=true
GET /ovirt-engine/api/hosts/123?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.108.10.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.108.11. install POST
Installs the latest version of VDSM and related software on the host.
The action also performs every configuration steps on the host which is done during adding host to the engine: kdump configuration, hosted-engine deploy, kernel options changes, etc.
The host type defines additional parameters for the action.
Example of installing a host, using curl and JSON, plain:
Example of installing a host using curl and JSON with hosted engine components:
Since version 4.1.2 of the engine, when a host is reinstalled we override the host firewall definitions by default.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | When set to 'true', this host will be activated after its installation completes. | |
|
| In | Indicates if the installation should be performed asynchronously. | |
|
| In |
When set to | |
|
| In |
The | |
|
| In | When installing {hypervisor-name}, an ISO image file is required. | |
|
| In | Indicates if the host should be rebooted after successful installation. | |
|
| In |
The password of the | |
|
| In | The SSH details used to connect to the host. | |
|
| In |
When set to |
6.108.11.1. activate
When set to 'true', this host will be activated after its installation completes. When set to 'false' the host will remain in 'maintenance' status after its installation. Absence of this parameter will be interpreted as 'true', since the desired default behavior is activating the host after install.
6.108.11.2. deploy_hosted_engine
When set to true this host will also deploy the self-hosted engine components. A missing value is treated as true i.e deploy. Omitting this parameter means false and will not perform any operation in the self-hosted engine area.
6.108.11.3. reboot
Indicates if the host should be rebooted after successful installation. The default value is true.
6.108.11.4. undeploy_hosted_engine
When set to true this host will un-deploy the self-hosted engine components, and this host will not function as part of the High Availability cluster. A missing value is treated as true i.e un-deploy. Omitting this parameter means false and will not perform any operation in the self-hosted engine area.
6.108.12. iscsidiscover POST
This method has been deprecated since Engine version 4.4.6. DiscoverIscsi should be used instead.
Discovers iSCSI targets on the host, using the initiator details. Returns an array of strings containing the discovered data.
For example, to discover iSCSI targets available in myiscsi.example.com, from host 123, send a request like this:
POST /ovirt-engine/api/hosts/123/iscsidiscover
POST /ovirt-engine/api/hosts/123/iscsidiscoverWith a request body like this:
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>
<action>
<iscsi>
<address>myiscsi.example.com</address>
</iscsi>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the discovery should be performed asynchronously. | |
|
| In | The target iSCSI device. | |
|
| Out | The iSCSI targets. |
6.108.12.1. iscsi_targets
The iSCSI targets. *
6.108.13. iscsilogin POST
Login to iSCSI targets on the host, using the target details.
When using this method to log in, you must use the iscsi details from the discovered targets results in the discoveriscsi method.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the login should be performed asynchronously. | |
|
| In | The target iSCSI device. |
6.108.14. refresh POST
Refresh the host devices and capabilities.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the refresh should be performed asynchronously. |
6.108.15. remove DELETE
Remove the host from the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates that the host should be removed even if it is non-responsive, or if it is part of a Gluster Storage cluster and has volume bricks on it. |
6.108.16. setupnetworks POST
This method is used to change the configuration of the network interfaces of a host.
For example, if you have a host with three network interfaces eth0, eth1 and eth2 and you want to configure a new bond using eth0 and eth1, and put a VLAN on top of it. Using a simple shell script and the curl command line HTTP client that can be done as follows:
This is valid for version 4 of the API. In previous versions some elements were represented as XML attributes instead of XML elements. In particular the options and ip elements were represented as follows:
<options name="mode" value="4"/> <options name="miimon" value="100"/> <ip address="192.168.122.10" netmask="255.255.255.0"/>
<options name="mode" value="4"/>
<options name="miimon" value="100"/>
<ip address="192.168.122.10" netmask="255.255.255.0"/>The same thing can be done using the Python SDK with the following code:
To make sure that the network configuration has been saved in the host, and that it will be applied when the host is rebooted, remember to call commitnetconfig.
Since Red Hat Virtualization Manager 4.3, it is possible to also specify commit_on_success in the setupnetworks request, in which case the new configuration is automatically saved in the {hypervisor-name} upon completing the setup and re-establishing connectivity between the {hypervisor-name} and Red Hat Virtualization Manager, and without waiting for a separate commitnetconfig request.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | ||
|
| In | Specifies whether to automatically save the configuration in the {hypervisor-name} upon completing the setup and re-establishing connectivity between the {hypervisor-name} and Red Hat Virtualization Manager, and without waiting for a separate commitnetconfig request. | |
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | A list of network attachments that will be synchronized. |
6.108.16.1. commit_on_success
Specifies whether to automatically save the configuration in the {hypervisor-name} upon completing the setup and re-establishing connectivity between the {hypervisor-name} and Red Hat Virtualization Manager, and without waiting for a separate commitnetconfig request. The default value is false, which means that the configuration will not be saved automatically.
6.108.17. syncallnetworks POST
To synchronize all networks on the host, send a request like this:
POST /ovirt-engine/api/hosts/123/syncallnetworks
POST /ovirt-engine/api/hosts/123/syncallnetworksWith a request body like this:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.108.18. unregisteredstoragedomainsdiscover POST
Discovers the block Storage Domains which are candidates to be imported to the setup. For FCP no arguments are required.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the discovery should be performed asynchronously. | |
|
| In | ||
|
| Out |
6.108.19. update PUT
Update the host properties.
For example, to update a the kernel command line of a host send a request like this:
PUT /ovirt-engine/api/hosts/123
PUT /ovirt-engine/api/hosts/123With request body like this:
<host>
<os>
<custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
</os>
</host>
<host>
<os>
<custom_kernel_cmdline>vfio_iommu_type1.allow_unsafe_interrupts=1</custom_kernel_cmdline>
</os>
</host>6.108.20. upgrade POST
Upgrades VDSM and selected software on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the upgrade should be performed asynchronously. | |
|
| In | This property is no longer relevant, since Vintage Node is no longer supported, and has been deprecated. | |
|
| In | Indicates if the host should be rebooted after the upgrade. | |
|
| In | Upgrade timeout. |
6.108.20.1. reboot
Indicates if the host should be rebooted after the upgrade. By default the host is rebooted.
This parameter is ignored for {hypervisor-name}, which is always rebooted after the upgrade.
6.108.20.2. timeout
Upgrade timeout.
The maximum time to wait for upgrade to finish in minutes. Default value is specified by ANSIBLE_PLAYBOOK_EXEC_DEFAULT_TIMEOUT configration option.
6.108.21. upgradecheck POST
Check if there are upgrades available for the host. If there are upgrades available an icon will be displayed next to host status icon in the Administration Portal. Audit log messages are also added to indicate the availability of upgrades. The upgrade can be started from the webadmin or by using the upgrade host action.
6.109. HostCpuUnits
| Name | Summary |
|---|---|
|
| Returns the List of all host’s CPUs with detailed information about the topology (socket, core) and with information about the current CPU pinning. |
6.109.1. list GET
Returns the List of all host’s CPUs with detailed information about the topology (socket, core) and with information about the current CPU pinning.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.109.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.110. HostDevice
A service to access a particular device of a host.
| Name | Summary |
|---|---|
|
| Retrieve information about a particular host’s device. |
6.110.1. get GET
Retrieve information about a particular host’s device.
An example of getting a host device:
GET /ovirt-engine/api/hosts/123/devices/456
GET /ovirt-engine/api/hosts/123/devices/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.110.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.111. HostDevices
A service to access host devices.
| Name | Summary |
|---|---|
|
| List the devices of a host. |
6.111.1. list GET
List the devices of a host.
The order of the returned list of devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of devices to return. |
6.111.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.111.1.2. max
Sets the maximum number of devices to return. If not specified all the devices are returned.
6.112. HostHook
| Name | Summary |
|---|---|
|
|
6.112.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.112.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.113. HostHooks
| Name | Summary |
|---|---|
|
| Returns the list of hooks configured for the host. |
6.113.1. list GET
Returns the list of hooks configured for the host.
The order of the returned list of hooks is random.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hooks to return. |
6.113.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.113.1.2. max
Sets the maximum number of hooks to return. If not specified, all the hooks are returned.
6.114. HostNic
A service to manage a network interface of a host.
| Name | Summary |
|---|---|
|
| |
|
| The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC. |
6.114.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the host network interface should be included in the response. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.114.1.1. all_content
Indicates if all of the attributes of the host network interface should be included in the response.
By default the following attributes are excluded:
-
virtual_functions_configuration
For example, to retrieve the complete representation network interface '456' of host '123':
GET /ovirt-engine/api/hosts/123/nics/456?all_content=true
GET /ovirt-engine/api/hosts/123/nics/456?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.114.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.114.2. updatevirtualfunctionsconfiguration POST
The action updates virtual function configuration in case the current resource represents an SR-IOV enabled NIC. The input should be consisted of at least one of the following properties:
-
allNetworksAllowed -
numberOfVirtualFunctions
Please see the HostNicVirtualFunctionsConfiguration type for the meaning of the properties.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In |
6.115. HostNics
A service to manage the network interfaces of a host.
| Name | Summary |
|---|---|
|
| Returns the list of network interfaces of the host. |
6.115.1. list GET
Returns the list of network interfaces of the host.
The order of the returned list of network interfaces isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the host network interface should be included in the response. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Out |
6.115.1.1. all_content
Indicates if all of the attributes of the host network interface should be included in the response.
By default the following attributes are excluded:
-
virtual_functions_configuration
For example, to retrieve the complete representation of network interface '456' of host '123':
GET /ovirt-engine/api/hosts/123/nics?all_content=true
GET /ovirt-engine/api/hosts/123/nics?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.115.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.115.1.3. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.116. HostNumaNode
| Name | Summary |
|---|---|
|
|
6.116.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.116.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.117. HostNumaNodes
| Name | Summary |
|---|---|
|
| Returns the list of NUMA nodes of the host. |
6.117.1. list GET
Returns the list of NUMA nodes of the host.
The order of the returned list of NUMA nodes isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of nodes to return. | |
|
| Out |
6.117.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.117.1.2. max
Sets the maximum number of nodes to return. If not specified all the nodes are returned.
6.118. HostStorage
A service to manage host storages.
| Name | Summary |
|---|---|
|
| Get list of storages. |
6.118.1. list GET
Get list of storages.
GET /ovirt-engine/api/hosts/123/storage
GET /ovirt-engine/api/hosts/123/storageThe XML response you get will be like this one:
The order of the returned list of storages isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates if the status of the LUNs in the storage should be checked. | |
|
| Out | Retrieved list of storages. |
6.118.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.118.1.2. report_status
Indicates if the status of the LUNs in the storage should be checked. Checking the status of the LUN is an heavy weight operation and this data is not always needed by the user. This parameter will give the option to not perform the status check of the LUNs.
The default is true for backward compatibility.
Here an example with the LUN status :
Here an example without the LUN status :
6.119. Hosts
A service that manages hosts.
| Name | Summary |
|---|---|
|
| Creates a new host. |
|
| Get a list of all available hosts. |
6.119.1. add POST
Creates a new host.
The host is created based on the attributes of the host parameter. The name, address, and root_password properties are required.
For example, to add a host, send the following request:
POST /ovirt-engine/api/hosts
POST /ovirt-engine/api/hostsWith the following request body:
<host> <name>myhost</name> <address>myhost.example.com</address> <root_password>myrootpassword</root_password> </host>
<host>
<name>myhost</name>
<address>myhost.example.com</address>
<root_password>myrootpassword</root_password>
</host>
The root_password element is only included in the client-provided initial representation and is not exposed in the representations returned from subsequent requests.
Since version 4.1.2 of the engine, when a host is newly added, the host’s firewall definitions are overridden by default.
To add a hosted engine host, use the optional deploy_hosted_engine parameter:
POST /ovirt-engine/api/hosts?deploy_hosted_engine=true
POST /ovirt-engine/api/hosts?deploy_hosted_engine=trueIf the cluster has a default external network provider that is supported for automatic deployment, the external network provider is deployed when adding the host. Only external network providers for OVN are supported for the automatic deployment. To deploy an external network provider other than the one defined in the clusters, overwrite the external network provider when adding hosts, by sending the following request:
POST /ovirt-engine/api/hosts
POST /ovirt-engine/api/hosts
With a request body that contains a reference to the desired provider in the external_network_provider_configuration:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
When set to | |
|
| In |
When set to | |
|
| In/Out | The host definition with which the new host is created is passed as a parameter, and the newly created host is returned. | |
|
| In | Indicates if the host should be rebooted after successful installation. | |
|
| In |
When set to |
6.119.1.1. activate
When set to true, this host will be activated after its installation completes. When set to false the host will remain in maintenance status after its installation. Absence of this parameter will be interpreted as true, since the desired default behavior is activating the host after install.
6.119.1.2. deploy_hosted_engine
When set to true, this host deploys the hosted engine components. A missing value is treated as true, i.e., deploy the hosted engine components. Omitting this parameter equals false, and the host performs no operation in the hosted engine area.
6.119.1.3. reboot
Indicates if the host should be rebooted after successful installation. The default value is true.
6.119.1.4. undeploy_hosted_engine
When set to true, this host un-deploys the hosted engine components and does not function as part of the High Availability cluster. A missing value is treated as true, i.e., un-deploy. Omitting this parameter equals false and the host performs no operation in the hosted engine area.
6.119.2. list GET
Get a list of all available hosts.
For example, to list the hosts send the following request:
GET /ovirt-engine/api/hosts
GET /ovirt-engine/api/hostsThe response body will be similar to this:
The order of the returned list of hosts is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the hosts should be included in the response. | |
|
| In |
Indicates if the search performed using the | |
|
| In |
This parameter can be used with | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of hosts to return. | |
|
| In | Accepts a comma-separated list of virtual machine IDs and returns the hosts that these virtual machines can be migrated to. | |
|
| In | A query string used to restrict the returned hosts. |
6.119.2.1. all_content
Indicates if all of the attributes of the hosts should be included in the response.
By default the following host attributes are excluded:
-
hosted_engine
For example, to retrieve the complete representation of the hosts:
GET /ovirt-engine/api/hosts?all_content=true
GET /ovirt-engine/api/hosts?all_content=trueThese attributes are not included by default because retrieving them impacts performance. They are seldom used and require additional queries to the database. Use this parameter with caution and only when specifically required.
6.119.2.2. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.119.2.3. check_vms_in_affinity_closure
This parameter can be used with migration_target_of to get valid migration targets for the listed virtual machines and all other virtual machines that are in positive enforcing affinity with the listed virtual machines.
This is useful in case the virtual machines will be migrated together with others in positive affinity groups.
The default value is false.
GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true
GET /ovirt-engine/api/hosts?migration_target_of=123,456&check_vms_in_affinity_closure=true6.119.2.4. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.119.2.5. max
Sets the maximum number of hosts to return. If not specified all the hosts are returned.
6.119.2.6. migration_target_of
Accepts a comma-separated list of virtual machine IDs and returns the hosts that these virtual machines can be migrated to.
For example, to retrieve the list of hosts to which the virtual machine with ID 123 and the virtual machine with ID 456 can be migrated to, send the following request:
GET /ovirt-engine/api/hosts?migration_target_of=123,456
GET /ovirt-engine/api/hosts?migration_target_of=123,4566.120. Icon
A service to manage an icon (read-only).
| Name | Summary |
|---|---|
|
| Get an icon. |
6.120.1. get GET
Get an icon.
GET /ovirt-engine/api/icons/123
GET /ovirt-engine/api/icons/123You will get a XML response like this one:
<icon id="123"> <data>Some binary data here</data> <media_type>image/png</media_type> </icon>
<icon id="123">
<data>Some binary data here</data>
<media_type>image/png</media_type>
</icon>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved icon. |
6.120.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.121. Icons
A service to manage icons.
| Name | Summary |
|---|---|
|
| Get a list of icons. |
6.121.1. list GET
Get a list of icons.
GET /ovirt-engine/api/icons
GET /ovirt-engine/api/iconsYou will get a XML response which is similar to this one:
The order of the returned list of icons isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved list of icons. | |
|
| In | Sets the maximum number of icons to return. |
6.121.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.121.1.2. max
Sets the maximum number of icons to return. If not specified all the icons are returned.
6.122. Image
| Name | Summary |
|---|---|
|
| |
|
| Imports an image. |
6.122.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.122.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.122.2. import POST
Imports an image.
If the import_as_template parameter is true then the image will be imported as a template, otherwise it will be imported as a disk.
When imported as a template, the name of the template can be specified by the optional template.name parameter. If that parameter is not specified, then the name of the template will be automatically assigned by the engine as GlanceTemplate-x (where x will be seven random hexadecimal characters).
When imported as a disk, the name of the disk can be specified by the optional disk.name parameter. If that parameter is not specified, then the name of the disk will be automatically assigned by the engine as GlanceDisk-x (where x will be the seven hexadecimal characters of the image identifier).
It is recommended to always explicitly specify the template or disk name, to avoid these automatic names generated by the engine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In |
The cluster to which the image should be imported if the | |
|
| In | The disk to import. | |
|
| In | Specifies if a template should be created from the imported disk. | |
|
| In | The storage domain to which the disk should be imported. | |
|
| In |
The name of the template being created if the |
6.123. ImageTransfer
This service provides a mechanism to control an image transfer. The client will have to create a transfer by using add of the image transfers service, stating the image to transfer data to/from.
After doing that, the transfer is managed by this service.
Using oVirt’s Python’s SDK:
Uploading a disk with id 123 (on a random host in the data center):
Uploading a disk with id 123 on host id 456:
If the user wishes to download a disk rather than upload, he/she should specify download as the direction attribute of the transfer. This will grant a read permission from the image, instead of a write permission.
E.g:
Transfers have phases, which govern the flow of the upload/download. A client implementing such a flow should poll/check the transfer’s phase and act accordingly. All the possible phases can be found in ImageTransferPhase.
After adding a new transfer, its phase will be initializing. The client will have to poll on the transfer’s phase until it changes. When the phase becomes transferring, the session is ready to start the transfer.
For example:
transfer_service = transfers_service.image_transfer_service(transfer.id) while transfer.phase == types.ImageTransferPhase.INITIALIZING: time.sleep(3) transfer = transfer_service.get()
transfer_service = transfers_service.image_transfer_service(transfer.id)
while transfer.phase == types.ImageTransferPhase.INITIALIZING:
time.sleep(3)
transfer = transfer_service.get()At that stage, if the phase of the transfer is paused_system, the session was not successfully established. This can happen if ovirt-imageio is not running in the selected host.
| Name | Summary |
|---|---|
|
| Cancel the image transfer session. |
|
| Extend the image transfer session. |
|
| After finishing to transfer the data, finalize the transfer. |
|
| Get the image transfer entity. |
|
| Pause the image transfer session. |
|
| Resume the image transfer session. |
6.123.1. cancel POST
Cancel the image transfer session. This terminates the transfer operation and removes the partial image.
6.123.2. extend POST
Extend the image transfer session.
6.123.3. finalize POST
After finishing to transfer the data, finalize the transfer.
This will make sure that the data being transferred is valid and fits the image entity that was targeted in the transfer. Specifically, will verify that if the image entity is a QCOW disk, the data uploaded is indeed a QCOW file, and that the image doesn’t have a backing file.
6.123.4. get GET
Get the image transfer entity.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.123.4.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.123.5. pause POST
Pause the image transfer session.
6.123.6. resume POST
Resume the image transfer session. The client will need to poll the transfer’s phase until it is different than resuming. For example:
6.124. ImageTransfers
This service manages image transfers, for performing Image I/O API in Red Hat Virtualization. Please refer to image transfer for further documentation.
| Name | Summary |
|---|---|
|
| Add a new image transfer. |
|
| Retrieves the list of image transfers that are currently being performed. |
6.124.1. add POST
Add a new image transfer. An image, disk or disk snapshot needs to be specified in order to make a new transfer.
The image attribute is deprecated since version 4.2 of the engine. Use the disk or snapshot attributes instead.
Creating a new image transfer for downloading or uploading a disk:
To create an image transfer to download or upload a disk with id 123, send the following request:
POST /ovirt-engine/api/imagetransfers
POST /ovirt-engine/api/imagetransfersWith a request body like this:
<image_transfer> <disk id="123"/> <direction>upload|download</direction> </image_transfer>
<image_transfer>
<disk id="123"/>
<direction>upload|download</direction>
</image_transfer>
Creating a new image transfer for downloading or uploading a disk_snapshot:
To create an image transfer to download or upload a disk_snapshot with id 456, send the following request:
POST /ovirt-engine/api/imagetransfers
POST /ovirt-engine/api/imagetransfersWith a request body like this:
<image_transfer> <snapshot id="456"/> <direction>download|upload</direction> </image_transfer>
<image_transfer>
<snapshot id="456"/>
<direction>download|upload</direction>
</image_transfer>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The image transfer to add. |
6.124.2. list GET
Retrieves the list of image transfers that are currently being performed.
The order of the returned list of image transfers is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | A list of image transfers that are currently being performed. |
6.124.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.125. Images
Manages the set of images available in an storage domain or in an OpenStack image provider.
| Name | Summary |
|---|---|
|
| Returns the list of images available in the storage domain or provider. |
6.125.1. list GET
Returns the list of images available in the storage domain or provider.
The order of the returned list of images isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of images to return. |
6.125.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.125.1.2. max
Sets the maximum number of images to return. If not specified all the images are returned.
6.126. InstanceType
| Name | Summary |
|---|---|
|
| Get a specific instance type and it’s attributes. |
|
| Removes a specific instance type from the system. |
|
| Update a specific instance type and it’s attributes. |
6.126.1. get GET
Get a specific instance type and it’s attributes.
GET /ovirt-engine/api/instancetypes/123
GET /ovirt-engine/api/instancetypes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.126.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.126.2. remove DELETE
Removes a specific instance type from the system.
If a virtual machine was created using an instance type X after removal of the instance type the virtual machine’s instance type will be set to custom.
DELETE /ovirt-engine/api/instancetypes/123
DELETE /ovirt-engine/api/instancetypes/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.126.3. update PUT
Update a specific instance type and it’s attributes.
All the attributes are editable after creation. If a virtual machine was created using an instance type X and some configuration in instance type X was updated, the virtual machine’s configuration will be updated automatically by the engine.
PUT /ovirt-engine/api/instancetypes/123
PUT /ovirt-engine/api/instancetypes/123
For example, to update the memory of instance type 123 to 1 GiB and set the cpu topology to 2 sockets and 1 core, send a request like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.127. InstanceTypeGraphicsConsole
| Name | Summary |
|---|---|
|
| Gets graphics console configuration of the instance type. |
|
| Remove the graphics console from the instance type. |
6.127.1. get GET
Gets graphics console configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the graphics console of the instance type. | |
|
| In | Indicates which inner links should be followed. |
6.127.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.127.2. remove DELETE
Remove the graphics console from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.128. InstanceTypeGraphicsConsoles
| Name | Summary |
|---|---|
|
| Add new graphics console to the instance type. |
|
| Lists all the configured graphics consoles of the instance type. |
6.128.1. add POST
Add new graphics console to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.128.2. list GET
Lists all the configured graphics consoles of the instance type.
The order of the returned list of graphics consoles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of graphics consoles of the instance type. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of consoles to return. |
6.128.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.128.2.2. max
Sets the maximum number of consoles to return. If not specified all the consoles are returned.
6.129. InstanceTypeNic
| Name | Summary |
|---|---|
|
| Gets network interface configuration of the instance type. |
|
| Remove the network interface from the instance type. |
|
| Updates the network interface configuration of the instance type. |
6.129.1. get GET
Gets network interface configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.129.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.129.2. remove DELETE
Remove the network interface from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.129.3. update PUT
Updates the network interface configuration of the instance type.
6.130. InstanceTypeNics
| Name | Summary |
|---|---|
|
| Add new network interface to the instance type. |
|
| Lists all the configured network interface of the instance type. |
6.130.1. add POST
Add new network interface to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.130.2. list GET
Lists all the configured network interface of the instance type.
The order of the returned list of network interfaces isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Nic[] | Out | |
|
| In | A query string used to restrict the returned templates. |
6.130.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.130.2.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.131. InstanceTypeWatchdog
| Name | Summary |
|---|---|
|
| Gets watchdog configuration of the instance type. |
|
| Remove a watchdog from the instance type. |
|
| Updates the watchdog configuration of the instance type. |
6.131.1. get GET
Gets watchdog configuration of the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.131.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.131.2. remove DELETE
Remove a watchdog from the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.131.3. update PUT
Updates the watchdog configuration of the instance type.
6.132. InstanceTypeWatchdogs
| Name | Summary |
|---|---|
|
| Add new watchdog to the instance type. |
|
| Lists all the configured watchdogs of the instance type. |
6.132.1. add POST
Add new watchdog to the instance type.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.132.2. list GET
Lists all the configured watchdogs of the instance type.
The order of the returned list of watchdogs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of watchdogs to return. | |
|
| In | A query string used to restrict the returned templates. | |
|
| Out |
6.132.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.132.2.2. max
Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.
6.133. InstanceTypes
| Name | Summary |
|---|---|
|
| Creates a new instance type. |
|
| Lists all existing instance types in the system. |
6.133.1. add POST
Creates a new instance type.
This requires only a name attribute and can include all hardware configurations of the virtual machine.
POST /ovirt-engine/api/instancetypes
POST /ovirt-engine/api/instancetypesWith a request body like this:
<instance_type> <name>myinstancetype</name> </template>
<instance_type>
<name>myinstancetype</name>
</template>Creating an instance type with all hardware configurations with a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.133.2. list GET
Lists all existing instance types in the system.
The order of the returned list of instance types isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of instance types to return. | |
|
| In | A query string used to restrict the returned templates. |
6.133.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.133.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.133.2.3. max
Sets the maximum number of instance types to return. If not specified all the instance types are returned.
6.134. IscsiBond
| Name | Summary |
|---|---|
|
| |
|
| Removes of an existing iSCSI bond. |
|
| Updates an iSCSI bond. |
6.134.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The iSCSI bond. | |
|
| In | Indicates which inner links should be followed. |
6.134.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.134.2. remove DELETE
Removes of an existing iSCSI bond.
For example, to remove the iSCSI bond 456 send a request like this:
DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456
DELETE /ovirt-engine/api/datacenters/123/iscsibonds/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.134.3. update PUT
Updates an iSCSI bond.
Updating of an iSCSI bond can be done on the name and the description attributes only. For example, to update the iSCSI bond 456 of data center 123, send a request like this:
PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234
PUT /ovirt-engine/api/datacenters/123/iscsibonds/1234The request body should look like this:
<iscsi_bond> <name>mybond</name> <description>My iSCSI bond</description> </iscsi_bond>
<iscsi_bond>
<name>mybond</name>
<description>My iSCSI bond</description>
</iscsi_bond>6.135. IscsiBonds
| Name | Summary |
|---|---|
|
| Create a new iSCSI bond on a data center. |
|
| Returns the list of iSCSI bonds configured in the data center. |
6.135.1. add POST
Create a new iSCSI bond on a data center.
For example, to create a new iSCSI bond on data center 123 using storage connections 456 and 789, send a request like this:
POST /ovirt-engine/api/datacenters/123/iscsibonds
POST /ovirt-engine/api/datacenters/123/iscsibondsThe request body should look like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.135.2. list GET
Returns the list of iSCSI bonds configured in the data center.
The order of the returned list of iSCSI bonds isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of bonds to return. |
6.135.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.135.2.2. max
Sets the maximum number of bonds to return. If not specified all the bonds are returned.
6.136. Job
A service to manage a job.
| Name | Summary |
|---|---|
|
| Set an external job execution to be cleared by the system. |
|
| Marks an external job execution as ended. |
|
| Retrieves a job. |
6.136.1. clear POST
Set an external job execution to be cleared by the system.
For example, to set a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/clear
POST /ovirt-engine/api/jobs/clearWith the following request body:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.136.2. end POST
Marks an external job execution as ended.
For example, to terminate a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/end
POST /ovirt-engine/api/jobs/endWith the following request body:
<action> <force>true</force> <status>finished</status> </action>
<action>
<force>true</force>
<status>finished</status>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the job should be forcibly terminated. | |
|
| In | Indicates if the job should be marked as successfully finished or as failed. |
6.136.2.1. succeeded
Indicates if the job should be marked as successfully finished or as failed.
This parameter is optional, and the default value is true.
6.136.3. get GET
Retrieves a job.
GET /ovirt-engine/api/jobs/123
GET /ovirt-engine/api/jobs/123You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieves the representation of the job. |
6.136.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.137. Jobs
A service to manage jobs.
| Name | Summary |
|---|---|
|
| Add an external job. |
|
| Retrieves the representation of the jobs. |
6.137.1. add POST
Add an external job.
For example, to add a job with the following request:
POST /ovirt-engine/api/jobs
POST /ovirt-engine/api/jobsWith the following request body:
<job> <description>Doing some work</description> <auto_cleared>true</auto_cleared> </job>
<job>
<description>Doing some work</description>
<auto_cleared>true</auto_cleared>
</job>The response should look like:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Job that will be added. |
6.137.2. list GET
Retrieves the representation of the jobs.
GET /ovirt-engine/api/jobs
GET /ovirt-engine/api/jobsYou will receive response in XML like this one:
The order of the returned list of jobs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| Job[] | Out | A representation of jobs. |
|
| In | Sets the maximum number of jobs to return. | |
|
| In | A query string used to restrict the returned jobs. |
6.137.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.137.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.137.2.3. max
Sets the maximum number of jobs to return. If not specified all the jobs are returned.
6.138. KatelloErrata
A service to manage Katello errata. The information is retrieved from Katello.
| Name | Summary |
|---|---|
|
| Retrieves the representation of the Katello errata. |
6.138.1. list GET
Retrieves the representation of the Katello errata.
GET /ovirt-engine/api/katelloerrata
GET /ovirt-engine/api/katelloerrataYou will receive response in XML like this one:
The order of the returned list of erratum isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A representation of Katello errata. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of errata to return. |
6.138.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.138.1.2. max
Sets the maximum number of errata to return. If not specified all the errata are returned.
6.139. KatelloErratum
A service to manage a Katello erratum.
| Name | Summary |
|---|---|
|
| Retrieves a Katello erratum. |
6.139.1. get GET
Retrieves a Katello erratum.
GET /ovirt-engine/api/katelloerrata/123
GET /ovirt-engine/api/katelloerrata/123You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieves the representation of the Katello erratum. | |
|
| In | Indicates which inner links should be followed. |
6.139.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.140. LinkLayerDiscoveryProtocol
A service to fetch information elements received by Link Layer Discovery Protocol (LLDP).
| Name | Summary |
|---|---|
|
| Fetches information elements received by LLDP. |
6.140.1. list GET
Fetches information elements received by LLDP.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieves a list of information elements received by LLDP. | |
|
| In | Indicates which inner links should be followed. |
6.140.1.1. elements
Retrieves a list of information elements received by LLDP.
For example, to retrieve the information elements received on the NIC 321 on host 123, send a request like this:
GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelements
GET ovirt-engine/api/hosts/123/nics/321/linklayerdiscoveryprotocolelementsIt will return a response like this:
6.140.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.141. MacPool
| Name | Summary |
|---|---|
|
| |
|
| Removes a MAC address pool. |
|
| Updates a MAC address pool. |
6.141.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.141.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.141.2. remove DELETE
Removes a MAC address pool.
For example, to remove the MAC address pool having id 123 send a request like this:
DELETE /ovirt-engine/api/macpools/123
DELETE /ovirt-engine/api/macpools/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.141.3. update PUT
Updates a MAC address pool.
The name, description, allow_duplicates, and ranges attributes can be updated.
For example, to update the MAC address pool of id 123 send a request like this:
PUT /ovirt-engine/api/macpools/123
PUT /ovirt-engine/api/macpools/123With a request body like this:
6.142. MacPools
| Name | Summary |
|---|---|
|
| Creates a new MAC address pool. |
|
| Return the list of MAC address pools of the system. |
6.142.1. add POST
Creates a new MAC address pool.
Creation of a MAC address pool requires values for the name and ranges attributes.
For example, to create MAC address pool send a request like this:
POST /ovirt-engine/api/macpools
POST /ovirt-engine/api/macpoolsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.142.2. list GET
Return the list of MAC address pools of the system.
The returned list of MAC address pools isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of pools to return. | |
|
| Out |
6.142.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.142.2.2. max
Sets the maximum number of pools to return. If not specified all the pools are returned.
6.143. Measurable
6.144. Moveable
| Name | Summary |
|---|---|
|
|
6.144.1. move POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. |
6.145. Network
A service managing a network
| Name | Summary |
|---|---|
|
| Gets a logical network. |
|
| Removes a logical network, or the association of a logical network to a data center. |
|
| Updates a logical network. |
6.145.1. get GET
Gets a logical network.
For example:
GET /ovirt-engine/api/networks/123
GET /ovirt-engine/api/networks/123Will respond:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.145.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.145.2. remove DELETE
Removes a logical network, or the association of a logical network to a data center.
For example, to remove the logical network 123 send a request like this:
DELETE /ovirt-engine/api/networks/123
DELETE /ovirt-engine/api/networks/123
Each network is bound exactly to one data center. So if we disassociate network with data center it has the same result as if we would just remove that network. However it might be more specific to say we’re removing network 456 of data center 123.
For example, to remove the association of network 456 to data center 123 send a request like this:
DELETE /ovirt-engine/api/datacenters/123/networks/456
DELETE /ovirt-engine/api/datacenters/123/networks/456
To remove an external logical network, the network has to be removed directly from its provider by OpenStack Networking API. The entity representing the external network inside Red Hat Virtualization is removed automatically, if auto_sync is enabled for the provider, otherwise the entity has to be removed using this method.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.145.3. update PUT
Updates a logical network.
The name, description, ip, vlan, stp and display attributes can be updated.
For example, to update the description of the logical network 123 send a request like this:
PUT /ovirt-engine/api/networks/123
PUT /ovirt-engine/api/networks/123With a request body like this:
<network> <description>My updated description</description> </network>
<network>
<description>My updated description</description>
</network>
The maximum transmission unit of a network is set using a PUT request to specify the integer value of the mtu attribute.
For example, to set the maximum transmission unit send a request like this:
PUT /ovirt-engine/api/datacenters/123/networks/456
PUT /ovirt-engine/api/datacenters/123/networks/456With a request body like this:
<network> <mtu>1500</mtu> </network>
<network>
<mtu>1500</mtu>
</network>Updating external networks is not propagated to the provider.
6.146. NetworkAttachment
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified network attachment on the host. |
6.146.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.146.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.146.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.146.3. update PUT
Update the specified network attachment on the host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.147. NetworkAttachments
Manages the set of network attachments of a host or host NIC.
| Name | Summary |
|---|---|
|
| Add a new network attachment to the network interface. |
|
| Returns the list of network attachments of the host or host NIC. |
6.147.1. add POST
Add a new network attachment to the network interface.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.147.2. list GET
Returns the list of network attachments of the host or host NIC.
The order of the returned list of network attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of attachments to return. |
6.147.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.147.2.2. max
Sets the maximum number of attachments to return. If not specified all the attachments are returned.
6.148. NetworkFilter
Manages a network filter.
Please note that version is referring to the minimal support version for the specific filter.
| Name | Summary |
|---|---|
|
| Retrieves a representation of the network filter. |
6.148.1. get GET
Retrieves a representation of the network filter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.148.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.149. NetworkFilters
Represents a readonly network filters sub-collection.
The network filter enables to filter packets send to/from the VM’s nic according to defined rules. For more information please refer to NetworkFilter service documentation
Network filters are supported in different versions, starting from version 3.0.
A network filter is defined for each vnic profile.
A vnic profile is defined for a specific network.
A network can be assigned to several different clusters. In the future, each network will be defined in cluster level.
Currently, each network is being defined at data center level. Potential network filters for each network are determined by the network’s data center compatibility version V. V must be >= the network filter version in order to configure this network filter for a specific network. Please note, that if a network is assigned to cluster with a version supporting a network filter, the filter may not be available due to the data center version being smaller then the network filter’s version.
Example of listing all of the supported network filters for a specific cluster:
GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfilters
GET http://localhost:8080/ovirt-engine/api/clusters/{cluster:id}/networkfiltersOutput:
| Name | Summary |
|---|---|
|
| Retrieves the representations of the network filters. |
6.149.1. list GET
Retrieves the representations of the network filters.
The order of the returned list of network filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.149.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.150. NetworkLabel
| Name | Summary |
|---|---|
|
| |
|
| Removes a label from a logical network. |
6.150.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.150.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.150.2. remove DELETE
Removes a label from a logical network.
For example, to remove the label exemplary from a logical network having id 123 send the following request:
DELETE /ovirt-engine/api/networks/123/networklabels/exemplary
DELETE /ovirt-engine/api/networks/123/networklabels/exemplary| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.151. NetworkLabels
Manages the ser of labels attached to a network or to a host NIC.
| Name | Summary |
|---|---|
|
| Attaches label to logical network. |
|
| Returns the list of labels attached to the network or host NIC. |
6.151.1. add POST
Attaches label to logical network.
You can attach labels to a logical network to automate the association of that logical network with physical host network interfaces to which the same label has been attached.
For example, to attach the label mylabel to a logical network having id 123 send a request like this:
POST /ovirt-engine/api/networks/123/networklabels
POST /ovirt-engine/api/networks/123/networklabelsWith a request body like this:
<network_label id="mylabel"/>
<network_label id="mylabel"/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.151.2. list GET
Returns the list of labels attached to the network or host NIC.
The order of the returned list of labels isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of labels to return. |
6.151.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.151.2.2. max
Sets the maximum number of labels to return. If not specified all the labels are returned.
6.152. Networks
Manages logical networks.
The engine creates a default ovirtmgmt network on installation. This network acts as the management network for access to hypervisor hosts. This network is associated with the Default cluster and is a member of the Default data center.
| Name | Summary |
|---|---|
|
| Creates a new logical network, or associates an existing network with a data center. |
|
| List logical networks. |
6.152.1. add POST
Creates a new logical network, or associates an existing network with a data center.
Creation of a new network requires the name and data_center elements.
For example, to create a network named mynetwork for data center 123 send a request like this:
POST /ovirt-engine/api/networks
POST /ovirt-engine/api/networksWith a request body like this:
<network> <name>mynetwork</name> <data_center id="123"/> </network>
<network>
<name>mynetwork</name>
<data_center id="123"/>
</network>
To associate the existing network 456 with the data center 123 send a request like this:
POST /ovirt-engine/api/datacenters/123/networks
POST /ovirt-engine/api/datacenters/123/networksWith a request body like this:
<network> <name>ovirtmgmt</name> </network>
<network>
<name>ovirtmgmt</name>
</network>
To create a network named exnetwork on top of an external OpenStack network provider 456 send a request like this:
POST /ovirt-engine/api/networks
POST /ovirt-engine/api/networks<network> <name>exnetwork</name> <external_provider id="456"/> <data_center id="123"/> </network>
<network>
<name>exnetwork</name>
<external_provider id="456"/>
<data_center id="123"/>
</network>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.152.2. list GET
List logical networks.
For example:
GET /ovirt-engine/api/networks
GET /ovirt-engine/api/networksWill respond:
The order of the returned list of networks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned networks. |
6.152.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.152.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.152.2.3. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.153. NicNetworkFilterParameter
This service manages a parameter for a network filter.
| Name | Summary |
|---|---|
|
| Retrieves a representation of the network filter parameter. |
|
| Removes the filter parameter. |
|
| Updates the network filter parameter. |
6.153.1. get GET
Retrieves a representation of the network filter parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The representation of the network filter parameter. |
6.153.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.153.2. remove DELETE
Removes the filter parameter.
For example, to remove the filter parameter with id 123 on NIC 456 of virtual machine 789 send a request like this:
DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123
DELETE /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/1236.153.3. update PUT
Updates the network filter parameter.
For example, to update the network filter parameter having with with id 123 on NIC 456 of virtual machine 789 send a request like this:
PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123
PUT /ovirt-engine/api/vms/789/nics/456/networkfilterparameters/123With a request body like this:
<network_filter_parameter> <name>updatedName</name> <value>updatedValue</value> </network_filter_parameter>
<network_filter_parameter>
<name>updatedName</name>
<value>updatedValue</value>
</network_filter_parameter>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network filter parameter that is being updated. |
6.154. NicNetworkFilterParameters
This service manages a collection of parameters for network filters.
| Name | Summary |
|---|---|
|
| Add a network filter parameter. |
|
| Retrieves the representations of the network filter parameters. |
6.154.1. add POST
Add a network filter parameter.
For example, to add the parameter for the network filter on NIC 456 of virtual machine 789 send a request like this:
POST /ovirt-engine/api/vms/789/nics/456/networkfilterparameters
POST /ovirt-engine/api/vms/789/nics/456/networkfilterparametersWith a request body like this:
<network_filter_parameter> <name>IP</name> <value>10.0.1.2</value> </network_filter_parameter>
<network_filter_parameter>
<name>IP</name>
<value>10.0.1.2</value>
</network_filter_parameter>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The network filter parameter that is being added. |
6.154.2. list GET
Retrieves the representations of the network filter parameters.
The order of the returned list of network filters isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of the network filter parameters. |
6.154.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.155. OpenstackImage
| Name | Summary |
|---|---|
|
| |
|
| Imports a virtual machine from a Glance image storage domain. |
6.155.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.155.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.155.2. import POST
Imports a virtual machine from a Glance image storage domain.
For example, to import the image with identifier 456 from the storage domain with identifier 123 send a request like this:
POST /ovirt-engine/api/openstackimageproviders/123/images/456/import
POST /ovirt-engine/api/openstackimageproviders/123/images/456/importWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In |
This parameter is mandatory in case of using | |
|
| In | ||
|
| In | Indicates whether the image should be imported as a template. | |
|
| In | ||
|
| In |
6.156. OpenstackImageProvider
| Name | Summary |
|---|---|
|
| |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified OpenStack image provider in the system. |
6.156.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.156.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.156.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.156.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.156.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.156.5. update PUT
Update the specified OpenStack image provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.157. OpenstackImageProviders
| Name | Summary |
|---|---|
|
| Add a new OpenStack image provider to the system. |
|
| Returns the list of providers. |
6.157.1. add POST
Add a new OpenStack image provider to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.157.2. list GET
Returns the list of providers.
The order of the returned list of providers isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned OpenStack image providers. |
6.157.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.157.2.2. max
Sets the maximum number of providers to return. If not specified all the providers are returned.
6.158. OpenstackImages
| Name | Summary |
|---|---|
|
| Lists the images of a Glance image storage domain. |
6.158.1. list GET
Lists the images of a Glance image storage domain.
The order of the returned list of images isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of images to return. |
6.158.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.158.1.2. max
Sets the maximum number of images to return. If not specified all the images are returned.
6.159. OpenstackNetwork
| Name | Summary |
|---|---|
|
| |
|
| This operation imports an external network into Red Hat Virtualization. |
6.159.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.159.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.159.2. import POST
This operation imports an external network into Red Hat Virtualization. The network will be added to the specified data center.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In | The data center into which the network is to be imported. |
6.159.2.1. data_center
The data center into which the network is to be imported. Data center is mandatory, and can be specified using the id or name attributes. The rest of the attributes will be ignored.
If auto_sync is enabled for the provider, the network might be imported automatically. To prevent this, automatic import can be disabled by setting the auto_sync to false, and enabling it again after importing the network.
6.160. OpenstackNetworkProvider
This service manages the OpenStack network provider.
| Name | Summary |
|---|---|
|
| Returns the representation of the object managed by this service. |
|
| Import the SSL certificates of the external host provider. |
|
| Removes the provider. |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Updates the provider. |
6.160.1. get GET
Returns the representation of the object managed by this service.
For example, to get the OpenStack network provider with identifier 1234, send a request like this:
GET /ovirt-engine/api/openstacknetworkproviders/1234
GET /ovirt-engine/api/openstacknetworkproviders/1234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.160.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.160.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.160.3. remove DELETE
Removes the provider.
For example, to remove the OpenStack network provider with identifier 1234, send a request like this:
DELETE /ovirt-engine/api/openstacknetworkproviders/1234
DELETE /ovirt-engine/api/openstacknetworkproviders/1234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.160.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.160.5. update PUT
Updates the provider.
For example, to update provider_name, requires_authentication, url, tenant_name and type properties, for the OpenStack network provider with identifier 1234, send a request like this:
PUT /ovirt-engine/api/openstacknetworkproviders/1234
PUT /ovirt-engine/api/openstacknetworkproviders/1234With a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The provider to update. |
6.161. OpenstackNetworkProviders
This service manages OpenStack network providers.
| Name | Summary |
|---|---|
|
| The operation adds a new network provider to the system. |
|
| Returns the list of providers. |
6.161.1. add POST
The operation adds a new network provider to the system. If the type property is not present, a default value of NEUTRON will be used.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.161.2. list GET
Returns the list of providers.
The order of the returned list of providers isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned OpenStack network providers. |
6.161.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.161.2.2. max
Sets the maximum number of providers to return. If not specified all the providers are returned.
6.162. OpenstackNetworks
| Name | Summary |
|---|---|
|
| Returns the list of networks. |
6.162.1. list GET
Returns the list of networks.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.162.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.162.1.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.163. OpenstackSubnet
| Name | Summary |
|---|---|
|
| |
|
|
6.163.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.163.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.163.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.164. OpenstackSubnets
| Name | Summary |
|---|---|
|
| |
|
| Returns the list of sub-networks. |
6.164.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.164.2. list GET
Returns the list of sub-networks.
The order of the returned list of sub-networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of sub-networks to return. | |
|
| Out |
6.164.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.164.2.2. max
Sets the maximum number of sub-networks to return. If not specified all the sub-networks are returned.
6.165. OpenstackVolumeAuthenticationKey
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified authentication key. |
6.165.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.165.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.165.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.165.3. update PUT
Update the specified authentication key.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.166. OpenstackVolumeAuthenticationKeys
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
| Add a new authentication key to the OpenStack volume provider. |
|
| Returns the list of authentication keys. |
6.166.1. add POST
Add a new authentication key to the OpenStack volume provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.166.2. list GET
Returns the list of authentication keys.
The order of the returned list of authentication keys isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of keys to return. |
6.166.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.166.2.2. max
Sets the maximum number of keys to return. If not specified all the keys are returned.
6.167. OpenstackVolumeProvider
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
| |
|
| Import the SSL certificates of the external host provider. |
|
| |
|
| In order to test connectivity for external provider we need to run following request where 123 is an id of a provider. |
|
| Update the specified OpenStack volume provider in the system. |
6.167.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.167.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.167.2. importcertificates POST
Import the SSL certificates of the external host provider.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
6.167.3. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation. |
6.167.3.1. force
Indicates if the operation should succeed, and the provider removed from the database, even if something fails during the operation.
This parameter is optional, and the default value is false.
6.167.4. testconnectivity POST
In order to test connectivity for external provider we need to run following request where 123 is an id of a provider.
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity
POST /ovirt-engine/api/externalhostproviders/123/testconnectivity| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the test should be performed asynchronously. |
6.167.5. update PUT
Update the specified OpenStack volume provider in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.168. OpenstackVolumeProviders
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
| Adds a new volume provider. |
|
| Retrieves the list of volume providers. |
6.168.1. add POST
Adds a new volume provider.
For example:
POST /ovirt-engine/api/openstackvolumeproviders
POST /ovirt-engine/api/openstackvolumeprovidersWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.168.2. list GET
Retrieves the list of volume providers.
The order of the returned list of volume providers isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of providers to return. | |
|
| Out | ||
|
| In | A query string used to restrict the returned volume providers. |
6.168.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.168.2.2. max
Sets the maximum number of providers to return. If not specified all the providers are returned.
6.169. OpenstackVolumeType
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
|
6.169.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.169.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.170. OpenstackVolumeTypes
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
| Name | Summary |
|---|---|
|
| Returns the list of volume types. |
6.170.1. list GET
Returns the list of volume types.
The order of the returned list of volume types isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of volume types to return. | |
|
| Out |
6.170.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.170.1.2. max
Sets the maximum number of volume types to return. If not specified all the volume types are returned.
6.171. OperatingSystem
| Name | Summary |
|---|---|
|
|
6.171.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.171.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.172. OperatingSystems
Manages the set of types of operating systems available in the system.
| Name | Summary |
|---|---|
|
| Returns the list of types of operating system available in the system. |
6.172.1. list GET
Returns the list of types of operating system available in the system.
The order of the returned list of operating systems isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.172.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.172.1.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.173. Permission
| Name | Summary |
|---|---|
|
| |
|
|
6.173.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.173.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.173.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.174. Permit
A service to manage a specific permit of the role.
| Name | Summary |
|---|---|
|
| Gets the information about the permit of the role. |
|
| Removes the permit from the role. |
6.174.1. get GET
Gets the information about the permit of the role.
For example to retrieve the information about the permit with the id 456 of the role with the id 123 send a request like this:
GET /ovirt-engine/api/roles/123/permits/456
GET /ovirt-engine/api/roles/123/permits/456<permit href="/ovirt-engine/api/roles/123/permits/456" id="456"> <name>change_vm_cd</name> <administrative>false</administrative> <role href="/ovirt-engine/api/roles/123" id="123"/> </permit>
<permit href="/ovirt-engine/api/roles/123/permits/456" id="456">
<name>change_vm_cd</name>
<administrative>false</administrative>
<role href="/ovirt-engine/api/roles/123" id="123"/>
</permit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The permit of the role. |
6.174.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.174.2. remove DELETE
Removes the permit from the role.
For example to remove the permit with id 456 from the role with id 123 send a request like this:
DELETE /ovirt-engine/api/roles/123/permits/456
DELETE /ovirt-engine/api/roles/123/permits/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.175. Permits
Represents a permits sub-collection of the specific role.
| Name | Summary |
|---|---|
|
| Adds a permit to the role. |
|
| List the permits of the role. |
6.175.1. add POST
Adds a permit to the role. The permit name can be retrieved from the cluster_levels service.
For example to assign a permit create_vm to the role with id 123 send a request like this:
POST /ovirt-engine/api/roles/123/permits
POST /ovirt-engine/api/roles/123/permitsWith a request body like this:
<permit> <name>create_vm</name> </permit>
<permit>
<name>create_vm</name>
</permit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The permit to add. |
6.175.2. list GET
List the permits of the role.
For example to list the permits of the role with the id 123 send a request like this:
GET /ovirt-engine/api/roles/123/permits
GET /ovirt-engine/api/roles/123/permitsThe order of the returned list of permits isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of permits to return. | |
|
| Out | List of permits. |
6.175.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.175.2.2. max
Sets the maximum number of permits to return. If not specified all the permits are returned.
6.176. Qos
| Name | Summary |
|---|---|
|
| Get specified QoS in the data center. |
|
| Remove specified QoS from datacenter. |
|
| Update the specified QoS in the dataCenter. |
6.176.1. get GET
Get specified QoS in the data center.
GET /ovirt-engine/api/datacenters/123/qoss/123
GET /ovirt-engine/api/datacenters/123/qoss/123You will get response like this one below:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Queried QoS object. |
6.176.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.176.2. remove DELETE
Remove specified QoS from datacenter.
DELETE /ovirt-engine/api/datacenters/123/qoss/123
DELETE /ovirt-engine/api/datacenters/123/qoss/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.176.3. update PUT
Update the specified QoS in the dataCenter.
PUT /ovirt-engine/api/datacenters/123/qoss/123
PUT /ovirt-engine/api/datacenters/123/qoss/123For example with curl:
curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \ "<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \ https://engine/ovirt-engine/api/datacenters/123/qoss/123
curl -u admin@internal:123456 -X PUT -H "content-type: application/xml" -d \
"<qos><name>321</name><description>321</description><max_iops>10</max_iops></qos>" \
https://engine/ovirt-engine/api/datacenters/123/qoss/123You will receive response like this:
6.177. Qoss
Manages the set of quality of service configurations available in a data center.
| Name | Summary |
|---|---|
|
| Add a new QoS to the dataCenter. |
|
| Returns the list of quality of service configurations available in the data center. |
6.177.1. add POST
Add a new QoS to the dataCenter.
POST /ovirt-engine/api/datacenters/123/qoss
POST /ovirt-engine/api/datacenters/123/qossThe response will look as follows:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Added QoS object. |
6.177.2. list GET
Returns the list of quality of service configurations available in the data center.
GET /ovirt-engine/api/datacenter/123/qoss
GET /ovirt-engine/api/datacenter/123/qossYou will get response which will look like this:
<qoss> <qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos> <qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos> <qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos> </qoss>
<qoss>
<qos href="/ovirt-engine/api/datacenters/123/qoss/1" id="1">...</qos>
<qos href="/ovirt-engine/api/datacenters/123/qoss/2" id="2">...</qos>
<qos href="/ovirt-engine/api/datacenters/123/qoss/3" id="3">...</qos>
</qoss>The returned list of quality of service configurations isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of QoS descriptors to return. | |
|
| Qos[] | Out | List of queried QoS objects. |
6.177.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.177.2.2. max
Sets the maximum number of QoS descriptors to return. If not specified all the descriptors are returned.
6.178. Quota
| Name | Summary |
|---|---|
|
| Retrieves a quota. |
|
| Delete a quota. |
|
| Updates a quota. |
6.178.1. get GET
Retrieves a quota.
An example of retrieving a quota:
GET /ovirt-engine/api/datacenters/123/quotas/456
GET /ovirt-engine/api/datacenters/123/quotas/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.178.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.178.2. remove DELETE
Delete a quota.
An example of deleting a quota:
DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321 -0472718ab224 HTTP/1.1 Accept: application/xml Content-type: application/xml
DELETE /ovirt-engine/api/datacenters/123-456/quotas/654-321
-0472718ab224 HTTP/1.1
Accept: application/xml
Content-type: application/xml| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.178.3. update PUT
Updates a quota.
An example of updating a quota:
PUT /ovirt-engine/api/datacenters/123/quotas/456
PUT /ovirt-engine/api/datacenters/123/quotas/4566.179. QuotaClusterLimit
| Name | Summary |
|---|---|
|
| |
|
|
6.179.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.179.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.179.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.180. QuotaClusterLimits
Manages the set of quota limits configured for a cluster.
| Name | Summary |
|---|---|
|
| Add a cluster limit to a specified Quota. |
|
| Returns the set of quota limits configured for the cluster. |
6.180.1. add POST
Add a cluster limit to a specified Quota.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.180.2. list GET
Returns the set of quota limits configured for the cluster.
The returned list of quota limits isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of limits to return. |
6.180.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.180.2.2. max
Sets the maximum number of limits to return. If not specified all the limits are returned.
6.181. QuotaStorageLimit
| Name | Summary |
|---|---|
|
| |
|
|
6.181.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.181.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.181.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. |
6.182. QuotaStorageLimits
Manages the set of storage limits configured for a quota.
| Name | Summary |
|---|---|
|
| Adds a storage limit to a specified quota. |
|
| Returns the list of storage limits configured for the quota. |
6.182.1. add POST
Adds a storage limit to a specified quota.
To create a 100GiB storage limit for all storage domains in a data center, send a request like this:
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimitsWith a request body like this:
<quota_storage_limit> <limit>100</limit> </quota_storage_limit>
<quota_storage_limit>
<limit>100</limit>
</quota_storage_limit>
To create a 50GiB storage limit for a storage domain with the ID 000, send a request like this:
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimits
POST /ovirt-engine/api/datacenters/123/quotas/456/quotastoragelimitsWith a request body like this:
<quota_storage_limit> <limit>50</limit> <storage_domain id="000"/> </quota_storage_limit>
<quota_storage_limit>
<limit>50</limit>
<storage_domain id="000"/>
</quota_storage_limit>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.182.2. list GET
Returns the list of storage limits configured for the quota.
The order of the returned list of storage limits is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of limits to return. |
6.182.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.182.2.2. max
Sets the maximum number of limits to return. If not specified, all the limits are returned.
6.183. Quotas
Manages the set of quotas configured for a data center.
| Name | Summary |
|---|---|
|
| Creates a new quota. |
|
| Lists quotas of a data center. |
6.183.1. add POST
Creates a new quota.
An example of creating a new quota:
POST /ovirt-engine/api/datacenters/123/quotas
POST /ovirt-engine/api/datacenters/123/quotas<quota> <name>myquota</name> <description>My new quota for virtual machines</description> </quota>
<quota>
<name>myquota</name>
<description>My new quota for virtual machines</description>
</quota>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.183.2. list GET
Lists quotas of a data center.
The order of the returned list of quotas isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of quota descriptors to return. | |
|
| Out |
6.183.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.183.2.2. max
Sets the maximum number of quota descriptors to return. If not specified all the descriptors are returned.
6.184. Role
| Name | Summary |
|---|---|
|
| Get the role. |
|
| Removes the role. |
|
| Updates a role. |
6.184.1. get GET
Get the role.
GET /ovirt-engine/api/roles/123
GET /ovirt-engine/api/roles/123You will receive XML response like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved role. |
6.184.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.184.2. remove DELETE
Removes the role.
To remove the role you need to know its id, then send request like this:
DELETE /ovirt-engine/api/roles/{role_id}
DELETE /ovirt-engine/api/roles/{role_id}| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.184.3. update PUT
Updates a role. You are allowed to update name, description and administrative attributes after role is created. Within this endpoint you can’t add or remove roles permits you need to use service that manages permits of role.
For example to update role’s name, description and administrative attributes send a request like this:
PUT /ovirt-engine/api/roles/123
PUT /ovirt-engine/api/roles/123With a request body like this:
<role> <name>MyNewRoleName</name> <description>My new description of the role</description> <administrative>true</administrative> </group>
<role>
<name>MyNewRoleName</name>
<description>My new description of the role</description>
<administrative>true</administrative>
</group>6.185. Roles
Provides read-only access to the global set of roles
| Name | Summary |
|---|---|
|
| Create a new role. |
|
| List roles. |
6.185.1. add POST
Create a new role. The role can be administrative or non-administrative and can have different permits.
For example, to add the MyRole non-administrative role with permits to login and create virtual machines send a request like this (note that you have to pass permit id):
POST /ovirt-engine/api/roles
POST /ovirt-engine/api/rolesWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Role that will be added. |
6.185.2. list GET
List roles.
GET /ovirt-engine/api/roles
GET /ovirt-engine/api/rolesYou will receive response in XML like this one:
The order of the returned list of roles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of roles to return. | |
|
| Out | Retrieved list of roles. |
6.185.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.185.2.2. max
Sets the maximum number of roles to return. If not specified all the roles are returned.
6.186. SchedulingPolicies
Manages the set of scheduling policies available in the system.
| Name | Summary |
|---|---|
|
| Add a new scheduling policy to the system. |
|
| Returns the list of scheduling policies available in the system. |
6.186.1. add POST
Add a new scheduling policy to the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.186.2. list GET
Returns the list of scheduling policies available in the system.
The order of the returned list of scheduling policies isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of policies to return. | |
|
| Out |
6.186.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.186.2.2. max
Sets the maximum number of policies to return. If not specified all the policies are returned.
6.187. SchedulingPolicy
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified user defined scheduling policy in the system. |
6.187.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.187.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.187.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.187.3. update PUT
Update the specified user defined scheduling policy in the system.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.188. SchedulingPolicyUnit
| Name | Summary |
|---|---|
|
| |
|
|
6.188.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.188.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.188.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.189. SchedulingPolicyUnits
Manages the set of scheduling policy units available in the system.
| Name | Summary |
|---|---|
|
| Returns the list of scheduling policy units available in the system. |
6.189.1. list GET
Returns the list of scheduling policy units available in the system.
The order of the returned list of scheduling policy units isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of policy units to return. | |
|
| Out |
6.189.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.189.1.2. max
Sets the maximum number of policy units to return. If not specified all the policy units are returned.
6.190. Snapshot
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Restores a virtual machine snapshot. |
6.190.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.190.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.190.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all the attributes of the virtual machine snapshot should be included in the response. | |
|
| In | Indicates if the remove should be performed asynchronously. |
6.190.2.1. all_content
Indicates if all the attributes of the virtual machine snapshot should be included in the response.
By default the attribute initialization.configuration.data is excluded.
For example, to retrieve the complete representation of the snapshot with id 456 of the virtual machine with id 123 send a request like this:
GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true
GET /ovirt-engine/api/vms/123/snapshots/456?all_content=true6.190.3. restore POST
Restores a virtual machine snapshot.
For example, to restore the snapshot with identifier 456 of virtual machine with identifier 123 send a request like this:
POST /ovirt-engine/api/vms/123/snapshots/456/restore
POST /ovirt-engine/api/vms/123/snapshots/456/restore
With an empty action in the body:
<action/>
<action/>Confirm that the commit operation is finished and the virtual machine is down before running the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the restore should be performed asynchronously. | |
|
| In | Specify the disks included in the snapshot’s restore. | |
|
| In |
6.190.3.1. disks
Specify the disks included in the snapshot’s restore.
For each disk parameter, it is also required to specify its image_id.
For example, to restore a snapshot with an identifier 456 of a virtual machine with identifier 123, including a disk with identifier 111 and image_id of 222, send a request like this:
POST /ovirt-engine/api/vms/123/snapshots/456/restore
POST /ovirt-engine/api/vms/123/snapshots/456/restoreRequest body:
6.191. SnapshotCdrom
| Name | Summary |
|---|---|
|
|
6.191.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.191.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.192. SnapshotCdroms
Manages the set of CD-ROM devices of a virtual machine snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of CD-ROM devices of the snapshot. |
6.192.1. list GET
Returns the list of CD-ROM devices of the snapshot.
The order of the returned list of CD-ROM devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of CDROMS to return. |
6.192.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.192.1.2. max
Sets the maximum number of CDROMS to return. If not specified all the CDROMS are returned.
6.193. SnapshotDisk
| Name | Summary |
|---|---|
|
|
6.193.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.193.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.194. SnapshotDisks
Manages the set of disks of an snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of disks of the snapshot. |
6.194.1. list GET
Returns the list of disks of the snapshot.
The order of the returned list of disks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.194.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.194.1.2. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.195. SnapshotNic
| Name | Summary |
|---|---|
|
|
6.195.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.195.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.196. SnapshotNics
Manages the set of NICs of an snapshot.
| Name | Summary |
|---|---|
|
| Returns the list of NICs of the snapshot. |
6.196.1. list GET
Returns the list of NICs of the snapshot.
The order of the returned list of NICs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Nic[] | Out |
6.196.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.196.1.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.197. Snapshots
Manages the set of snapshots of a storage domain or virtual machine.
| Name | Summary |
|---|---|
|
| Creates a virtual machine snapshot. |
|
| Returns the list of snapshots of the storage domain or virtual machine. |
6.197.1. add POST
Creates a virtual machine snapshot.
For example, to create a new snapshot for virtual machine 123 send a request like this:
POST /ovirt-engine/api/vms/123/snapshots
POST /ovirt-engine/api/vms/123/snapshotsWith a request body like this:
<snapshot> <description>My snapshot</description> </snapshot>
<snapshot>
<description>My snapshot</description>
</snapshot>
For including only a sub-set of disks in the snapshots, add disk_attachments element to the request body. Note that disks which are not specified in disk_attachments element will not be a part of the snapshot. If an empty disk_attachments element is passed, the snapshot will include only the virtual machine configuration. If no disk_attachments element is passed, then all the disks will be included in the snapshot.
For each disk, image_id element can be specified for setting the new active image id. This is used in order to restore a chain of images from backup. I.e. when restoring a disk with snapshots, the relevant image_id should be specified for each snapshot (so the identifiers of the disk snapshots are identical to the backup).
When a snapshot is created, the default value for the persist_memorystate attribute is true. That means that the content of the memory of the virtual machine will be included in the snapshot, and it also means that the virtual machine will be paused for a longer time. That can negatively affect applications that are very sensitive to timing (NTP servers, for example). In those cases make sure that you set the attribute to false:
<snapshot> <description>My snapshot</description> <persist_memorystate>false</persist_memorystate> </snapshot>
<snapshot>
<description>My snapshot</description>
<persist_memorystate>false</persist_memorystate>
</snapshot>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.197.2. list GET
Returns the list of snapshots of the storage domain or virtual machine.
The order of the returned list of snapshots isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all the attributes of the virtual machine snapshot should be included in the response. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of snapshots to return. | |
|
| Out |
6.197.2.1. all_content
Indicates if all the attributes of the virtual machine snapshot should be included in the response.
By default the attribute initialization.configuration.data is excluded.
For example, to retrieve the complete representation of the virtual machine with id 123 snapshots send a request like this:
GET /ovirt-engine/api/vms/123/snapshots?all_content=true
GET /ovirt-engine/api/vms/123/snapshots?all_content=true6.197.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.197.2.3. max
Sets the maximum number of snapshots to return. If not specified all the snapshots are returned.
6.198. SshPublicKey
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Replaces the key with a new resource. |
6.198.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.198.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.198.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.198.3. update PUT
Replaces the key with a new resource.
Since version 4.4.8 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Instead please use DELETE followed by add operation.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.199. SshPublicKeys
| Name | Summary |
|---|---|
|
| |
|
| Returns a list of SSH public keys of the user. |
6.199.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.199.2. list GET
Returns a list of SSH public keys of the user.
For example, to retrieve the list of SSH keys of user with identifier 123, send a request like this:
GET /ovirt-engine/api/users/123/sshpublickeys
GET /ovirt-engine/api/users/123/sshpublickeysThe result will be the following XML document:
Or the following JSON object
The order of the returned list of keys is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | ||
|
| In | Sets the maximum number of keys to return. |
6.199.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.199.2.2. max
Sets the maximum number of keys to return. If not specified all the keys are returned.
6.200. Statistic
| Name | Summary |
|---|---|
|
|
6.200.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.200.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.201. Statistics
| Name | Summary |
|---|---|
|
| Retrieves a list of statistics. |
6.201.1. list GET
Retrieves a list of statistics.
For example, to retrieve the statistics for virtual machine 123 send a request like this:
GET /ovirt-engine/api/vms/123/statistics
GET /ovirt-engine/api/vms/123/statisticsThe result will be like this:
Just a single part of the statistics can be retrieved by specifying its id at the end of the URI. That means:
GET /ovirt-engine/api/vms/123/statistics/456
GET /ovirt-engine/api/vms/123/statistics/456Outputs:
The order of the returned list of statistics isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of statistics to return. | |
|
| Out |
6.201.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.201.1.2. max
Sets the maximum number of statistics to return. If not specified all the statistics are returned.
6.202. Step
A service to manage a step.
| Name | Summary |
|---|---|
|
| Marks an external step execution as ended. |
|
| Retrieves a step. |
6.202.1. end POST
Marks an external step execution as ended.
For example, to terminate a step with identifier 456 which belongs to a job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/123/steps/456/end
POST /ovirt-engine/api/jobs/123/steps/456/endWith the following request body:
<action> <force>true</force> <succeeded>true</succeeded> </action>
<action>
<force>true</force>
<succeeded>true</succeeded>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. | |
|
| In | Indicates if the step should be forcibly terminated. | |
|
| In | Indicates if the step should be marked as successfully finished or as failed. |
6.202.1.1. succeeded
Indicates if the step should be marked as successfully finished or as failed.
This parameter is optional, and the default value is true.
6.202.2. get GET
Retrieves a step.
GET /ovirt-engine/api/jobs/123/steps/456
GET /ovirt-engine/api/jobs/123/steps/456You will receive response in XML like this one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieves the representation of the step. |
6.202.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.203. Steps
A service to manage steps.
| Name | Summary |
|---|---|
|
| Add an external step to an existing job or to an existing step. |
|
| Retrieves the representation of the steps. |
6.203.1. add POST
Add an external step to an existing job or to an existing step.
For example, to add a step to job with identifier 123 send the following request:
POST /ovirt-engine/api/jobs/123/steps
POST /ovirt-engine/api/jobs/123/stepsWith the following request body:
The response should look like:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Step that will be added. |
6.203.2. list GET
Retrieves the representation of the steps.
GET /ovirt-engine/api/job/123/steps
GET /ovirt-engine/api/job/123/stepsYou will receive response in XML like this one:
The order of the returned list of steps isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of steps to return. | |
|
| Out | A representation of steps. |
6.203.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.203.2.2. max
Sets the maximum number of steps to return. If not specified all the steps are returned.
6.204. Storage
| Name | Summary |
|---|---|
|
|
6.204.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates if the status of the LUNs in the storage should be checked. | |
|
| Out |
6.204.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.204.1.2. report_status
Indicates if the status of the LUNs in the storage should be checked. Checking the status of the LUN is an heavy weight operation and this data is not always needed by the user. This parameter will give the option to not perform the status check of the LUNs.
The default is true for backward compatibility.
Here an example with the LUN status :
Here an example without the LUN status :
6.205. StorageDomain
| Name | Summary |
|---|---|
|
| Retrieves the description of the storage domain. |
|
| Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server. |
|
| This operation reduces logical units from the storage domain. |
|
| This operation refreshes the LUN size. |
|
| Removes the storage domain. |
|
| Updates a storage domain. |
|
|
This operation forces the update of the |
6.205.1. get GET
Retrieves the description of the storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The description of the storage domain. |
6.205.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.205.2. isattached POST
Used for querying if the storage domain is already attached to a data center using the is_attached boolean field, which is part of the storage server. IMPORTANT: Executing this API will cause the host to disconnect from the storage domain.
6.205.3. reduceluns POST
This operation reduces logical units from the storage domain.
In order to do so the data stored on the provided logical units will be moved to other logical units of the storage domain and only then they will be reduced from the storage domain.
For example, in order to reduce two logical units from a storage domain send a request like this:
POST /ovirt-engine/api/storageDomains/123/reduceluns
POST /ovirt-engine/api/storageDomains/123/reducelunsWith a request body like this:
Note that this operation is only applicable to block storage domains (i.e., storage domains with the xref:types-storage_type[storage type] of iSCSI or FCP).
Note that this operation is only applicable to block storage domains (i.e., storage domains with the
xref:types-storage_type[storage type] of iSCSI or FCP).| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The logical units that need to be reduced from the storage domain. |
6.205.4. refreshluns POST
This operation refreshes the LUN size.
After increasing the size of the underlying LUN on the storage server, the user can refresh the LUN size. This action forces a rescan of the provided LUNs and updates the database with the new size, if required.
For example, in order to refresh the size of two LUNs send a request like this:
POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshluns
POST /ovirt-engine/api/storageDomains/262b056b-aede-40f1-9666-b883eff59d40/refreshlunsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the refresh should be performed asynchronously. | |
|
| In | The LUNs that need to be refreshed. |
6.205.5. remove DELETE
Removes the storage domain.
Without any special parameters, the storage domain is detached from the system and removed from the database. The storage domain can then be imported to the same or to a different setup, with all the data on it. If the storage is not accessible the operation will fail.
If the destroy parameter is true then the operation will always succeed, even if the storage is not accessible, the failure is just ignored and the storage domain is removed from the database anyway.
If the format parameter is true then the actual storage is formatted, and the metadata is removed from the LUN or directory, so it can no longer be imported to the same or to a different setup.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible. | |
|
| In | Indicates if the actual storage should be formatted, removing all the metadata from the underlying LUN or directory: [source] ---- DELETE /ovirt-engine/api/storageDomains/123?format=true ----
This parameter is optional, and the default value is | |
|
| In | Indicates which host should be used to remove the storage domain. |
6.205.5.1. destroy
Indicates if the operation should succeed, and the storage domain removed from the database, even if the storage is not accessible.
DELETE /ovirt-engine/api/storageDomains/123?destroy=true
DELETE /ovirt-engine/api/storageDomains/123?destroy=true
This parameter is optional, and the default value is false. When the value of destroy is true the host parameter will be ignored.
6.205.5.2. host
Indicates which host should be used to remove the storage domain.
This parameter is mandatory, except if the destroy parameter is included and its value is true, in that case the host parameter will be ignored.
The value should contain the name or the identifier of the host. For example, to use the host named myhost to remove the storage domain with identifier 123 send a request like this:
DELETE /ovirt-engine/api/storageDomains/123?host=myhost
DELETE /ovirt-engine/api/storageDomains/123?host=myhost6.205.6. update PUT
Updates a storage domain.
Not all of the StorageDomain's attributes are updatable after creation. Those that can be updated are: name, description, comment, warning_low_space_indicator, critical_space_action_blocker and wipe_after_delete. (Note that changing the wipe_after_delete attribute will not change the wipe after delete property of disks that already exist).
To update the name and wipe_after_delete attributes of a storage domain with an identifier 123, send a request as follows:
PUT /ovirt-engine/api/storageDomains/123
PUT /ovirt-engine/api/storageDomains/123With a request body as follows:
<storage_domain> <name>data2</name> <wipe_after_delete>true</wipe_after_delete> </storage_domain>
<storage_domain>
<name>data2</name>
<wipe_after_delete>true</wipe_after_delete>
</storage_domain>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The updated storage domain. |
6.205.7. updateovfstore POST
This operation forces the update of the OVF_STORE of this storage domain.
The OVF_STORE is a disk image that contains the metadata of virtual machines and disks that reside in the storage domain. This metadata is used in case the domain is imported or exported to or from a different data center or a different installation.
By default the OVF_STORE is updated periodically (set by default to 60 minutes) but users might want to force an update after an important change, or when the they believe the OVF_STORE is corrupt.
When initiated by the user, OVF_STORE update will be performed whether an update is needed or not.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the |
6.206. StorageDomainContentDisk
| Name | Summary |
|---|---|
|
|
6.206.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.206.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.207. StorageDomainContentDisks
Manages the set of disks available in a storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of disks available in the storage domain. |
6.207.1. list GET
Returns the list of disks available in the storage domain.
The order of the returned list of disks is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. | |
|
| In | A query string used to restrict the returned disks. |
6.207.1.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.207.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.207.1.3. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.208. StorageDomainDisk
Manages a single disk available in a storage domain.
Since version 4.2 of the engine this service is intended only to list disks available in the storage domain, and to register unregistered disks. All the other operations, like copying a disk, moving a disk, etc, have been deprecated and will be removed in the future. To perform those operations use the service that manages all the disks of the system or the service that manages a specific disk.
| Name | Summary |
|---|---|
|
| Copies a disk to the specified storage domain. |
|
| Exports a disk to an export storage domain. |
|
| Retrieves the description of the disk. |
|
| Moves a disk to another storage domain. |
|
| Reduces the size of the disk image. |
|
| Removes a disk. |
|
| Sparsify the disk. |
|
| Updates the disk. |
6.208.1. copy POST
Copies a disk to the specified storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To copy a disk use the copy operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Description of the resulting disk. | |
|
| In | The storage domain where the new disk will be created. |
6.208.2. export POST
Exports a disk to an export storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To export a disk use the export operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | The export storage domain where the disk should be exported to. |
6.208.3. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.208.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.208.4. move POST
Moves a disk to another storage domain.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To move a disk use the move operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the move should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | The storage domain where the disk will be moved to. |
6.208.5. reduce POST
Reduces the size of the disk image.
Invokes reduce on the logical volume (i.e. this is only applicable for block storage domains). This is applicable for floating disks and disks attached to non-running virtual machines. There is no need to specify the size as the optimal size is calculated automatically.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.208.6. remove DELETE
Removes a disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.208.7. sparsify POST
Sparsify the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To remove a disk use the remove operation of the service that manages that disk.
6.208.8. update PUT
Updates the disk.
Since version 4.2 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To update a disk use the update operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The update to apply to the disk. |
6.209. StorageDomainDisks
Manages the collection of disks available inside a specific storage domain.
| Name | Summary |
|---|---|
|
| Adds or registers a disk. |
|
| Retrieves the list of disks that are available in the storage domain. |
6.209.1. add POST
Adds or registers a disk.
Since version 4.2 of the Red Hat Virtualization Manager this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. To add a new disk use the add operation of the service that manages the disks of the system. To register an unregistered disk use the register operation of the service that manages that disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The disk to add or register. | |
|
| In | Indicates if a new disk should be added or if an existing unregistered disk should be registered. |
6.209.1.1. unregistered
Indicates if a new disk should be added or if an existing unregistered disk should be registered. If the value is true then the identifier of the disk to register needs to be provided. For example, to register the disk with ID 456 send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=true
POST /ovirt-engine/api/storagedomains/123/disks?unregistered=trueWith a request body like this:
<disk id="456"/>
<disk id="456"/>
If the value is false then a new disk will be created in the storage domain. In that case the provisioned_size, format, and name attributes are mandatory. For example, to create a new copy on write disk of 1 GiB, send a request like this:
POST /ovirt-engine/api/storagedomains/123/disks
POST /ovirt-engine/api/storagedomains/123/disksWith a request body like this:
<disk> <name>mydisk</name> <format>cow</format> <provisioned_size>1073741824</provisioned_size> </disk>
<disk>
<name>mydisk</name>
<format>cow</format>
<provisioned_size>1073741824</provisioned_size>
</disk>
The default value is false.
This parameter has been deprecated since version 4.2 of the Red Hat Virtualization Manager.
6.209.2. list GET
Retrieves the list of disks that are available in the storage domain.
The order of the returned list of disks is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. | |
|
| In | Indicates whether to retrieve a list of registered or unregistered disks in the storage domain. |
6.209.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.209.2.2. max
Sets the maximum number of disks to return. If not specified, all the disks are returned.
6.209.2.3. unregistered
Indicates whether to retrieve a list of registered or unregistered disks in the storage domain. To get a list of unregistered disks in the storage domain the call should indicate the unregistered flag. For example, to get a list of unregistered disks the REST API call should look like this:
GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true
GET /ovirt-engine/api/storagedomains/123/disks?unregistered=true
The default value of the unregistered flag is false. The request only applies to storage domains that are attached.
6.210. StorageDomainServerConnection
| Name | Summary |
|---|---|
|
| |
|
| Detaches a storage connection from storage. |
6.210.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.210.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.210.2. remove DELETE
Detaches a storage connection from storage.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.211. StorageDomainServerConnections
Manages the set of connections to storage servers that exist in a storage domain.
| Name | Summary |
|---|---|
|
| |
|
| Returns the list of connections to storage servers that existin the storage domain. |
6.211.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.211.2. list GET
Returns the list of connections to storage servers that existin the storage domain.
The order of the returned list of connections isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of connections to return. |
6.211.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.211.2.2. max
Sets the maximum number of connections to return. If not specified all the connections are returned.
6.212. StorageDomainTemplate
| Name | Summary |
|---|---|
|
| |
|
| Action to import a template from an export storage domain. |
|
| Register the Template means importing the Template from the data domain by inserting the configuration of the Template and disks into the database without the copy process. |
|
|
6.212.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.212.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.212.2. import POST
Action to import a template from an export storage domain.
For example, to import the template 456 from the storage domain 123 send the following request:
POST /ovirt-engine/api/storagedomains/123/templates/456/import
POST /ovirt-engine/api/storagedomains/123/templates/456/importWith the following request body:
If you register an entity without specifying the cluster ID or name, the cluster name from the entity’s OVF will be used (unless the register request also includes the cluster mapping).
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In |
Use the optional | |
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | ||
|
| In |
6.212.2.1. clone
Use the optional clone parameter to generate new UUIDs for the imported template and its entities.
You can import a template with the clone parameter set to false when importing a template from an export domain, with templates that were exported by a different Red Hat Virtualization environment.
6.212.3. register POST
Register the Template means importing the Template from the data domain by inserting the configuration of the Template and disks into the database without the copy process.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates whether a template is allowed to be registered with only some of its disks. | |
|
| In | Indicates if the registration should be performed asynchronously. | |
|
| In | ||
|
| In | ||
|
| In | ||
|
| In | This parameter describes how the template should be registered. | |
|
| In | ||
|
| In | Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. |
6.212.3.1. allow_partial_import
Indicates whether a template is allowed to be registered with only some of its disks.
If this flag is true, the system will not fail in the validation process if an image is not found, but instead it will allow the template to be registered without the missing disks. This is mainly used during registration of a template when some of the storage domains are not available. The default value is false.
6.212.3.2. registration_configuration
This parameter describes how the template should be registered.
This parameter is optional. If the parameter is not specified, the template will be registered with the same configuration that it had in the original environment where it was created.
6.212.3.3. vnic_profile_mappings
Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process.
Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future. To specify vnic_profile_mappings use the vnic_profile_mappings attribute inside the RegistrationConfiguration type.
6.212.4. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.213. StorageDomainTemplates
Manages the set of templates available in a storage domain.
| Name | Summary |
|---|---|
|
| Returns the list of templates availalbe in the storage domain. |
6.213.1. list GET
Returns the list of templates availalbe in the storage domain.
The order of the returned list of templates isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of templates to return. | |
|
| Out | ||
|
| In | Indicates whether to retrieve a list of registered or unregistered templates which contain disks on the storage domain. |
6.213.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.213.1.2. max
Sets the maximum number of templates to return. If not specified all the templates are returned.
6.213.1.3. unregistered
Indicates whether to retrieve a list of registered or unregistered templates which contain disks on the storage domain. To get a list of unregistered templates the call should indicate the unregistered flag. For example, to get a list of unregistered templates the REST API call should look like this:
GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true
GET /ovirt-engine/api/storagedomains/123/templates?unregistered=true
The default value of the unregisterd flag is false. The request only apply to storage domains that are attached.
6.214. StorageDomainVm
| Name | Summary |
|---|---|
|
| |
|
| Imports a virtual machine from an export storage domain. |
|
| |
|
| Deletes a virtual machine from an export storage domain. |
6.214.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.214.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.214.2. import POST
Imports a virtual machine from an export storage domain.
For example, send a request like this:
POST /ovirt-engine/api/storagedomains/123/vms/456/import
POST /ovirt-engine/api/storagedomains/123/vms/456/importWith a request body like this:
To import a virtual machine as a new entity add the clone parameter:
Include an optional disks parameter to choose which disks to import. For example, to import the disks of the template that have the identifiers 123 and 456 send the following request body:
If you register an entity without specifying the cluster ID or name, the cluster name from the entity’s OVF will be used (unless the register request also includes the cluster mapping).
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the import should be performed asynchronously. | |
|
| In | Indicates if the identifiers of the imported virtual machine should be regenerated. | |
|
| In | ||
|
| In | Indicates of the snapshots of the virtual machine that is imported should be collapsed, so that the result will be a virtual machine without snapshots. | |
|
| In | ||
|
| In | ||
|
| In |
6.214.2.1. clone
Indicates if the identifiers of the imported virtual machine should be regenerated.
By default when a virtual machine is imported the identifiers are preserved. This means that the same virtual machine can’t be imported multiple times, as that identifiers needs to be unique. To allow importing the same machine multiple times set this parameter to true, as the default is false.
6.214.2.2. collapse_snapshots
Indicates of the snapshots of the virtual machine that is imported should be collapsed, so that the result will be a virtual machine without snapshots.
This parameter is optional, and if it isn’t explicitly specified the default value is false.
6.214.3. register POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates whether a virtual machine is allowed to be registered with only some of its disks. | |
|
| In | Indicates if the registration should be performed asynchronously. | |
|
| In | ||
|
| In | ||
|
| In | Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine. | |
|
| In | This parameter describes how the virtual machine should be registered. | |
|
| In | ||
|
| In | Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process. |
6.214.3.1. allow_partial_import
Indicates whether a virtual machine is allowed to be registered with only some of its disks.
If this flag is true, the engine will not fail in the validation process if an image is not found, but instead it will allow the virtual machine to be registered without the missing disks. This is mainly used during registration of a virtual machine when some of the storage domains are not available. The default value is false.
6.214.3.2. reassign_bad_macs
Indicates if the problematic MAC addresses should be re-assigned during the import process by the engine.
A MAC address would be considered as a problematic one if one of the following is true:
- It conflicts with a MAC address that is already allocated to a virtual machine in the target environment.
- It’s out of the range of the target MAC address pool.
6.214.3.3. registration_configuration
This parameter describes how the virtual machine should be registered.
This parameter is optional. If the parameter is not specified, the virtual machine will be registered with the same configuration that it had in the original environment where it was created.
6.214.3.4. vnic_profile_mappings
Deprecated attribute describing mapping rules for virtual NIC profiles that will be applied during the import\register process.
Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future. To specify vnic_profile_mappings use the vnic_profile_mappings attribute inside the RegistrationConfiguration type.
6.214.4. remove DELETE
Deletes a virtual machine from an export storage domain.
For example, to delete the virtual machine 456 from the storage domain 123, send a request like this:
DELETE /ovirt-engine/api/storagedomains/123/vms/456
DELETE /ovirt-engine/api/storagedomains/123/vms/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.215. StorageDomainVmDiskAttachment
Returns the details of the disks attached to a virtual machine in the export domain.
| Name | Summary |
|---|---|
|
| Returns the details of the attachment with all its properties and a link to the disk. |
6.215.1. get GET
Returns the details of the attachment with all its properties and a link to the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The disk attachment. | |
|
| In | Indicates which inner links should be followed. |
6.215.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.216. StorageDomainVmDiskAttachments
Returns the details of a disk attached to a virtual machine in the export domain.
| Name | Summary |
|---|---|
|
| List the disks that are attached to the virtual machine. |
6.216.1. list GET
List the disks that are attached to the virtual machine.
The order of the returned list of disk attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.216.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.217. StorageDomainVms
Lists the virtual machines of an export storage domain.
For example, to retrieve the virtual machines that are available in the storage domain with identifier 123 send the following request:
GET /ovirt-engine/api/storagedomains/123/vms
GET /ovirt-engine/api/storagedomains/123/vmsThis will return the following response body:
Virtual machines and templates in these collections have a similar representation to their counterparts in the top-level Vm and Template collections, except they also contain a StorageDomain reference and an import action.
| Name | Summary |
|---|---|
|
| Returns the list of virtual machines of the export storage domain. |
6.217.1. list GET
Returns the list of virtual machines of the export storage domain.
The order of the returned list of virtual machines isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of virtual machines to return. | |
|
| In | Indicates whether to retrieve a list of registered or unregistered virtual machines which contain disks on the storage domain. | |
|
| Vm[] | Out |
6.217.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.217.1.2. max
Sets the maximum number of virtual machines to return. If not specified all the virtual machines are returned.
6.217.1.3. unregistered
Indicates whether to retrieve a list of registered or unregistered virtual machines which contain disks on the storage domain. To get a list of unregistered virtual machines the call should indicate the unregistered flag. For example, to get a list of unregistered virtual machines the REST API call should look like this:
GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true
GET /ovirt-engine/api/storagedomains/123/vms?unregistered=true
The default value of the unregisterd flag is false. The request only apply to storage domains that are attached.
6.218. StorageDomains
Manages the set of storage domains in the system.
| Name | Summary |
|---|---|
|
| Adds a new storage domain. |
|
| Returns the list of storage domains in the system. |
6.218.1. add POST
Adds a new storage domain.
Creation of a new StorageDomain requires the name, type, host, and storage attributes. Identify the host attribute with the id or name attributes. In Red Hat Virtualization 3.6 and later you can enable the wipe after delete option by default on the storage domain. To configure this, specify wipe_after_delete in the POST request. This option can be edited after the domain is created, but doing so will not change the wipe after delete property of disks that already exist.
To add a new storage domain with specified name, type, storage.type, storage.address, and storage.path, and using a host with an id 123, send a request like this:
POST /ovirt-engine/api/storageDomains
POST /ovirt-engine/api/storageDomainsWith a request body like this:
To create a new NFS ISO storage domain send a request like this:
To create a new iSCSI storage domain send a request like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The storage domain to add. |
6.218.2. list GET
Returns the list of storage domains in the system.
The order of the returned list of storage domains is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the search should be performed taking case into account. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of storage domains to return. | |
|
| In | A query string used to restrict the returned storage domains. | |
|
| Out | A list of the storage domains in the system. |
6.218.2.1. case_sensitive
Indicates if the search should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case, set it to false.
6.218.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.218.2.3. max
Sets the maximum number of storage domains to return. If not specified, all the storage domains are returned.
6.219. StorageServerConnection
| Name | Summary |
|---|---|
|
| |
|
| Removes a storage connection. |
|
| Updates the storage connection. |
6.219.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.219.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.219.2. remove DELETE
Removes a storage connection.
A storage connection can only be deleted if neither storage domain nor LUN disks reference it. The host name or id is optional; providing it disconnects (unmounts) the connection from that host.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | The name or identifier of the host from which the connection would be unmounted (disconnected). |
6.219.2.1. host
The name or identifier of the host from which the connection would be unmounted (disconnected). If not provided, no host will be disconnected.
For example, to use the host with identifier 456 to delete the storage connection with identifier 123 send a request like this:
DELETE /ovirt-engine/api/storageconnections/123?host=456
DELETE /ovirt-engine/api/storageconnections/123?host=4566.219.3. update PUT
Updates the storage connection.
For example, to change the address of an NFS storage server, send a request like this:
PUT /ovirt-engine/api/storageconnections/123
PUT /ovirt-engine/api/storageconnections/123With a request body like this:
<storage_connection> <address>mynewnfs.example.com</address> </storage_connection>
<storage_connection>
<address>mynewnfs.example.com</address>
</storage_connection>To change the connection of an iSCSI storage server, send a request like this:
PUT /ovirt-engine/api/storageconnections/123
PUT /ovirt-engine/api/storageconnections/123With a request body like this:
<storage_connection> <port>3260</port> <target>iqn.2017-01.com.myhost:444</target> </storage_connection>
<storage_connection>
<port>3260</port>
<target>iqn.2017-01.com.myhost:444</target>
</storage_connection>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | ||
|
| In | Indicates if the operation should succeed regardless to the relevant storage domain’s status (i. |
6.219.3.1. force
Indicates if the operation should succeed regardless to the relevant storage domain’s status (i.e. updating is also applicable when storage domain’s status is not maintenance).
This parameter is optional, and the default value is false.
6.220. StorageServerConnectionExtension
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update a storage server connection extension for the given host. |
6.220.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.220.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.220.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.220.3. update PUT
Update a storage server connection extension for the given host.
To update the storage connection 456 of host 123 send a request like this:
PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456
PUT /ovirt-engine/api/hosts/123/storageconnectionextensions/456With a request body like this:
<storage_connection_extension> <target>iqn.2016-01.com.example:mytarget</target> <username>myuser</username> <password>mypassword</password> </storage_connection_extension>
<storage_connection_extension>
<target>iqn.2016-01.com.example:mytarget</target>
<username>myuser</username>
<password>mypassword</password>
</storage_connection_extension>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.221. StorageServerConnectionExtensions
| Name | Summary |
|---|---|
|
| Creates a new storage server connection extension for the given host. |
|
| Returns the list os storage connection extensions. |
6.221.1. add POST
Creates a new storage server connection extension for the given host.
The extension lets the user define credentials for an iSCSI target for a specific host. For example to use myuser and mypassword as the credentials when connecting to the iSCSI target from host 123 send a request like this:
POST /ovirt-engine/api/hosts/123/storageconnectionextensions
POST /ovirt-engine/api/hosts/123/storageconnectionextensionsWith a request body like this:
<storage_connection_extension> <target>iqn.2016-01.com.example:mytarget</target> <username>myuser</username> <password>mypassword</password> </storage_connection_extension>
<storage_connection_extension>
<target>iqn.2016-01.com.example:mytarget</target>
<username>myuser</username>
<password>mypassword</password>
</storage_connection_extension>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.221.2. list GET
Returns the list os storage connection extensions.
The order of the returned list of storage connections isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of extensions to return. |
6.221.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.221.2.2. max
Sets the maximum number of extensions to return. If not specified all the extensions are returned.
6.222. StorageServerConnections
| Name | Summary |
|---|---|
|
| Creates a new storage connection. |
|
| Returns the list of storage connections. |
6.222.1. add POST
Creates a new storage connection.
For example, to create a new storage connection for the NFS server mynfs.example.com and NFS share /export/mydata send a request like this:
POST /ovirt-engine/api/storageconnections
POST /ovirt-engine/api/storageconnectionsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.222.2. list GET
Returns the list of storage connections.
The order of the returned list of connections isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of connections to return. |
6.222.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.222.2.2. max
Sets the maximum number of connections to return. If not specified all the connections are returned.
6.223. System
| Name | Summary |
|---|---|
|
| Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects. |
|
|
6.223.1. get GET
Returns basic information describing the API, like the product name, the version number and a summary of the number of relevant objects.
GET /ovirt-engine/api
GET /ovirt-engine/apiWe get following response:
The entry point provides a user with links to the collections in a virtualization environment. The rel attribute of each collection link provides a reference point for each link.
The entry point also contains other data such as product_info, special_objects and summary.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.223.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.223.2. reloadconfigurations POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reload should be performed asynchronously. |
6.224. SystemOption
A service that provides values of specific configuration option of the system.
| Name | Summary |
|---|---|
|
| Get the values of specific configuration option. |
6.224.1. get GET
Get the values of specific configuration option.
For example to retrieve the values of configuration option MigrationPolicies send a request like this:
GET /ovirt-engine/api/options/MigrationPolicies
GET /ovirt-engine/api/options/MigrationPoliciesThe response to that request will be the following:
The appropriate permissions are required to query configuration options. Some options can be queried only by users with administrator permissions.
There is NO backward compatibility and no guarantee about the names or values of the options. Options may be removed and their meaning can be changed at any point.
We strongly discourage the use of this service for applications other than the ones that are released simultaneously with the engine. Usage by other applications is not supported. Therefore there will be no documentation listing accessible configuration options.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The returned configuration option of the system. | |
|
| In | Optional version parameter that specifies that only particular version of the configuration option should be returned. |
6.224.1.1. version
Optional version parameter that specifies that only particular version of the configuration option should be returned. If this parameter isn’t used then all the versions will be returned.
For example, to get the value of the MigrationPolicies option but only for version 4.2 send a request like this:
GET /ovirt-engine/api/options/MigrationPolicies?version=4.2
GET /ovirt-engine/api/options/MigrationPolicies?version=4.2The response to that request will be like this:
6.225. SystemOptions
Service that provides values of configuration options of the system.
6.226. SystemPermissions
This service doesn’t add any new methods, it is just a placeholder for the annotation that specifies the path of the resource that manages the permissions assigned to the system object.
| Name | Summary |
|---|---|
|
| Assign a new permission to a user or group for specific entity. |
|
| List all the permissions of the specific entity. |
6.226.1. add POST
Assign a new permission to a user or group for specific entity.
For example, to assign the UserVmManager role to the virtual machine with id 123 to the user with id 456 send a request like this:
POST /ovirt-engine/api/vms/123/permissions
POST /ovirt-engine/api/vms/123/permissionsWith a request body like this:
To assign the SuperUser role to the system to the user with id 456 send a request like this:
POST /ovirt-engine/api/permissions
POST /ovirt-engine/api/permissionsWith a request body like this:
If you want to assign permission to the group instead of the user please replace the user element with the group element with proper id of the group. For example to assign the UserRole role to the cluster with id 123 to the group with id 789 send a request like this:
POST /ovirt-engine/api/clusters/123/permissions
POST /ovirt-engine/api/clusters/123/permissionsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The permission. |
6.226.2. list GET
List all the permissions of the specific entity.
For example to list all the permissions of the cluster with id 123 send a request like this:
GET /ovirt-engine/api/clusters/123/permissions
GET /ovirt-engine/api/clusters/123/permissionsThe order of the returned permissions isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The list of permissions. |
6.226.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.227. Tag
A service to manage a specific tag in the system.
| Name | Summary |
|---|---|
|
| Gets the information about the tag. |
|
| Removes the tag from the system. |
|
| Updates the tag entity. |
6.227.1. get GET
Gets the information about the tag.
For example to retrieve the information about the tag with the id 123 send a request like this:
GET /ovirt-engine/api/tags/123
GET /ovirt-engine/api/tags/123<tag href="/ovirt-engine/api/tags/123" id="123"> <name>root</name> <description>root</description> </tag>
<tag href="/ovirt-engine/api/tags/123" id="123">
<name>root</name>
<description>root</description>
</tag>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The tag. |
6.227.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.227.2. remove DELETE
Removes the tag from the system.
For example to remove the tag with id 123 send a request like this:
DELETE /ovirt-engine/api/tags/123
DELETE /ovirt-engine/api/tags/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.227.3. update PUT
Updates the tag entity.
For example to update parent tag to tag with id 456 of the tag with id 123 send a request like this:
PUT /ovirt-engine/api/tags/123
PUT /ovirt-engine/api/tags/123With request body like:
<tag> <parent id="456"/> </tag>
<tag>
<parent id="456"/>
</tag>
You may also specify a tag name instead of id. For example to update parent tag to tag with name mytag of the tag with id 123 send a request like this:
<tag>
<parent>
<name>mytag</name>
</parent>
</tag>
<tag>
<parent>
<name>mytag</name>
</parent>
</tag>6.228. Tags
Represents a service to manage collection of the tags in the system.
| Name | Summary |
|---|---|
|
| Add a new tag to the system. |
|
| List the tags in the system. |
6.228.1. add POST
Add a new tag to the system.
For example, to add new tag with name mytag to the system send a request like this:
POST /ovirt-engine/api/tags
POST /ovirt-engine/api/tagsWith a request body like this:
<tag> <name>mytag</name> </tag>
<tag>
<name>mytag</name>
</tag>The root tag is a special pseudo-tag assumed as the default parent tag if no parent tag is specified. The root tag cannot be deleted nor assigned a parent tag.
To create new tag with specific parent tag send a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The added tag. |
6.228.2. list GET
List the tags in the system.
For example to list the full hierarchy of the tags in the system send a request like this:
GET /ovirt-engine/api/tags
GET /ovirt-engine/api/tagsIn the previous XML output you can see the following hierarchy of the tags:
root: (id: 111)
- root2 (id: 222)
- root3 (id: 333)
root: (id: 111)
- root2 (id: 222)
- root3 (id: 333)The order of the returned list of tags isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of tags to return. | |
|
| Tag[] | Out | List of all tags in the system. |
6.228.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.228.2.2. max
Sets the maximum number of tags to return. If not specified all the tags are returned.
6.229. Template
Manages the virtual machine template and template versions.
| Name | Summary |
|---|---|
|
| Exports a template to the data center export domain. |
|
| Returns the information about this template or template version. |
|
| Removes a virtual machine template. |
|
| Updates the template. |
6.229.1. export POST
Exports a template to the data center export domain.
For example, send the following request:
POST /ovirt-engine/api/templates/123/export
POST /ovirt-engine/api/templates/123/exportWith a request body like this:
<action> <storage_domain id="456"/> <exclusive>true<exclusive/> </action>
<action>
<storage_domain id="456"/>
<exclusive>true<exclusive/>
</action>
Since version 4.2 of the engine it is also possible to export a template as a virtual appliance (OVA). For example, to export template 123 as an OVA file named myvm.ova that is placed in the directory /home/ovirt/ on host myhost:
POST /ovirt-engine/api/templates/123/export
POST /ovirt-engine/api/templates/123/exportWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the existing templates with the same name should be overwritten. | |
|
| In | Specifies the destination export storage domain. |
6.229.1.1. exclusive
Indicates if the existing templates with the same name should be overwritten.
The export action reports a failed action if a template of the same name exists in the destination domain. Set this parameter to true to change this behavior and overwrite any existing template.
6.229.2. get GET
Returns the information about this template or template version.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | The information about the template or template version. |
6.229.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.229.3. remove DELETE
Removes a virtual machine template.
DELETE /ovirt-engine/api/templates/123
DELETE /ovirt-engine/api/templates/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the removal should be performed asynchronously. |
6.229.4. update PUT
Updates the template.
The name, description, type, memory, cpu, topology, os, high_availability, display, stateless, usb, and timezone elements can be updated after a template has been created.
For example, to update a template so that it has 1 GiB of memory send a request like this:
PUT /ovirt-engine/api/templates/123
PUT /ovirt-engine/api/templates/123With the following request body:
<template> <memory>1073741824</memory> </template>
<template>
<memory>1073741824</memory>
</template>
The version_name name attribute is the only one that can be updated within the version attribute used for template versions:
<template>
<version>
<version_name>mytemplate_2</version_name>
</version>
</template>
<template>
<version>
<version_name>mytemplate_2</version_name>
</version>
</template>6.230. TemplateCdrom
A service managing a CD-ROM device on templates.
| Name | Summary |
|---|---|
|
| Returns the information about this CD-ROM device. |
6.230.1. get GET
Returns the information about this CD-ROM device.
For example, to get information about the CD-ROM device of template 123 send a request like:
GET /ovirt-engine/api/templates/123/cdroms/
GET /ovirt-engine/api/templates/123/cdroms/| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the CD-ROM device. | |
|
| In | Indicates which inner links should be followed. |
6.230.1.1. cdrom
The information about the CD-ROM device.
The information consists of cdrom attribute containing reference to the CD-ROM device, the template, and optionally the inserted disk.
If there is a disk inserted then the file attribute will contain a reference to the ISO image:
<cdrom href="..." id="00000000-0000-0000-0000-000000000000"> <template href="/ovirt-engine/api/templates/123" id="123"/> <file id="mycd.iso"/> </cdrom>
<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
<template href="/ovirt-engine/api/templates/123" id="123"/>
<file id="mycd.iso"/>
</cdrom>
If there is no disk inserted then the file attribute won’t be reported:
<cdrom href="..." id="00000000-0000-0000-0000-000000000000"> <template href="/ovirt-engine/api/templates/123" id="123"/> </cdrom>
<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
<template href="/ovirt-engine/api/templates/123" id="123"/>
</cdrom>6.230.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.231. TemplateCdroms
Lists the CD-ROM devices of a template.
| Name | Summary |
|---|---|
|
| Returns the list of CD-ROM devices of the template. |
6.231.1. list GET
Returns the list of CD-ROM devices of the template.
The order of the returned list of CD-ROM devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of CD-ROM devices of the template. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of CD-ROMs to return. |
6.231.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.231.1.2. max
Sets the maximum number of CD-ROMs to return. If not specified all the CD-ROMs are returned.
6.232. TemplateDisk
| Name | Summary |
|---|---|
|
| Copy the specified disk attached to the template to a specific storage domain. |
|
| |
|
| |
|
|
6.232.1. copy POST
Copy the specified disk attached to the template to a specific storage domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the copy should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In |
6.232.2. export POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the export should be performed asynchronously. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In |
6.232.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.232.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.232.4. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.233. TemplateDiskAttachment
This service manages the attachment of a disk to a template.
| Name | Summary |
|---|---|
|
| Returns the details of the attachment. |
|
| Removes the disk from the template. |
6.233.1. get GET
Returns the details of the attachment.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.233.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.233.2. remove DELETE
Removes the disk from the template. The disk will only be removed if there are other existing copies of the disk on other storage domains.
A storage domain has to be specified to determine which of the copies should be removed (template disks can have copies on multiple storage domains).
DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d74
DELETE /ovirt-engine/api/templates/{template:id}/diskattachments/{attachment:id}?storage_domain=072fbaa1-08f3-4a40-9f34-a5ca22dd1d746.234. TemplateDiskAttachments
This service manages the set of disks attached to a template. Each attached disk is represented by a DiskAttachment.
| Name | Summary |
|---|---|
|
| List the disks that are attached to the template. |
6.234.1. list GET
List the disks that are attached to the template.
The order of the returned list of attachments isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.234.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.235. TemplateDisks
| Name | Summary |
|---|---|
|
| Returns the list of disks of the template. |
6.235.1. list GET
Returns the list of disks of the template.
The order of the returned list of disks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.235.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.235.1.2. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.236. TemplateGraphicsConsole
| Name | Summary |
|---|---|
|
| Gets graphics console configuration of the template. |
|
| Remove the graphics console from the template. |
6.236.1. get GET
Gets graphics console configuration of the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the graphics console of the template. | |
|
| In | Indicates which inner links should be followed. |
6.236.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.236.2. remove DELETE
Remove the graphics console from the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.237. TemplateGraphicsConsoles
| Name | Summary |
|---|---|
|
| Add new graphics console to the template. |
|
| Lists all the configured graphics consoles of the template. |
6.237.1. add POST
Add new graphics console to the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.237.2. list GET
Lists all the configured graphics consoles of the template.
The order of the returned list of graphics consoles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of graphics consoles of the template. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of consoles to return. |
6.237.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.237.2.2. max
Sets the maximum number of consoles to return. If not specified all the consoles are returned.
6.238. TemplateMediatedDevice
| Name | Summary |
|---|---|
|
| Gets mediated device configuration of the template. |
|
| Remove the mediated device from the template. |
|
| Updates the information about the mediated device. |
6.238.1. get GET
Gets mediated device configuration of the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the mediated device of the template. | |
|
| In | Indicates which inner links should be followed. |
6.238.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.238.2. remove DELETE
Remove the mediated device from the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.238.3. update PUT
Updates the information about the mediated device.
You can update the information using specParams element.
For example, to update a mediated device, send a request like this:
with response body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The information about the mediated device. |
6.238.3.1. devices
The information about the mediated device.
The request data must contain specParams properties. The response data contains complete information about the updated mediated device.
6.239. TemplateMediatedDevices
A service that manages mediated devices of a template.
| Name | Summary |
|---|---|
|
| Add new mediated device to the template. |
|
| Lists all the configured mediated devices of the template. |
6.239.1. add POST
Add new mediated device to the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.239.2. list GET
Lists all the configured mediated devices of the template.
The order of the returned list of mediated devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of mediated devices of the template. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of mediated devices to return. |
6.239.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.239.2.2. max
Sets the maximum number of mediated devices to return. If not specified all the mediated devices are returned.
6.240. TemplateNic
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the specified network interface card attached to the template. |
6.240.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.240.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.240.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.240.3. update PUT
Update the specified network interface card attached to the template.
6.241. TemplateNics
| Name | Summary |
|---|---|
|
| Add a new network interface card to the template. |
|
| Returns the list of NICs of the template. |
6.241.1. add POST
Add a new network interface card to the template.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.241.2. list GET
Returns the list of NICs of the template.
The order of the returned list of NICs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Nic[] | Out |
6.241.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.241.2.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.242. TemplateWatchdog
| Name | Summary |
|---|---|
|
| |
|
| |
|
| Update the watchdog for the template identified by the given id. |
6.242.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.242.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.242.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.242.3. update PUT
Update the watchdog for the template identified by the given id.
6.243. TemplateWatchdogs
| Name | Summary |
|---|---|
|
| Add a watchdog to the template identified by the given id. |
|
| Returns the list of watchdogs. |
6.243.1. add POST
Add a watchdog to the template identified by the given id.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.243.2. list GET
Returns the list of watchdogs.
The order of the returned list of watchdogs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of watchdogs to return. | |
|
| Out |
6.243.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.243.2.2. max
Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.
6.244. Templates
This service manages the virtual machine templates available in the system.
| Name | Summary |
|---|---|
|
| Creates a new template. |
|
| Returns the list of virtual machine templates. |
6.244.1. add POST
Creates a new template.
This requires the name and vm elements. To identify the virtual machine use the vm.id or vm.name attributes. For example, to create a template from a virtual machine with the identifier 123 send a request like this:
POST /ovirt-engine/api/templates
POST /ovirt-engine/api/templatesWith a request body like this:
<template> <name>mytemplate</name> <vm id="123"/> </template>
<template>
<name>mytemplate</name>
<vm id="123"/>
</template>Since version 4.3, in order to create virtual machine template from a snapshot send a request body like this:
The disks of the template can be customized, making some of their characteristics different from the disks of the original virtual machine. To do so use the vm.disk_attachments attribute, specifying the identifier of the disk of the original virtual machine and the characteristics that you want to change. For example, if the original virtual machine has a disk with the identifier 456, and, for that disk, you want to change the name to mydisk the format to Copy On Write and make it sparse, send a request body like this:
The template can be created as a sub-version of an existing template. This requires the name and vm attributes for the new template, and the base_template and version_name attributes for the new template version. The base_template and version_name attributes must be specified within a version section enclosed in the template section. Identify the virtual machine with the id or name attributes.
The destination storage domain of the template can be customized, in one of two ways:
Globally, at the request level. The request must list the desired disk attachments to be created on the storage domain. If the disk attachments are not listed, the global storage domain parameter will be ignored.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Per each disk attachment. Specify the desired storage domain for each disk attachment. Specifying the global storage definition will override the storage domain per disk attachment specification.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Specifies if the permissions of the virtual machine should be copied to the template. | |
|
| In | Seals the template. | |
|
| In/Out | The information about the template or template version. |
6.244.1.1. clone_permissions
Specifies if the permissions of the virtual machine should be copied to the template.
If this optional parameter is provided, and its value is true, then the permissions of the virtual machine (only the direct ones, not the inherited ones) will be copied to the created template. For example, to create a template from the myvm virtual machine copying its permissions, send a request like this:
POST /ovirt-engine/api/templates?clone_permissions=true
POST /ovirt-engine/api/templates?clone_permissions=trueWith a request body like this:
6.244.1.2. seal
Seals the template.
If this optional parameter is provided and its value is true, then the template is sealed after creation.
Sealing erases all host-specific configuration from the filesystem: SSH keys, UDEV rules, MAC addresses, system ID, hostname, and so on, thus making it easier to use the template to create multiple virtual machines without manual intervention.
Currently, sealing is supported only for Linux operating systems.
6.244.2. list GET
Returns the list of virtual machine templates.
For example:
GET /ovirt-engine/api/templates
GET /ovirt-engine/api/templatesWill return the list of virtual machines and virtual machine templates.
The order of the returned list of templates is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of templates to return. | |
|
| In | A query string used to restrict the returned templates. | |
|
| Out | The list of virtual machine templates. |
6.244.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.244.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.244.2.3. max
Sets the maximum number of templates to return. If not specified, all the templates are returned.
6.245. UnmanagedNetwork
| Name | Summary |
|---|---|
|
| |
|
|
6.245.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.245.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.245.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.246. UnmanagedNetworks
| Name | Summary |
|---|---|
|
| Returns the list of unmanaged networks of the host. |
6.246.1. list GET
Returns the list of unmanaged networks of the host.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.246.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.246.1.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.247. User
A service to manage a user in the system. Use this service to either get users details or remove users. In order to add new users please use users.
| Name | Summary |
|---|---|
|
| Gets the system user information. |
|
| Removes the system user. |
|
| Updates information about the user. |
6.247.1. get GET
Gets the system user information.
Usage:
GET /ovirt-engine/api/users/1234
GET /ovirt-engine/api/users/1234Will return the user information:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The system user. |
6.247.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.247.2. remove DELETE
Removes the system user.
Usage:
DELETE /ovirt-engine/api/users/1234
DELETE /ovirt-engine/api/users/1234| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.247.3. update PUT
Updates information about the user.
Only the user_options field can be updated.
For example, to update user options:
PUT /ovirt-engine/api/users/123
PUT /ovirt-engine/api/users/123With a request body like this:
Since version 4.4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Please use the options endpoint instead.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.248. UserOption
| Name | Summary |
|---|---|
|
| Returns a user profile property of type JSON. |
|
| Deletes an existing property of type JSON. |
6.248.1. get GET
Returns a user profile property of type JSON.
Example request(for user with identifier 123 and option with identifier 456):
GET /ovirt-engine/api/users/123/options/456
GET /ovirt-engine/api/users/123/options/456The result will be the following XML document:
<user_option href="/ovirt-engine/api/users/123/options/456" id="456">
<name>SomeName</name>
<content>["any", "JSON"]</content>
<user href="/ovirt-engine/api/users/123" id="123"/>
</user_option>
<user_option href="/ovirt-engine/api/users/123/options/456" id="456">
<name>SomeName</name>
<content>["any", "JSON"]</content>
<user href="/ovirt-engine/api/users/123" id="123"/>
</user_option>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out |
6.248.2. remove DELETE
Deletes an existing property of type JSON.
Example request(for user with identifier 123 and option with identifier 456):
DELETE /ovirt-engine/api/users/123/options/456
DELETE /ovirt-engine/api/users/123/options/4566.249. UserOptions
| Name | Summary |
|---|---|
|
| Adds a new user profile property of type JSON. |
|
| Returns a list of user profile properties of type JSON. |
6.249.1. add POST
Adds a new user profile property of type JSON.
Example request(for user with identifier 123):
POST /ovirt-engine/api/users/123/options
POST /ovirt-engine/api/users/123/optionsPayload:
<user_option>
<name>SomeName</name>
<content>["any", "JSON"]</content>
</user_option>
<user_option>
<name>SomeName</name>
<content>["any", "JSON"]</content>
</user_option>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.249.2. list GET
Returns a list of user profile properties of type JSON.
Example request(for user with identifier 123):
GET /ovirt-engine/api/users/123/options
GET /ovirt-engine/api/users/123/optionsThe result will be the following XML document:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out |
6.250. Users
A service to manage the users in the system.
| Name | Summary |
|---|---|
|
| Add user from a directory service. |
|
| List all the users in the system. |
6.250.1. add POST
Add user from a directory service.
For example, to add the myuser user from the myextension-authz authorization provider send a request like this:
POST /ovirt-engine/api/users
POST /ovirt-engine/api/usersWith a request body like this:
In case you are working with Active Directory you have to pass user principal name (UPN) as username, followed by authorization provider name. Due to bug 1147900 you need to provide also principal parameter set to UPN of the user.
For example, to add the user with UPN myuser@mysubdomain.mydomain.com from the myextension-authz authorization provider send a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.250.2. list GET
List all the users in the system.
Usage:
GET /ovirt-engine/api/users
GET /ovirt-engine/api/usersWill return the list of users:
The order of the returned list of users isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of users to return. | |
|
| In | A query string used to restrict the returned users. | |
|
| Out | The list of users. |
6.250.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.250.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.250.2.3. max
Sets the maximum number of users to return. If not specified all the users are returned.
6.251. VirtualFunctionAllowedNetwork
| Name | Summary |
|---|---|
|
| |
|
|
6.251.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.251.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.251.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.252. VirtualFunctionAllowedNetworks
| Name | Summary |
|---|---|
|
| |
|
| Returns the list of networks. |
6.252.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.252.2. list GET
Returns the list of networks.
The order of the returned list of networks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of networks to return. | |
|
| Out |
6.252.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.252.2.2. max
Sets the maximum number of networks to return. If not specified all the networks are returned.
6.253. Vm
| Name | Summary |
|---|---|
|
| Apply an automatic CPU and NUMA configuration on the VM. |
|
| This operation stops any migration of a virtual machine to another physical host. |
|
| |
|
| Permanently restores the virtual machine to the state of the previewed snapshot. |
|
| Detaches a virtual machine from a pool. |
|
| Exports the virtual machine. |
|
| Freezes virtual machine file systems. |
|
| Retrieves the description of the virtual machine. |
|
| Initiates the automatic user logon to access a virtual machine from an external console. |
|
| Sets the global maintenance mode on the hosted engine virtual machine. |
|
| Migrates a virtual machine to another physical host. |
|
| Temporarily restores the virtual machine to the state of a snapshot. |
|
| Sends a reboot request to a virtual machine. |
|
| Removes the virtual machine, including the virtual disks attached to it. |
|
| |
|
| Sends a reset request to a virtual machine. |
|
| Captures screenshot of the current state of the VM. |
|
| This operation sends a shutdown request to a virtual machine. |
|
| Starts the virtual machine. |
|
| This operation forces a virtual machine to power-off. |
|
| This operation saves the virtual machine state to disk and stops it. |
|
| Thaws virtual machine file systems. |
|
| Generates a time-sensitive authentication token for accessing a virtual machine’s display. |
|
| Restores the virtual machine to the state it had before previewing the snapshot. |
|
| Update the virtual machine in the system for the given virtual machine id. |
6.253.1. autopincpuandnumanodes POST
Apply an automatic CPU and NUMA configuration on the VM.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Instead please use PUT followed by update operation.
An example for a request:
POST /ovirt-engine/api/vms/123/autopincpuandnumanodes
POST /ovirt-engine/api/vms/123/autopincpuandnumanodesWith a request body like this:
<action> <optimize_cpu_settings>true</optimize_cpu_settings> </action>
<action>
<optimize_cpu_settings>true</optimize_cpu_settings>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the detach action should be performed asynchronously. | |
|
| In | Specifies how the auto CPU and NUMA configuration is applied. |
6.253.1.1. optimize_cpu_settings
Specifies how the auto CPU and NUMA configuration is applied. If set to true, will adjust the CPU topology to fit the VM pinned host hardware. Otherwise, it will use the VM CPU topology.
6.253.2. cancelmigration POST
This operation stops any migration of a virtual machine to another physical host.
POST /ovirt-engine/api/vms/123/cancelmigration
POST /ovirt-engine/api/vms/123/cancelmigration
The cancel migration action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the migration should cancelled asynchronously. |
6.253.3. clone POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the clone should be performed asynchronously. | |
|
| In |
Use the | |
|
| In | The storage domain on which the virtual machines disks will be copied to. | |
|
| In |
6.253.3.1. discard_snapshots
Use the discard_snapshots parameter when the virtual machine should be clone with its snapshots collapsed. Default is true.
6.253.4. commitsnapshot POST
Permanently restores the virtual machine to the state of the previewed snapshot.
See the preview_snapshot operation for details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the snapshots should be committed asynchronously. |
6.253.5. detach POST
Detaches a virtual machine from a pool.
POST /ovirt-engine/api/vms/123/detach
POST /ovirt-engine/api/vms/123/detach
The detach action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the detach action should be performed asynchronously. |
6.253.6. export POST
Exports the virtual machine.
A virtual machine can be exported to an export domain. For example, to export virtual machine 123 to the export domain myexport:
POST /ovirt-engine/api/vms/123/export
POST /ovirt-engine/api/vms/123/exportWith a request body like this:
Since version 4.2 of the engine it is also possible to export a virtual machine as a virtual appliance (OVA). For example, to export virtual machine 123 as an OVA file named myvm.ova that is placed in the directory /home/ovirt/ on host myhost:
POST /ovirt-engine/api/vms/123/export
POST /ovirt-engine/api/vms/123/exportWith a request body like this:
Confirm that the export operation has completed before attempting any actions on the export domain.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the export should be performed asynchronously. | |
|
| In |
Use the | |
|
| In |
Use the | |
|
| In | The (export) storage domain to export the virtual machine to. |
6.253.7. freezefilesystems POST
Freezes virtual machine file systems.
This operation freezes a virtual machine’s file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.
Example:
POST /ovirt-engine/api/vms/123/freezefilesystems
POST /ovirt-engine/api/vms/123/freezefilesystems<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the freeze should be performed asynchronously. |
6.253.8. get GET
Retrieves the description of the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all of the attributes of the virtual machine should be included in the response. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Indicates if the returned result describes the virtual machine as it is currently running or if describes the virtual machine with the modifications that have already been performed but that will only come into effect when the virtual machine is restarted. | |
|
| In | Indicates if the results should expose the OVF as it appears in OVA files of that VM. | |
|
| Out | Description of the virtual machine. |
6.253.8.1. all_content
Indicates if all of the attributes of the virtual machine should be included in the response.
By default the following attributes are excluded:
-
console -
initialization.configuration.data- The OVF document describing the virtual machine. -
rng_source -
soundcard -
virtio_scsi
For example, to retrieve the complete representation of the virtual machine '123':
GET /ovirt-engine/api/vms/123?all_content=true
GET /ovirt-engine/api/vms/123?all_content=trueThese attributes are not included by default as they reduce performance. These attributes are seldom used and require additional queries to the database. Only use this parameter when required as it will reduce performance.
6.253.8.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.253.8.3. next_run
Indicates if the returned result describes the virtual machine as it is currently running or if describes the virtual machine with the modifications that have already been performed but that will only come into effect when the virtual machine is restarted. By default the value is false.
If the parameter is included in the request, but without a value, it is assumed that the value is true. The the following request:
GET /vms/{vm:id};next_run
GET /vms/{vm:id};next_run
Is equivalent to using the value true:
GET /vms/{vm:id};next_run=true
GET /vms/{vm:id};next_run=true6.253.8.4. ovf_as_ova
Indicates if the results should expose the OVF as it appears in OVA files of that VM. The OVF document describing the virtual machine. This parameter will work only when all_content=True is set. The OVF will be presented in initialization.configuration.data.
For example:
GET /vms/{vm:id}?all_content=true&ovf_as_ova=true
GET /vms/{vm:id}?all_content=true&ovf_as_ova=true6.253.9. logon POST
Initiates the automatic user logon to access a virtual machine from an external console.
This action requires the ovirt-guest-agent-gdm-plugin and the ovirt-guest-agent-pam-module packages to be installed and the ovirt-guest-agent service to be running on the virtual machine.
Users require the appropriate user permissions for the virtual machine in order to access the virtual machine from an external console.
For example:
POST /ovirt-engine/api/vms/123/logon
POST /ovirt-engine/api/vms/123/logonRequest body:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the logon should be performed asynchronously. |
6.253.10. maintenance POST
Sets the global maintenance mode on the hosted engine virtual machine.
This action has no effect on other virtual machines.
Example:
POST /ovirt-engine/api/vms/123/maintenance
POST /ovirt-engine/api/vms/123/maintenance<action> <maintenance_enabled>true<maintenance_enabled/> </action>
<action>
<maintenance_enabled>true<maintenance_enabled/>
</action>6.253.11. migrate POST
Migrates a virtual machine to another physical host.
Example:
POST /ovirt-engine/api/vms/123/migrate
POST /ovirt-engine/api/vms/123/migrateTo specify a specific host to migrate the virtual machine to:
<action> <host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/> </action>
<action>
<host id="2ab5e1da-b726-4274-bbf7-0a42b16a0fc3"/>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the migration should be performed asynchronously. | |
|
| In | Specifies the cluster the virtual machine should migrate to. | |
|
| In | Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable. | |
|
| In | Specifies a specific host that the virtual machine should migrate to. | |
|
| In | Migrate also all other virtual machines in positive enforcing affinity groups with this virtual machine, that are running on the same host. |
6.253.11.1. cluster
Specifies the cluster the virtual machine should migrate to. This is an optional parameter. By default, the virtual machine is migrated to another host within the same cluster.
Live migration to another cluster is not supported. Strongly consider the target cluster’s hardware architecture and network architecture before attempting a migration.
6.253.11.2. force
Specifies that the virtual machine should migrate even if the virtual machine is defined as non-migratable. This is an optional parameter. By default, it is set to false.
6.253.11.3. host
Specifies a specific host that the virtual machine should migrate to. This is an optional parameter. By default, the Red Hat Virtualization Manager automatically selects a default host for migration within the same cluster. If an API user requires a specific host, the user can specify the host with either an id or name parameter.
6.253.11.4. migrate_vms_in_affinity_closure
Migrate also all other virtual machines in positive enforcing affinity groups with this virtual machine, that are running on the same host.
The default value is false.
6.253.12. previewsnapshot POST
Temporarily restores the virtual machine to the state of a snapshot.
The snapshot is indicated with the snapshot.id parameter. It is restored temporarily, so that the content can be inspected. Once that inspection is finished, the state of the virtual machine can be made permanent, using the commit_snapshot method, or discarded using the undo_snapshot method.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the preview should be performed asynchronously. | |
|
| In | Specify the disks included in the snapshot’s preview. | |
|
| In | Specify the lease storage domain ID to use in the preview of the snapshot. | |
|
| In | ||
|
| In | ||
|
| In |
6.253.12.1. disks
Specify the disks included in the snapshot’s preview.
For each disk parameter, it is also required to specify its image_id.
For example, to preview a snapshot with identifier 456 which includes a disk with identifier 111 and its image_id as 222, send a request like this:
POST /ovirt-engine/api/vms/123/previewsnapshot
POST /ovirt-engine/api/vms/123/previewsnapshotRequest body:
6.253.12.2. lease
Specify the lease storage domain ID to use in the preview of the snapshot. If lease parameter is not passed, then the previewed snapshot lease storage domain will be used. If lease parameter is passed with empty storage domain parameter, then no lease will be used for the snapshot preview. If lease parameter is passed with storage domain parameter then the storage domain ID can be only one of the leases domain IDs that belongs to one of the virtual machine snapshots. This is an optional parameter, set by default to null
6.253.13. reboot POST
Sends a reboot request to a virtual machine.
For example:
POST /ovirt-engine/api/vms/123/reboot
POST /ovirt-engine/api/vms/123/reboot
The reboot action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>To reboot the VM even if a backup is running for it, the action should include the 'force' element.
For example, to force reboot virtual machine 123:
POST /ovirt-engine/api/vms/123/reboot
POST /ovirt-engine/api/vms/123/reboot<action>
<force>true</force>
</action>
<action>
<force>true</force>
</action>6.253.14. remove DELETE
Removes the virtual machine, including the virtual disks attached to it.
For example, to remove the virtual machine with identifier 123:
DELETE /ovirt-engine/api/vms/123
DELETE /ovirt-engine/api/vms/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. | |
|
| In | Indicates if the attached virtual disks should be detached first and preserved instead of being removed. | |
|
| In | Indicates if the virtual machine should be forcibly removed. |
6.253.14.1. force
Indicates if the virtual machine should be forcibly removed.
Locked virtual machines and virtual machines with locked disk images cannot be removed without this flag set to true.
6.253.15. reordermacaddresses POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the action should be performed asynchronously. |
6.253.16. reset POST
Sends a reset request to a virtual machine.
For example:
POST /ovirt-engine/api/vms/123/reset
POST /ovirt-engine/api/vms/123/reset
The reset action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the reset should be performed asynchronously. |
6.253.17. screenshot POST
Captures screenshot of the current state of the VM.
For example:
POST /ovirt-engine/api/vms/123/screenshot
POST /ovirt-engine/api/vms/123/screenshot
The screenshot action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>6.253.18. shutdown POST
This operation sends a shutdown request to a virtual machine.
For example:
POST /ovirt-engine/api/vms/123/shutdown
POST /ovirt-engine/api/vms/123/shutdown
The shutdown action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>To shutdown the VM even if a backup is running for it, the action should include the 'force' element.
For example, to force shutdown virtual machine 123:
POST /ovirt-engine/api/vms/123/shutdown
POST /ovirt-engine/api/vms/123/shutdown<action>
<force>true</force>
</action>
<action>
<force>true</force>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the shutdown should be performed asynchronously. | |
|
| In | Indicates if the VM should be forcibly shutdown even if a backup is running for it. | |
|
| In | The reason the virtual machine was stopped. |
6.253.18.1. reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
6.253.19. start POST
Starts the virtual machine.
If the virtual environment is complete and the virtual machine contains all necessary components to function, it can be started.
This example starts the virtual machine:
POST /ovirt-engine/api/vms/123/start
POST /ovirt-engine/api/vms/123/startWith a request body:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the start action should be performed asynchronously. | |
|
| In | ||
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In |
If set to | |
|
| In |
If set to | |
|
| In |
If set to | |
|
| In |
If set to | |
|
| In |
If set to | |
|
| In | The definition of the virtual machine for this specific run. | |
|
| In | Indicates that this run configuration will be discarded even in the case of guest-initiated reboot. |
6.253.19.1. pause
If set to true, start the virtual machine in paused mode. The default is false.
6.253.19.2. use_cloud_init
If set to true, the initialization type is set to cloud-init. The default value is false. See cloud-init documentation for details.
6.253.19.3. use_ignition
If set to true, the initialization type is set to Ignition. The default value is false. See Ignition documentation for details.
6.253.19.4. use_initialization
If set to true, the initialization type is set by the VM’s OS. Windows will set to Sysprep, Linux to cloud-init and RedHat CoreOS to Ignition. If any of the initialization-types are explicitly set (useCloudInit, useSysprep or useIgnition), they will be prioritized and this flag will be ignored. The default value is false.
6.253.19.5. use_sysprep
If set to true, the initialization type is set to Sysprep. The default value is false. See Sysprep for details.
6.253.19.6. vm
The definition of the virtual machine for this specific run.
For example:
This will set the boot device to the CDROM only for this specific start. After the virtual machine is powered off, this definition will be reverted.
6.253.19.7. volatile
Indicates that this run configuration will be discarded even in the case of guest-initiated reboot. The default value is false.
6.253.20. stop POST
This operation forces a virtual machine to power-off.
For example:
POST /ovirt-engine/api/vms/123/stop
POST /ovirt-engine/api/vms/123/stop
The stop action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>To stop the VM even if a backup is running for it, the action should include the 'force' element.
For example, to force stop virtual machine 123:
POST /ovirt-engine/api/vms/123/stop
POST /ovirt-engine/api/vms/123/stop<action>
<force>true</force>
</action>
<action>
<force>true</force>
</action>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the stop action should be performed asynchronously. | |
|
| In | Indicates if the VM should be forcibly stop even if a backup is running for it. | |
|
| In | The reason the virtual machine was stopped. |
6.253.20.1. reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
6.253.21. suspend POST
This operation saves the virtual machine state to disk and stops it. Start a suspended virtual machine and restore the virtual machine state with the start action.
For example:
POST /ovirt-engine/api/vms/123/suspend
POST /ovirt-engine/api/vms/123/suspend
The suspend action does not take any action specific parameters; therefore, the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the suspend action should be performed asynchronously. |
6.253.22. thawfilesystems POST
Thaws virtual machine file systems.
This operation thaws a virtual machine’s file systems using the QEMU guest agent when taking a live snapshot of a running virtual machine. Normally, this is done automatically by the manager, but this must be executed manually with the API for virtual machines using OpenStack Volume (Cinder) disks.
Example:
POST /api/vms/123/thawfilesystems
POST /api/vms/123/thawfilesystems<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the thaw file systems action should be performed asynchronously. |
6.253.23. ticket POST
Generates a time-sensitive authentication token for accessing a virtual machine’s display.
For example:
POST /ovirt-engine/api/vms/123/ticket
POST /ovirt-engine/api/vms/123/ticketThe client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.
The response specifies the actual ticket value and expiry used.
If the virtual machine is configured to support only one graphics protocol then the generated authentication token will be valid for that protocol. But if the virtual machine is configured to support multiple protocols, VNC and SPICE, then the authentication token will only be valid for the SPICE protocol.
In order to obtain an authentication token for a specific protocol, for example for VNC, use the ticket method of the service, which manages the graphics consoles of the virtual machine, by sending a request:
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket6.253.24. undosnapshot POST
Restores the virtual machine to the state it had before previewing the snapshot.
See the preview_snapshot operation for details.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the undo snapshot action should be performed asynchronously. |
6.253.25. update PUT
Update the virtual machine in the system for the given virtual machine id.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In | Indicates if the update should be applied to the virtual machine immediately or if it should be applied only when the virtual machine is restarted. | |
|
| In/Out |
6.253.25.1. next_run
Indicates if the update should be applied to the virtual machine immediately or if it should be applied only when the virtual machine is restarted. The default value is false, so by default changes are applied immediately.
6.254. VmApplication
A service that provides information about an application installed in a virtual machine.
| Name | Summary |
|---|---|
|
| Returns the information about the application. |
6.254.1. get GET
Returns the information about the application.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the application. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. |
6.254.1.1. application
The information about the application.
The information consists of name attribute containing the name of the application (which is an arbitrary string that may also contain additional information such as version) and vm attribute identifying the virtual machine.
For example, a request like this:
GET /ovirt-engine/api/vms/123/applications/789
GET /ovirt-engine/api/vms/123/applications/789May return information like this:
<application href="/ovirt-engine/api/vms/123/applications/789" id="789"> <name>ovirt-guest-agent-common-1.0.12-3.el7</name> <vm href="/ovirt-engine/api/vms/123" id="123"/> </application>
<application href="/ovirt-engine/api/vms/123/applications/789" id="789">
<name>ovirt-guest-agent-common-1.0.12-3.el7</name>
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>6.254.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.255. VmApplications
A service that provides information about applications installed in a virtual machine.
| Name | Summary |
|---|---|
|
| Returns a list of applications installed in the virtual machine. |
6.255.1. list GET
Returns a list of applications installed in the virtual machine.
The order of the returned list of applications isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | A list of applications installed in the virtual machine. | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of applications to return. |
6.255.1.1. applications
A list of applications installed in the virtual machine.
For example, a request like this:
GET /ovirt-engine/api/vms/123/applications/
GET /ovirt-engine/api/vms/123/applications/May return a list like this:
6.255.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.255.1.3. max
Sets the maximum number of applications to return. If not specified all the applications are returned.
6.256. VmBackup
A service managing a backup of a virtual machines.
| Name | Summary |
|---|---|
|
| Finalize the virtual machine backup entity. |
|
| Returns information about the virtual machine backup. |
6.256.1. finalize POST
Finalize the virtual machine backup entity.
End backup, unlock resources, and perform cleanups. To finalize a virtual machine with an id '123' and a backup with an id '456' send a request as follows:
POST /ovirt-engine/api/vms/123/backups/456/finalize
POST /ovirt-engine/api/vms/123/backups/456/finalizeWith a request body as follows:
<action />
<action />6.256.2. get GET
Returns information about the virtual machine backup.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the virtual machine backup entities. | |
|
| In | Indicates which inner links should be followed. |
6.256.2.1. backup
The information about the virtual machine backup entities.
6.256.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.257. VmBackupDisk
| Name | Summary |
|---|---|
|
| Retrieves the description of the disk. |
6.257.1. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.257.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.258. VmBackupDisks
| Name | Summary |
|---|---|
|
| Returns the list of disks in backup. |
6.258.1. list GET
Returns the list of disks in backup.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.258.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.258.1.2. max
Sets the maximum number of disks to return. If not specified, all the disks are returned.
6.259. VmBackups
Lists the backups of a virtual machine.
| Name | Summary |
|---|---|
|
| Adds a new backup entity to a virtual machine. |
|
| The list of virtual machine backups. |
6.259.1. add POST
Adds a new backup entity to a virtual machine.
For example, to start a new incremental backup of a virtual machine since checkpoint id previous-checkpoint-uuid, send a request like this:
POST /ovirt-engine/api/vms/123/backups
POST /ovirt-engine/api/vms/123/backupsWith a request body like this:
The response body:
To provide the ID of the created backup, send a request like this:
POST /ovirt-engine/api/vms/123/backups
POST /ovirt-engine/api/vms/123/backupsWith a request body like this:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The information about the virtual machine backup entity. | |
|
| In | Indicates if the backup will fail if VM failed to freeze or not. | |
|
| In | Indicate whether to use the active volume for performing the backup. |
6.259.1.1. require_consistency
Indicates if the backup will fail if VM failed to freeze or not.
If requireConsistency=True VM backup will fail in case of a failure to freeze the VM.
The REST API call should look like this:
POST /ovirt-engine/api/vms/123/backups?require_consistency=true
POST /ovirt-engine/api/vms/123/backups?require_consistency=true
The default value of the requireConsistency flag is false.
6.259.1.2. use_active
Indicate whether to use the active volume for performing the backup.
If useActive=False a snapshot will be created for the backup operation.
The REST API call should look like this:
POST /ovirt-engine/api/vms/123/backups?use_active=false
POST /ovirt-engine/api/vms/123/backups?use_active=false
The default value of the useActive flag is false.
6.259.2. list GET
The list of virtual machine backups.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the virtual machine backup entities. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of virtual machine backups to return. |
6.259.2.1. backups
The information about the virtual machine backup entities.
6.259.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.259.2.3. max
Sets the maximum number of virtual machine backups to return. If not specified, all the virtual machine backups are returned.
6.260. VmCdrom
Manages a CDROM device of a virtual machine.
Changing and ejecting the disk is done using always the update method, to change the value of the file attribute.
| Name | Summary |
|---|---|
|
| Returns the information about this CDROM device. |
|
| Updates the information about this CDROM device. |
6.260.1. get GET
Returns the information about this CDROM device.
The information consists of cdrom attribute containing reference to the CDROM device, the virtual machine, and optionally the inserted disk.
If there is a disk inserted then the file attribute will contain a reference to the ISO image:
<cdrom href="..." id="00000000-0000-0000-0000-000000000000"> <file id="mycd.iso"/> <vm href="/ovirt-engine/api/vms/123" id="123"/> </cdrom>
<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
<file id="mycd.iso"/>
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>
If there is no disk inserted then the file attribute won’t be reported:
<cdrom href="..." id="00000000-0000-0000-0000-000000000000"> <vm href="/ovirt-engine/api/vms/123" id="123"/> </cdrom>
<cdrom href="..." id="00000000-0000-0000-0000-000000000000">
<vm href="/ovirt-engine/api/vms/123" id="123"/>
</cdrom>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the CDROM device. | |
|
| In | Indicates if the operation should return the information for the currently running virtual machine. | |
|
| In | Indicates which inner links should be followed. |
6.260.1.1. current
Indicates if the operation should return the information for the currently running virtual machine. This parameter is optional, and the default value is false.
6.260.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.260.2. update PUT
Updates the information about this CDROM device.
It allows to change or eject the disk by changing the value of the file attribute. For example, to insert or change the disk send a request like this:
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000
The body should contain the new value for the file attribute:
<cdrom> <file id="mycd.iso"/> </cdrom>
<cdrom>
<file id="mycd.iso"/>
</cdrom>
The value of the id attribute, mycd.iso in this example, should correspond to a file available in an attached ISO storage domain.
To eject the disk use a file with an empty id:
<cdrom> <file id=""/> </cdrom>
<cdrom>
<file id=""/>
</cdrom>
By default the above operations change permanently the disk that will be visible to the virtual machine after the next boot, but they do not have any effect on the currently running virtual machine. If you want to change the disk that is visible to the current running virtual machine, add the current=true parameter. For example, to eject the current disk send a request like this:
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=true
PUT /ovirt-engine/api/vms/123/cdroms/00000000-0000-0000-0000-000000000000?current=trueWith a request body like this:
<cdrom> <file id=""/> </cdrom>
<cdrom>
<file id=""/>
</cdrom>
The changes made with the current=true parameter are never persisted, so they won’t have any effect after the virtual machine is rebooted.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The information about the CDROM device. | |
|
| In | Indicates if the update should apply to the currently running virtual machine, or to the virtual machine after the next boot. |
6.260.2.1. current
Indicates if the update should apply to the currently running virtual machine, or to the virtual machine after the next boot. This parameter is optional, and the default value is false, which means that by default the update will have effect only after the next boot.
6.261. VmCdroms
Manages the CDROM devices of a virtual machine.
Currently virtual machines have exactly one CDROM device. No new devices can be added, and the existing one can’t be removed, thus there are no add or remove methods. Changing and ejecting CDROM disks is done with the update method of the service that manages the CDROM device.
| Name | Summary |
|---|---|
|
| Add a cdrom to a virtual machine identified by the given id. |
|
| Returns the list of CDROM devices of the virtual machine. |
6.261.1. add POST
Add a cdrom to a virtual machine identified by the given id.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.261.2. list GET
Returns the list of CDROM devices of the virtual machine.
The order of the returned list of CD-ROM devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of CDROM devices of the virtual machine. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of CDROMs to return. |
6.261.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.261.2.2. max
Sets the maximum number of CDROMs to return. If not specified all the CDROMs are returned.
6.262. VmCheckpoint
A service managing a checkpoint of a virtual machines.
| Name | Summary |
|---|---|
|
| Returns information about the virtual machine checkpoint. |
|
| Remove the virtual machine checkpoint entity. |
6.262.1. get GET
Returns information about the virtual machine checkpoint.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the virtual machine checkpoint entity. | |
|
| In | Indicates which inner links should be followed. |
6.262.1.1. checkpoint
The information about the virtual machine checkpoint entity.
6.262.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.262.2. remove DELETE
Remove the virtual machine checkpoint entity.
Remove the checkpoint from libvirt and the database.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.263. VmCheckpointDisk
| Name | Summary |
|---|---|
|
| Retrieves the description of the disk. |
6.263.1. get GET
Retrieves the description of the disk.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The description of the disk. | |
|
| In | Indicates which inner links should be followed. |
6.263.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.264. VmCheckpointDisks
| Name | Summary |
|---|---|
|
| Returns the list of disks in checkpoint. |
6.264.1. list GET
Returns the list of disks in checkpoint.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of retrieved disks. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.264.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.264.1.2. max
Sets the maximum number of disks to return. If not specified, all the disks are returned.
6.265. VmCheckpoints
Lists the checkpoints of a virtual machine.
| Name | Summary |
|---|---|
|
| The list of virtual machine checkpoints. |
6.265.1. list GET
The list of virtual machine checkpoints.
To get a list of checkpoints for a virtual machine with an id '123', send a request as follows:
GET /ovirt-engine/api/vms/123/checkpoints
GET /ovirt-engine/api/vms/123/checkpoints| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the virtual machine checkpoint entities. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of virtual machine checkpoints to return. |
6.265.1.1. checkpoints
The information about the virtual machine checkpoint entities.
6.265.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.265.1.3. max
Sets the maximum number of virtual machine checkpoints to return. If not specified, all the virtual machine checkpoints are returned.
6.266. VmDisk
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| Reduces the size of the disk image. |
|
| Detach the disk from the virtual machine. |
|
|
6.266.1. activate POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.266.2. deactivate POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. |
6.266.3. export POST
6.266.4. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. |
6.266.4.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.266.5. move POST
6.266.6. reduce POST
Reduces the size of the disk image.
Invokes reduce on the logical volume (i.e. this is only applicable for block storage domains). This is applicable for floating disks and disks attached to non-running virtual machines. There is no need to specify the size as the optimal size is calculated automatically.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.266.7. remove DELETE
Detach the disk from the virtual machine.
In version 3 of the API this used to also remove the disk completely from the system, but starting with version 4 it doesn’t. If you need to remove it completely use the remove method of the top level disk service.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.266.8. update PUT
6.267. VmDisks
| Name | Summary |
|---|---|
|
| |
|
| Returns the list of disks of the virtual machine. |
6.267.1. add POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.267.2. list GET
Returns the list of disks of the virtual machine.
The order of the returned list of disks isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | ||
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of disks to return. |
6.267.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.267.2.2. max
Sets the maximum number of disks to return. If not specified all the disks are returned.
6.268. VmGraphicsConsole
| Name | Summary |
|---|---|
|
| Retrieves the graphics console configuration of the virtual machine. |
|
| |
|
|
Generates the file which is compatible with |
|
| Remove the graphics console from the virtual machine. |
|
| Generates a time-sensitive authentication token for accessing this virtual machine’s console. |
6.268.1. get GET
Retrieves the graphics console configuration of the virtual machine.
By default, when the current parameter is not specified, the data returned corresponds to the next execution of the virtual machine. In the current implementation of the system this means that the address and port attributes will not be populated because the system does not know what address and port will be used for the next execution. Since in most cases those attributes are needed, it is strongly advised to aways explicitly include the current parameter with the value true.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the graphics console of the virtual machine. | |
|
| In | Specifies if the data returned should correspond to the next execution of the virtual machine, or to the current execution. | |
|
| In | Indicates which inner links should be followed. |
6.268.1.1. current
Specifies if the data returned should correspond to the next execution of the virtual machine, or to the current execution.
The address and port attributes will not be populated unless the value is true.
For example, to get data for the current execution of the virtual machine, including the address and port attributes, send a request like this:
GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true
GET /ovit-engine/api/vms/123/graphicsconsoles/456?current=true
The default value is false.
6.268.1.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.268.2. proxyticket POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the generation of the ticket should be performed asynchronously. | |
|
| Out |
6.268.3. remoteviewerconnectionfile POST
Generates the file which is compatible with remote-viewer client.
Use the following request to generate remote viewer connection file of the graphics console. Note that this action generates the file only if virtual machine is running.
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/remoteviewerconnectionfile
The remoteviewerconnectionfile action does not take any action specific parameters, so the request body should contain an empty action:
<action/>
<action/>
The response contains the file, which can be used with remote-viewer client.
E.g., to fetch the content of remote viewer connection file and save it into temporary file, user can use oVirt Python SDK as follows:
When you create the remote viewer connection file, then you can connect to virtual machine graphic console, as follows:
#!/bin/sh -ex remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv
#!/bin/sh -ex
remote-viewer --ovirt-ca-file=/etc/pki/ovirt-engine/ca.pem /tmp/remote_viewer_connection_file.vv| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out |
Contains the file which is compatible with |
6.268.3.1. remote_viewer_connection_file
Contains the file which is compatible with remote-viewer client.
User can use the content of this attribute to create a file, which can be passed to remote-viewer client to connect to virtual machine graphic console.
6.268.4. remove DELETE
Remove the graphics console from the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.268.5. ticket POST
Generates a time-sensitive authentication token for accessing this virtual machine’s console.
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticket
POST /ovirt-engine/api/vms/123/graphicsconsoles/456/ticketThe client-provided action optionally includes a desired ticket value and/or an expiry time in seconds.
In any case, the response specifies the actual ticket value and expiry used.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The generated ticket that can be used to access this console. |
6.269. VmGraphicsConsoles
| Name | Summary |
|---|---|
|
| Add new graphics console to the virtual machine. |
|
| Lists all the configured graphics consoles of the virtual machine. |
6.269.1. add POST
Add new graphics console to the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.269.2. list GET
Lists all the configured graphics consoles of the virtual machine.
By default, when the current parameter is not specified, the data returned corresponds to the next execution of the virtual machine. In the current implementation of the system this means that the address and port attributes will not be populated because the system does not know what address and port will be used for the next execution. Since in most cases those attributes are needed, it is strongly advised to aways explicitly include the current parameter with the value true.
The order of the returned list of graphics consoles is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of graphics consoles of the virtual machine. | |
|
| In | Specifies if the data returned should correspond to the next execution of the virtual machine, or to the current execution. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of consoles to return. |
6.269.2.1. current
Specifies if the data returned should correspond to the next execution of the virtual machine, or to the current execution.
The address and port attributes will not be populated unless the value is true.
For example, to get data for the current execution of the virtual machine, including the address and port attributes, send a request like this:
GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true
GET /ovirt-engine/api/vms/123/graphicsconsoles?current=true
The default value is false.
6.269.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.269.2.3. max
Sets the maximum number of consoles to return. If not specified all the consoles are returned.
6.270. VmHostDevice
A service to manage individual host device attached to a virtual machine.
| Name | Summary |
|---|---|
|
| Retrieve information about particular host device attached to given virtual machine. |
|
| Remove the attachment of this host device from given virtual machine. |
6.270.1. get GET
Retrieve information about particular host device attached to given virtual machine.
Example:
GET /ovirt-engine/api/vms/123/hostdevices/456
GET /ovirt-engine/api/vms/123/hostdevices/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved information about the host device attached to given virtual machine. | |
|
| In | Indicates which inner links should be followed. |
6.270.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.270.2. remove DELETE
Remove the attachment of this host device from given virtual machine.
In case this device serves as an IOMMU placeholder, it cannot be removed (remove will result only in setting its placeholder flag to true). Note that all IOMMU placeholder devices will be removed automatically as soon as there will be no more non-placeholder devices (all devices from given IOMMU group are detached).
DELETE /ovirt-engine/api/vms/123/hostdevices/456
DELETE /ovirt-engine/api/vms/123/hostdevices/456| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.271. VmHostDevices
A service to manage host devices attached to a virtual machine.
| Name | Summary |
|---|---|
|
| Attach target device to given virtual machine. |
|
| List the host devices assigned to given virtual machine. |
6.271.1. add POST
Attach target device to given virtual machine.
Example:
POST /ovirt-engine/api/vms/123/hostdevices
POST /ovirt-engine/api/vms/123/hostdevicesWith request body of type HostDevice, for example
<host_device id="123" />
<host_device id="123" />A necessary precondition for a successful host device attachment is that the virtual machine must be pinned to exactly one host. The device ID is then taken relative to this host.
Attachment of a PCI device that is part of a bigger IOMMU group will result in attachment of the remaining devices from that IOMMU group as "placeholders". These devices are then identified using the placeholder attribute of the HostDevice type set to true.
In case you want attach a device that already serves as an IOMMU placeholder, simply issue an explicit Add operation for it, and its placeholder flag will be cleared, and the device will be accessible to the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The host device to be attached to given virtual machine. |
6.271.2. list GET
List the host devices assigned to given virtual machine.
The order of the returned list of devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | Retrieved list of host devices attached to given virtual machine. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of devices to return. |
6.271.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.271.2.2. max
Sets the maximum number of devices to return. If not specified all the devices are returned.
6.272. VmMediatedDevice
| Name | Summary |
|---|---|
|
| Retrieves the configuration of mediated devices in the virtual machine. |
|
| Remove the mediated device from the virtual machine. |
|
| Updates the information about the mediated device. |
6.272.1. get GET
Retrieves the configuration of mediated devices in the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The information about the mediated device of the virtual machine. | |
|
| In | Indicates which inner links should be followed. |
6.272.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.272.2. remove DELETE
Remove the mediated device from the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.272.3. update PUT
Updates the information about the mediated device.
You can update the information using specParams element.
For example, to update a mediated device, send a request like this:
with response body:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The information about the mediated device. |
6.272.3.1. device
The information about the mediated device.
The request data must contain specParams properties. The response data contains complete information about the updated mediated device.
6.273. VmMediatedDevices
A service that manages mediated devices of a VM.
| Name | Summary |
|---|---|
|
| Add a new mediated device to the virtual machine. |
|
| Lists all the configured mediated devices of the virtual machine. |
6.273.1. add POST
Add a new mediated device to the virtual machine.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.273.2. list GET
Lists all the configured mediated devices of the virtual machine.
The order of the returned list of mediated devices is not guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| Out | The list of mediated devices of the virtual machine. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of mediated devices to return. |
6.273.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.273.2.2. max
Sets the maximum number of mediated devices to return. If not specified all the mediated devices are returned.
6.274. VmNic
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| Removes the NIC. |
|
| Updates the NIC. |
6.274.1. activate POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the activation should be performed asynchronously. |
6.274.2. deactivate POST
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the deactivation should be performed asynchronously. |
6.274.3. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.274.3.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.274.4. remove DELETE
Removes the NIC.
For example, to remove the NIC with id 456 from the virtual machine with id 123 send a request like this:
DELETE /ovirt-engine/api/vms/123/nics/456
DELETE /ovirt-engine/api/vms/123/nics/456The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:
- Red Hat Enterprise Linux 6
- Red Hat Enterprise Linux 5
- Windows Server 2008 and
- Windows Server 2003
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.274.5. update PUT
Updates the NIC.
For example, to update the NIC having with 456 belonging to virtual the machine with id 123 send a request like this:
PUT /ovirt-engine/api/vms/123/nics/456
PUT /ovirt-engine/api/vms/123/nics/456With a request body like this:
<nic> <name>mynic</name> <interface>e1000</interface> <vnic_profile id='789'/> </nic>
<nic>
<name>mynic</name>
<interface>e1000</interface>
<vnic_profile id='789'/>
</nic>The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:
- Red Hat Enterprise Linux 6
- Red Hat Enterprise Linux 5
- Windows Server 2008 and
- Windows Server 2003
6.275. VmNics
| Name | Summary |
|---|---|
|
| Adds a NIC to the virtual machine. |
|
| Returns the list of NICs of the virtual machine. |
6.275.1. add POST
Adds a NIC to the virtual machine.
The following example adds to the virtual machine 123 a network interface named mynic using virtio and the NIC profile 456.
POST /ovirt-engine/api/vms/123/nics
POST /ovirt-engine/api/vms/123/nics<nic> <name>mynic</name> <interface>virtio</interface> <vnic_profile id="456"/> </nic>
<nic>
<name>mynic</name>
<interface>virtio</interface>
<vnic_profile id="456"/>
</nic>
The following example sends that request using curl:
The hotplugging feature only supports virtual machine operating systems with hotplugging operations. Example operating systems include:
- Red Hat Enterprise Linux 6
- Red Hat Enterprise Linux 5
- Windows Server 2008 and
- Windows Server 2003
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.275.2. list GET
Returns the list of NICs of the virtual machine.
The order of the returned list of NICs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of NICs to return. | |
|
| Nic[] | Out |
6.275.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.275.2.2. max
Sets the maximum number of NICs to return. If not specified all the NICs are returned.
6.276. VmNumaNode
| Name | Summary |
|---|---|
|
| |
|
| Removes a virtual NUMA node. |
|
| Updates a virtual NUMA node. |
6.276.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.276.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.276.2. remove DELETE
Removes a virtual NUMA node.
An example of removing a virtual NUMA node:
DELETE /ovirt-engine/api/vms/123/numanodes/456
DELETE /ovirt-engine/api/vms/123/numanodes/456It’s required to remove the numa nodes from the highest index first.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.276.3. update PUT
Updates a virtual NUMA node.
An example of pinning a virtual NUMA node to a physical NUMA node on the host:
PUT /ovirt-engine/api/vms/123/numanodes/456
PUT /ovirt-engine/api/vms/123/numanodes/456The request body should contain the following:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out |
6.277. VmNumaNodes
| Name | Summary |
|---|---|
|
| Creates a new virtual NUMA node for the virtual machine. |
|
| Lists virtual NUMA nodes of a virtual machine. |
6.277.1. add POST
Creates a new virtual NUMA node for the virtual machine.
An example of creating a NUMA node:
POST /ovirt-engine/api/vms/c7ecd2dc/numanodes Accept: application/xml Content-type: application/xml
POST /ovirt-engine/api/vms/c7ecd2dc/numanodes
Accept: application/xml
Content-type: application/xmlThe request body can contain the following:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.277.2. list GET
Lists virtual NUMA nodes of a virtual machine.
The order of the returned list of NUMA nodes isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of nodes to return. | |
|
| Out |
6.277.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.277.2.2. max
Sets the maximum number of nodes to return. If not specified all the nodes are returned.
6.278. VmPool
A service to manage a virtual machines pool.
| Name | Summary |
|---|---|
|
| This operation allocates a virtual machine in the virtual machine pool. |
|
| Get the virtual machine pool. |
|
| Removes a virtual machine pool. |
|
| Update the virtual machine pool. |
6.278.1. allocatevm POST
This operation allocates a virtual machine in the virtual machine pool.
POST /ovirt-engine/api/vmpools/123/allocatevm
POST /ovirt-engine/api/vmpools/123/allocatevm
The allocate virtual machine action does not take any action specific parameters, so the request body should contain an empty action:
<action/>
<action/>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the allocation should be performed asynchronously. |
6.278.2. get GET
Get the virtual machine pool.
GET /ovirt-engine/api/vmpools/123
GET /ovirt-engine/api/vmpools/123You will get a XML response like that one:
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out | Retrieved virtual machines pool. |
6.278.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.278.3. remove DELETE
Removes a virtual machine pool.
DELETE /ovirt-engine/api/vmpools/123
DELETE /ovirt-engine/api/vmpools/123| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.278.4. update PUT
Update the virtual machine pool.
PUT /ovirt-engine/api/vmpools/123
PUT /ovirt-engine/api/vmpools/123
The name, description, size, prestarted_vms and max_user_vms attributes can be updated after the virtual machine pool has been created.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The virtual machine pool that is being updated. | |
|
| In | Specifies if virtual machines created for the pool should be sealed after creation. |
6.278.4.1. seal
Specifies if virtual machines created for the pool should be sealed after creation.
If this optional parameter is provided, and its value is true, virtual machines created for the pool will be sealed after creation. If the value is 'false', the virtual machines will not be sealed. If the parameter is not provided, the virtual machines will be sealed, only if they are created from a sealed template and their guest OS is not set to Windows. This parameter affects only the virtual machines created when the pool is updated.
For example, to update a virtual machine pool and to seal the additional virtual machines that are created, send a request like this:
PUT /ovirt-engine/api/vmpools/123?seal=true
PUT /ovirt-engine/api/vmpools/123?seal=trueWith the following body:
<vmpool> <name>VM_Pool_B</name> <description>Virtual Machine Pool B</description> <size>7</size> </vmpool>
<vmpool>
<name>VM_Pool_B</name>
<description>Virtual Machine Pool B</description>
<size>7</size>
</vmpool>6.279. VmPools
Provides read-write access to virtual machines pools.
| Name | Summary |
|---|---|
|
| Creates a new virtual machine pool. |
|
| Get a list of available virtual machines pools. |
6.279.1. add POST
Creates a new virtual machine pool.
A new pool requires the name, cluster and template attributes. Identify the cluster and template with the id or name nested attributes:
POST /ovirt-engine/api/vmpools
POST /ovirt-engine/api/vmpoolsWith the following body:
<vmpool> <name>mypool</name> <cluster id="123"/> <template id="456"/> </vmpool>
<vmpool>
<name>mypool</name>
<cluster id="123"/>
<template id="456"/>
</vmpool>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | Pool to add. | |
|
| In | Specifies if virtual machines created for the pool should be sealed after creation. |
6.279.1.1. seal
Specifies if virtual machines created for the pool should be sealed after creation.
If this optional parameter is provided, and its value is true, virtual machines created for the pool will be sealed after creation. If the value is 'false', the virtual machines will not be sealed. If the parameter is not provided, the virtual machines will be sealed, only if they are created from a sealed template and their guest OS is not set to Windows. This parameter affects only the virtual machines created when the pool is created.
For example, to create a virtual machine pool with 5 virtual machines and to seal them, send a request like this:
POST /ovirt-engine/api/vmpools?seal=true
POST /ovirt-engine/api/vmpools?seal=trueWith the following body:
6.279.2. list GET
Get a list of available virtual machines pools.
GET /ovirt-engine/api/vmpools
GET /ovirt-engine/api/vmpoolsYou will receive the following response:
The order of the returned list of pools is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of pools to return. | |
|
| Out | Retrieved pools. | |
|
| In | A query string used to restrict the returned pools. |
6.279.2.1. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.279.2.2. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.279.2.3. max
Sets the maximum number of pools to return. If this value is not specified, all of the pools are returned.
6.280. VmReportedDevice
| Name | Summary |
|---|---|
|
|
6.280.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.280.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.281. VmReportedDevices
| Name | Summary |
|---|---|
|
| Returns the list of reported devices of the virtual machine. |
6.281.1. list GET
Returns the list of reported devices of the virtual machine.
The order of the returned list of devices isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of devices to return. | |
|
| Out |
6.281.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.281.1.2. max
Sets the maximum number of devices to return. If not specified all the devices are returned.
6.282. VmSession
| Name | Summary |
|---|---|
|
|
6.282.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.282.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.283. VmSessions
Provides information about virtual machine user sessions.
| Name | Summary |
|---|---|
|
| Lists all user sessions for this virtual machine. |
6.283.1. list GET
Lists all user sessions for this virtual machine.
For example, to retrieve the session information for virtual machine 123 send a request like this:
GET /ovirt-engine/api/vms/123/sessions
GET /ovirt-engine/api/vms/123/sessionsThe response body will contain something like this:
The order of the returned list of sessions isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of sessions to return. | |
|
| Out |
6.283.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.283.1.2. max
Sets the maximum number of sessions to return. If not specified all the sessions are returned.
6.284. VmWatchdog
A service managing a watchdog on virtual machines.
| Name | Summary |
|---|---|
|
| Returns the information about the watchdog. |
|
| Removes the watchdog from the virtual machine. |
|
| Updates the information about the watchdog. |
6.284.1. get GET
Returns the information about the watchdog.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out | The information about the watchdog. |
6.284.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.284.1.2. watchdog
The information about the watchdog.
The information consists of model element, action element and the reference to the virtual machine. It may look like this:
6.284.2. remove DELETE
Removes the watchdog from the virtual machine.
For example, to remove a watchdog from a virtual machine, send a request like this:
DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000
DELETE /ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.284.3. update PUT
Updates the information about the watchdog.
You can update the information using action and model elements.
For example, to update a watchdog, send a request like this:
PUT /ovirt-engine/api/vms/123/watchdogs <watchdog> <action>reset</action> </watchdog>
PUT /ovirt-engine/api/vms/123/watchdogs
<watchdog>
<action>reset</action>
</watchdog>with response body:
<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"> <vm href="/ovirt-engine/api/vms/123" id="123"/> <action>reset</action> <model>i6300esb</model> </watchdog>
<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
<vm href="/ovirt-engine/api/vms/123" id="123"/>
<action>reset</action>
<model>i6300esb</model>
</watchdog>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The information about the watchdog. |
6.284.3.1. watchdog
The information about the watchdog.
The request data must contain at least one of model and action elements. The response data contains complete information about the updated watchdog.
6.285. VmWatchdogs
Lists the watchdogs of a virtual machine.
| Name | Summary |
|---|---|
|
| Adds new watchdog to the virtual machine. |
|
| The list of watchdogs of the virtual machine. |
6.285.1. add POST
Adds new watchdog to the virtual machine.
For example, to add a watchdog to a virtual machine, send a request like this:
POST /ovirt-engine/api/vms/123/watchdogs <watchdog> <action>poweroff</action> <model>i6300esb</model> </watchdog>
POST /ovirt-engine/api/vms/123/watchdogs
<watchdog>
<action>poweroff</action>
<model>i6300esb</model>
</watchdog>with response body:
<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000"> <vm href="/ovirt-engine/api/vms/123" id="123"/> <action>poweroff</action> <model>i6300esb</model> </watchdog>
<watchdog href="/ovirt-engine/api/vms/123/watchdogs/00000000-0000-0000-0000-000000000000" id="00000000-0000-0000-0000-000000000000">
<vm href="/ovirt-engine/api/vms/123" id="123"/>
<action>poweroff</action>
<model>i6300esb</model>
</watchdog>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The information about the watchdog. |
6.285.1.1. watchdog
The information about the watchdog.
The request data must contain model element (such as i6300esb) and action element (one of none, reset, poweroff, dump, pause). The response data additionally contains references to the added watchdog and to the virtual machine.
6.285.2. list GET
The list of watchdogs of the virtual machine.
The order of the returned list of watchdogs isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of watchdogs to return. | |
|
| Out | The information about the watchdog. |
6.285.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.285.2.2. max
Sets the maximum number of watchdogs to return. If not specified all the watchdogs are returned.
6.285.2.3. watchdogs
The information about the watchdog.
The information consists of model element, action element and the reference to the virtual machine. It may look like this:
6.286. Vms
| Name | Summary |
|---|---|
|
| Creates a new virtual machine. |
|
| Returns the list of virtual machines of the system. |
6.286.1. add POST
Creates a new virtual machine.
The virtual machine can be created in different ways:
- From a template. In this case the identifier or name of the template must be provided. For example, using a plain shell script and XML:
- From a snapshot. In this case the identifier of the snapshot has to be provided. For example, using a plain shel script and XML:
When creating a virtual machine from a template or from a snapshot it is usually useful to explicitly indicate in what storage domain to create the disks for the virtual machine. If the virtual machine is created from a template then this is achieved passing a set of disk_attachment elements that indicate the mapping:
When the virtual machine is created from a snapshot this set of disks is slightly different, it uses the image_id attribute instead of id.
It is possible to specify additional virtual machine parameters in the XML description, e.g. a virtual machine of desktop type, with 2 GiB of RAM and additional description can be added sending a request body like the following:
A bootable CDROM device can be set like this:
In order to boot from CDROM, you first need to insert a disk, as described in the CDROM service. Then booting from that CDROM can be specified using the os.boot.devices attribute:
In all cases the name or identifier of the cluster where the virtual machine will be created is mandatory.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Specifies if and how the auto CPU and NUMA configuration is applied. | |
|
| In | Specifies if the virtual machine should be independent of the template. | |
|
| In | Specifies if the permissions of the template should be copied to the virtual machine. | |
|
| In | Relevant for admin users only. | |
|
| In | Specifies if the virtual machine should be sealed after creation. | |
|
| In/Out |
6.286.1.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Instead please use POST followed by add operation.
An example for a request:
POST /ovirt-engine/api/vms?auto_pinning_policy=existing/adjust
POST /ovirt-engine/api/vms?auto_pinning_policy=existing/adjustWith a request body like this:
6.286.1.2. clone
Specifies if the virtual machine should be independent of the template.
When a virtual machine is created from a template by default the disks of the virtual machine depend on the disks of the template, they are using the copy on write mechanism so that only the differences from the template take up real storage space. If this parameter is specified and the value is true then the disks of the created virtual machine will be cloned, and independent of the template. For example, to create an independent virtual machine, send a request like this:
POST /ovirt-engine/vms?clone=true
POST /ovirt-engine/vms?clone=trueWith a request body like this:
When this parameter is true the permissions of the template will also be copied, as when using clone_permissions=true.
6.286.1.3. clone_permissions
Specifies if the permissions of the template should be copied to the virtual machine.
If this optional parameter is provided, and its values is true then the permissions of the template (only the direct ones, not the inherited ones) will be copied to the created virtual machine. For example, to create a virtual machine from the mytemplate template copying its permissions, send a request like this:
POST /ovirt-engine/api/vms?clone_permissions=true
POST /ovirt-engine/api/vms?clone_permissions=trueWith a request body like this:
6.286.1.4. filter
Relevant for admin users only. Indicates whether to assign UserVmManager role on the created Virtual Machine for this user. This will enable the user to later access the Virtual Machine as though he were a non-admin user, foregoing his admin permissions (by providing filter=true).
admin-as-user (meaning providing filter=true) POST requests on an existing Virtual Machine will fail unless the Virtual Machine has been previously created by the admin as a user (meaning with filter=true).
6.286.1.5. seal
Specifies if the virtual machine should be sealed after creation.
If this optional parameter is provided, and its value is true, the virtual machine will be sealed after creation. If the value is 'false', the virtual machine will not be sealed. If the parameter is not provided, the virtual machine will be sealed, only if it is created from a sealed template and its guest OS is not set to Windows.
For example, to create a virtual machine from the mytemplate template and to seal it, send a request like this:
POST /ovirt-engine/api/vms?seal=true
POST /ovirt-engine/api/vms?seal=trueWith a request body like this:
6.286.2. list GET
Returns the list of virtual machines of the system.
The order of the returned list of virtual machines is guaranteed only if the sortby clause is included in the search parameter.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if all the attributes of the virtual machines should be included in the response. | |
|
| In |
Indicates if the search performed using the | |
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | The maximum number of results to return. | |
|
| In | Indicates if the results should expose the OVF as it appears in OVA files of that VM. | |
|
| In | A query string used to restrict the returned virtual machines. | |
|
| Vm[] | Out |
6.286.2.1. all_content
Indicates if all the attributes of the virtual machines should be included in the response.
By default the following attributes are excluded:
-
console -
initialization.configuration.data- The OVF document describing the virtual machine. -
rng_source -
soundcard -
virtio_scsi
For example, to retrieve the complete representation of the virtual machines send a request like this:
GET /ovirt-engine/api/vms?all_content=true
GET /ovirt-engine/api/vms?all_content=trueThe reason for not including these attributes is performance: they are seldom used and they require additional queries to the database. So try to use the this parameter only when it is really needed.
6.286.2.2. case_sensitive
Indicates if the search performed using the search parameter should be performed taking case into account. The default value is true, which means that case is taken into account. If you want to search ignoring case set it to false.
6.286.2.3. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.286.2.4. ovf_as_ova
Indicates if the results should expose the OVF as it appears in OVA files of that VM. The OVF document describing the virtual machine. This parameter will work only when all_content=True is set. The OVF will be presented in initialization.configuration.data.
For example:
GET /vms?all_content=true&ovf_as_ova=true
GET /vms?all_content=true&ovf_as_ova=true6.287. VnicProfile
This service manages a vNIC profile.
| Name | Summary |
|---|---|
|
| Retrieves details about a vNIC profile. |
|
| Removes the vNIC profile. |
|
| Updates details of a vNIC profile. |
6.287.1. get GET
Retrieves details about a vNIC profile.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.287.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.287.2. remove DELETE
Removes the vNIC profile.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.287.3. update PUT
Updates details of a vNIC profile.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the update should be performed asynchronously. | |
|
| In/Out | The vNIC profile that is being updated. |
6.288. VnicProfiles
This service manages the collection of all vNIC profiles.
| Name | Summary |
|---|---|
|
| Add a vNIC profile. |
|
| List all vNIC profiles. |
6.288.1. add POST
Add a vNIC profile.
For example to add vNIC profile 123 to network 456 send a request to:
POST /ovirt-engine/api/networks/456/vnicprofiles
POST /ovirt-engine/api/networks/456/vnicprofilesWith the following body:
Please note that there is a default network filter to each VNIC profile. For more details of how the default network filter is calculated please refer to the documentation in NetworkFilters.
The automatically created vNIC profile for the external network will be without network filter.
The output of creating a new VNIC profile depends in the body arguments that were given. In case no network filter was given, the default network filter will be configured. For example:
In case an empty network filter was given, no network filter will be configured for the specific VNIC profile regardless of the VNIC profile’s default network filter. For example:
<vnic_profile> <name>no_network_filter</name> <network_filter/> </vnic_profile>
<vnic_profile>
<name>no_network_filter</name>
<network_filter/>
</vnic_profile>In case that a specific valid network filter id was given, the VNIC profile will be configured with the given network filter regardless of the VNIC profiles’s default network filter. For example:
<vnic_profile> <name>user_choice_network_filter</name> <network_filter id= "0000001b-001b-001b-001b-0000000001d5"/> </vnic_profile>
<vnic_profile>
<name>user_choice_network_filter</name>
<network_filter id= "0000001b-001b-001b-001b-0000000001d5"/>
</vnic_profile>| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out | The vNIC profile that is being added. |
6.288.2. list GET
List all vNIC profiles.
The order of the returned list of vNIC profiles isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of profiles to return. | |
|
| Out | The list of all vNIC profiles. |
6.288.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.288.2.2. max
Sets the maximum number of profiles to return. If not specified all the profiles are returned.
6.289. Weight
| Name | Summary |
|---|---|
|
| |
|
|
6.289.1. get GET
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| Out |
6.289.1.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.289.2. remove DELETE
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the remove should be performed asynchronously. |
6.290. Weights
| Name | Summary |
|---|---|
|
| Add a weight to a specified user defined scheduling policy. |
|
| Returns the list of weights. |
6.290.1. add POST
Add a weight to a specified user defined scheduling policy.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In/Out |
6.290.2. list GET
Returns the list of weights.
The order of the returned list of weights isn’t guaranteed.
| Name | Type | Direction | Summary |
|---|---|---|---|
|
| In | Indicates if the results should be filtered according to the permissions of the user. | |
|
| In | Indicates which inner links should be followed. | |
|
| In | Sets the maximum number of weights to return. | |
|
| Out |
6.290.2.1. follow
Indicates which inner links should be followed. The objects referenced by these links will be fetched as part of the current request. See here for details.
6.290.2.2. max
Sets the maximum number of weights to return. If not specified all the weights are returned.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}