Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data

Interface VpnInstanceOpDataEntry

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

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

     list vpn-instance-op-data-entry {
   key vrf-id;
   leaf vpn-id {
     type uint32;
   }
   leaf vrf-id {
     type string;
   }
   leaf vpn-instance-name {
     type string;
   }
   leaf vpn-interface-count {
     type uint32;
   }
   uses vpn-route-list;
   list vpn-to-dpn-list {
     key dpnId;
     leaf dpnId {
       type uint64;
     }
     list vpn-interfaces {
       key interface-name;
       leaf interface-name {
         type string;
       }
     }
     list ip-addresses {
       key ip-address;
       leaf ip-address {
         type string;
       }
       leaf ip-address-source {
         type enumeration {
           enum ExternalFixedIP;
           enum FloatingIP;
         }
       }
     }
     leaf dpn-state {
       type enumeration {
         enum active {
           value 0;
         }
         enum inactive {
           value 1;
         }
       }
       default active;
     }
   }
   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 bgpvpn-type {
     type enumeration {
       enum InternetBGPVPN {
         value 0;
       }
       enum BGPVPN {
         value 1;
       }
       enum InternalVPN {
         value 2;
       }
     }
   }
   leaf type {
     type enumeration {
       enum l3 {
         value 0;
       }
       enum l2 {
         value 1;
       }
     }
     default l3;
   }
   leaf l3vni {
     type uint32;
   }
   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 vpn-state {
     type enumeration {
       enum created {
         value 0;
       }
       enum pending_delete {
         value 3;
       }
     }
     default created;
   }
   leaf-list rd {
     type string;
   }
 }
    The schema path to identify an instance is odl-l3vpn/vpn-instance-op-data/vpn-instance-op-data-entry

    To create instances of this class use VpnInstanceOpDataEntryBuilder.

    See Also:
    VpnInstanceOpDataEntryBuilder, VpnInstanceOpDataEntryKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

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

      • bindingHashCode

        static int bindingHashCode​(@NonNull VpnInstanceOpDataEntry 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 VpnInstanceOpDataEntry 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 VpnInstanceOpDataEntry 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

      • getVpnId

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

      • getVrfId

        java.lang.String getVrfId()
        Return vrfId, or null if it is not present. 
             
         The vrf-id command configures a route distinguisher (RD) for the IPv4 or IPv6
         address family of a VPN instance or vpn instance name for internal vpn case.
        Returns:
        java.lang.String vrfId, or null if it is not present.

      • getVpnInstanceName

        java.lang.String getVpnInstanceName()
        Return vpnInstanceName, or null if it is not present. 
             
         Typical the VPN Uuid
        Returns:
        java.lang.String vpnInstanceName, or null if it is not present.

      • getVpnInterfaceCount

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

      • getVpnToDpnList

        @Nullable java.util.Map<VpnToDpnListKey,​VpnToDpnList> getVpnToDpnList()
        Return vpnToDpnList, or null if it is not present.
        Returns:
        java.util.Map vpnToDpnList, or null if it is not present.

      • nonnullVpnToDpnList

        default @NonNull java.util.Map<VpnToDpnListKey,​VpnToDpnList> nonnullVpnToDpnList()
        Return vpnToDpnList, or an empty list if it is not present.
        Returns:
        java.util.Map vpnToDpnList, or an empty list if it is not present.

      • getIpAddressFamilyConfigured

        VpnInstanceOpDataEntry.IpAddressFamilyConfigured getIpAddressFamilyConfigured()
        Return ipAddressFamilyConfigured, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry.IpAddressFamilyConfigured ipAddressFamilyConfigured, or null if it is not present.

      • getBgpvpnType

        VpnInstanceOpDataEntry.BgpvpnType getBgpvpnType()
        Return bgpvpnType, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry.BgpvpnType bgpvpnType, or null if it is not present.

      • getType

        VpnInstanceOpDataEntry.Type getType()
        Return type, or null if it is not present. 
             
         The type of the VPN Instance. L3 indicates it is an L3VPN. L2 indicates it is an
         EVPN
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry.Type type, 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.

      • 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.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.VpnTargets vpnTargets, or null if it is not present.

      • getVpnState

        VpnInstanceOpDataEntry.VpnState getVpnState()
        Return vpnState, or null if it is not present. 
             
         Represents a stage in this VpnInstance's lifecycle.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.VpnInstanceOpDataEntry.VpnState vpnState, or null if it is not present.

      • getRd

        @Nullable java.util.List<java.lang.String> getRd()
        Return rd, or null if it is not present.
        Returns:
        java.util.List rd, or null if it is not present.