Interface Prefix

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Prefixes>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixKey>

    public interface Prefix
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Prefixes>, org.opendaylight.yangtools.yang.binding.Augmentable<Prefix>, org.opendaylight.yangtools.yang.binding.Identifiable<PrefixKey>
    A prefix is a rule with a BGP filter. The left hand side of the rule is the prefix filter. It specifies a set of IP addresses. If a BGP announcement contains an address that matches, the rule is applied. The right hand side of the rule specifies the action that is to be applied.

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

     list prefix {
       key seq-nr;
       leaf seq-nr {
         type uint16;
       }
       container prefix-filter {
         choice ip-address-group {
           case ip-address {
             leaf ip-address {
               type inet:ip-address;
             }
           }
           case prefix {
             leaf prefix {
               type inet:ip-prefix;
             }
           }
           case host {
             leaf ip-host-address {
               type inet:host;
             }
           }
           case ip-range {
             leaf lower {
               type inet:ip-address;
             }
             leaf upper {
               type inet:ip-address;
             }
           }
         }
         leaf action {
           type actions-enum;
         }
         container statistics {
           leaf prefix-hit-count {
             type uint32;
             config false;
           }
         }
       }
     }
     
    The schema path to identify an instance is bgp/prefix-lists/prefix-list/prefixes/prefix

    To create instances of this class use PrefixBuilder.

    See Also:
    PrefixBuilder, PrefixKey
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getSeqNr()
        Sequence number of the rule. The sequence number is included for compatibility purposes with CLI; from a machine-to-machine interface perspective, it would strictly speaking not be required as list elements can be arranged in a particular order.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 seqNr, or null if not present
      • getPrefixFilter

        @Nullable PrefixFilter getPrefixFilter()
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists.prefix.list.prefixes.prefix.PrefixFilter prefixFilter, or null if not present
      • key

        PrefixKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<PrefixKey>