Interface OvsdbNodeAttributes

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    OvsdbNodeAugmentation

    @Generated("mdsal-binding-generator")
    public interface OvsdbNodeAttributes
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Plugin will not allow multiple connections to the same device. If an attempts to make more than one connection to the device by putting multiple entries in the config data store, then it is the responsibility of the application to clean the config data store

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

     grouping ovsdb-node-attributes {
       container connection-info {
         uses ovsdb-connection-info-attributes;
       }
       leaf db-version {
         type string;
       }
       leaf ovs-version {
         type string;
       }
       list managed-node-entry {
         key bridge-ref;
         leaf bridge-ref {
           type ovsdb-bridge-ref;
         }
       }
       list datapath-type-entry {
         key datapath-type;
         leaf datapath-type {
           type identityref {
             base datapath-type-base;
           }
         }
       }
       list interface-type-entry {
         key interface-type;
         leaf interface-type {
           type identityref {
             base interface-type-base;
           }
         }
       }
       list openvswitch-external-ids {
         key external-id-key;
         leaf external-id-key {
           type string;
         }
         leaf external-id-value {
           type string;
         }
       }
       list openvswitch-other-configs {
         key other-config-key;
         leaf other-config-key {
           type string;
         }
         leaf other-config-value {
           type string;
         }
       }
       list manager-entry {
         config false;
         key target;
         leaf target {
           type inet:uri;
         }
         leaf connected {
           type boolean;
         }
         leaf number_of_connections {
           type uint32;
         }
       }
       list qos-entries {
         key qos-id;
         leaf qos-id {
           type inet:uri;
         }
         leaf qos-uuid {
           type yang:uuid;
         }
         leaf qos-type {
           type identityref {
             base qos-type-base;
           }
         }
         list queue-list {
           key queue-number;
           leaf queue-number {
             type uint32;
           }
           leaf queue-ref {
             type ovsdb-queue-ref;
           }
         }
         list qos-external-ids {
           key qos-external-id-key;
           leaf qos-external-id-key {
             type string;
           }
           leaf qos-external-id-value {
             type string;
           }
         }
         list qos-other-config {
           key other-config-key;
           leaf other-config-key {
             type string;
           }
           leaf other-config-value {
             type string;
           }
         }
       }
       list queues {
         key queue-id;
         leaf queue-id {
           type inet:uri;
         }
         leaf queue-uuid {
           type yang:uuid;
         }
         leaf dscp {
           type uint8;
         }
         list queues-external-ids {
           key queues-external-id-key;
           leaf queues-external-id-key {
             type string;
           }
           leaf queues-external-id-value {
             type string;
           }
         }
         list queues-other-config {
           key queue-other-config-key;
           leaf queue-other-config-key {
             type string;
           }
           leaf queue-other-config-value {
             type string;
           }
         }
       }
       list autoattach {
         key autoattach-id;
         leaf autoattach-id {
           type inet:uri;
         }
         leaf bridge-id {
           type inet:uri;
         }
         leaf autoattach-uuid {
           type yang:uuid;
         }
         leaf system-name {
           type string;
         }
         leaf system-description {
           type string;
         }
         list mappings {
           key mappings-key;
           leaf mappings-key {
             type uint32 {
               range 0..16777215;
             }
           }
           leaf mappings-value {
             type uint16 {
               range 0..4095;
             }
           }
         }
         list autoattach-external-ids {
           key autoattach-external-id-key;
           leaf autoattach-external-id-key {
             type string;
           }
           leaf autoattach-external-id-value {
             type string;
           }
         }
       }
     }
     
    • 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 OvsdbNodeAttributes> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getConnectionInfo

        ConnectionInfo getConnectionInfo()
        Return connectionInfo, or null if it is not present.
        Returns:
        ConnectionInfo connectionInfo, or null if it is not present.
      • getDbVersion

        String getDbVersion()
        Return dbVersion, or null if it is not present.
             
                 The database schema version
             
         
        Returns:
        String dbVersion, or null if it is not present.
      • requireDbVersion

        default @NonNull String requireDbVersion()
        Return dbVersion, guaranteed to be non-null.
             
                 The database schema version
             
         
        Returns:
        String dbVersion, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if dbVersion is not present
      • getOvsVersion

        String getOvsVersion()
        Return ovsVersion, or null if it is not present.
             
                 The Open_vSwitch version number
             
         
        Returns:
        String ovsVersion, or null if it is not present.
      • requireOvsVersion

        default @NonNull String requireOvsVersion()
        Return ovsVersion, guaranteed to be non-null.
             
                 The Open_vSwitch version number
             
         
        Returns:
        String ovsVersion, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if ovsVersion is not present
      • getManagedNodeEntry

        @Nullable Map<ManagedNodeEntryKey,​ManagedNodeEntry> getManagedNodeEntry()
        Return managedNodeEntry, or null if it is not present.
        Returns:
        Map<ManagedNodeEntryKey, ManagedNodeEntry> managedNodeEntry, or null if it is not present.
      • nonnullManagedNodeEntry

        default @NonNull Map<ManagedNodeEntryKey,​ManagedNodeEntry> nonnullManagedNodeEntry()
        Return managedNodeEntry, or an empty list if it is not present.
        Returns:
        Map<ManagedNodeEntryKey, ManagedNodeEntry> managedNodeEntry, or an empty list if it is not present.
      • getDatapathTypeEntry

        @Nullable Map<DatapathTypeEntryKey,​DatapathTypeEntry> getDatapathTypeEntry()
        Return datapathTypeEntry, or null if it is not present.
        Returns:
        Map<DatapathTypeEntryKey, DatapathTypeEntry> datapathTypeEntry, or null if it is not present.
      • nonnullDatapathTypeEntry

        default @NonNull Map<DatapathTypeEntryKey,​DatapathTypeEntry> nonnullDatapathTypeEntry()
        Return datapathTypeEntry, or an empty list if it is not present.
        Returns:
        Map<DatapathTypeEntryKey, DatapathTypeEntry> datapathTypeEntry, or an empty list if it is not present.
      • getInterfaceTypeEntry

        @Nullable Map<InterfaceTypeEntryKey,​InterfaceTypeEntry> getInterfaceTypeEntry()
        Return interfaceTypeEntry, or null if it is not present.
        Returns:
        Map<InterfaceTypeEntryKey, InterfaceTypeEntry> interfaceTypeEntry, or null if it is not present.
      • nonnullInterfaceTypeEntry

        default @NonNull Map<InterfaceTypeEntryKey,​InterfaceTypeEntry> nonnullInterfaceTypeEntry()
        Return interfaceTypeEntry, or an empty list if it is not present.
        Returns:
        Map<InterfaceTypeEntryKey, InterfaceTypeEntry> interfaceTypeEntry, or an empty list if it is not present.
      • getOpenvswitchExternalIds

        @Nullable Map<OpenvswitchExternalIdsKey,​OpenvswitchExternalIds> getOpenvswitchExternalIds()
        Return openvswitchExternalIds, or null if it is not present.
             
                 Key-value pairs for use by external frameworks that integrate with Open vSwitch.
                 external_ids : system-id: optional string A unique identifier for the Open
                 vSwitch's physical host. The form of the identifier depends on the type of the
                 host. On a Citrix XenServer, this will likely be the same as
                 external_ids:xs-system-uuid. external_ids : xs-system-uuid: optional string The
                 Citrix XenServer universally unique identifier for the physical host as
                 displayed by xe-host-list.
             
         
        Returns:
        Map<OpenvswitchExternalIdsKey, OpenvswitchExternalIds> openvswitchExternalIds, or null if it is not present.
      • nonnullOpenvswitchExternalIds

        default @NonNull Map<OpenvswitchExternalIdsKey,​OpenvswitchExternalIds> nonnullOpenvswitchExternalIds()
        Return openvswitchExternalIds, or an empty list if it is not present.
        Returns:
        Map<OpenvswitchExternalIdsKey, OpenvswitchExternalIds> openvswitchExternalIds, or an empty list if it is not present.
      • getOpenvswitchOtherConfigs

        @Nullable Map<OpenvswitchOtherConfigsKey,​OpenvswitchOtherConfigs> getOpenvswitchOtherConfigs()
        Return openvswitchOtherConfigs, or null if it is not present.
             
                 Key-value pairs for configuring rarely used features. other_config :
                 stats-update-interval: optional string This option will affect the update of the
                 statistics column in the following tables: Port, Interface , Mirror.
                 other_config : flow-restore-wait: optional string either true or false When
                 ovs-vswitchd starts up, it has an empty flow table and therefore it handles all
                 arriving packets in its default fashion according to its configuration, by
                 dropping them or sending them to an OpenFlow controller or switching them as a
                 standalone switch. other_config : flow-limit: optional string containing an
                 integer, at least 0. The maximum number of flows allowed in the datapath flow
                 table. other_config : n-dpdk-rxqs: optional string containing an integer, at
                 least 1 Specifies the number of rx queues to be created for each dpdk interface.
                 If not specified or specified to 0, one rx queue will be created for each dpdk
                 interface by default. other_config : pmd-cpu-mask: optional string Specifies CPU
                 mask for setting the cpu affinity of PMD (Poll Mode Driver) threads. Value
                 should be in the form of hex string, similar to the dpdk EAL '-c COREMASK'
                 option input or the 'taskset' mask input. other_config : n-handler-threads:
                 optional string containing an integer, at least 1 Specifies the number of
                 threads for software datapaths to use for handling new flows. The default the
                 number of online CPU cores minus the number of revalidators. other_config :
                 n-revalidator-threads: optional string, containing an integer, at least 1
                 Specifies the number of threads for software datapaths to use for revalidating
                 flows in the datapath. other_config : enable-statistics: optional string either
                 ture or false. Set this value to true to enable populating the statistics column
                 or to false to explicitly disable it.
             
         
        Returns:
        Map<OpenvswitchOtherConfigsKey, OpenvswitchOtherConfigs> openvswitchOtherConfigs, or null if it is not present.
      • nonnullOpenvswitchOtherConfigs

        default @NonNull Map<OpenvswitchOtherConfigsKey,​OpenvswitchOtherConfigs> nonnullOpenvswitchOtherConfigs()
        Return openvswitchOtherConfigs, or an empty list if it is not present.
        Returns:
        Map<OpenvswitchOtherConfigsKey, OpenvswitchOtherConfigs> openvswitchOtherConfigs, or an empty list if it is not present.
      • getManagerEntry

        @Nullable Map<ManagerEntryKey,​ManagerEntry> getManagerEntry()
        Return managerEntry, or null if it is not present.
             
                 Node managers info
             
         
        Returns:
        Map<ManagerEntryKey, ManagerEntry> managerEntry, or null if it is not present.
      • nonnullManagerEntry

        default @NonNull Map<ManagerEntryKey,​ManagerEntry> nonnullManagerEntry()
        Return managerEntry, or an empty list if it is not present.
        Returns:
        Map<ManagerEntryKey, ManagerEntry> managerEntry, or an empty list if it is not present.
      • getQosEntries

        @Nullable Map<QosEntriesKey,​QosEntries> getQosEntries()
        Return qosEntries, or null if it is not present.
        Returns:
        Map<QosEntriesKey, QosEntries> qosEntries, or null if it is not present.
      • nonnullQosEntries

        default @NonNull Map<QosEntriesKey,​QosEntries> nonnullQosEntries()
        Return qosEntries, or an empty list if it is not present.
        Returns:
        Map<QosEntriesKey, QosEntries> qosEntries, or an empty list if it is not present.
      • getQueues

        @Nullable Map<QueuesKey,​Queues> getQueues()
        Return queues, or null if it is not present.
        Returns:
        Map<QueuesKey, Queues> queues, or null if it is not present.
      • nonnullQueues

        default @NonNull Map<QueuesKey,​Queues> nonnullQueues()
        Return queues, or an empty list if it is not present.
        Returns:
        Map<QueuesKey, Queues> queues, or an empty list if it is not present.
      • getAutoattach

        @Nullable Map<AutoattachKey,​Autoattach> getAutoattach()
        Return autoattach, or null if it is not present.
        Returns:
        Map<AutoattachKey, Autoattach> autoattach, or null if it is not present.
      • nonnullAutoattach

        default @NonNull Map<AutoattachKey,​Autoattach> nonnullAutoattach()
        Return autoattach, or an empty list if it is not present.
        Returns:
        Map<AutoattachKey, Autoattach> autoattach, or an empty list if it is not present.