Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances

Interface VpnInstance

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<VpnInstance>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<VpnInstances>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInstanceKey>
    @Generated("mdsal-binding-generator")
public interface VpnInstance
extends org.opendaylight.yangtools.yang.binding.ChildOf<VpnInstances>, org.opendaylight.yangtools.yang.binding.Augmentable<VpnInstance>, org.opendaylight.yangtools.yang.binding.Identifiable<VpnInstanceKey>

    This class represents the following YANG schema fragment defined in module l3vpn-instances-interfaces 

     list vpn-instance {
   key vpn-instance-name;
   leaf vpn-instance-name {
     type string;
   }
   leaf-list route-distinguisher {
     type string {
       length 3..21;
     }
   }
   container vpnTargets {
     list vpnTarget {
       key vrfRTValue;
       leaf vrfRTValue {
         type string {
           length 3..21;
         }
       }
       leaf vrfRTType {
         type enumeration {
           enum export_extcommunity {
             value 0;
           }
           enum import_extcommunity {
             value 1;
           }
           enum both {
             value 2;
           }
         }
       }
     }
   }
   leaf l2vpn {
     type boolean;
     default false;
   }
   leaf bgpvpn-type {
     type enumeration {
       enum InternetBGPVPN {
         value 0;
       }
       enum BGPVPN {
         value 1;
       }
       enum InternalVPN {
         value 2;
       }
     }
     default BGPVPN;
   }
   leaf ip-address-family-configured {
     type enumeration {
       enum undefined {
         value 0;
       }
       enum ipv4 {
         value 4;
       }
       enum ipv6 {
         value 6;
       }
       enum ipv4-and-ipv6 {
         value 10;
       }
     }
     default undefined;
   }
   leaf l3vni {
     type uint32;
   }
 }
    The schema path to identify an instance is l3vpn-instances-interfaces/vpn-instances/vpn-instance

    To create instances of this class use VpnInstanceBuilder.

    See Also:
    VpnInstanceBuilder, VpnInstanceKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

        default java.lang.Class<VpnInstance> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull VpnInstance obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull VpnInstance thisObj,
                             java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null

      • bindingToString

        static java.lang.String bindingToString​(@NonNull VpnInstance obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null

      • getVpnInstanceName

        java.lang.String getVpnInstanceName()
        Return vpnInstanceName, or null if it is not present. 
             
         The name of the vpn-instance.
        Returns:
        java.lang.String vpnInstanceName, or null if it is not present.

      • getRouteDistinguisher

        @Nullable java.util.List<java.lang.String> getRouteDistinguisher()
        Return routeDistinguisher, or null if it is not present. 
             
         A set of configuration parameters that is applicable to both IPv4 and IPv6
         address family for a VPN instance. Format is ASN:nn or IP-address:nn.
        Returns:
        java.util.List routeDistinguisher, or null if it is not present.

      • getVpnTargets

        VpnTargets getVpnTargets()
        Return vpnTargets, or null if it is not present. 
             
         The vpn-target command configures the export or import VPN target extended
         community attribute for the VPN instance IPv4/IPv6 address family. Format is
         ASN:nn or IP-address:nn.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.VpnTargets vpnTargets, or null if it is not present.

      • getL2vpn

        java.lang.Boolean getL2vpn()
        Return l2vpn, or null if it is not present. 
             
         The type of the VPN Instance. false indicates it is an L3VPN. true indicates it
         is an EVPN
        Returns:
        java.lang.Boolean l2vpn, or null if it is not present.

      • isL2vpn

        @Deprecated(forRemoval=true)
default java.lang.Boolean isL2vpn()
        Deprecated, for removal: This API element is subject to removal in a future version.

      • getBgpvpnType

        VpnInstance.BgpvpnType getBgpvpnType()
        Return bgpvpnType, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance.BgpvpnType bgpvpnType, or null if it is not present.

      • getIpAddressFamilyConfigured

        VpnInstance.IpAddressFamilyConfigured getIpAddressFamilyConfigured()
        Return ipAddressFamilyConfigured, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance.IpAddressFamilyConfigured ipAddressFamilyConfigured, or null if it is not present.

      • getL3vni

        org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
        Return l3vni, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 l3vni, or null if it is not present.