VOL-148 : AAA changes for sending RADIUS packets on configurable VLAN
Patchset contains documentation changes to reflect the latest code
Change-Id: Iacbdb97cbb9bea12e8308a473cba52e1ec7871be
diff --git a/README.md b/README.md
index 179aaf7..e9dbda4 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@
"radiusServerPort" : "1812",
"radiusMac" : "00:1e:67:d2:ee:f7",
"vlanId" : "4000",
- "useSocket" : "false",
+ "radiusConnectionType" : "socket",
"radiusServerConnectPoints": [ "of:00000000000000b2/2" ],
"packetCustomizer" : "sample"
}
@@ -22,7 +22,7 @@
##### nasIp
IP Address of the NAS which is requesting authentication of the user
##### nasMac
-MAC Address of the NAS which is requesting authentication of the user `(Used only when useSocket is false)`
+MAC Address of the NAS which is requesting authentication of the user `(Used only when radiusConnectionType is port)`
##### radiusSecret
Shared secret
##### radiusIp
@@ -30,18 +30,18 @@
##### radiusServerPort
UDP Port Number on which RADIUS Server is listening
##### radiusMac
-MAC address of the RADIUS server or next hop router `(Used only when useSocket is false)`
+MAC address of the RADIUS server or next hop router `(Used only when radiusConnectionType is port)`
##### vlanId
-VLAN on which the RADIUS Server is available `(Used only when useSocket is false)`
-##### useSocket
+VLAN on which the RADIUS Server is available `(Used only when radiusConnectionType is port)`
+##### radiusConnectionType
There are two options for communication with the Radius Server
-- Communication using a UDP socket
-- Communication using directly the port of the SDN switch connected to the Radius Server.
+- "socket" : Communication using a UDP socket.
+- "port" : Communication using directly the port of the SDN switch connected to the Radius Server.
-When useSocket is false, the RADIUS packets sent out would carry the IP and MAC address of the device from which the EAP packets were received. That device should be available in the `SubscriberAndDeviceInformationService (Sadis)`. AAA application fetches data from Sadis based on the serial number of the device.
+When `port` is used, the RADIUS packets sent out would carry the IP and MAC address of the device from which the EAP packets were received. That device should be available in the `SubscriberAndDeviceInformationService (Sadis)`. AAA application fetches data from Sadis based on the serial number of the device.
##### radiusServerConnectPoints
-Connect point of SDN switch through which the RADIUS Server is reachable `(Used only when useSocket is false)`
+Connect point of SDN switch through which the RADIUS Server is reachable `(Used only when radiusConnectionType is port)`
##### packetCustomizer
The values of RADIUS attributes expected by the RADIUS Server might be different in different scenarios or in case of different Operators.