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

    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;
       }
     }
     
    The schema path to identify an instance is ovsdb/ovsdb-bridge-attributes
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • 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

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

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

        @Nullable OvsdbBridgeName getBridgeName()
        The name of the bridge
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbBridgeName bridgeName, or null if not present
      • getProtocolEntry

        @Nullable List<ProtocolEntry> getProtocolEntry()
        Returns:
        java.util.List protocolEntry, or null if not present
      • nonnullProtocolEntry

        default @NonNull List<ProtocolEntry> nonnullProtocolEntry()
        Returns:
        java.util.List protocolEntry, or an empty list if it is not present
      • getControllerEntry

        @Nullable List<ControllerEntry> getControllerEntry()
        Bridge controller info
        Returns:
        java.util.List controllerEntry, or null if not present
      • nonnullControllerEntry

        default @NonNull List<ControllerEntry> nonnullControllerEntry()
        Returns:
        java.util.List controllerEntry, or an empty list if it is not present
      • getDatapathId

        @Nullable DatapathId getDatapathId()
        Datapath-id of the bridge
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.DatapathId datapathId, or null if not present
      • getDatapathType

        @Nullable Class<? extends DatapathTypeBase> getDatapathType()
        The datapath type of the bridge
        Returns:
        java.lang.Class datapathType, or null if not present
      • getFailMode

        @Nullable Class<? extends OvsdbFailModeBase> getFailMode()
        Failmode of the bridge
        Returns:
        java.lang.Class failMode, or null if not present
      • getFlowNode

        @Nullable FlowNodeRef getFlowNode()
        Flow node corresponding to this bridge
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.FlowNodeRef flowNode, or null if not present
      • getManagedBy

        @Nullable OvsdbNodeRef getManagedBy()
        The OVSDB which this bridge belongs to
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.ovsdb.rev150105.OvsdbNodeRef managedBy, or null if not present
      • isStpEnable

        @Nullable Boolean isStpEnable()
        Enable spanning tree on the bridge. By default, STP is disabled on bridges
        Returns:
        java.lang.Boolean stpEnable, or null if not present
      • getBridgeExternalIds

        @Nullable List<BridgeExternalIds> getBridgeExternalIds()
        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:
        java.util.List bridgeExternalIds, or null if not present
      • nonnullBridgeExternalIds

        default @NonNull List<BridgeExternalIds> nonnullBridgeExternalIds()
        Returns:
        java.util.List bridgeExternalIds, or an empty list if it is not present
      • getBridgeOtherConfigs

        @Nullable List<BridgeOtherConfigs> getBridgeOtherConfigs()
        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:
        java.util.List bridgeOtherConfigs, or null if not present
      • nonnullBridgeOtherConfigs

        default @NonNull List<BridgeOtherConfigs> nonnullBridgeOtherConfigs()
        Returns:
        java.util.List bridgeOtherConfigs, or an empty list if it is not present
      • getAutoAttach

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