types.VmBase Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of model Show documentation
Model management tools for the oVirt Engine API.
There is a newer version: 4.6.0
/*
Copyright (c) 2015-2016 Red Hat, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package types;

import org.ovirt.api.metamodel.annotations.Link;
import org.ovirt.api.metamodel.annotations.Type;

import java.util.Date;

@Type
public interface VmBase extends Identified {
    VmType type();

    /**
     * The virtual machine's memory, in bytes.
     *
     * For example, in order to update a virtual machine to contain 1 GiB of memory send a request like this:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/vms/123
     * ----
     *
     * With a request body like this:
     *
     * [source,xml]
     * ----
     * 
     *   1073741824
     * 
     * ----
     *
     * NOTE: Memory in the previous example is converted to bytes using the following formula: +
     * 1 GiB = 2^30^ bytes = 1073741824 bytes.
     *
     * NOTE: Memory hot plug is supported from oVirt 3.6 onwards.
     * You can use the example above to increase memory while the virtual machine is running.
     *
     * @author Yanir Quinn 
     * @date 14 Sep 2016
     * @status added
     */
    Integer memory();

    /**
     * The configuration of the CPU of the virtual machine.
     *
     * The sockets configuration can be updated without rebooting the virtual machine. The cores and the threads require
     * a reboot in order to take place.
     *
     * For example, to change the number of sockets to 4 immediately and the number of cores and threads to 2 after
     * reboot send a request:
     *
     * [source]
     * ----
     * PUT /ovirt-engine/api/vms/123
     * ----
     *
     * With a request body:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     
     *       4
     *       2
     *       2
     *     
     *   
     * 
     * ----
     *
     * @author Jenny Tokar 
     * @date 14 Sep 2016
     * @status added
     */
    Cpu cpu();
    Integer cpuShares();
    Bios bios();
    OperatingSystem os();
    Date creationTime();
    String origin();
    Boolean stateless();
    Boolean deleteProtected();
    HighAvailability highAvailability();
    Display display();
    Sso sso();
    RngDevice rngDevice();
    Console console();
    Domain domain();
    Usb usb();
    Boolean soundcardEnabled();
    Boolean tunnelMigration();
    Integer migrationDowntime();
    VirtioScsi virtioScsi();
    SerialNumber serialNumber();
    Boolean startPaused();
    MigrationOptions migration();
    Io io();
    CustomProperty[] customProperties();
    String customEmulatedMachine();
    String customCpuModel();
    TimeZone timeZone();
    Icon smallIcon();
    Icon largeIcon();
    Initialization initialization();
    MemoryPolicy memoryPolicy();

    /**
     * Virtual machine custom compatibility version.
     *
     * This field allows to customize a virtual machine to its own compatibility version.  If
     * `custom_compatibility_version` is set, it overrides the cluster's compatibility version
     * for this particular virtual machine.
     *
     * The compatibility version of a virtual machine is limited by the data center the virtual
     * machine resides in and is checked against capabilities of the host the virtual machine is
     * planned to run on.
     */
    Version customCompatibilityVersion();

    @Link Cluster cluster();
    @Link StorageDomain storageDomain();
    @Link CpuProfile cpuProfile();
    @Link Quota quota();
}