From b83a4a9d291991b07034c0889694eda247e9c8cd Mon Sep 17 00:00:00 2001
From: Marek Gradzki <mgradzki@cisco.com>
Date: Thu, 9 Feb 2017 14:33:52 +0100
Subject: HC2VPP-53: YANG model for DHCP Relay

Change-Id: Ia6dd23a731b1889f5b69ff1761604c29ff84f03c
Signed-off-by: Marek Gradzki <mgradzki@cisco.com>
---
 dhcp/dhcp-api/asciidoc/Readme.adoc | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 dhcp/dhcp-api/asciidoc/Readme.adoc

(limited to 'dhcp/dhcp-api/asciidoc/Readme.adoc')

diff --git a/dhcp/dhcp-api/asciidoc/Readme.adoc b/dhcp/dhcp-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..12e3bcd56
--- /dev/null
+++ b/dhcp/dhcp-api/asciidoc/Readme.adoc
@@ -0,0 +1,14 @@
+= dhcp-api
+
+Provides YANG model that defines DHCP configuration for VPP.
+
+Currently only DHCP relay configuration is supported.
+
+Operational data model is not supported
+(there is no binary API for reading DHCP configuration).
+
+== Notes on model
+* DHCP relay configuration is based on dhcp_proxy_config_2 message API:
+  https://git.fd.io/vpp/tree/src/vnet/dhcp/dhcp.api#n48
+* More info regarding functionality provided by VPP can be found
+  at https://docs.fd.io/vpp/17.04/clicmd_src_vnet_dhcp.html#clicmd_set_dhcp_proxy
-- 
cgit 1.2.3-korg

