Skip to content

Commit

Permalink
Deprecate API document in favor of YAML API document
Browse files Browse the repository at this point in the history 
The devel/api.md is unmantained, user should use YAML API document
instead.

Signed-off-by: Gris Ge <[email protected]>
  • Loading branch information
@cathay4t
cathay4t committed Jun 18, 2024
1 parent 6a4da7c commit cab3e5d
Showing 1 changed file with 1 addition and 195 deletions.
196 changes: 1 addition & 195 deletions devel/api.md
View file
Original file line number Diff line number Diff line change
@@ -1,198 +1,4 @@
<!-- vim-markdown-toc GFM -->

* [Introduction](#introduction)
* [Query network state](#query-network-state)
* [Apply network state](#apply-network-state)
* [Change Network State with Manual Transaction Control](#change-network-state-with-manual-transaction-control)
* [Error handling](#error-handling)
* [NmstateError](#nmstateerror)
* [NmstateDependencyError](#nmstatedependencyerror)
* [NmstateValueError](#nmstatevalueerror)
* [NmstatePermissionError](#nmstatepermissionerror)
* [NmstateConflictError](#nmstateconflicterror)
* [NmstateLibnmError](#nmstatelibnmerror)
* [NmstateVerificationError](#nmstateverificationerror)
* [NmstateNotImplementedError](#nmstatenotimplementederror)
* [NmstateInternalError](#nmstateinternalerror)
* [NmstateNotSupportedError](#nmstatenotsupportederror)
* [NmstateTimeoutError](#nmstatetimeouterror)
* [NmstatePluginError](#nmstatepluginerror)
* [Schema](#schema)
* [Network State Main layout](#network-state-main-layout)
* [Basic Interface](#basic-interface)
* [Basic Interface: Example](#basic-interface-example)
* [`Interface.NAME`](#interfacename)
* [`Interface.TYPE`](#interfacetype)
* [`Interface.STATE`](#interfacestate)
* [`Interface.MTU`](#interfacemtu)
* [`Interface.MIN_MTU`](#interfacemin_mtu)
* [`Interface.MAX_MTU`](#interfacemax_mtu)
* [`Interface.MAC`](#interfacemac)
* [`Interface.COPY_MAC_FROM`](#interfacecopy_mac_from)
* [`Interface.DESCRIPTION`](#interfacedescription)
* [`InterfaceIP`](#interfaceip)
* [`Interface.IPV4`](#interfaceipv4)
* [`InterfaceIPv4.ENABLED`](#interfaceipv4enabled)
* [`InterfaceIPv4.DHCP`](#interfaceipv4dhcp)
* [`InterfaceIPv4.AUTO_ROUTES`](#interfaceipv4auto_routes)
* [`InterfaceIPv4.AUTO_GATEWAY`](#interfaceipv4auto_gateway)
* [`InterfaceIPv4.AUTO_DNS`](#interfaceipv4auto_dns)
* [`InterfaceIPv4.AUTO_ROUTE_TABLE_ID`](#interfaceipv4auto_route_table_id)
* [`InterfaceIPv4.AUTO_ROUTE_METRIC`](#interfaceipv4auto_route_metric)
* [`InterfaceIPv4.ADDRESS`](#interfaceipv4address)
* [`InterfaceIPv4.ADDRESS_IP`](#interfaceipv4address_ip)
* [`InterfaceIPv4.ADDRESS_PREFIX_LENGTH`](#interfaceipv4address_prefix_length)
* [`Interface.IPV6`](#interfaceipv6)
* [`InterfaceIPv6.ENABLED`](#interfaceipv6enabled)
* [`InterfaceIPv6.DHCP`](#interfaceipv6dhcp)
* [`InterfaceIPv6.AUTOCONF`](#interfaceipv6autoconf)
* [`InterfaceIPv6.AUTO_ROUTES`](#interfaceipv6auto_routes)
* [`InterfaceIPv6.AUTO_GATEWAY`](#interfaceipv6auto_gateway)
* [`InterfaceIPv6.AUTO_DNS`](#interfaceipv6auto_dns)
* [`InterfaceIPv6.AUTO_ROUTE_TABLE_ID`](#interfaceipv6auto_route_table_id)
* [`InterfaceIPv6.AUTO_ROUTE_METRIC`](#interfaceipv6auto_route_metric)
* [`InterfaceIPv6.ADDRESS`](#interfaceipv6address)
* [`InterfaceIPv6.ADDRESS_IP`](#interfaceipv6address_ip)
* [`InterfaceIPv6.ADDRESS_PREFIX_LENGTH`](#interfaceipv6address_prefix_length)
* [Ethernet](#ethernet)
* [`Interface.ACCEPT_ALL_MAC_ADDRESSES`](#interfaceaccept_all_mac_addresses)
* [`Interface.WAIT_IP`](#interfacewait_ip)
* [`Interface.CONTROLLER`](#interfacecontroller)
* [`Interface.PROFILE_NAME`](#interfaceprofile_name)
* [`Interface.IDENTIFIER`](#interfaceidentifier)
* [`Ethernet.AUTO_NEGOTIATION`](#ethernetauto_negotiation)
* [`Ethernet.DUPLEX`](#ethernetduplex)
* [`Ethernet.SPEED`](#ethernetspeed)
* [`Ethernet.SRIOV_SUBTREE`](#ethernetsriov_subtree)
* [Limitations of SR-IOV configuration](#limitations-of-sr-iov-configuration)
* [`Ethernet.SRIOV.TOTAL_VFS`](#ethernetsriovtotal_vfs)
* [`Ethernet.SRIOV.VFS_SUBTREE`](#ethernetsriovvfs_subtree)
* [`Ethernet.SRIOV.VFS.ID`](#ethernetsriovvfsid)
* [`Ethernet.SRIOV.VFS.MAC_ADDRESS`](#ethernetsriovvfsmac_address)
* [`Ethernet.SRIOV.VFS.SPOOF_CHECK`](#ethernetsriovvfsspoof_check)
* [`Ethernet.SRIOV.VFS.TRUST`](#ethernetsriovvfstrust)
* [`Ethernet.SRIOV.VFS.MIN_TX_RATE`](#ethernetsriovvfsmin_tx_rate)
* [`Ethernet.SRIOV.VFS.VLAN_ID`](#ethernetsriovvfsvlan_id)
* [`Ethernet.SRIOV.VFS.QOS`](#ethernetsriovvfsqos)
* [VLAN](#vlan)
* [`VLAN.ID`](#vlanid)
* [`VLAN.BASE_IFACE`](#vlanbase_iface)
* [VXLAN](#vxlan)
* [`VXLAN.ID`](#vxlanid)
* [`VXLAN.BASE_IFACE`](#vxlanbase_iface)
* [`VXLAN.REMOTE`](#vxlanremote)
* [`VXLAN.DESTINATION_PORT`](#vxlandestination_port)
* [`VXLAN.LOCAL`](#vxlanlocal)
* [`VXLAN.LEARNING`](#vxlanlearning)
* [Linux Bridge](#linux-bridge)
* [Limitations of Linux Bridge Interface](#limitations-of-linux-bridge-interface)
* [`LinuxBridge.Options.GROUP_FORWARD_MASK`](#linuxbridgeoptionsgroup_forward_mask)
* [`LinuxBridge.Options.MAC_AGEING_TIME`](#linuxbridgeoptionsmac_ageing_time)
* [`LinuxBridge.Options.MULTICAST_SNOOPING`](#linuxbridgeoptionsmulticast_snooping)
* [`LinuxBridge.Options.GROUP_ADDR`](#linuxbridgeoptionsgroup_addr)
* [`LinuxBridge.Options.GROUP_FWD_MASK`](#linuxbridgeoptionsgroup_fwd_mask)
* [`LinuxBridge.Options.HASH_ELASTICITY`](#linuxbridgeoptionshash_elasticity)
* [`LinuxBridge.Options.HASH_MAX`](#linuxbridgeoptionshash_max)
* [`LinuxBridge.Options.MULTICAST_ROUTER`](#linuxbridgeoptionsmulticast_router)
* [`LinuxBridge.Options.MULTICAST_LAST_MEMBER_COUNT`](#linuxbridgeoptionsmulticast_last_member_count)
* [`LinuxBridge.Options.MULTICAST_LAST_MEMBER_INTERVAL`](#linuxbridgeoptionsmulticast_last_member_interval)
* [`LinuxBridge.Options.MULTICAST_MEMBERSHIP_INTERVAL`](#linuxbridgeoptionsmulticast_membership_interval)
* [`LinuxBridge.Options.MULTICAST_QUERIER`](#linuxbridgeoptionsmulticast_querier)
* [`LinuxBridge.Options.MULTICAST_QUERIER_INTERVAL`](#linuxbridgeoptionsmulticast_querier_interval)
* [`LinuxBridge.Options.MULTICAST_QUERY_USE_IFADDR`](#linuxbridgeoptionsmulticast_query_use_ifaddr)
* [`LinuxBridge.Options.MULTICAST_QUERY_INTERVAL`](#linuxbridgeoptionsmulticast_query_interval)
* [`LinuxBridge.Options.MULTICAST_QUERY_RESPONSE_INTERVAL`](#linuxbridgeoptionsmulticast_query_response_interval)
* [`LinuxBridge.Options.MULTICAST_STARTUP_QUERY_COUNT`](#linuxbridgeoptionsmulticast_startup_query_count)
* [`LinuxBridge.Options.MULTICAST_STARTUP_QUERY_INTERVAL`](#linuxbridgeoptionsmulticast_startup_query_interval)
* [`LinuxBridge.Options.VLAN_DEFAULT_PVID`](#linuxbridgeoptionsvlan_default_pvid)
* [`LinuxBridge.STP.ENABLED`](#linuxbridgestpenabled)
* [`LinuxBridge.STP.FORWARD_DELAY`](#linuxbridgestpforward_delay)
* [`LinuxBridge.STP.HELLO_TIME`](#linuxbridgestphello_time)
* [`LinuxBridge.STP.MAX_AGE`](#linuxbridgestpmax_age)
* [`LinuxBridge.STP.PRIORITY`](#linuxbridgestppriority)
* [`LinuxBridge.Port.SUBTREE`](#linuxbridgeportsubtree)
* [`LinuxBridge.Port.NAME`](#linuxbridgeportname)
* [`LinuxBridge.Port.STP_PRIORITY`](#linuxbridgeportstp_priority)
* [`LinuxBridge.Port.STP_HAIRPIN_MODE`](#linuxbridgeportstp_hairpin_mode)
* [`LinuxBridge.Port.STP_PATH_COST`](#linuxbridgeportstp_path_cost)
* [`LinuxBridge.Port.VLAN_SUBTREE`](#linuxbridgeportvlan_subtree)
* [`LinuxBridge.Port.Vlan.MODE`](#linuxbridgeportvlanmode)
* [`LinuxBridge.Port.Vlan.ENABLE_NATIVE`](#linuxbridgeportvlanenable_native)
* [`LinuxBridge.Port.Vlan.TAG`](#linuxbridgeportvlantag)
* [`LinuxBridge.Port.Vlan.TRUNK_TAGS`](#linuxbridgeportvlantrunk_tags)
* [Interface - Bond](#interface---bond)
* [`Bond.MODE`](#bondmode)
* [`Bond.OPTIONS_SUBTREE`](#bondoptions_subtree)
* [`Bond.PORT`](#bondport)
* [Interface - Open vSwitch(OVS) Bridge](#interface---open-vswitchovs-bridge)
* [Limitations of OpenvSwitch Interfaces](#limitations-of-openvswitch-interfaces)
* [`OVSBridge.Options.FAIL_MODE`](#ovsbridgeoptionsfail_mode)
* [`OVSBridge.Options.MCAST_SNOOPING_ENABLE`](#ovsbridgeoptionsmcast_snooping_enable)
* [`OVSBridge.Options.RSTP`](#ovsbridgeoptionsrstp)
* [`OVSBridge.Options.STP`](#ovsbridgeoptionsstp)
* [`OVSBridge.PORT_SUBTREE`](#ovsbridgeport_subtree)
* [`OVSBridge.Port.NAME`](#ovsbridgeportname)
* [Interface - Open vSwitch(OVS) Internal](#interface---open-vswitchovs-internal)
* [`OVSInterface.Patch.PEER`](#ovsinterfacepatchpeer)
* [MAC VTAP](#mac-vtap)
* [`MacVtap.BASE_IFACE`](#macvtapbase_iface)
* [`MacVtap.MODE`](#macvtapmode)
* [`MacVtap.PROMISCUOUS`](#macvtappromiscuous)
* [MAC VLAN](#mac-vlan)
* [`MacVlan.BASE_IFACE`](#macvlanbase_iface)
* [`MacVlan.MODE`](#macvlanmode)
* [`MacVlan.PROMISCUOUS`](#macvlanpromiscuous)
* [IP over InfiniBand(IPoIB)](#ip-over-infinibandipoib)
* [`InfiniBand.BASE_IFACE`](#infinibandbase_iface)
* [`InfiniBand.MODE`](#infinibandmode)
* [`InfiniBand.PKEY`](#infinibandpkey)
* [Virtual Routing and Forwarding (VRF)](#virtual-routing-and-forwarding-vrf)
* [`VRF.ROUTE_TABLE_ID`](#vrfroute_table_id)
* [`VRF.PORT_SUBTREE`](#vrfport_subtree)
* [Team](#team)
* [Limitations of Team interface](#limitations-of-team-interface)
* [`Team.Port.NAME`](#teamportname)
* [`Team.Runner.NAME`](#teamrunnername)
* [Linux Virtual Ethernet(veth)](#linux-virtual-ethernetveth)
* [`Veth.CONFIG_SUBTREE`](#vethconfig_subtree)
* [`Veth.PEER`](#vethpeer)
* [LLDP](#lldp)
* [`LLDP.CONFIG_SUBTREE`](#lldpconfig_subtree)
* [`LLDP.ENABLED`](#lldpenabled)
* [`LLDP.NEIGHBORS_SUBTREE`](#lldpneighbors_subtree)
* [`LLDP.Nieghbors.DESCRIPTION`](#lldpnieghborsdescription)
* [`LLDP.Neighbors.TLV_TYPE`](#lldpneighborstlv_type)
* [`LLDP.Neighbors.TLV_SUBTYPE`](#lldpneighborstlv_subtype)
* [`LLDP.Neighbors.ORGANIZATION_CODE`](#lldpneighborsorganization_code)
* [Route](#route)
* [`Route.TABLE_ID`](#routetable_id)
* [`Route.DESTINATION`](#routedestination)
* [`Route.NEXT_HOP_INTERFACE`](#routenext_hop_interface)
* [`Route.NEXT_HOP_ADDRESS`](#routenext_hop_address)
* [`Route.METRIC`](#routemetric)
* [`Route.WEIGHT`](#routeweight)
* [Route Rule](#route-rule)
* [`RouteRule.CONFIG`](#routeruleconfig)
* [`RouteRule.IP_FROM`](#routeruleip_from)
* [`RouteRule.IP_TO`](#routeruleip_to)
* [`RouteRule.PRIORITY`](#routerulepriority)
* [`RouteRule.ROUTE_TABLE`](#routeruleroute_table)
* [`RouteRule.USE_DEFAULT_PRIORITY`](#routeruleuse_default_priority)
* [`RouteRule.USE_DEFAULT_ROUTE_TABLE`](#routeruleuse_default_route_table)
* [`RouteRule.FWMARK`](#routerulefwmark)
* [`RouteRule.FWMASK`](#routerulefwmask)
* [`RouteRule.FAMILY`](#routerulefamily)
* [`RouteRule.FAMILY_IPV4`](#routerulefamily_ipv4)
* [`RouteRule.FAMILY_IPV6`](#routerulefamily_ipv6)
* [`RouteRule.IIF`](#routeruleiif)
* [`RouteRule.ACTION`](#routeruleaction)
* [DNS client configuration](#dns-client-configuration)
* [Limitations of static DNS configuration](#limitations-of-static-dns-configuration)
* [`DNS.SEARCH`](#dnssearch)
* [`DNS.SERVER`](#dnsserver)
* [Multipath TCP](#multipath-tcp)

<!-- vim-markdown-toc -->
**This document is not maintained anymore, please use [YAML API document][yaml_api_doc]**

# Introduction

Expand Down

0 comments on commit cab3e5d

Please sign in to comment.