Interface OvsdbPortInterfaceAttributes
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
- All Known Subinterfaces:
OvsdbTerminationPointAugmentation
@Generated("mdsal-binding-generator")
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; } }
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic enum
This class represents the following YANG schema fragment defined in module ovsdb -
Field Summary
Modifier and TypeFieldDescriptionstatic final @NonNull org.opendaylight.yangtools.yang.common.QName
YANG identifier of the statement represented by this class. -
Method Summary
Modifier and TypeMethodDescriptionorg.opendaylight.yangtools.yang.common.Uint32
Return ifindex, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return ingressPolicingBurst, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return ingressPolicingRate, ornull
if it is not present.@Nullable Map<InterfaceBfdKey,
InterfaceBfd> Return interfaceBfd, ornull
if it is not present.@Nullable Map<InterfaceBfdStatusKey,
InterfaceBfdStatus> Return interfaceBfdStatus, ornull
if it is not present.@Nullable Map<InterfaceExternalIdsKey,
InterfaceExternalIds> Return interfaceExternalIds, ornull
if it is not present.@Nullable Map<InterfaceLldpKey,
InterfaceLldp> Return interfaceLldp, ornull
if it is not present.@Nullable Map<InterfaceOtherConfigsKey,
InterfaceOtherConfigs> Return interfaceOtherConfigs, ornull
if it is not present.Return interfaceType, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return interfaceUuid, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
getMac()
Return mac, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return macInUse, ornull
if it is not present.getName()
Return name, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
Return ofport, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint16
Return ofportRequest, ornull
if it is not present.@Nullable Map<OptionsKey,
Options> Return options, ornull
if it is not present.@Nullable Map<PortExternalIdsKey,
PortExternalIds> Return portExternalIds, ornull
if it is not present.@Nullable Map<PortOtherConfigsKey,
PortOtherConfigs> Return portOtherConfigs, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return portUuid, ornull
if it is not present.@Nullable Map<QosEntryKey,
QosEntry> Return qosEntry, ornull
if it is not present.Return trunks, ornull
if it is not present.Return vlanMode, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
Return vlanTag, ornull
if it is not present.Class<? extends OvsdbPortInterfaceAttributes>
default @NonNull Map<InterfaceBfdKey,
InterfaceBfd> Return interfaceBfd, or an empty list if it is not present.default @NonNull Map<InterfaceBfdStatusKey,
InterfaceBfdStatus> Return interfaceBfdStatus, or an empty list if it is not present.default @NonNull Map<InterfaceExternalIdsKey,
InterfaceExternalIds> Return interfaceExternalIds, or an empty list if it is not present.default @NonNull Map<InterfaceLldpKey,
InterfaceLldp> Return interfaceLldp, or an empty list if it is not present.default @NonNull Map<InterfaceOtherConfigsKey,
InterfaceOtherConfigs> Return interfaceOtherConfigs, or an empty list if it is not present.default @NonNull Map<OptionsKey,
Options> Return options, or an empty list if it is not present.default @NonNull Map<PortExternalIdsKey,
PortExternalIds> Return portExternalIds, or an empty list if it is not present.default @NonNull Map<PortOtherConfigsKey,
PortOtherConfigs> Return portOtherConfigs, or an empty list if it is not present.default @NonNull Map<QosEntryKey,
QosEntry> Return qosEntry, or an empty list if it is not present.Return trunks, or an empty list if it is not present.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return ifindex, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return ingressPolicingBurst, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return ingressPolicingRate, guaranteed to be non-null.default @NonNull InterfaceTypeBase
Return interfaceType, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return interfaceUuid, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return mac, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress
Return macInUse, guaranteed to be non-null.default @NonNull String
Return name, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
Return ofport, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint16
Return ofportRequest, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
Return portUuid, guaranteed to be non-null.default @NonNull OvsdbPortInterfaceAttributes.VlanMode
Return vlanMode, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId
Return vlanTag, guaranteed to be non-null.
-
Field Details
-
QNAME
static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAMEYANG identifier of the statement represented by this class.
-
-
Method Details
-
implementedInterface
Class<? extends OvsdbPortInterfaceAttributes> implementedInterface()- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getPortUuid
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getPortUuid()Return portUuid, ornull
if it is not present.The unique identifier of the OVSDB port
- Returns:
Uuid
portUuid, ornull
if it is not present.
-
requirePortUuid
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requirePortUuid()Return portUuid, guaranteed to be non-null.The unique identifier of the OVSDB port
- Returns:
Uuid
portUuid, guaranteed to be non-null.- Throws:
NoSuchElementException
- if portUuid is not present
-
getInterfaceUuid
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getInterfaceUuid()Return interfaceUuid, ornull
if it is not present.The unique identifier of the OVSDB interface
- Returns:
Uuid
interfaceUuid, ornull
if it is not present.
-
requireInterfaceUuid
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireInterfaceUuid()Return interfaceUuid, guaranteed to be non-null.The unique identifier of the OVSDB interface
- Returns:
Uuid
interfaceUuid, guaranteed to be non-null.- Throws:
NoSuchElementException
- if interfaceUuid is not present
-
getName
String getName()Return name, ornull
if it is not present.The name of the OVSDB port/interface
- Returns:
String
name, ornull
if it is not present.
-
requireName
Return name, guaranteed to be non-null.The name of the OVSDB port/interface
- Returns:
String
name, guaranteed to be non-null.- Throws:
NoSuchElementException
- if name is not present
-
getIfindex
org.opendaylight.yangtools.yang.common.Uint32 getIfindex()Return ifindex, ornull
if it is not present.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:
Uint32
ifindex, ornull
if it is not present.
-
requireIfindex
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIfindex()Return ifindex, guaranteed to be non-null.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:
Uint32
ifindex, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ifindex is not present
-
getMac
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMac()Return mac, ornull
if it is not present.Ethernet address to use for this interface. If unset, the default is used
- Returns:
MacAddress
mac, ornull
if it is not present.
-
requireMac
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireMac()Return mac, guaranteed to be non-null.Ethernet address to use for this interface. If unset, the default is used
- Returns:
MacAddress
mac, guaranteed to be non-null.- Throws:
NoSuchElementException
- if mac is not present
-
getMacInUse
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getMacInUse()Return macInUse, ornull
if it is not present.The MAC address in use by this interface
- Returns:
MacAddress
macInUse, ornull
if it is not present.
-
requireMacInUse
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireMacInUse()Return macInUse, guaranteed to be non-null.The MAC address in use by this interface
- Returns:
MacAddress
macInUse, guaranteed to be non-null.- Throws:
NoSuchElementException
- if macInUse is not present
-
getInterfaceType
InterfaceTypeBase getInterfaceType()Return interfaceType, ornull
if it is not present.The type of the OVSDB interface
- Returns:
InterfaceTypeBase
interfaceType, ornull
if it is not present.
-
requireInterfaceType
Return interfaceType, guaranteed to be non-null.The type of the OVSDB interface
- Returns:
InterfaceTypeBase
interfaceType, guaranteed to be non-null.- Throws:
NoSuchElementException
- if interfaceType is not present
-
getOptions
@Nullable Map<OptionsKey,Options> getOptions()Return options, ornull
if it is not present.Port/Interface related optional input values
- Returns:
Map<OptionsKey, Options>
options, ornull
if it is not present.
-
nonnullOptions
Return options, or an empty list if it is not present.- Returns:
Map<OptionsKey, Options>
options, or an empty list if it is not present.
-
getOfport
org.opendaylight.yangtools.yang.common.Uint32 getOfport()Return ofport, ornull
if it is not present.Port/Interface related optional ofport
- Returns:
Uint32
ofport, ornull
if it is not present.
-
requireOfport
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireOfport()Return ofport, guaranteed to be non-null.Port/Interface related optional ofport
- Returns:
Uint32
ofport, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ofport is not present
-
getOfportRequest
org.opendaylight.yangtools.yang.common.Uint16 getOfportRequest()Return ofportRequest, ornull
if it is not present.Port/Interface related optional ofport_request, in range 1 to 65279
- Returns:
Uint16
ofportRequest, ornull
if it is not present.
-
requireOfportRequest
default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireOfportRequest()Return ofportRequest, guaranteed to be non-null.Port/Interface related optional ofport_request, in range 1 to 65279
- Returns:
Uint16
ofportRequest, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ofportRequest is not present
-
getVlanTag
org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId getVlanTag()Return vlanTag, ornull
if it is not present.The VLAN tag of the termination point.
- Returns:
VlanId
vlanTag, ornull
if it is not present.
-
requireVlanTag
default @NonNull org.opendaylight.yang.gen.v1.urn.opendaylight.l2.types.rev130827.VlanId requireVlanTag()Return vlanTag, guaranteed to be non-null.The VLAN tag of the termination point.
- Returns:
VlanId
vlanTag, guaranteed to be non-null.- Throws:
NoSuchElementException
- if vlanTag is not present
-
getTrunks
Return trunks, ornull
if it is not present.Represents the trunks of a termination point.
- Returns:
List<Trunks>
trunks, ornull
if it is not present.
-
nonnullTrunks
Return trunks, or an empty list if it is not present.- Returns:
List<Trunks>
trunks, or an empty list if it is not present.
-
getVlanMode
OvsdbPortInterfaceAttributes.VlanMode getVlanMode()Return vlanMode, ornull
if it is not present.The VLAN mode of the termination point.
- Returns:
VlanMode
vlanMode, ornull
if it is not present.
-
requireVlanMode
Return vlanMode, guaranteed to be non-null.The VLAN mode of the termination point.
- Returns:
VlanMode
vlanMode, guaranteed to be non-null.- Throws:
NoSuchElementException
- if vlanMode is not present
-
getPortOtherConfigs
@Nullable Map<PortOtherConfigsKey,PortOtherConfigs> getPortOtherConfigs()Return portOtherConfigs, ornull
if it is not present.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:
Map<PortOtherConfigsKey, PortOtherConfigs>
portOtherConfigs, ornull
if it is not present.
-
nonnullPortOtherConfigs
Return portOtherConfigs, or an empty list if it is not present.- Returns:
Map<PortOtherConfigsKey, PortOtherConfigs>
portOtherConfigs, or an empty list if it is not present.
-
getInterfaceOtherConfigs
@Nullable Map<InterfaceOtherConfigsKey,InterfaceOtherConfigs> getInterfaceOtherConfigs()Return interfaceOtherConfigs, ornull
if it is not present.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:
Map<InterfaceOtherConfigsKey, InterfaceOtherConfigs>
interfaceOtherConfigs, ornull
if it is not present.
-
nonnullInterfaceOtherConfigs
Return interfaceOtherConfigs, or an empty list if it is not present.- Returns:
Map<InterfaceOtherConfigsKey, InterfaceOtherConfigs>
interfaceOtherConfigs, or an empty list if it is not present.
-
getPortExternalIds
@Nullable Map<PortExternalIdsKey,PortExternalIds> getPortExternalIds()Return portExternalIds, ornull
if it is not present.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:
Map<PortExternalIdsKey, PortExternalIds>
portExternalIds, ornull
if it is not present.
-
nonnullPortExternalIds
Return portExternalIds, or an empty list if it is not present.- Returns:
Map<PortExternalIdsKey, PortExternalIds>
portExternalIds, or an empty list if it is not present.
-
getInterfaceExternalIds
@Nullable Map<InterfaceExternalIdsKey,InterfaceExternalIds> getInterfaceExternalIds()Return interfaceExternalIds, ornull
if it is not present.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:
Map<InterfaceExternalIdsKey, InterfaceExternalIds>
interfaceExternalIds, ornull
if it is not present.
-
nonnullInterfaceExternalIds
Return interfaceExternalIds, or an empty list if it is not present.- Returns:
Map<InterfaceExternalIdsKey, InterfaceExternalIds>
interfaceExternalIds, or an empty list if it is not present.
-
getInterfaceLldp
@Nullable Map<InterfaceLldpKey,InterfaceLldp> getInterfaceLldp()Return interfaceLldp, ornull
if it is not present.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:
Map<InterfaceLldpKey, InterfaceLldp>
interfaceLldp, ornull
if it is not present.
-
nonnullInterfaceLldp
Return interfaceLldp, or an empty list if it is not present.- Returns:
Map<InterfaceLldpKey, InterfaceLldp>
interfaceLldp, or an empty list if it is not present.
-
getInterfaceBfd
@Nullable Map<InterfaceBfdKey,InterfaceBfd> getInterfaceBfd()Return interfaceBfd, ornull
if it is not present.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:
Map<InterfaceBfdKey, InterfaceBfd>
interfaceBfd, ornull
if it is not present.
-
nonnullInterfaceBfd
Return interfaceBfd, or an empty list if it is not present.- Returns:
Map<InterfaceBfdKey, InterfaceBfd>
interfaceBfd, or an empty list if it is not present.
-
getInterfaceBfdStatus
@Nullable Map<InterfaceBfdStatusKey,InterfaceBfdStatus> getInterfaceBfdStatus()Return interfaceBfdStatus, ornull
if it is not present.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:
Map<InterfaceBfdStatusKey, InterfaceBfdStatus>
interfaceBfdStatus, ornull
if it is not present.
-
nonnullInterfaceBfdStatus
Return interfaceBfdStatus, or an empty list if it is not present.- Returns:
Map<InterfaceBfdStatusKey, InterfaceBfdStatus>
interfaceBfdStatus, or an empty list if it is not present.
-
getQosEntry
@Nullable Map<QosEntryKey,QosEntry> getQosEntry()Return qosEntry, ornull
if it is not present.- Returns:
Map<QosEntryKey, QosEntry>
qosEntry, ornull
if it is not present.
-
nonnullQosEntry
Return qosEntry, or an empty list if it is not present.- Returns:
Map<QosEntryKey, QosEntry>
qosEntry, or an empty list if it is not present.
-
getIngressPolicingRate
org.opendaylight.yangtools.yang.common.Uint32 getIngressPolicingRate()Return ingressPolicingRate, ornull
if it is not present.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:
Uint32
ingressPolicingRate, ornull
if it is not present.
-
requireIngressPolicingRate
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIngressPolicingRate()Return ingressPolicingRate, guaranteed to be non-null.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:
Uint32
ingressPolicingRate, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ingressPolicingRate is not present
-
getIngressPolicingBurst
org.opendaylight.yangtools.yang.common.Uint32 getIngressPolicingBurst()Return ingressPolicingBurst, ornull
if it is not present.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:
Uint32
ingressPolicingBurst, ornull
if it is not present.
-
requireIngressPolicingBurst
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIngressPolicingBurst()Return ingressPolicingBurst, guaranteed to be non-null.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:
Uint32
ingressPolicingBurst, guaranteed to be non-null.- Throws:
NoSuchElementException
- if ingressPolicingBurst is not present
-