Skip to content

Commit cab3e5d

Browse files
cathay4tcathay4t
committed
Deprecate API document in favor of YAML API document
The devel/api.md is unmantained, user should use YAML API document instead. Signed-off-by: Gris Ge <[email protected]>
1 parent 6a4da7c commit cab3e5d

File tree

1 file changed

+1
-195
lines changed

1 file changed

+1
-195
lines changed

‎devel/api.md

Lines changed: 1 addition & 195 deletions
Original file line numberDiff line numberDiff line change
@@ -1,198 +1,4 @@
1-
<!-- vim-markdown-toc GFM -->
2-
3-
* [Introduction](#introduction)
4-
* [Query network state](#query-network-state)
5-
* [Apply network state](#apply-network-state)
6-
* [Change Network State with Manual Transaction Control](#change-network-state-with-manual-transaction-control)
7-
* [Error handling](#error-handling)
8-
* [NmstateError](#nmstateerror)
9-
* [NmstateDependencyError](#nmstatedependencyerror)
10-
* [NmstateValueError](#nmstatevalueerror)
11-
* [NmstatePermissionError](#nmstatepermissionerror)
12-
* [NmstateConflictError](#nmstateconflicterror)
13-
* [NmstateLibnmError](#nmstatelibnmerror)
14-
* [NmstateVerificationError](#nmstateverificationerror)
15-
* [NmstateNotImplementedError](#nmstatenotimplementederror)
16-
* [NmstateInternalError](#nmstateinternalerror)
17-
* [NmstateNotSupportedError](#nmstatenotsupportederror)
18-
* [NmstateTimeoutError](#nmstatetimeouterror)
19-
* [NmstatePluginError](#nmstatepluginerror)
20-
* [Schema](#schema)
21-
* [Network State Main layout](#network-state-main-layout)
22-
* [Basic Interface](#basic-interface)
23-
* [Basic Interface: Example](#basic-interface-example)
24-
* [`Interface.NAME`](#interfacename)
25-
* [`Interface.TYPE`](#interfacetype)
26-
* [`Interface.STATE`](#interfacestate)
27-
* [`Interface.MTU`](#interfacemtu)
28-
* [`Interface.MIN_MTU`](#interfacemin_mtu)
29-
* [`Interface.MAX_MTU`](#interfacemax_mtu)
30-
* [`Interface.MAC`](#interfacemac)
31-
* [`Interface.COPY_MAC_FROM`](#interfacecopy_mac_from)
32-
* [`Interface.DESCRIPTION`](#interfacedescription)
33-
* [`InterfaceIP`](#interfaceip)
34-
* [`Interface.IPV4`](#interfaceipv4)
35-
* [`InterfaceIPv4.ENABLED`](#interfaceipv4enabled)
36-
* [`InterfaceIPv4.DHCP`](#interfaceipv4dhcp)
37-
* [`InterfaceIPv4.AUTO_ROUTES`](#interfaceipv4auto_routes)
38-
* [`InterfaceIPv4.AUTO_GATEWAY`](#interfaceipv4auto_gateway)
39-
* [`InterfaceIPv4.AUTO_DNS`](#interfaceipv4auto_dns)
40-
* [`InterfaceIPv4.AUTO_ROUTE_TABLE_ID`](#interfaceipv4auto_route_table_id)
41-
* [`InterfaceIPv4.AUTO_ROUTE_METRIC`](#interfaceipv4auto_route_metric)
42-
* [`InterfaceIPv4.ADDRESS`](#interfaceipv4address)
43-
* [`InterfaceIPv4.ADDRESS_IP`](#interfaceipv4address_ip)
44-
* [`InterfaceIPv4.ADDRESS_PREFIX_LENGTH`](#interfaceipv4address_prefix_length)
45-
* [`Interface.IPV6`](#interfaceipv6)
46-
* [`InterfaceIPv6.ENABLED`](#interfaceipv6enabled)
47-
* [`InterfaceIPv6.DHCP`](#interfaceipv6dhcp)
48-
* [`InterfaceIPv6.AUTOCONF`](#interfaceipv6autoconf)
49-
* [`InterfaceIPv6.AUTO_ROUTES`](#interfaceipv6auto_routes)
50-
* [`InterfaceIPv6.AUTO_GATEWAY`](#interfaceipv6auto_gateway)
51-
* [`InterfaceIPv6.AUTO_DNS`](#interfaceipv6auto_dns)
52-
* [`InterfaceIPv6.AUTO_ROUTE_TABLE_ID`](#interfaceipv6auto_route_table_id)
53-
* [`InterfaceIPv6.AUTO_ROUTE_METRIC`](#interfaceipv6auto_route_metric)
54-
* [`InterfaceIPv6.ADDRESS`](#interfaceipv6address)
55-
* [`InterfaceIPv6.ADDRESS_IP`](#interfaceipv6address_ip)
56-
* [`InterfaceIPv6.ADDRESS_PREFIX_LENGTH`](#interfaceipv6address_prefix_length)
57-
* [Ethernet](#ethernet)
58-
* [`Interface.ACCEPT_ALL_MAC_ADDRESSES`](#interfaceaccept_all_mac_addresses)
59-
* [`Interface.WAIT_IP`](#interfacewait_ip)
60-
* [`Interface.CONTROLLER`](#interfacecontroller)
61-
* [`Interface.PROFILE_NAME`](#interfaceprofile_name)
62-
* [`Interface.IDENTIFIER`](#interfaceidentifier)
63-
* [`Ethernet.AUTO_NEGOTIATION`](#ethernetauto_negotiation)
64-
* [`Ethernet.DUPLEX`](#ethernetduplex)
65-
* [`Ethernet.SPEED`](#ethernetspeed)
66-
* [`Ethernet.SRIOV_SUBTREE`](#ethernetsriov_subtree)
67-
* [Limitations of SR-IOV configuration](#limitations-of-sr-iov-configuration)
68-
* [`Ethernet.SRIOV.TOTAL_VFS`](#ethernetsriovtotal_vfs)
69-
* [`Ethernet.SRIOV.VFS_SUBTREE`](#ethernetsriovvfs_subtree)
70-
* [`Ethernet.SRIOV.VFS.ID`](#ethernetsriovvfsid)
71-
* [`Ethernet.SRIOV.VFS.MAC_ADDRESS`](#ethernetsriovvfsmac_address)
72-
* [`Ethernet.SRIOV.VFS.SPOOF_CHECK`](#ethernetsriovvfsspoof_check)
73-
* [`Ethernet.SRIOV.VFS.TRUST`](#ethernetsriovvfstrust)
74-
* [`Ethernet.SRIOV.VFS.MIN_TX_RATE`](#ethernetsriovvfsmin_tx_rate)
75-
* [`Ethernet.SRIOV.VFS.VLAN_ID`](#ethernetsriovvfsvlan_id)
76-
* [`Ethernet.SRIOV.VFS.QOS`](#ethernetsriovvfsqos)
77-
* [VLAN](#vlan)
78-
* [`VLAN.ID`](#vlanid)
79-
* [`VLAN.BASE_IFACE`](#vlanbase_iface)
80-
* [VXLAN](#vxlan)
81-
* [`VXLAN.ID`](#vxlanid)
82-
* [`VXLAN.BASE_IFACE`](#vxlanbase_iface)
83-
* [`VXLAN.REMOTE`](#vxlanremote)
84-
* [`VXLAN.DESTINATION_PORT`](#vxlandestination_port)
85-
* [`VXLAN.LOCAL`](#vxlanlocal)
86-
* [`VXLAN.LEARNING`](#vxlanlearning)
87-
* [Linux Bridge](#linux-bridge)
88-
* [Limitations of Linux Bridge Interface](#limitations-of-linux-bridge-interface)
89-
* [`LinuxBridge.Options.GROUP_FORWARD_MASK`](#linuxbridgeoptionsgroup_forward_mask)
90-
* [`LinuxBridge.Options.MAC_AGEING_TIME`](#linuxbridgeoptionsmac_ageing_time)
91-
* [`LinuxBridge.Options.MULTICAST_SNOOPING`](#linuxbridgeoptionsmulticast_snooping)
92-
* [`LinuxBridge.Options.GROUP_ADDR`](#linuxbridgeoptionsgroup_addr)
93-
* [`LinuxBridge.Options.GROUP_FWD_MASK`](#linuxbridgeoptionsgroup_fwd_mask)
94-
* [`LinuxBridge.Options.HASH_ELASTICITY`](#linuxbridgeoptionshash_elasticity)
95-
* [`LinuxBridge.Options.HASH_MAX`](#linuxbridgeoptionshash_max)
96-
* [`LinuxBridge.Options.MULTICAST_ROUTER`](#linuxbridgeoptionsmulticast_router)
97-
* [`LinuxBridge.Options.MULTICAST_LAST_MEMBER_COUNT`](#linuxbridgeoptionsmulticast_last_member_count)
98-
* [`LinuxBridge.Options.MULTICAST_LAST_MEMBER_INTERVAL`](#linuxbridgeoptionsmulticast_last_member_interval)
99-
* [`LinuxBridge.Options.MULTICAST_MEMBERSHIP_INTERVAL`](#linuxbridgeoptionsmulticast_membership_interval)
100-
* [`LinuxBridge.Options.MULTICAST_QUERIER`](#linuxbridgeoptionsmulticast_querier)
101-
* [`LinuxBridge.Options.MULTICAST_QUERIER_INTERVAL`](#linuxbridgeoptionsmulticast_querier_interval)
102-
* [`LinuxBridge.Options.MULTICAST_QUERY_USE_IFADDR`](#linuxbridgeoptionsmulticast_query_use_ifaddr)
103-
* [`LinuxBridge.Options.MULTICAST_QUERY_INTERVAL`](#linuxbridgeoptionsmulticast_query_interval)
104-
* [`LinuxBridge.Options.MULTICAST_QUERY_RESPONSE_INTERVAL`](#linuxbridgeoptionsmulticast_query_response_interval)
105-
* [`LinuxBridge.Options.MULTICAST_STARTUP_QUERY_COUNT`](#linuxbridgeoptionsmulticast_startup_query_count)
106-
* [`LinuxBridge.Options.MULTICAST_STARTUP_QUERY_INTERVAL`](#linuxbridgeoptionsmulticast_startup_query_interval)
107-
* [`LinuxBridge.Options.VLAN_DEFAULT_PVID`](#linuxbridgeoptionsvlan_default_pvid)
108-
* [`LinuxBridge.STP.ENABLED`](#linuxbridgestpenabled)
109-
* [`LinuxBridge.STP.FORWARD_DELAY`](#linuxbridgestpforward_delay)
110-
* [`LinuxBridge.STP.HELLO_TIME`](#linuxbridgestphello_time)
111-
* [`LinuxBridge.STP.MAX_AGE`](#linuxbridgestpmax_age)
112-
* [`LinuxBridge.STP.PRIORITY`](#linuxbridgestppriority)
113-
* [`LinuxBridge.Port.SUBTREE`](#linuxbridgeportsubtree)
114-
* [`LinuxBridge.Port.NAME`](#linuxbridgeportname)
115-
* [`LinuxBridge.Port.STP_PRIORITY`](#linuxbridgeportstp_priority)
116-
* [`LinuxBridge.Port.STP_HAIRPIN_MODE`](#linuxbridgeportstp_hairpin_mode)
117-
* [`LinuxBridge.Port.STP_PATH_COST`](#linuxbridgeportstp_path_cost)
118-
* [`LinuxBridge.Port.VLAN_SUBTREE`](#linuxbridgeportvlan_subtree)
119-
* [`LinuxBridge.Port.Vlan.MODE`](#linuxbridgeportvlanmode)
120-
* [`LinuxBridge.Port.Vlan.ENABLE_NATIVE`](#linuxbridgeportvlanenable_native)
121-
* [`LinuxBridge.Port.Vlan.TAG`](#linuxbridgeportvlantag)
122-
* [`LinuxBridge.Port.Vlan.TRUNK_TAGS`](#linuxbridgeportvlantrunk_tags)
123-
* [Interface - Bond](#interface---bond)
124-
* [`Bond.MODE`](#bondmode)
125-
* [`Bond.OPTIONS_SUBTREE`](#bondoptions_subtree)
126-
* [`Bond.PORT`](#bondport)
127-
* [Interface - Open vSwitch(OVS) Bridge](#interface---open-vswitchovs-bridge)
128-
* [Limitations of OpenvSwitch Interfaces](#limitations-of-openvswitch-interfaces)
129-
* [`OVSBridge.Options.FAIL_MODE`](#ovsbridgeoptionsfail_mode)
130-
* [`OVSBridge.Options.MCAST_SNOOPING_ENABLE`](#ovsbridgeoptionsmcast_snooping_enable)
131-
* [`OVSBridge.Options.RSTP`](#ovsbridgeoptionsrstp)
132-
* [`OVSBridge.Options.STP`](#ovsbridgeoptionsstp)
133-
* [`OVSBridge.PORT_SUBTREE`](#ovsbridgeport_subtree)
134-
* [`OVSBridge.Port.NAME`](#ovsbridgeportname)
135-
* [Interface - Open vSwitch(OVS) Internal](#interface---open-vswitchovs-internal)
136-
* [`OVSInterface.Patch.PEER`](#ovsinterfacepatchpeer)
137-
* [MAC VTAP](#mac-vtap)
138-
* [`MacVtap.BASE_IFACE`](#macvtapbase_iface)
139-
* [`MacVtap.MODE`](#macvtapmode)
140-
* [`MacVtap.PROMISCUOUS`](#macvtappromiscuous)
141-
* [MAC VLAN](#mac-vlan)
142-
* [`MacVlan.BASE_IFACE`](#macvlanbase_iface)
143-
* [`MacVlan.MODE`](#macvlanmode)
144-
* [`MacVlan.PROMISCUOUS`](#macvlanpromiscuous)
145-
* [IP over InfiniBand(IPoIB)](#ip-over-infinibandipoib)
146-
* [`InfiniBand.BASE_IFACE`](#infinibandbase_iface)
147-
* [`InfiniBand.MODE`](#infinibandmode)
148-
* [`InfiniBand.PKEY`](#infinibandpkey)
149-
* [Virtual Routing and Forwarding (VRF)](#virtual-routing-and-forwarding-vrf)
150-
* [`VRF.ROUTE_TABLE_ID`](#vrfroute_table_id)
151-
* [`VRF.PORT_SUBTREE`](#vrfport_subtree)
152-
* [Team](#team)
153-
* [Limitations of Team interface](#limitations-of-team-interface)
154-
* [`Team.Port.NAME`](#teamportname)
155-
* [`Team.Runner.NAME`](#teamrunnername)
156-
* [Linux Virtual Ethernet(veth)](#linux-virtual-ethernetveth)
157-
* [`Veth.CONFIG_SUBTREE`](#vethconfig_subtree)
158-
* [`Veth.PEER`](#vethpeer)
159-
* [LLDP](#lldp)
160-
* [`LLDP.CONFIG_SUBTREE`](#lldpconfig_subtree)
161-
* [`LLDP.ENABLED`](#lldpenabled)
162-
* [`LLDP.NEIGHBORS_SUBTREE`](#lldpneighbors_subtree)
163-
* [`LLDP.Nieghbors.DESCRIPTION`](#lldpnieghborsdescription)
164-
* [`LLDP.Neighbors.TLV_TYPE`](#lldpneighborstlv_type)
165-
* [`LLDP.Neighbors.TLV_SUBTYPE`](#lldpneighborstlv_subtype)
166-
* [`LLDP.Neighbors.ORGANIZATION_CODE`](#lldpneighborsorganization_code)
167-
* [Route](#route)
168-
* [`Route.TABLE_ID`](#routetable_id)
169-
* [`Route.DESTINATION`](#routedestination)
170-
* [`Route.NEXT_HOP_INTERFACE`](#routenext_hop_interface)
171-
* [`Route.NEXT_HOP_ADDRESS`](#routenext_hop_address)
172-
* [`Route.METRIC`](#routemetric)
173-
* [`Route.WEIGHT`](#routeweight)
174-
* [Route Rule](#route-rule)
175-
* [`RouteRule.CONFIG`](#routeruleconfig)
176-
* [`RouteRule.IP_FROM`](#routeruleip_from)
177-
* [`RouteRule.IP_TO`](#routeruleip_to)
178-
* [`RouteRule.PRIORITY`](#routerulepriority)
179-
* [`RouteRule.ROUTE_TABLE`](#routeruleroute_table)
180-
* [`RouteRule.USE_DEFAULT_PRIORITY`](#routeruleuse_default_priority)
181-
* [`RouteRule.USE_DEFAULT_ROUTE_TABLE`](#routeruleuse_default_route_table)
182-
* [`RouteRule.FWMARK`](#routerulefwmark)
183-
* [`RouteRule.FWMASK`](#routerulefwmask)
184-
* [`RouteRule.FAMILY`](#routerulefamily)
185-
* [`RouteRule.FAMILY_IPV4`](#routerulefamily_ipv4)
186-
* [`RouteRule.FAMILY_IPV6`](#routerulefamily_ipv6)
187-
* [`RouteRule.IIF`](#routeruleiif)
188-
* [`RouteRule.ACTION`](#routeruleaction)
189-
* [DNS client configuration](#dns-client-configuration)
190-
* [Limitations of static DNS configuration](#limitations-of-static-dns-configuration)
191-
* [`DNS.SEARCH`](#dnssearch)
192-
* [`DNS.SERVER`](#dnsserver)
193-
* [Multipath TCP](#multipath-tcp)
194-
195-
<!-- vim-markdown-toc -->
1+
**This document is not maintained anymore, please use [YAML API document][yaml_api_doc]**
1962

1973
# Introduction
1984

0 commit comments

Comments
 (0)