services.externalhostproviders.ExternalDiscoveredHostsService 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.In;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.ExternalDiscoveredHost;

/**
 * This service manages external discovered hosts.
 *
 * @author Yaniv Bronhaim 
 * @date 24 Apr 2017
 * @status added
 */
@Service
@Area("Infrastructure")
public interface ExternalDiscoveredHostsService {
    /**
     * Get list of discovered hosts' information.
     *
     * Discovered hosts are fetched from third-party providers such as Foreman.
     *
     * To list all discovered hosts for provider `123` send the following:
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/externalhostproviders/123/discoveredhost
     * ----
     *
     * [source,xml]
     * ----
     * 
     *  
     *   mac001a4ad04031
     *   10.34.67.42
     *   2017-04-24 11:05:41 UTC
     *   00:1a:4a:d0:40:31
     *   sat0
     *   
     *  
     *  
     *   mac001a4ad04040
     *   10.34.67.43
     *   2017-04-24 11:05:41 UTC
     *   00:1a:4a:d0:40:40
     *   sat0
     *   
     *  
     *  ...
     * 
     * ----
     *
     * The order of the returned list of hosts isn't guaranteed.
     *
     * @author Yaniv Bronhaim 
     * @author Juan Hernandez 
     * @date 24 Apr 2017
     * @status added
     */
    interface List extends Follow {
        /**
         * List of discovered hosts
         */
        @Out ExternalDiscoveredHost[] hosts();

        /**
         * Sets the maximum number of hosts to return. If not specified all the hosts are returned.
         */
        @In Integer max();
    }

    @Service ExternalDiscoveredHostService host(String id);
}