services.VmHostDeviceService 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 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 services;

import annotations.Area;
import mixins.Follow;
import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.HostDevice;

/**
 * A service to manage individual host device attached to a virtual machine.
 *
 * @author Martin Betak 
 * @date 12 Dec 2016
 * @status added
 */
@Service
@Area("Virtualization")
public interface VmHostDeviceService {

    /**
     * Retrieve information about particular host device attached to given virtual machine.
     *
     * Example:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/vms/123/hostdevices/456
     * ----
     *
     * [source,xml]
     * ----
     * 
     *   pci_0000_04_00_0
     *   pci
     *   30
     *   true
     *   
     *     GM107GL [Quadro K2200]
     *   
     *   
     *     NVIDIA Corporation
     *   
     *   
     *   
     *     pci_0000_00_03_0
     *   
     *   
     * 
     * ----
     *
     * @author Martin Betak 
     * @date 12 Dec 2016
     * @status added
     */
    interface Get extends Follow {
        /**
         * Retrieved information about the host device attached to given virtual machine.
         *
         * @author Martin Betak 
         * @date 12 Dec 2016
         * @status added
         */
        @Out HostDevice device();
    }

    /**
     * Remove the attachment of this host device from given virtual machine.
     *
     * NOTE: 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).
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/vms/123/hostdevices/456
     * ----
     *
     * @author Martin Betak 
     * @date 12 Dec 2016
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }
}