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>

    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>
    Specifies the name of the VPN instance. It is a string of 1 to 31 characters.

    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 type {
         type enumeration {
           enum l3 {
             value 0;
           }
           enum l2 {
             value 1;
           }
         }
         default l3;
       }
       leaf l3vni {
         type uint32;
       }
       leaf description {
         type string {
           length 1..242;
           pattern ([^?]*);
         }
       }
       container ipv4-family {
         uses vpn-af-config;
       }
       container ipv6-family {
         uses vpn-af-config;
       }
     }
     
    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
      • getVpnInstanceName

        @Nullable java.lang.String getVpnInstanceName()
        The name of the vpn-instance.
        Returns:
        java.lang.String vpnInstanceName, or null if not present
      • getType

        @Nullable VpnInstance.Type getType()
        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.neutronvpn.l3vpn.rev200204.vpn.instances.VpnInstance.Type type, or null if not present
      • getL3vni

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 l3vni, or null if not present
      • getDescription

        @Nullable java.lang.String getDescription()
        A textual description of VPN instance, the VPN instance description helps users memorize the VPN instance.
        Returns:
        java.lang.String description, or null if not present
      • getIpv4Family

        @Nullable Ipv4Family getIpv4Family()
        The IPv4 address family is enabled for the VPN instance.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.Ipv4Family ipv4Family, or null if not present
      • getIpv6Family

        @Nullable Ipv6Family getIpv6Family()
        The IPv6 address family is enabled for the VPN instance.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.l3vpn.rev200204.vpn.instances.vpn.instance.Ipv6Family ipv6Family, or null if not present