services.FenceAgentsService 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.mandatory;
import static org.ovirt.api.metamodel.language.ApiLanguage.optional;

/**
 * A service to manage fence agents for a specific host.
 *
 * @author Piotr Kliczewski 
 * @date 24 Apr 2017
 * @status added
 */
@Service
@Area("Infrastructure")
public interface FenceAgentsService {
    /**
     * Add a new fencing-agent to the host.
     *
     * [source]
     *
     * ----
     * POST /ovirt-engine/api/hosts/123/fenceagents
     *
     * You should consult the /usr/sbin/fence_ manual page for
     * the legal parameters to [name1=value1, name2=value2,...] in the options field.
     * If any parameter in options appears by name that means that it is mandatory.
     * For example in slot=7[,name1=value1, name2=value2,...]
     * slot is mandatory.
     * ----
     *
     * apc, bladecenter, wti fencing agent/s sample request:
     *
     * [source,xml]
     *
     *   
     *     apc
     *     1
     *     192.168.1.101
     *     user
     *     xxx
     *     9
     *     slot=7[,name1=value1, name2=value2,...]
     *   
     *
     * apc_snmp, hpblade, ilo, ilo2, ilo_ssh, redfish, rsa fencing agent/s sample request:
     *
     * [source,xml]
     *
     *   
     *     apc_snmp
     *     1
     *     192.168.1.101
     *     user
     *     xxx
     *     9
     *     [name1=value1, name2=value2,...]
     *   
     *
     *
     * cisco_ucs, drac5, eps fencing agent/s sample request:
     *
     * [source,xml]
     *
     *   
     *     cisco_ucs
     *     1
     *     192.168.1.101
     *     user
     *     xxx
     *     slot=7[,name1=value1, name2=value2,...]
     *   
     *
     * drac7, ilo3, ilo4, ipmilan, rsb fencing agent/s sample request:
     *
     * [source,xml]
     *
     *   
     *     drac7
     *     1
     *     192.168.1.101
     *     user
     *     xxx
     *     [name1=value1, name2=value2,...]
     *   
     * @author Ori Liel 
     * @author Eli Mesika 
     * @date 26 Nov 2019
     * @status added
     */
    interface Add {
        @InputDetail
        default void inputDetail() {
            mandatory(agent().address());
            mandatory(agent().order());
            mandatory(agent().password());
            mandatory(agent().type());
            mandatory(agent().username());
            optional(agent().port());
            optional(agent().encryptOptions());
            optional(agent().name());
        }
        @In @Out Agent agent();
    }

    /**
     * Returns the list of fencing agents configured for the host.
     *
     * [source]
     * ----
     * GET /ovirt-engine/api/hosts/123/fenceagents
     * ----
     *
     * And here is sample response:
     *
     * [source,xml]
     * ----
     * 
     *   
     *     apc
     *     1
     *     192.168.1.101
     *     user
     *     xxx
     *     9
     *     name1=value1, name2=value2
     *   
     * 
     * ----
     *
     * The order of the returned list of fencing agents isn't guaranteed.
     *
     * @author Piotr Kliczewski 
     * @author Juan Hernandez 
     * @date 24 Apr 2017
     * @status added
     */
    interface List extends Follow {

        /**
         * List of fence agent details.
         *
         * @author Piotr Kliczewski 
         * @date 24 Apr 2017
         * @status added
         */
        @Out Agent[] agents();

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

    /**
     * Reference to service that manages a specific fence agent
     * for this host.
     *
     * @author Piotr Kliczewski 
     * @date 24 Apr 2017
     * @status added
     */
    @Service FenceAgentService agent(String id);
}