Blame libnmstate/schema.py

Packit b9ca78
#
Packit b9ca78
# Copyright (c) 2018-2020 Red Hat, Inc.
Packit b9ca78
#
Packit b9ca78
# This file is part of nmstate
Packit b9ca78
#
Packit b9ca78
# This program is free software: you can redistribute it and/or modify
Packit b9ca78
# it under the terms of the GNU Lesser General Public License as published by
Packit b9ca78
# the Free Software Foundation, either version 2.1 of the License, or
Packit b9ca78
# (at your option) any later version.
Packit b9ca78
#
Packit b9ca78
# This program is distributed in the hope that it will be useful,
Packit b9ca78
# but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit b9ca78
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit b9ca78
# GNU Lesser General Public License for more details.
Packit b9ca78
#
Packit b9ca78
# You should have received a copy of the GNU Lesser General Public License
Packit b9ca78
# along with this program. If not, see <https://www.gnu.org/licenses/>.
Packit b9ca78
#
Packit b9ca78
Packit b9ca78
import pkgutil
Packit b9ca78
import yaml
Packit b9ca78
Packit b9ca78
Packit b9ca78
def load(schema_name):
Packit b9ca78
    return yaml.load(
Packit b9ca78
        pkgutil.get_data("libnmstate", "schemas/" + schema_name + ".yaml"),
Packit b9ca78
        Loader=yaml.SafeLoader,
Packit b9ca78
    )
Packit b9ca78
Packit b9ca78
Packit b9ca78
ifaces_schema = load("operational-state")
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Interface:
Packit b9ca78
    KEY = "interfaces"
Packit b9ca78
Packit b9ca78
    NAME = "name"
Packit b9ca78
    TYPE = "type"
Packit b9ca78
    STATE = "state"
Packit b9ca78
    DESCRIPTION = "description"
Packit b9ca78
Packit b9ca78
    IPV4 = "ipv4"
Packit b9ca78
    IPV6 = "ipv6"
Packit b9ca78
Packit b9ca78
    MAC = "mac-address"
Packit b9ca78
    MTU = "mtu"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Route:
Packit b9ca78
    KEY = "routes"
Packit b9ca78
Packit b9ca78
    RUNNING = "running"
Packit b9ca78
    CONFIG = "config"
Packit b9ca78
    STATE = "state"
Packit b9ca78
    STATE_ABSENT = "absent"
Packit b9ca78
    TABLE_ID = "table-id"
Packit b9ca78
    DESTINATION = "destination"
Packit b9ca78
    NEXT_HOP_INTERFACE = "next-hop-interface"
Packit b9ca78
    NEXT_HOP_ADDRESS = "next-hop-address"
Packit b9ca78
    METRIC = "metric"
Packit b9ca78
    USE_DEFAULT_METRIC = -1
Packit b9ca78
    USE_DEFAULT_ROUTE_TABLE = 0
Packit b9ca78
Packit b9ca78
Packit b9ca78
class RouteRule:
Packit b9ca78
    KEY = "route-rules"
Packit b9ca78
    CONFIG = "config"
Packit b9ca78
    IP_FROM = "ip-from"
Packit b9ca78
    IP_TO = "ip-to"
Packit b9ca78
    PRIORITY = "priority"
Packit b9ca78
    ROUTE_TABLE = "route-table"
Packit b9ca78
    USE_DEFAULT_PRIORITY = -1
Packit b9ca78
    USE_DEFAULT_ROUTE_TABLE = 0
Packit b9ca78
Packit b9ca78
Packit b9ca78
class DNS:
Packit b9ca78
    KEY = "dns-resolver"
Packit b9ca78
    RUNNING = "running"
Packit b9ca78
    CONFIG = "config"
Packit b9ca78
    SERVER = "server"
Packit b9ca78
    SEARCH = "search"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Constants:
Packit b9ca78
    INTERFACES = Interface.KEY
Packit b9ca78
    ROUTES = Route.KEY
Packit b9ca78
    DNS = DNS.KEY
Packit b9ca78
Packit b9ca78
Packit b9ca78
class InterfaceState:
Packit b9ca78
    KEY = Interface.STATE
Packit b9ca78
Packit b9ca78
    DOWN = "down"
Packit b9ca78
    UP = "up"
Packit b9ca78
    ABSENT = "absent"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class InterfaceType:
Packit b9ca78
    KEY = Interface.TYPE
Packit b9ca78
Packit b9ca78
    BOND = "bond"
Packit b9ca78
    DUMMY = "dummy"
Packit b9ca78
    ETHERNET = "ethernet"
Packit b9ca78
    LINUX_BRIDGE = "linux-bridge"
Packit b9ca78
    OVS_BRIDGE = "ovs-bridge"
Packit b9ca78
    OVS_INTERFACE = "ovs-interface"
Packit b9ca78
    OVS_PORT = "ovs-port"
Packit b9ca78
    UNKNOWN = "unknown"
Packit b9ca78
    VLAN = "vlan"
Packit b9ca78
    VXLAN = "vxlan"
Packit b9ca78
    TEAM = "team"
Packit b9ca78
    OTHER = "other"
Packit b9ca78
Packit b9ca78
    VIRT_TYPES = (
Packit b9ca78
        BOND,
Packit b9ca78
        DUMMY,
Packit b9ca78
        LINUX_BRIDGE,
Packit b9ca78
        OVS_BRIDGE,
Packit b9ca78
        OVS_PORT,
Packit b9ca78
        OVS_INTERFACE,
Packit b9ca78
        TEAM,
Packit b9ca78
        VLAN,
Packit b9ca78
        VXLAN,
Packit b9ca78
    )
Packit b9ca78
Packit b9ca78
Packit b9ca78
class InterfaceIP:
Packit b9ca78
    ENABLED = "enabled"
Packit b9ca78
    ADDRESS = "address"
Packit b9ca78
    ADDRESS_IP = "ip"
Packit b9ca78
    ADDRESS_PREFIX_LENGTH = "prefix-length"
Packit b9ca78
    DHCP = "dhcp"
Packit b9ca78
    AUTO_DNS = "auto-dns"
Packit b9ca78
    AUTO_GATEWAY = "auto-gateway"
Packit b9ca78
    AUTO_ROUTES = "auto-routes"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class InterfaceIPv4(InterfaceIP):
Packit b9ca78
    pass
Packit b9ca78
Packit b9ca78
Packit b9ca78
class InterfaceIPv6(InterfaceIP):
Packit b9ca78
    AUTOCONF = "autoconf"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Bond:
Packit b9ca78
    KEY = InterfaceType.BOND
Packit b9ca78
    CONFIG_SUBTREE = "link-aggregation"
Packit b9ca78
Packit b9ca78
    MODE = "mode"
Packit b9ca78
    SLAVES = "slaves"
Packit b9ca78
    OPTIONS_SUBTREE = "options"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class BondMode:
Packit b9ca78
    ROUND_ROBIN = "balance-rr"
Packit b9ca78
    ACTIVE_BACKUP = "active-backup"
Packit b9ca78
    XOR = "balance-xor"
Packit b9ca78
    BROADCAST = "broadcast"
Packit b9ca78
    LACP = "802.3ad"
Packit b9ca78
    TLB = "balance-tlb"
Packit b9ca78
    ALB = "balance-alb"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Bridge:
Packit b9ca78
    CONFIG_SUBTREE = "bridge"
Packit b9ca78
    OPTIONS_SUBTREE = "options"
Packit b9ca78
    PORT_SUBTREE = "port"
Packit b9ca78
Packit b9ca78
    class Port:
Packit b9ca78
        NAME = "name"
Packit b9ca78
        VLAN_SUBTREE = "vlan"
Packit b9ca78
Packit b9ca78
        class Vlan:
Packit b9ca78
            ENABLE_NATIVE = "enable-native"
Packit b9ca78
            TRUNK_TAGS = "trunk-tags"
Packit b9ca78
            MODE = "mode"
Packit b9ca78
            TAG = "tag"
Packit b9ca78
Packit b9ca78
            class Mode:
Packit b9ca78
                ACCESS = "access"
Packit b9ca78
                TRUNK = "trunk"
Packit b9ca78
                UNKNOWN = "unknown"
Packit b9ca78
Packit b9ca78
            class TrunkTags:
Packit b9ca78
                ID = "id"
Packit b9ca78
                ID_RANGE = "id-range"
Packit b9ca78
                MIN_RANGE = "min"
Packit b9ca78
                MAX_RANGE = "max"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class LinuxBridge(Bridge):
Packit b9ca78
    TYPE = "linux-bridge"
Packit b9ca78
    STP_SUBTREE = "stp"
Packit b9ca78
    MULTICAST_SUBTREE = "multicast"
Packit b9ca78
Packit b9ca78
    class Options:
Packit b9ca78
        GROUP_FORWARD_MASK = "group-forward-mask"
Packit b9ca78
        MAC_AGEING_TIME = "mac-ageing-time"
Packit b9ca78
        MULTICAST_SNOOPING = "multicast-snooping"
Packit b9ca78
        GROUP_ADDR = "group-addr"
Packit b9ca78
        GROUP_FWD_MASK = "group-fwd-mask"
Packit b9ca78
        HASH_ELASTICITY = "hash-elasticity"
Packit b9ca78
        HASH_MAX = "hash-max"
Packit b9ca78
        MULTICAST_ROUTER = "multicast-router"
Packit b9ca78
        MULTICAST_LAST_MEMBER_COUNT = "multicast-last-member-count"
Packit b9ca78
        MULTICAST_LAST_MEMBER_INTERVAL = "multicast-last-member-interval"
Packit b9ca78
        MULTICAST_MEMBERSHIP_INTERVAL = "multicast-membership-interval"
Packit b9ca78
        MULTICAST_QUERIER = "multicast-querier"
Packit b9ca78
        MULTICAST_QUERIER_INTERVAL = "multicast-querier-interval"
Packit b9ca78
        MULTICAST_QUERY_USE_IFADDR = "multicast-query-use-ifaddr"
Packit b9ca78
        MULTICAST_QUERY_INTERVAL = "multicast-query-interval"
Packit b9ca78
        MULTICAST_QUERY_RESPONSE_INTERVAL = "multicast-query-response-interval"
Packit b9ca78
        MULTICAST_STARTUP_QUERY_COUNT = "multicast-startup-query-count"
Packit b9ca78
        MULTICAST_STARTUP_QUERY_INTERVAL = "multicast-startup-query-interval"
Packit b9ca78
Packit b9ca78
        # Read only properties begin
Packit b9ca78
        HELLO_TIMER = "hello-timer"
Packit b9ca78
        GC_TIMER = "gc-timer"
Packit b9ca78
        # Read only properties end
Packit b9ca78
Packit b9ca78
    class Port(Bridge.Port):
Packit b9ca78
        STP_HAIRPIN_MODE = "stp-hairpin-mode"
Packit b9ca78
        STP_PATH_COST = "stp-path-cost"
Packit b9ca78
        STP_PRIORITY = "stp-priority"
Packit b9ca78
Packit b9ca78
    class STP:
Packit b9ca78
        ENABLED = "enabled"
Packit b9ca78
        FORWARD_DELAY = "forward-delay"
Packit b9ca78
        HELLO_TIME = "hello-time"
Packit b9ca78
        MAX_AGE = "max-age"
Packit b9ca78
        PRIORITY = "priority"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Ethernet:
Packit b9ca78
    TYPE = InterfaceType.ETHERNET
Packit b9ca78
    CONFIG_SUBTREE = "ethernet"
Packit b9ca78
Packit b9ca78
    AUTO_NEGOTIATION = "auto-negotiation"
Packit b9ca78
    SPEED = "speed"
Packit b9ca78
    DUPLEX = "duplex"
Packit b9ca78
Packit b9ca78
    FULL_DUPLEX = "full"
Packit b9ca78
    HALF_DUPLEX = "half"
Packit b9ca78
Packit b9ca78
    SRIOV_SUBTREE = "sr-iov"
Packit b9ca78
Packit b9ca78
    class SRIOV:
Packit b9ca78
        TOTAL_VFS = "total-vfs"
Packit b9ca78
        VFS_SUBTREE = "vfs"
Packit b9ca78
Packit b9ca78
        class VFS:
Packit b9ca78
            ID = "id"
Packit b9ca78
            MAC_ADDRESS = "mac-address"
Packit b9ca78
            SPOOF_CHECK = "spoof-check"
Packit b9ca78
            TRUST = "trust"
Packit b9ca78
            MIN_TX_RATE = "min-tx-rate"
Packit b9ca78
            MAX_TX_RATE = "max-tx-rate"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class VLAN:
Packit b9ca78
    TYPE = InterfaceType.VLAN
Packit b9ca78
    CONFIG_SUBTREE = "vlan"
Packit b9ca78
Packit b9ca78
    ID = "id"
Packit b9ca78
    BASE_IFACE = "base-iface"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class VXLAN:
Packit b9ca78
    TYPE = InterfaceType.VXLAN
Packit b9ca78
    CONFIG_SUBTREE = "vxlan"
Packit b9ca78
Packit b9ca78
    ID = "id"
Packit b9ca78
    BASE_IFACE = "base-iface"
Packit b9ca78
    REMOTE = "remote"
Packit b9ca78
    DESTINATION_PORT = "destination-port"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class OvsDB:
Packit b9ca78
    OVS_DB_SUBTREE = "ovs-db"
Packit b9ca78
    # Don't use hypen as this is OVS data base entry
Packit b9ca78
    EXTERNAL_IDS = "external_ids"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class OVSInterface(OvsDB):
Packit b9ca78
    TYPE = InterfaceType.OVS_INTERFACE
Packit b9ca78
    PATCH_CONFIG_SUBTREE = "patch"
Packit b9ca78
Packit b9ca78
    class Patch:
Packit b9ca78
        PEER = "peer"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class OVSBridge(Bridge, OvsDB):
Packit b9ca78
    TYPE = "ovs-bridge"
Packit b9ca78
Packit b9ca78
    class Options:
Packit b9ca78
        FAIL_MODE = "fail-mode"
Packit b9ca78
        MCAST_SNOOPING_ENABLED = "mcast-snooping-enable"
Packit b9ca78
        RSTP = "rstp"
Packit b9ca78
        STP = "stp"
Packit b9ca78
Packit b9ca78
    class Port(Bridge.Port):
Packit b9ca78
        LINK_AGGREGATION_SUBTREE = "link-aggregation"
Packit b9ca78
Packit b9ca78
        class LinkAggregation:
Packit b9ca78
            MODE = "mode"
Packit b9ca78
            SLAVES_SUBTREE = "slaves"
Packit b9ca78
Packit b9ca78
            class Slave:
Packit b9ca78
                NAME = "name"
Packit b9ca78
Packit b9ca78
            class Options:
Packit b9ca78
                DOWN_DELAY = "bond-downdelay"
Packit b9ca78
                UP_DELAY = "bond-updelay"
Packit b9ca78
Packit b9ca78
            class Mode:
Packit b9ca78
                ACTIVE_BACKUP = "active-backup"
Packit b9ca78
                BALANCE_SLB = "balance-slb"
Packit b9ca78
                BALANCE_TCP = "balance-tcp"
Packit b9ca78
                LACP = "lacp"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class Team:
Packit b9ca78
    TYPE = InterfaceType.TEAM
Packit b9ca78
    CONFIG_SUBTREE = InterfaceType.TEAM
Packit b9ca78
Packit b9ca78
    PORT_SUBTREE = "ports"
Packit b9ca78
    RUNNER_SUBTREE = "runner"
Packit b9ca78
Packit b9ca78
    class Port:
Packit b9ca78
        NAME = "name"
Packit b9ca78
Packit b9ca78
    class Runner:
Packit b9ca78
        NAME = "name"
Packit b9ca78
Packit b9ca78
        class RunnerMode:
Packit b9ca78
            LOAD_BALANCE = "loadbalance"
Packit b9ca78
Packit b9ca78
Packit b9ca78
class LLDP:
Packit b9ca78
    CONFIG_SUBTREE = "lldp"
Packit b9ca78
    ENABLED = "enabled"
Packit b9ca78
    NEIGHBORS_SUBTREE = "neighbors"
Packit b9ca78
Packit b9ca78
    class Neighbors:
Packit b9ca78
        DESCRIPTION = "_description"
Packit b9ca78
        TLV_TYPE = "type"
Packit b9ca78
        TLV_SUBTYPE = "subtype"
Packit b9ca78
        ORGANIZATION_CODE = "oui"