Changes between Version 7 and Version 8 of FeddPluginCalls

Timestamp:

Jun 29, 2010 10:50:14 AM (14 years ago)

Author:

faber

Comment:

--

FeddPluginCalls

@@ -170 +170 @@
 The embedding provides a way for the experiment controller to map elements from the global experiment description into a name in the plug-in's name space.  Currently this is available to the user from the [FeddCommands#fedd_ftopo.py fedd_ftopo.py] command and is used in ad hoc ways.  In a future release this information will be useful in executing remote operations from the experiment controller.
 
-== !TerminateSegment ===
+== !TerminateSegment ==
 
+This operation basically undoes the resource assignemnt and configuration accomplished by !StartSegment.  The sub-experiment resources are released and the connectivity and services terminated.  Local facility rules on cleaning the resources and restoring them to use by others apply.
+
+The request message looks like:
+
+{{{
+request = {
+    'allocID': { 'fedid': fedid_obj },
+    'force': True,
+}
+}}}
+
+AllocID identifies the sub-experiment to terminate.  If {{{force}}} is True, remove resources even if they are in the middle of being allocate or if the plug-in would otherwise not do so.
+
+The response messgae looks like:
+
+{{{
+response = {
+    'allocID': { 'fedid': fedid_obj },
+    'deallocationLog': 'A long string',
+}
+}}}
+
+The {{{allocID}}} tells which segment has been destroyed.  A plug-in can also send the deallocation log to the experiment controller and on to the user.  [FeddCommands#fedd_terminate.py fedd_terminate.py] provides an option to display or save these logs, if plug-ins send them.
+
+== !ReleaseAccess ==
+