Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105

Interface OvsdbPortInterfaceAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    OvsdbTerminationPointAugmentation
    public interface OvsdbPortInterfaceAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

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

     grouping ovsdb-port-interface-attributes {
   leaf port-uuid {
     type yang:uuid;
   }
   leaf interface-uuid {
     type yang:uuid;
   }
   leaf name {
     type string;
   }
   leaf ifindex {
     type uint32;
     config false;
   }
   leaf mac {
     type yang:mac-address;
   }
   leaf mac-in-use {
     type yang:mac-address;
     config false;
   }
   leaf interface-type {
     type identityref {
       base interface-type-base;
     }
   }
   list options {
     key option;
     leaf option {
       type string;
     }
     leaf value {
       type string;
     }
   }
   leaf ofport {
     type uint32;
   }
   leaf ofport_request {
     type uint16 {
       range 1..65279;
     }
   }
   leaf vlan-tag {
     type ethertype:vlan-id;
   }
   list trunks {
     leaf trunk {
       type ethertype:vlan-id;
     }
   }
   leaf vlan-mode {
     type enumeration {
       enum access {
         value 1;
       }
       enum native-tagged {
         value 2;
       }
       enum native-untagged {
         value 3;
       }
       enum trunk {
         value 4;
       }
     }
   }
   list port-other-configs {
     key other-config-key;
     leaf other-config-key {
       type string;
     }
     leaf other-config-value {
       type string;
     }
   }
   list interface-other-configs {
     key other-config-key;
     leaf other-config-key {
       type string;
     }
     leaf other-config-value {
       type string;
     }
   }
   list port-external-ids {
     key external-id-key;
     leaf external-id-key {
       type string;
     }
     leaf external-id-value {
       type string;
     }
   }
   list interface-external-ids {
     key external-id-key;
     leaf external-id-key {
       type string;
     }
     leaf external-id-value {
       type string;
     }
   }
   list interface-lldp {
     key lldp-key;
     leaf lldp-key {
       type string;
     }
     leaf lldp-value {
       type string;
     }
   }
   list interface-bfd {
     key bfd-key;
     leaf bfd-key {
       type string;
     }
     leaf bfd-value {
       type string;
     }
   }
   list interface-bfd-status {
     key bfd-status-key;
     leaf bfd-status-key {
       type string;
     }
     leaf bfd-status-value {
       type string;
     }
   }
   list qos-entry {
     key qos-key;
     max-elements 1;
     leaf qos-key {
       type uint32 {
         range 1..1;
       }
     }
     leaf qos-ref {
       type ovsdb-qos-ref;
     }
   }
   leaf ingress-policing-rate {
     type uint32;
   }
   leaf ingress-policing-burst {
     type uint32;
   }
 }
    The schema path to identify an instance is ovsdb/ovsdb-port-interface-attributes

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        Class<? extends OvsdbPortInterfaceAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • getPortUuid

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortUuid()
        The unique identifier of the OVSDB port
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid portUuid, or null if not present

      • getInterfaceUuid

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getInterfaceUuid()
        The unique identifier of the OVSDB interface
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid interfaceUuid, or null if not present

      • getName

        @Nullable String getName()
        The name of the OVSDB port/interface
        Returns:
        java.lang.String name, or null if not present

      • getIfindex

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getIfindex()
        The ifindex is useful for seamless integration with protocols such as SNMP and sFlow. It is a positive interface index as defined for SNMP MIB-II in RFCs 1213 and 2863 if the interface has one, otherwise 0. It is a read-only column and an integer in the range 0 to 4,294,967,295
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 ifindex, or null if not present

      • getMac

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMac()
        Ethernet address to use for this interface. If unset, the default is used
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress mac, or null if not present

      • getMacInUse

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacInUse()
        The MAC address in use by this interface
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress macInUse, or null if not present

      • getInterfaceType

        @Nullable Class<? extends InterfaceTypeBase> getInterfaceType()
        The type of the OVSDB interface
        Returns:
        java.lang.Class interfaceType, or null if not present

      • getOptions

        @Nullable List<Options> getOptions()
        Port/Interface related optional input values
        Returns:
        java.util.List options, or null if not present

      • nonnullOptions

        default @NonNull List<Options> nonnullOptions()
        Returns:
        java.util.List options, or an empty list if it is not present

      • getOfport

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getOfport()
        Port/Interface related optional ofport
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 ofport, or null if not present

      • getOfportRequest

        @Nullable org.opendaylight.yangtools.yang.common.Uint16 getOfportRequest()
        Port/Interface related optional ofport_request, in range 1 to 65279
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 ofportRequest, or null if not present

      • getVlanTag

        @Nullable org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanTag()
        The VLAN tag of the termination point.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId vlanTag, or null if not present

      • getTrunks

        @Nullable List<Trunks> getTrunks()
        Represents the trunks of a termination point.
        Returns:
        java.util.List trunks, or null if not present

      • nonnullTrunks

        default @NonNull List<Trunks> nonnullTrunks()
        Returns:
        java.util.List trunks, or an empty list if it is not present

      • getVlanMode

        @Nullable OvsdbPortInterfaceAttributes.VlanMode getVlanMode()
        The VLAN mode of the termination point.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbPortInterfaceAttributes.VlanMode vlanMode, or null if not present

      • getPortOtherConfigs

        @Nullable List<PortOtherConfigs> getPortOtherConfigs()
        Other config attributes for Ports other_config : priority-tags: optional string either true or false An 802.1Q header contains two important pieces of information: a VLAN ID and a priority. other_config : bond-hash-basis: optional string containing an integer An integer hashed along with flows when choosing output slaves in load balanced bonds. When changed, all flows will be assigned different hash values possibly causing slave selection decisions to change. other_config : bond-detect-mode: optional string either miimon or carrier The means used to detect link failures. Defaults to carrier which uses each interface's carrier to detect failures. When set to miimon, will check for failures by polling each interface's MII. other_config : bond-miimon-interval: optional string containing an integer The interval, in milliseconds, between successive attempts to poll each interface's MII. Relevant only when other_config:bond-detect-mode is miimon other_config : lacp-system-id: optional string The LACP system ID of this Port. The system ID of a LACP bond is used to identify itself to its partners. Must be a nonzero MAC address. Defaults to the bridge Ethernet address if unset. other_config : lacp-system-priority: optional string containing an integer, in range 1 to 65,535 The LACP system priority of this Port. In LACP negotiations, link status decisions are made by the system with the numerically lower priority. other_config : lacp-time: optional string either slow or fast. The LACP timing which should be used on this Port. By default slow is used. When configured to be fast LACP heartbeats are requested at a rate of once per second causing connectivity problems to be detected more quickly. In slow mode, heartbeats are requested at a rate of once every 30 seconds. other_config : lacp-fallback-ab: optional string either true or false Determines the behavior of openvswitch bond in LACP mode. If the partner switch does not support LACP, setting this option to true allows openvswitch to fallback to active-backup. If the option is set to false, the bond will be disabled. In both the cases, once the partner switch is configured to LACP mode, the bond will use LACP. other_config : bond-rebalance-interval: optional string, containing an integer, in range 0 to 10,000 For a load balanced bonded port, the number of milliseconds between successive attempts to rebalance the bond, that is, to move flows from one interface on the bond to another in an attempt to keep usage of each interface roughly equal. If zero, load balancing is disabled on the bond (link failure still cause flows to move). If less than 1000ms, the rebalance interval will be 1000ms. other_config : stp-enable: optional string either true or false. If spanning tree is enabled on the bridge, member ports are enabled by default (with the exception of bond, internal, and mirror ports which do not work with STP). If this column's value is false spanning tree is disabled on the port. other_config : stp-port-num: optional string containing an integer, in range 1 to 255 The port number used for the lower 8 bits of the port-id. By default, the numbers will be assigned automatically. If any port's number is manually configured on a bridge, then they must all be. other_config : stp-port-priority: optional string containing an integer, in range 0 to 255 The port's relative priority value for determining the root port (the upper 8 bits of the port-id). other_config : stp-path-cost: optional string containing an integer, in range 0 to 65,535 Spanning tree path cost for the port. A lower number indicates a faster link. By default, the cost is based on the maximum speed of the link. other_config : rstp-enable: optional string either true or false If rapid spanning tree is enabled on the bridge, member ports are enabled by default (with the exception of bond, internal, and mirror ports which do not work with RSTP). If this column's value is false rapid spanning tree is disabled on the port. other_config : rstp-port-priority: optional string containing an integer, in range 0 to 240 The port's relative priority value for determining the root port, in multiples of 16. By default, the port priority is 0x80 (128). other_config : rstp-port-num: optional string containing an integer, in range 1 to 4,095 The local RSTP port number, used as the lower 12 bits of the port-id. other_config : rstp-port-path-cost: optional string containing an integer The port path cost. The Port's contribution, when it is the Root Port, to the Root Path Cost for the Bridge. other_config : rstp-port-admin-edge: optional string either true or false other_config : rstp-port-auto-edge: optional string either true or false The auto edge port parameter for the Port. Default is true. other_config : rstp-port-mcheck: optional string either true or false The mcheck port parameter for the Port. Default is false. other_config : mcast-snooping-flood: optional string either true or false If set to true, multicast packets are unconditionally forwarded to the specific port
        Returns:
        java.util.List portOtherConfigs, or null if not present

      • nonnullPortOtherConfigs

        default @NonNull List<PortOtherConfigs> nonnullPortOtherConfigs()
        Returns:
        java.util.List portOtherConfigs, or an empty list if it is not present

      • getInterfaceOtherConfigs

        @Nullable List<InterfaceOtherConfigs> getInterfaceOtherConfigs()
        Other config attributes for Interfaces other_config : enable-vlan-splinters: optional string either true or false. Set to true to enable VLAN splinters on this interface. Defaults to false.
        Returns:
        java.util.List interfaceOtherConfigs, or null if not present

      • nonnullInterfaceOtherConfigs

        default @NonNull List<InterfaceOtherConfigs> nonnullInterfaceOtherConfigs()
        Returns:
        java.util.List interfaceOtherConfigs, or an empty list if it is not present

      • getPortExternalIds

        @Nullable List<PortExternalIds> getPortExternalIds()
        Port external ids external_ids : fake-bridge-id-*: optional string External IDs for a fake bridge (see the fake_bridge column) are defined by prefixing a Bridge external_ids key with fake-bridge-, e.g. fake-bridge-xs-network-uuids.
        Returns:
        java.util.List portExternalIds, or null if not present

      • nonnullPortExternalIds

        default @NonNull List<PortExternalIds> nonnullPortExternalIds()
        Returns:
        java.util.List portExternalIds, or an empty list if it is not present

      • getInterfaceExternalIds

        @Nullable List<InterfaceExternalIds> getInterfaceExternalIds()
        Interface external ids external_ids : attached-mac: optional string. The MAC address programmed into the ''virtual hardware'' for this interface, in the form xx:xx:xx:xx:xx:xx. For Citrix XenServer, this is the value of the MAC field in the VIF record for this interface. external_ids : iface-id: optional string. A system-unique identifier for the interface. On XenServer, this will commonly be the same as external_ids:xs-vif-uuid. external_ids : iface-status: optional string either active or inactive Hypervisors may sometimes have more than one interface associated with a given external_ids:iface-id, only one of which is actually in use at a given time. external_ids : xs-vif-uuid: optional string. The virtual interface associated with this interface. external_ids : xs-network-uuid: optional string. The virtual network to which this interface is attached. external_ids : vm-id: optional string. The VM to which this interface belongs. On XenServer, this will be the same as external_ids:xsvm-uuid. external_ids : xs-vm-uuid: optional string. The VM to which this interface belongs
        Returns:
        java.util.List interfaceExternalIds, or null if not present

      • nonnullInterfaceExternalIds

        default @NonNull List<InterfaceExternalIds> nonnullInterfaceExternalIds()
        Returns:
        java.util.List interfaceExternalIds, or an empty list if it is not present

      • getInterfaceLldp

        @Nullable List<InterfaceLldp> getInterfaceLldp()
        Auto Attach configuration for a particular interface. If LLDP is enabled on an interface, the interface processes received LLDP packets and never passes them to OpenFlow or forwards them. lldp : enable: optional string, either true or false True to enable LLDP on this Interface. If not specified, LLDP will be disabled by default.
        Returns:
        java.util.List interfaceLldp, or null if not present

      • nonnullInterfaceLldp

        default @NonNull List<InterfaceLldp> nonnullInterfaceLldp()
        Returns:
        java.util.List interfaceLldp, or an empty list if it is not present

      • getInterfaceBfd

        @Nullable List<InterfaceBfd> getInterfaceBfd()
        BFD configuration for a particular interface. BFD, defined in RFC 5880 and RFC 5881, allows point-to-point detection of connectivity failures by occasional transmission of BFD control messages. bfd : enable: optional string, either true or false True to enable BFD on this Interface. If not specified, BFD will be disabled by default. bfd : min_rx: optional string containing an integer, at least 1. The shortest interval, in milliseconds, at which this BFD session offers to receive BFD control messages. The remote endpoint may choose to send messages at a slower rate. Defaults to 1000. bfd : min_tx: optional string containing an integer, at least 1. The shortest interval, in milliseconds, at which this BFD session is willing to transmit BFD control messages. Messages will actually be transmitted at a slower rate if the remote endpoint is not willing to receive as quickly as specified. Defaults to 100. bfd : decay_min_rx: optional string containing an integer An alternate receive interval, in milliseconds, that must be greater than or equal to bfd:min_rx. The implementation switches from bfd:min_rx to bfd:decay_min_rx when there is no obvious incoming data traffic at the interface, to reduce the CPU and bandwidth cost of monitoring an idle interface. This feature may be disabled by setting a value of 0. This feature is reset whenever bfd:decay_min_rx bfd:min_rx changes. bfd : forwarding_if_rx: optional string, either true or false When true, traffic received on the Interface is used to indicate the capability of packet I/O. BFD control packets are still transmitted and received. At least one BFD control packet must be received every 100 * bfd:min_rx amount of time. Otherwise, even if traffic are received, the bfd-status:forwarding will be false. bfd : cpath_down: optional string, either true or false Set to true to notify the remote endpoint that traffic should not be forwarded to this system for some reason other than a connectivity failure on the interface being monitored. The typical underlying reason is concatenated path down, that is, that connectivity beyond the local system is down. Defaults to false. bfd : cpath_down: optional string, either true or false Set to true to notify the remote endpoint that traffic should not be forwarded to this system for some reason other than a connectivity failure on the interface being monitored. The typical underlying reason is concatenated path down, that is, that connectivity beyond the local system is down. Defaults to false. bfd : check_tnl_key: optional string, either true or false Set to true to make BFD accept only control messages with a tunnel key of zero. By default, BFD accepts control messages with any tunnel key. bfd : bfd_local_dst_mac: optional string, mac address Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC used as destination for transmitted BFD packets. The default is 00:23:20:00:00:01 bfd : bfd_remote_dst_mac: optional string, mac address Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC used for checking the destination of received BFD packets. Packets with different destination MAC will not be considered as BFD packets. If not specified the destination MAC address of received BFD packets are not checked. bfd : bfd_src_ip: optional string, ip address Set to an IPv4 address to set the IP address used as source for transmitted BFD packets. The default is 169.254.1.1 bfd : bfd_dst_ip: optional string, ip address Set to an IPv4 address to set the IP address used as destination for transmitted BFD packets. The default is 169.254.1.0
        Returns:
        java.util.List interfaceBfd, or null if not present

      • nonnullInterfaceBfd

        default @NonNull List<InterfaceBfd> nonnullInterfaceBfd()
        Returns:
        java.util.List interfaceBfd, or an empty list if it is not present

      • getInterfaceBfdStatus

        @Nullable List<InterfaceBfdStatus> getInterfaceBfdStatus()
        BFD status for a particular interface. The switch sets key-value pairs in the bfd_status column to report the status of BFD on this interface. When BFD is not enabled, with bfd:enable, the switch clears all key-value pairs from bfd_status. bfd_status : state: optional string, one of [admin_down, down, init, up] Reports the state of the BFD session. The BFD session is fully healthy and negotiated if UP. bfd_status : forwarding: optional string, true or false Reports whether the BFD session believes this Interface may be used to forward traffic. Typically this means the local session is signaling UP, and the remote system isn't signaling a problem such as concatenated path down. bfd_status : diagnostic: optional string A diagnostic code specifying the local system's reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status : remote_state: optional string, one of [admin_down, down, init, up] Reports the state of the remote endpoint's BFD session. bfd_status : remote_diagnostic: optional string A diagnostic code specifying the remote system's reason for the last change in session state. The error messages are defined in section 4.1 of [RFC 5880]. bfd_status : flap_count: optional string, containing an integer, minimum 0 Counts the number of bfd_status:forwarding flaps since start. A flap is considered as a change of the bfd_status:forwarding value.
        Returns:
        java.util.List interfaceBfdStatus, or null if not present

      • nonnullInterfaceBfdStatus

        default @NonNull List<InterfaceBfdStatus> nonnullInterfaceBfdStatus()
        Returns:
        java.util.List interfaceBfdStatus, or an empty list if it is not present

      • getQosEntry

        @Nullable List<QosEntry> getQosEntry()
        Returns:
        java.util.List qosEntry, or null if not present

      • nonnullQosEntry

        default @NonNull List<QosEntry> nonnullQosEntry()
        Returns:
        java.util.List qosEntry, or an empty list if it is not present

      • getIngressPolicingRate

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getIngressPolicingRate()
        Maximum rate for data received on this interface in kbps. Data received faster than this rate is dropped. Set to 0 (default) to disable policing
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 ingressPolicingRate, or null if not present

      • getIngressPolicingBurst

        @Nullable org.opendaylight.yangtools.yang.common.Uint32 getIngressPolicingBurst()
        Maximum burst size for data received on this interface in kb. The default burst size if set to 0 is 1000 kb. This value has no effect if ingress-policing-rate is 0.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 ingressPolicingBurst, or null if not present