From: Thierry Parmentelat <thierry.parmentelat@inria.fr>
Date: Tue, 2 Jun 2015 15:08:22 +0000 (+0200)
Subject: document the options available to Allocate
X-Git-Tag: sfa-3.1-16~17
X-Git-Url: http://git.onelab.eu/?p=sfa.git;a=commitdiff_plain;h=a5034fbc10823e7210a47030b195e4d06594bc89

document the options available to Allocate
---

diff --git a/sfa/planetlab/pldriver.py b/sfa/planetlab/pldriver.py
index 896aeac9..89a2d626 100644
--- a/sfa/planetlab/pldriver.py
+++ b/sfa/planetlab/pldriver.py
@@ -647,6 +647,17 @@ class PlDriver (Driver):
         return status
 
     def allocate (self, urn, rspec_string, expiration, options=None):
+        """
+        Allocate a PL slice
+
+        Supported options:
+        (*) geni_users
+        (*) append : if set to True, provided attributes are appended 
+            to the current list of tags for the slice
+            otherwise, the set of provided attributes are meant to be the 
+            the exact set of tags at the end of the call, meaning pre-existing tags
+            are deleted if not repeated in the incoming request
+        """
         if options is None: options={}
         xrn = Xrn(urn)
         aggregate = PlAggregate(self)