doc: Add service provisioning method in Manager API
authorHenri Bragge <henri.bragge@ixonos.com>
Fri, 1 Apr 2011 08:41:37 +0000 (11:41 +0300)
committerSamuel Ortiz <sameo@linux.intel.com>
Mon, 11 Apr 2011 10:02:42 +0000 (12:02 +0200)
doc/manager-api.txt

index 2c7aa07..c247d9f 100644 (file)
@@ -97,6 +97,17 @@ Methods              dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
+               void ProvisionService(string configuration)
+
+                       Provide a configuration for services.
+
+                       Service configuration is provided as a single string
+                       that follows the same format as configuration files,
+                       see config-format.txt. An exception to this format
+                       is that only one service can be provisioned per call.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
                object ConnectProvider(dict provider)
 
                        Connect to a VPN specified by the given provider