Interface VpnInstance

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    L3vpn, L3vpnInstances

    @Generated("mdsal-binding-generator")
    public interface VpnInstance
    extends org.opendaylight.yangtools.yang.binding.DataObject

    This class represents the following YANG schema fragment defined in module neutronvpn

     grouping vpn-instance {
       leaf id {
         type yang:uuid;
       }
       leaf name {
         type string;
       }
       leaf tenant-id {
         type yang:uuid;
       }
       leaf-list route-distinguisher {
         type string;
       }
       leaf-list import-RT {
         type string;
       }
       leaf-list export-RT {
         type string;
       }
       list router-ids {
         key router-id;
         leaf router-id {
           type yang:uuid;
         }
       }
       leaf-list network-ids {
         type yang:uuid;
       }
       leaf l3vni {
         type uint32;
       }
     }
     
    The schema path to identify an instance is neutronvpn/vpn-instance
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      @Nullable java.util.List<java.lang.String> getExportRT()
      Return exportRT, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()
      Return id, or null if it is not present.
      @Nullable java.util.List<java.lang.String> getImportRT()
      Return importRT, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getL3vni()
      Return l3vni, or null if it is not present.
      java.lang.String getName()
      Return name, or null if it is not present.
      @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()
      Return networkIds, or null if it is not present.
      @Nullable java.util.List<java.lang.String> getRouteDistinguisher()
      Return routeDistinguisher, or null if it is not present.
      @Nullable java.util.Map<RouterIdsKey,​RouterIds> getRouterIds()
      Return routerIds, or null if it is not present.
      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
      Return tenantId, or null if it is not present.
      java.lang.Class<? extends VpnInstance> implementedInterface()  
      default @NonNull java.util.Map<RouterIdsKey,​RouterIds> nonnullRouterIds()
      Return routerIds, or an empty list if it is not present.
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getId()
        Return id, or null if it is not present.
             
                 vpn-id
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid id, or null if it is not present.
      • getName

        java.lang.String getName()
        Return name, or null if it is not present.
             
                 VPN name
             
         
        Returns:
        java.lang.String name, or null if it is not present.
      • getTenantId

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getTenantId()
        Return tenantId, or null if it is not present.
             
                 The UUID of the tenant that will own the subnet.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid tenantId, 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.
             
                 configures a route distinguisher (RD) for the VPN instance. Format is ASN:nn or
                 IP-address:nn.
             
         
        Returns:
        java.util.List routeDistinguisher, or null if it is not present.
      • getImportRT

        @Nullable java.util.List<java.lang.String> getImportRT()
        Return importRT, or null if it is not present.
             
                 configures a list of import route target. Format is ASN:nn or IP-address:nn.
             
         
        Returns:
        java.util.List importRT, or null if it is not present.
      • getExportRT

        @Nullable java.util.List<java.lang.String> getExportRT()
        Return exportRT, or null if it is not present.
             
                 configures a list of export route targets. Format is ASN:nn or IP-address:nn.
             
         
        Returns:
        java.util.List exportRT, or null if it is not present.
      • getRouterIds

        @Nullable java.util.Map<RouterIdsKey,​RouterIds> getRouterIds()
        Return routerIds, or null if it is not present.
        Returns:
        java.util.Map routerIds, or null if it is not present.
      • nonnullRouterIds

        default @NonNull java.util.Map<RouterIdsKey,​RouterIds> nonnullRouterIds()
        Return routerIds, or an empty list if it is not present.
        Returns:
        java.util.Map routerIds, or an empty list if it is not present.
      • getNetworkIds

        @Nullable java.util.List<org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid> getNetworkIds()
        Return networkIds, or null if it is not present.
             
                 UUID representing the network 
             
         
        Returns:
        java.util.List networkIds, 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.