1 files changed, 27 insertions, 9 deletions
diff --git a/vyroute/basic_function/BGPRoute.py b/vyroute/basic_function/BGPRoute.py
index bcb891d..a84c896 100644
--- a/vyroute/basic_function/BGPRoute.py
+++ b/vyroute/basic_function/BGPRoute.py
@@ -2,13 +2,20 @@
 def bgp_as(obj, self_as, neighbor, multihop, remote_as, update_source):
     """VyOS BGP router basic setting about AS
 
+    Parameter example:
+    'self_as':'65538'
+    'neighbor':'192.168.10.5'
+    'multihop':'2'
+    'remote_as':'65537'
+    'update_source':'192.168.10.6'
+
     :param obj: A connection object
     :param self_as: The AS number of the router you login
     :param neighbor: The neighbor router address
     :param multihop: The amount of hops
     :param remote_as: The remote AS number
     :param update_source: The update source
-    :return: A message
+    :return: A message or an error
     """
     bgp_multihop_configuration = "set protocols bgp %s neighbor %s ebgp-multihop %s"
     bgp_remote_as_configuration = "set protocols bgp %s neighbor %s remote-as %s"
@@ -35,7 +42,7 @@ def bgp_as(obj, self_as, neighbor, multihop, remote_as, update_source):
         if reg > 0:
             return error_message
         else:
-            return "Result:Configured successfully"
+            return "Result : Configured successfully"
     except Exception as e:
         return e
 
@@ -43,10 +50,14 @@ def bgp_as(obj, self_as, neighbor, multihop, remote_as, update_source):
 def bgp_network(obj, self_as, network_range):
     """Add a network to BGP router
 
+    Parameter example:
+    'self_as':'65538'
+    'network_range':'10.20.10.0/24'
+
     :param obj: A connection object
     :param self_as: The AS number of the router you login
     :param network_range: The target network,don't forget the netmask
-    :return: A message
+    :return: A message or an error
     """
     bgp_network_configuration = "set protocols bgp %s network %s"
 
@@ -56,7 +67,7 @@ def bgp_network(obj, self_as, network_range):
         if len(obj.before) > obj.before.index('\r\n') + 2:
             return obj.before
         else:
-            return "Result:Configured successfully"
+            return "Result : Configured successfully"
     except Exception as e:
         return e
 
@@ -64,10 +75,14 @@ def bgp_network(obj, self_as, network_range):
 def bgp_router_id(obj, self_as, router_id):
     """Set a router id for the router you login
 
+    Parameter example:
+    'self_as':'65538'
+    'router_id':'10.20.10.0'
+
     :param obj:A connection object
     :param self_as: The AS number of the router you login
     :param router_id: The router id,or you can use the router address as router id
-    :return: A message
+    :return: A message or an error
     """
     bgp_router_id_configuration = "set protocols bgp %s parameters router-id %s"
 
@@ -77,7 +92,7 @@ def bgp_router_id(obj, self_as, router_id):
         if len(obj.before) > obj.before.index('\r\n') + 2:
             return obj.before
         else:
-            return "Result:Configured successfully"
+            return "Result : Configured successfully"
     except Exception as e:
         return e
 
@@ -85,11 +100,14 @@ def bgp_router_id(obj, self_as, router_id):
 def bgp_blackhole_route(obj, network_range):
     """Set a blackhole route
 
+    Parameter example:
+    '10.20.10.0/24'
+
     :param obj: A connection object
     :param network_range: The target network,don't forget the netmask
-    :return: A message
+    :return: A message or an error
     """
-    bgp_blackhole_configuration = "set protocols static route %s blackhole distance '254' "
+    bgp_blackhole_configuration = "set protocols static route %s blackhole distance 254"
 
     try:
         obj.sendline(bgp_blackhole_configuration % network_range)
@@ -97,6 +115,6 @@ def bgp_blackhole_route(obj, network_range):
         if len(obj.before) > obj.before.index('\r\n') + 2:
             return obj.before
         else:
-            return "Result:Configured successfully"
+            return "Result : Configured successfully"
     except Exception as e:
         return e