services.FenceAgentService 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.InputDetail;
import org.ovirt.api.metamodel.annotations.Out;
import org.ovirt.api.metamodel.annotations.Service;
import types.Agent;

import static org.ovirt.api.metamodel.language.ApiLanguage.optional;

/**
 * A service to manage fence agent for a specific host.
 *
 * @author Piotr Kliczewski 
 * @date 24 Apr 2017
 * @status added
 *
 */
@Service
@Area("Infrastructure")
public interface FenceAgentService {

    /**
     * Gets details of this fence agent.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/hosts/123/fenceagents/0
     * ----
     *
     * And here is sample response:
     *
     * [source,xml]
     * ----
     * 
     *   apc
     *   1
     *   192.168.1.101
     *   user
     *   xxx
     *   9
     *   name1=value1, name2=value2
     * 
     * ----
     *
     * @author Piotr Kliczewski 
     * @date 24 Apr 2017
     * @status added
     *
     */
    interface Get extends Follow {

        /**
         * Fence agent details.
         *
         * @author Piotr Kliczewski 
         * @date 24 Apr 2017
         * @status added
         */
        @Out Agent agent();
    }

    /**
     * Update a fencing-agent.
     *
     * @author Ori Liel 
     * @date 18 Jan 2017
     * @status added
     */
    interface Update {
        @InputDetail
        default void inputDetail() {
            optional(agent().address());
            optional(agent().order());
            optional(agent().password());
            optional(agent().port());
            optional(agent().type());
            optional(agent().username());
            optional(agent().encryptOptions());
            optional(agent().name());
        }

        /**
         * Fence agent details.
         *
         * @author Piotr Kliczewski 
         * @date 24 Apr 2017
         * @status added
         */
        @In @Out Agent agent();

        /**
         * Indicates if the update should be performed asynchronously.
         */
        @In Boolean async();
    }

    /**
     * Removes a fence agent for a specific host.
     *
     * [source]
     * ----
     * DELETE /ovirt-engine/api/hosts/123/fenceagents/0
     * ----
     *
     * @author Piotr Kliczewski 
     * @date 24 Apr 2017
     * @status added
     */
    interface Remove {
        /**
         * Indicates if the remove should be performed asynchronously.
         */
        @In Boolean async();
    }
}