services.externalhostproviders.ExternalDiscoveredHostService 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.externalhostproviders;

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

/**
 * This service manages a single discovered host.
 *
 * @author Yaniv Bronhaim 
 * @date 24 Apr 2017
 * @status added
 */
@Service
@Area("Infrastructure")
public interface ExternalDiscoveredHostService {
    /**
     * 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
     * ....
     *
     * The result will be like this:
     *
     * [source,xml]
     * ----
     * 
     *  mac001a4ad04040
     *  10.34.67.43
     *  2017-04-24 11:05:41 UTC
     *  00:1a:4a:d0:40:40
     *  sat0
     *  
     * 
     * ----
     *
     * @author Yaniv Bronhaim 
     * @date 24 Apr 2017
     * @status added
     */
    interface Get extends Follow {
        /**
         * Host's hardware and config information.
         *
         * @author Yaniv Bronhaim 
         * @date 24 Apr 2017
         * @status added
         */
        @Out ExternalDiscoveredHost host();
    }
}