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

Interface OvsdbBridgeAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    OvsdbBridgeAugmentation
    @Generated("mdsal-binding-generator")
public interface OvsdbBridgeAttributes
extends org.opendaylight.yangtools.yang.binding.DataObject

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

     grouping ovsdb-bridge-attributes {
   leaf bridge-uuid {
     type yang:uuid;
   }
   leaf bridge-openflow-node-ref {
     type instance-identifier;
   }
   leaf bridge-name {
     type ovsdb-bridge-name;
   }
   list protocol-entry {
     key protocol;
     leaf protocol {
       type identityref {
         base ovsdb-bridge-protocol-base;
       }
     }
   }
   list controller-entry {
     key target;
     leaf target {
       type inet:uri;
     }
     leaf controller-uuid {
       type yang:uuid;
     }
     leaf is-connected {
       type boolean;
     }
     leaf max_backoff {
       type uint32 {
         range 1000..max;
       }
     }
     leaf inactivity_probe {
       type uint32;
     }
   }
   leaf datapath-id {
     type datapath-id;
   }
   leaf datapath-type {
     type identityref {
       base datapath-type-base;
     }
   }
   leaf fail-mode {
     type identityref {
       base ovsdb-fail-mode-base;
     }
   }
   leaf flow-node {
     type flow-node-ref;
   }
   leaf managed-by {
     type ovsdb-node-ref;
   }
   leaf stp_enable {
     type boolean;
   }
   list bridge-external-ids {
     key bridge-external-id-key;
     leaf bridge-external-id-key {
       type string;
     }
     leaf bridge-external-id-value {
       type string;
     }
   }
   list bridge-other-configs {
     key bridge-other-config-key;
     leaf bridge-other-config-key {
       type string;
     }
     leaf bridge-other-config-value {
       type string;
     }
   }
   leaf auto-attach {
     type yang:uuid;
   }
 }

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

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

      • getBridgeUuid

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getBridgeUuid()
        Return bridgeUuid, or null if it is not present. 
             
         The unique identifier of the bridge
        Returns:
        Uuid bridgeUuid, or null if it is not present.

      • requireBridgeUuid

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireBridgeUuid()
        Return bridgeUuid, guaranteed to be non-null. 
             
         The unique identifier of the bridge
        Returns:
        Uuid bridgeUuid, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bridgeUuid is not present

      • getBridgeOpenflowNodeRef

        org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> getBridgeOpenflowNodeRef()
        Return bridgeOpenflowNodeRef, or null if it is not present. 
             
         A reference to the openflow node
        Returns:
        InstanceIdentifier<?> bridgeOpenflowNodeRef, or null if it is not present.

      • requireBridgeOpenflowNodeRef

        default @NonNull org.opendaylight.yangtools.yang.binding.InstanceIdentifier<?> requireBridgeOpenflowNodeRef()
        Return bridgeOpenflowNodeRef, guaranteed to be non-null. 
             
         A reference to the openflow node
        Returns:
        InstanceIdentifier<?> bridgeOpenflowNodeRef, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bridgeOpenflowNodeRef is not present

      • getBridgeName

        OvsdbBridgeName getBridgeName()
        Return bridgeName, or null if it is not present. 
             
         The name of the bridge
        Returns:
        OvsdbBridgeName bridgeName, or null if it is not present.

      • requireBridgeName

        default @NonNull OvsdbBridgeName requireBridgeName()
        Return bridgeName, guaranteed to be non-null. 
             
         The name of the bridge
        Returns:
        OvsdbBridgeName bridgeName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if bridgeName is not present

      • getProtocolEntry

        @Nullable Map<ProtocolEntryKey,​ProtocolEntry> getProtocolEntry()
        Return protocolEntry, or null if it is not present.
        Returns:
        Map<ProtocolEntryKey, ProtocolEntry> protocolEntry, or null if it is not present.

      • nonnullProtocolEntry

        default @NonNull Map<ProtocolEntryKey,​ProtocolEntry> nonnullProtocolEntry()
        Return protocolEntry, or an empty list if it is not present.
        Returns:
        Map<ProtocolEntryKey, ProtocolEntry> protocolEntry, or an empty list if it is not present.

      • getControllerEntry

        @Nullable Map<ControllerEntryKey,​ControllerEntry> getControllerEntry()
        Return controllerEntry, or null if it is not present. 
             
         Bridge controller info
        Returns:
        Map<ControllerEntryKey, ControllerEntry> controllerEntry, or null if it is not present.

      • nonnullControllerEntry

        default @NonNull Map<ControllerEntryKey,​ControllerEntry> nonnullControllerEntry()
        Return controllerEntry, or an empty list if it is not present.
        Returns:
        Map<ControllerEntryKey, ControllerEntry> controllerEntry, or an empty list if it is not present.

      • getDatapathId

        DatapathId getDatapathId()
        Return datapathId, or null if it is not present. 
             
         Datapath-id of the bridge
        Returns:
        DatapathId datapathId, or null if it is not present.

      • requireDatapathId

        default @NonNull DatapathId requireDatapathId()
        Return datapathId, guaranteed to be non-null. 
             
         Datapath-id of the bridge
        Returns:
        DatapathId datapathId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if datapathId is not present

      • getDatapathType

        Class<? extends DatapathTypeBase> getDatapathType()
        Return datapathType, or null if it is not present. 
             
         The datapath type of the bridge
        Returns:
        Class<? extends DatapathTypeBase> datapathType, or null if it is not present.

      • requireDatapathType

        default @NonNull Class<? extends DatapathTypeBase> requireDatapathType()
        Return datapathType, guaranteed to be non-null. 
             
         The datapath type of the bridge
        Returns:
        Class<? extends DatapathTypeBase> datapathType, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if datapathType is not present

      • getFailMode

        Class<? extends OvsdbFailModeBase> getFailMode()
        Return failMode, or null if it is not present. 
             
         Failmode of the bridge
        Returns:
        Class<? extends OvsdbFailModeBase> failMode, or null if it is not present.

      • requireFailMode

        default @NonNull Class<? extends OvsdbFailModeBase> requireFailMode()
        Return failMode, guaranteed to be non-null. 
             
         Failmode of the bridge
        Returns:
        Class<? extends OvsdbFailModeBase> failMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if failMode is not present

      • getFlowNode

        FlowNodeRef getFlowNode()
        Return flowNode, or null if it is not present. 
             
         Flow node corresponding to this bridge
        Returns:
        FlowNodeRef flowNode, or null if it is not present.

      • requireFlowNode

        default @NonNull FlowNodeRef requireFlowNode()
        Return flowNode, guaranteed to be non-null. 
             
         Flow node corresponding to this bridge
        Returns:
        FlowNodeRef flowNode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if flowNode is not present

      • getManagedBy

        OvsdbNodeRef getManagedBy()
        Return managedBy, or null if it is not present. 
             
         The OVSDB which this bridge belongs to
        Returns:
        OvsdbNodeRef managedBy, or null if it is not present.

      • requireManagedBy

        default @NonNull OvsdbNodeRef requireManagedBy()
        Return managedBy, guaranteed to be non-null. 
             
         The OVSDB which this bridge belongs to
        Returns:
        OvsdbNodeRef managedBy, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if managedBy is not present

      • getStpEnable

        Boolean getStpEnable()
        Return stpEnable, or null if it is not present. 
             
         Enable spanning tree on the bridge. By default, STP is disabled on bridges
        Returns:
        Boolean stpEnable, or null if it is not present.

      • requireStpEnable

        default @NonNull Boolean requireStpEnable()
        Return stpEnable, guaranteed to be non-null. 
             
         Enable spanning tree on the bridge. By default, STP is disabled on bridges
        Returns:
        Boolean stpEnable, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if stpEnable is not present

      • getBridgeExternalIds

        @Nullable Map<BridgeExternalIdsKey,​BridgeExternalIds> getBridgeExternalIds()
        Return bridgeExternalIds, or null if it is not present. 
             
         Key-value pairs for use by external frameworks that integrate with Open vSwitch.
         external_ids : bridge-id: optional string A unique identifier of the bridge. On
         Citrix XenServer this will commonly be the same as
         external_ids:xs-network-uuids. external_ids : xs-network-uuids: optional string
         Semicolon-delimited set of universally unique identifier(s) for the network with
         which this bridge is associated on a Citrix XenServer host. The network
         identifiers are RFC 4122 UUIDs as displayed by, e.g., xe network-list.
        Returns:
        Map<BridgeExternalIdsKey, BridgeExternalIds> bridgeExternalIds, or null if it is not present.

      • nonnullBridgeExternalIds

        default @NonNull Map<BridgeExternalIdsKey,​BridgeExternalIds> nonnullBridgeExternalIds()
        Return bridgeExternalIds, or an empty list if it is not present.
        Returns:
        Map<BridgeExternalIdsKey, BridgeExternalIds> bridgeExternalIds, or an empty list if it is not present.

      • getBridgeOtherConfigs

        @Nullable Map<BridgeOtherConfigsKey,​BridgeOtherConfigs> getBridgeOtherConfigs()
        Return bridgeOtherConfigs, or null if it is not present. 
             
         Key-value pairs for configuring rarely used features. other_config : hwaddr:
         optional string An Ethernet address in the form xx:xx:xx:xx:xx:xx to set the
         hardware address of the local port and influence the datapath ID. other_config :
         forward-bpdu: optional string either true or false. Option to allow forwarding
         of BPDU frames when NORMAL action is invoked. Frames with reserved Ethernet
         addresses (e.g. STP BPDU) will be forwarded when this option is enabled and the
         switch is not providing that functionality. other_config : mac-aging-time:
         optional string containing an integer, at least 1 The maximum number of seconds
         to retain a MAC learning entry for which no packets have been seen. The default
         is currently 300 seconds (5 minutes). The value, if specified, is forced into a
         reasonable range, currently 15 to 3600 seconds. other_config : mac-table-size:
         optional string containing an integer, at least 1 The maximum number of MAC
         addresses to learn. The default is currently 2048. The value, if specified, is
         forced into a reasonable range, currently 10 to 1,000,000. other_config :
         datapath-id: optional string Exactly 16 hex digits to set the OpenFlow datapath
         ID to a specific value. May not be all-zero. other_config : dp-desc: optional
         string Human readable description of datapath. It it a maximum 256 byte-long
         free-form string to describe the datapath for debugging purposes. other_config :
         disable-in-band: optional string either true or false If set to true, disable
         in-band control on the bridge regardless of controller and manager settings.
         other_config : in-band-queue: optional string containing an integer, in range 0
         to 4,294,967,295 A queue ID as a nonnegative integer. other_config :
         stp-system-id: optional string The bridge's STP identifier (the lower 48 bits of
         the bridge-id) in the form xx:xx:xx:xx:xx:xx. By default, the identifier is the
         MAC address of the bridge. other_config : stp-priority: optional string
         containing an integer, in range 0 to 65,535 The bridge's relative priority value
         for determining the root bridge (the upper 16 bits of the bridgeid). A bridge
         with the lowest bridge-id is elected the root. By default, the priority is
         0x8000. other_config : stp-hello-time: optional string containing an integer, in
         range 1 to 10 The interval between transmissions of hello messages by designated
         ports, in seconds. By default the hello interval is 2 seconds. other_config :
         stp-max-age: optional string containing an integer, in range 6 to 40 The maximum
         age of the information transmitted by the bridge when it is the root bridge, in
         seconds. By default, the maximum age is 20 seconds. other_config :
         stp-forward-delay: optional string containing an integer, in range 4 to 30 The
         delay to wait between transitioning root and designated ports to forwarding, in
         seconds. By default, the forwarding delay is 15 seconds. other_config :
         mcast-snooping-aging-time: optional string, containing an integer, at least 1
         The maximum number of seconds to retain a multicast snooping entry for which no
         packets have been seen. The default is currently 300 seconds (5 minutes). The
         value, if specified, is forced into a reasonable range, currently 15 to 3600
         seconds. other_config : mcast-snooping-table-size: optional string, containing
         an integer, at least 1 The maximum number of multicast snooping addresses to
         learn. The default is currently 2048. The value, if specified, is forced into a
         reasonable range, currently 10 to 1,000,000. other_config :
         mcast-snooping-disable-flood-unregistered: optional string, either true or false
         If set to false, unregistered multicast packets are forwarded to all ports. If
         set to true, unregistered multicast packets are forwarded to ports connected to
         multicast routers.
        Returns:
        Map<BridgeOtherConfigsKey, BridgeOtherConfigs> bridgeOtherConfigs, or null if it is not present.

      • nonnullBridgeOtherConfigs

        default @NonNull Map<BridgeOtherConfigsKey,​BridgeOtherConfigs> nonnullBridgeOtherConfigs()
        Return bridgeOtherConfigs, or an empty list if it is not present.
        Returns:
        Map<BridgeOtherConfigsKey, BridgeOtherConfigs> bridgeOtherConfigs, or an empty list if it is not present.

      • getAutoAttach

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getAutoAttach()
        Return autoAttach, or null if it is not present. 
             
         The unique identifier of the auto_attach entry for this bridge.
        Returns:
        Uuid autoAttach, or null if it is not present.

      • requireAutoAttach

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid requireAutoAttach()
        Return autoAttach, guaranteed to be non-null. 
             
         The unique identifier of the auto_attach entry for this bridge.
        Returns:
        Uuid autoAttach, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if autoAttach is not present