services.ExternalVmImportsService 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) 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 services;

import org.ovirt.api.metamodel.annotations.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;

import annotations.Area;
import types.ExternalVmImport;

/**
 * Provides capability to import external virtual machines.
 *
 * @author Martin Betak 
 * @date 27 Jul 2016
 * @status added
 * @since 4.0.4
 */
@Service
@Area("Virtualization")
public interface ExternalVmImportsService {

    /**
     * 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:
     *
     * [source]
     * ----
     * POST /externalvmimports
     * ----
     *
     * With request body of type <>, for example:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     my_vm
     *   
     *   
     *   
     *   vm_name_as_is_in_vmware
     *   true
     *   vmware_user
     *   123456
     *   VMWARE
     *   vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1
     *   
     * 
     * ----
     *
     * @author Martin Betak 
     * @date 27 Jul 2016
     * @status added
     * @since 4.0
     */
    interface Add {
        @In @Out ExternalVmImport _import();
    }
}