CHANGES.adoc

Changes

This document describes the relevant changes between releases of the API model.

4.4.12 / Jan 16 2019

New features:

• introduce ignition initialization type

Bug fixes:

• Fix follow host devices issue 1772846

• Fix Travis faliure (by using openjdk instead of oraclejdk)

4.4.11 / Nov 02 2019

New features:

• Added 'discardSnapshots', 'storageDomain' params to VM clone

• Added MDevType type and mDevTypes() to HostDevice

4.4.10 / Oct 23 2019

New features:

• Added properties for user type.

• Add HOST_CERTIFICATE_HAS_INVALID_SAN event 1763084.

4.4.9 / Oct 9 2019

New features:

• Add the support for stop and shutdown 1450351.

• Add copyhostnetworks method 1627465.

• Add encrypted to migration options 1739557.

4.4.8 / Sep 12 2019

New features:

• Add maintenance_after_restart to host fence action. 1574443.

Deprecations:

• Deprecate linux boot params 1732437.

4.4.7 / Aug 30 2019

New features:

• Echo external event to oVirt log on host.

• Cluster-wide BIOS Type default

• Add timeout to host upgrade 1728617.

Deprecations:

• Drop ovirt node legacy support 1718790.

4.4.6 / Aug 9 2019

New features:

• Introduce API for Event-Notifications 1700338.

4.4.5 / Jul 4 2019

New features:

• Added AffinityGroupHostsService 1652064.

• Add new option to remove SerialNumberPolicy 1607414.

• Add services for labels in affinity groups 1680499.

Deprecations:

• Announce the depreciation of Neutron agent configuration 1638675.

4.4.4 / Jul 4 2019

New features:

• It should be possible to specify exact v4.0 as NFS version 1690026.

4.4.3 / Jun 26 2019

New features:

• Add priority to AffinityGroup type 1680498.

• Add allContent to HostNic Services 1718141.

4.4.2 / Jun 11 2019

New features:

• Allow setting a disk ScsiGenericIO to disabled 1714834.

4.4.1 / Jun 3 2019

New features:

• Treat image transfers cancelled by user/system differently 1533362.

4.4.0 / May 2 2019

New features:

• Add new parameters to HostsService.List and VmService.Migrate 1651406.

4.3.22 / Mar 25 2019

New features:

• Add Hosted Engine disk types to content type Bug-Url: 1663626.

• Add Hosted Engine disk types to content type Bug-Url: 1600788.

4.3.21 / Jan 16 2019

New features:

• Add activate input param to add/install/approve host 1561539.

• Deprecate 'maintenance_reason' and 'optional_reason' 1580346.

• Added support for incremental backup.

• Added backup and format to ImageTransfer.

Bug fixes:

• Change HostNic statistics and labels to Link 1661207.

• Remove driver_name from managed block storage type 1664742.

4.3.20 / Dec 19 2018

New features:

• Added block size Storage domain property 1592916.

• Added V5 storage format 1592916.

• Add driverSensitiveOptions to managed block storage type.

• Add managed block storage type.

• Setup networks commit on success.

4.3.19 / Dec 4 2018

New features:

• Add vGPU placement to Host 1641125.

• Specify cloud-init protocol in vm intialization 1611889.

4.3.18 / Oct 11 2018

New features:

• Added SATA to DiskInterface enum.

• Add disks link to Snapshot type.

4.3.17 / Sep 7 2018

New features:

• Add support for OpenStack Identity API v3 1598391.

• Added linkedGlusterVolume to the StorageServerConnection type and services 1563257.

4.3.16 / Aug 29 2018

New features:

• Added LogMaxMemoryUsedThresholdType enum and LogMaxMemoryUsedThreshold to Cluster 1560132.

4.3.15 / Aug 9 2018

New features:

• Move biosType from VmBase to Bios 1327846.

• Add note to upgrade host 1603020.

• Indicate network operation in progress 1477599.

4.3.14 / Jul 18 2018

New features:

• Poly dhcpv6 and autoconf iface config 1360839.

• Added BiosType enum and biosType property to VmBase 1327846.

4.3.13 / Jun 27 2018

New features:

• Add 'Multi Queues Enabled' to VmBase 1574771.

4.3.12 / Jun 25 2018

New features:

• Added Reduce action to Disk services #1443963.

4.3.11 / May 29 2018

New features:

• Add 'sync all networks in cluster' #1558847.

• Add search parameter to providers #1572071.

• Support create a template from snapshot #1570486.

• Add migrationTargetOf to HostsService.

4.3.10 / Apr 16 2018

New features:

• ImageTransfer - adding 'clientInactivityTimeout' property #1563278.

• Add architecture to OperatingSystemInfo #1552026.

• Add import template from configuration #1526032.

4.3.9 / Apr 4 2018

New features:

• Add cancel action to transfer image session.

• Add export template as OVA to a given path on a host #1526033.

Bug fixes:

• Deprecate OsType #1537679.

4.3.8 / Mar 5 2018

New features:

• Add service to list user groups 1545716.

4.3.7 / Feb 7 2018

New features:

• Expose syncAllNetworks command for HostService.

• Move VmPlacementPolicy attribute from Vm to VmBase #1375678.

• Document JobsService as a searchable entity.

• Add lease parameter to preview snapshot #1532577.

4.3.6 / Jan 3 2018

New features:

• Deprecate the discard_zeroes_data attribute of the LogicalUnit type and the supports_discard_zeroes_data of the StorageDomain type, as they have been removed from the kernel.

• Add new content_type attribute to the Disk type #1511420.

Bug fixes:

• Make CPU type optional when adding a cluster #1525912.

4.3.5 / Dec 20 2017

New features:

• Add support for setting external network providers by name when adding or updating a cluster #1511369.

• Add new unmanaged attribute to the OpenStackNetworkProvider type.

• Move virtual NIC profile mappings insde registration configuration #1522799.

4.3.4 / Nov 22 2017

New features:

• Added new discovered_targets output parameter to the operation that discovers host iSCSI storage #1510860.

4.3.3 / Nov 15 2017

New features:

• Add OVA value to the ConfigurationType enumerated type.

• Add search parameters to the operation that lists jobs.

• Add auto_sync attribute to the OpenStack network provider type #1511823.

• Add operation to export a virtual machine as OVA file.

• Add active and transferred attributes to the ImageTransfer type.

• Add external_provider and external_provider_physical_network attributes to the Network type.

• Add transfer_url to the ImageTransfer type.

Bug fixes:

• Fix input detail of the operation that exports a virtual machine: it is mandatory to have the identifier or name of the destination storage domain.

4.3.2 / Nov 8 2017

New features:

• Add storageErrorResumeBehaviour to virtual machines, templates and instance types #1317450.

• Add reboot parameter to the upgrade method of the service that manages a host.

• Add registrationConfiguration parameter to the operations that register virtual machines and templates.

• Add documentation explaining how to add snapshots with disk attachments.

• Add the follow parameter to all the Get and List operations.

• Add the force parameter to the operation that puts a storage domain into maintenance mode #1321585.

• Deprecate the OpenStack network provider pluginType attribute, replacing it with externalPluginType.

• Add quota and diskProfile parameters to the operations that move and copy disks #1496704.

• Add authenticatedUser and effectiveUser links to the Api type #1472418.

Bug fixes:

• Add image parameter to HostService.upgrade #1488434.

• Don’t require name or identifier for adding SSH public key #1497641.

• Add documentation explaining how to add a template with disks in specific storage domains #1492614.

• Add vnicProfileMappings parameter to the operation that registers a template.

4.3.1 / Oct 11 2017

New features:

• Add new services and types to enable automatic provisioning of external network providers during host installation.

Bug fixes:

• Rename IBM Z architecture from S390 to S390X in order to explicitly indicate that it is the 64-bit variant.

• Explicitly indicate that CPU type is mandtory when adding a cluster.

4.3.0 / Sep 26 2017

New features:

• Add new S390 value to the Architecture type.

• Add new DIAG288 value to the WatchdogModel type.

4.2.19 / Sep 25 2017

New features:

• Add new HIGH_PERFORMANCE value to the VmType enum.

• Add new types and services for access to system configuration options.

4.2.18 / Sep 13 2017

Bug fixes:

• Fix optional fields in storage domain add and update 1488929.

4.2.17 / Sep 6 2017

Bug fixes:

• Storage domain identifier isn’t mandatory to create quota limit.

• Don’t require deprecated affinity group attributes #1488729.

4.2.16 / Aug 28 2017

New features:

• Add support for creating image transfers using disks and snapshots.

• Add size and type properties to the Image type.

• Add total_size attribute to the Disk type.

• Add support for listing cluster level features, and enabling/disabing them for clusters.

4.2.15 / Aug 16 2017

New features:

• Update @since tags to reflect backport of LLDP to oVirt 4.1.5.

• Add firewalType attribute to the Cluster type.

• Add hasIllegalImages attribute to the Vm type.

Bug fixes:

• Fix live documentation for adding a new cluster.

4.2.14 / Jul 19 2017

New features:

• Add Link Layer Discovery Protocol (LLDP).

• Add a refresh parameter to FilesService.list.

4.2.13 / Jun 28 2017

New features:

• Add volatile parameter to the method that starts a virtual machine.

• Add RefreshLun method to the service that manages a disk. #1404389.

4.2.12 / May 31 2017

New features:

• Fix the documentation of the method that lists events #1447622.

• Fix the direction of the main parameter of the method that adds a CDROM to a virtual machine. It should be input and output.

New features:

• Improve the documentation explaining that in general the order of the results of list methods isn’t guaranteed.

• Add the index attribute to the Event type #1448511.

4.2.11 / May 3 2017

Bug fixes:

• Add the all_content parameter to Host.Get and Hosts.List #1444081.

• Update to metamodel 1.2.6 to handle correctly nested methods in the generated AsciiDoc documentation.

4.2.10 / Apr 19 2017

New features:

• Add readOnly attribute to the DiskAttachment type.

Bug fixes:

• Fix the type of the Host.nics link. It should be of type HostNic[], not Nic[].

4.2.9 / Mar 29 2017

New features:

• Replace generic assigned networks services with services specific to the type of object that they are assigned to, in particular data centers and clusters.

• Add driver attribute to HostDevice type.

• Add specification of input details.

• Add common concepts document.

• Add appendix containing changes from version 3 to version 4 of the API.

Bug fixes:

• Update to metamodel 1.2.5 to handle correctly or and COLLECTION in the specification of input details.

4.2.8 / Mar 14 2017

Bug fixes:

• Add unregistered parameter for the operations to list disks, virtual machines, and templates in storage domains #1428159.

• Rename NetworkFilterParameter service to NicNetworkFilterParameter.

• Fix the direction of the statistic parameter of the Statistic service, must be out only.

4.2.7 / Mar 8 2017

Bug fixes:

• Replace the Seal operation of the service that manages a template with a new seal parameter in the operation that adds a template #1335642.

4.2.6 / Mar 1 2017

New features:

• Add auto_storage_select attribute to the VmPool type.

Bug fixes:

• Move vnic_profile_mappings and reassign_bad_macs from the import operation to the register operation #1425731.

4.2.5 / Feb 22 2017

New features:

• Add all_content parameter to snapshots services.

• Add default_route value to the NetworkUsage enum.

• Add IPv6 details to the NicConfiguration type.

• Add NFS 4.2 support.

4.2.4 / Jan 27 2017

New features:

• Add StorageDomainDisks and AttachedStorageDomainDisks.

• Add operation to register storage domain disk.

4.2.3 / Jan 17 2017

New features:

• Add new lease attribute to virtual machines and templates.

4.2.2 / Jan 12 2017

New features:

• Add new NetworkFilterParameter type and related services.

• Add execution_host link to the Step type.

4.2.1 / Jan 4 2017

New features:

• Add initial_size attribute to the Disk type.

4.2.0 / Dec 20 2016

New features:

• Add succeeded parameter to the operation that end an external job.

4.1.24 / Dec 14 2016

New features:

• Added new v4 value to the StorageFormat enum.

4.1.23 / Dec 9 2016

New features:

• Deprecate the xml value of the HostProtocol enum.

• Add the new AffinityRule type, together with the vms_rule and hosts_rule attributes of the existing AffinityGroup type. This replaces the now deprecated positive and enforcing attributes of the AffinityGroup type.

• Add new reduceluns operation to the service that manages a storage domain.

Bug fixes:

• Revert the addition of the progress attribute to the Disk type.

• Fix the main parameter of the operation to update disks so that it is both in and out.

4.1.22 / Nov 30 2016

New features:

• Add qcow_version attribute to the Disk type.

• Add update operation to the service that manages a specific disk, with support for updating the QCOW version of the disk.

• Add discard_after_delete attribute to the StorageDomain type.

4.1.21 / Nov 23 2016

New features:

• Add seal operation to the service that manages templates.

• Add progress attribute to the Disk and Step types.

• Add allow_partial_import parameter to the operations that import virtual machines and templates.

• Add ticket operation to the service that manages the graphics console of a virtual machine.

4.1.20 / Nov 17 2016

New features:

• Deprecate the legacy USB type.

• Add remoteviewerconnectionfile action to the GraphicsConsole service.

• Add max attribute to the MemoryPolicy type.

4.1.19 / Nov 10 2016

Bug fixes:

• Disable generation of Javadoc, as we already generate a documentation artifact containg the generated AsciiDoc and HTML.

4.1.18 / Nov 10 2016

New features:

• Add gluster_tuned_profile to the Cluster type.

• Add skip_if_gluster_bricks_up and skip_if_gluster_quorum_not_met attributes to the FencingPolicy type.

• Add the ImageTransferDirection enumerated type and the direction attribute to the ImageTransfer type.

Bug fixes:

• Replace the generic GraphicsConsole and GraphicsConsoles with specific services for virtual machines, templates and instance types.

4.1.17 / Nov 2 2016

New features:

• Added urandom to the RngSource enumerated type.

• Added migratable flag to the VnicProfile type.

4.1.16 / Oct 27 2016

New features:

• Make Ip.version optional.

• Add the active_slave link to the Bonding type.

• Add DNS configuration support to Network and NetworkAttachment.

• Add remote_viewer_connection_file attribute to the GraphicsConsole type, and the populate_remote_viewer_connection_file parameter to the operations that retrive the representation ov graphics consoles.

• Add the uses_scsi_reservation attribute to the DiskAttachment type.

4.1.15 / Oct 18 2016

Bug fixes:

• Add missing template and storage_domain parameters to the operation that imports an image.

• Add the next_run parameter to the operation that updates a virtual machine.

• Add the all_content parameters to the operations that list and retrieve virtual machines.

4.1.14 / Oct 5 2016

New features:

• Add gluster value to the NetworkUsage enum.

• Add force parameter to the operation that updates a storage server connection.

• Add supportsDiscard and supportsDiscardZeroesData attributes to the StorageDomain type.

• Add VnicProfileMapping type.

• Add vnicProfileMappings and reassignBadMacs parameters to the operation that imports a storage domain.

Bug fixes:

• Move the quota link from the Vm type to the VmBase type.

4.1.13 / Sep 22 2016

New features:

• Add the sparsify method to DiskService.

• Add the discardMaxSize and discardZeroesData to the LogicalUnit type.

Bug fixes:

• Fix the type of the ticket parameter of the VmService.ticket method.

• Fix the type of the authentication_method attribute of the Ssh type.

• Rename the AuthenticationMethod enum type to SshAuthenticationMethod.

• Fix the name of the exclusive parameter o the TemplateService.export method.

• Add the missing cluster parameter to the OpenstackImageService.import method.

4.1.12 / Sep 6 2016

New features:

• Add services to support disk attachments of virtual machines available for import from storage domains.

4.1.11 / Aug 31 2016

New features:

• Add the custom_scheduling_policy_properties attribute to the Cluster type.

• Add services and types to support transfer of images.

Bug fixes:

• Remove the add and remove operations of virtual machine CDROMs.

• Fix the type of the usages attribute of the Network type, it should be a list of values of the NetworkUsage enum, not a list of strings.

4.1.10 / Aug 18 2016

Bug fixes:

• Add the missing @Out annotation to the primary parameter of the service that imports virtual machines from external systems.

4.1.9 / Aug 18 2016

New features:

• Add the clone_permissions parameter to the operations that add virtual machines and templates.

• Add the clone parameter to the operation that adds a new virtual machine.

• Add the ad_partner_mac attribute to the bonding type.

• Add the ad_aggregator_id attribute to the host NIC type.

• Add the upgradecheck action to the host service.

• Add the ExternalVmImportsService and related types.

Bug fixes:

• Add the active property back to the disk type.

4.1.8 / Aug 2 2016

Bug fixes:

• Remove the active property from Disk.

4.1.7 / Jul 28 2016

Bug fixes:

• Add logicalName attribute to the disk attachment type.

• Fix the name of the parameter to get virtual machine from affinity label, should be vm instead of host.

4.1.6 / Jul 15 2016

New features:

• Add the originalTemplate link to the virtual machine type.

• Add permits to the cluster level type.

Bug fixes:

• Add the current parameter to the virtual machine graphics consoles service.

• Fix the name of the output parameter of the method to list affinity groups, should be groups instead of list.

4.1.5 / Jul 7 2016

New features:

• Add the active flag to DiskAttachment type.

• Add the template disk attachments services and types, replacing the disks collection.

Bug fixes:

• Add the from parameter of the events service.

4.1.4 / Jul 4 2016

New features:

• Removed the disks locator from the virtual machine service, as it has been replaced by diskAttachments.

4.1.3 / Jun 30 2016

Bug fixes:

• Added missing links to all types.

4.1.2 / Jun 28 2016

New features:

• Added switchType attribute to Host type.

4.1.1 / Jun 24 2016

New features:

• Add collapseSnapshots parameter to the operation that imports a virtual machine from an export storage domain.

• Add passDiscard attribute to the DiskAttachment type.

• Add reportedKernelCmdline and customKernelCmdLine attributes to the OperatingSystem type.

• Add the host, destroy and format parameters to the operation that removes a storage domain.

4.1.0 / Jun 21 2016

New features:

• Add Update method to the DiskAttachment service.

• Add types and services for cluster levels support.

4.0.22 / Jun 14 2016

Buf fixes:

• Restore the macPool attribute of the DataCenter type.

4.0.21 / Jun 10 2016

New features:

• Add stateful attribute to the VmPool type.

4.0.20 / Jun 1 2016

New features:

• Remove the macPool from the DataCenter type.

• Add types and services for affinity labels.

• Add parameters for deploy and undeploy of hosted engine during host installation.

• Use the @Area annotation to assign areas to services.

4.0.19 / May 18 2016

Bug fixes:

• Added vm link to the DiskAttachment type.

Other changes:

• Renamed the Label type and services to NetworkLabel.

4.0.18 / May 17 2016

New features:

• Add new DiskAttachment type and services, intended to manage the set of disks attached to a virtual machine. Eventually this will replace the existing /vms/{vm:id}/disks sub-collection.

• Add locator for the networks filter service to the VNIC profile service.

4.0.17 / May 13 2016

New features:

• Renamed SELinuxMode to SeLinuxMode.

• Removed the Status type and replaced with the corresponding enum types.

• Add new MigrationBandwidth and MigrationBandwidthAssignmentMethod types, as well as a new bandwidth attribute to the existing MigrationOptions type.

4.0.16 / May 4 2016

New features:

• Add new OVIRT_NODE value for the Next Generation Node to the HostType enum type.

4.0.15 / Apr 28 2016

New features:

• Add new MigrationPolicy type, and new policy attribute to the existing MigrationOptions type.

• Add new OpenStackNetworkProviderType enum type, and new type attribute to the existing OpenStackNetworkProvider type.

Bug fixes:

• Fix the name of the parameter of the operation to list storage domains, should be storageDomains, in plural.

4.0.14 / Apr 19 2016

New features:

• Add reportStatus parameter to the operations that list and get host storage details.

Removed features:

• Removed the liveSnapshotSupported attribute of host.

4.0.13 / Apr 13 2016

New features:

• Add customCompatibilityVersion to VmBase.

• Add instance type to pool creation.

• Add HostType enum.

4.0.12 / Apr 6 2016

New features:

• Add operation to update OVF store to the storage domains service.

• Add IPv6 fields to host NIC.

4.0.11 / Mar 29 2016

New features:

• Use type safe enums for IP version and boot protocol.

• Add AUTOCONF to the list of boot protocols.

Removed features:

• Removed the 3.0 API for moving a VM between storage domains.

4.0.10 / Mar 21 2016

New features:

• Add support for importing external network.

Bug fixes:

• Fix use of wrong enums.

4.0.9 / Mar 11 2016

Bug fixes:

• Fix the name of the openstackImageProviders service locator.

4.0.8 / Mar 8 2016

Removed features:

• Removed the 3.0 API for managing host network interfaces and the old SetupNetworks operation.

Bug fixes:

• Fix the name of the watchdogs parameter.

• Add the max parameter to the List operation of the service that manages virtual machines.

4.0.7 / Feb 29 2016

New features:

• Added Api and related types.

4.0.6 / Feb 24 2016

New features:

• Generate HTML documentation of the module during the build, using the document profile.

• Added support for network filters.

• Added the stop_gluster_service parameter to the operation that deactivates a host.

4.0.5 / Feb 10 2016

New features:

• Moved the documentation to AsciiDoc format.

• Added a new document Maven profile that generates the AsciiDoc and HTML documentation.

4.0.4 / Feb 2 2016

Bug fixes:

• Fix the name of the IcsiDetails.diskId attribute, it should be diskId, not diskIo.

• Fix the type of the Group.roles attribute, it should be a list of roles instead of a single role.

• Fix the type of the Host.hooks attribute, it should be a list of hooks instead of a single hook.

4.0.3 / Jan 22 2016

Bug fixes:

• Fixed the name of the comment attribute.

4.0.2 / Jan 14 2016

New features:

• Added macPool attribute to cluster.

4.0.1 / Jan 7 2016

Bug fixes:

• Fix virtual NUMA node locator name, should be numaNodes instead of virtualNumaNodes.

New features:

• Renamed SystemKatello to EngineKatello.

• Added the filter parameter to relevant services.

• Added the caseSensitive parameter to relevant services.

• Added the search parameter to relevant services.

4.0.0 / Dec 18 2015

Initial release.