types.VnicProfile 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 types;

import org.ovirt.api.metamodel.annotations.Link;
import org.ovirt.api.metamodel.annotations.Type;

/**
 * A vNIC profile is a collection of settings that can be applied to individual <>.
 *
 * @author Dominik Holler 
 * @author Megan Lewis 
 * @date 17 Jan 2017
 * @status updated_by_docs
 */
@Type
public interface VnicProfile extends Identified {

    /**
     * Enables port mirroring.
     *
     * Port mirroring copies layer 3 network traffic on a given <> and
     * <> to a NIC on a <>. This virtual machine
     * can be used for network debugging and tuning, intrusion detection, and monitoring the behavior of other
     * virtual machines on the same host and logical network. The only
     * traffic copied is internal to one logical network on one host. There is no
     * increase in traffic on the network external to the host; however a virtual machine
     * with port mirroring enabled uses more host CPU and RAM than other virtual machines.
     *
     * Port mirroring has the following limitations:
     *
     *  - Hot plugging a NIC with a vNIC profile that has port mirroring enabled is not supported.
     *  - Port mirroring cannot be altered when the vNIC profile is attached to a virtual machine.
     *
     * Given the above limitations, it is recommended that you enable port mirroring on an additional,
     * dedicated vNIC profile.
     *
     * IMPORTANT: Enabling port mirroring reduces the privacy of other network users.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 20 Feb 2017
     * @status updated_by_docs
     */
    Boolean portMirroring();

    /**
     * Custom properties applied to the vNIC profile.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 17 Jan 2017
     * @status updated_by_docs
     */
    CustomProperty[] customProperties();

    /**
     * Enables passthrough to an SR-IOV-enabled <>.
     *
     * A vNIC profile enables a NIC to be directly connected to a
     * <> of an SR-IOV-enabled
     * host NIC, if passthrough is enabled. The NIC will then bypass the software network virtualization and
     * connect directly to the VF for direct device assignment.
     *
     * Passthrough cannot be enabled if the vNIC profile is already attached to a NIC.
     * If a vNIC profile has passthrough enabled, `qos` and `port_mirroring` are disabled for the vNIC profile.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 20 Feb 2017
     * @status updated_by_docs
     */
    VnicPassThrough passThrough();

    /**
     * Marks whether `pass_through` NIC is migratable or not.
     *
     * If `pass_through.mode` is set to `disabled` this option has no meaning, and it will be considered to be `true`.
     * If you omit this option from a request, by default, this will be set to `true`.
     *
     * When migrating a virtual machine, this virtual machine will be migrated only if all `pass_through` NICs are
     * flagged as `migratable`.
     *
     * @author Martin Mucha 
     * @author Megan Lewis 
     * @date 20 Feb 2017
     * @status updated_by_docs
     * @since 4.1
     */
    Boolean migratable();

    /**
     * Reference to the network that the vNIC profile is applied to.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 17 Jan 2017
     * @status updated_by_docs
     */
    @Link Network network();

    /**
     * Reference to the quality of service attributes to apply to the vNIC profile.
     *
     * Quality of Service attributes regulate inbound and outbound network traffic of the
     * NIC.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 17 Jan 2017
     * @status updated_by_docs
     */
    @Link Qos qos();

    /**
     * Reference to the top-level network filter that applies to the NICs that use this profile.
     *
     * Network filters enhance the ability to manage the network packets traffic
     * to and from virtual machines.
     * The network filter may either contain a reference to other filters, rules for traffic
     * filtering, or a combination of both.
     *
     * @author Alona Kaplan 
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 20 Feb 2017
     * @status updated_by_docs
     */
    @Link NetworkFilter networkFilter();

    /**
     * Failover vNIC profile for SR-IOV migration without downtime
     *
     * @author Ales Musil 
     * @date 30 March 2021
     * @since 4.4.6
     * @status new
     */
    @Link VnicProfile failover();

    /**
     * Permissions to allow usage of the vNIC profile.
     *
     * @author Dominik Holler 
     * @author Megan Lewis 
     * @date 17 Jan 2017
     * @status updated_by_docs
     */
    @Link Permission[] permissions();
}