Changes between Version 4 and Version 5 of DRAFT_GAPI_AM_API_V2


Ignore:
Timestamp:
12/06/11 11:44:57 (13 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DRAFT_GAPI_AM_API_V2

    v4 v5  
    176176}}}
    177177
    178 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
     178As with all AM API methods, the return is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    179179
    180180{{{
     
    190190}}}
    191191
     192For details on the standard AM API return struct and {{{code}}}, {{{value}}}, and {{{output}}} entries, see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page].
     193
    192194This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#DiscoverResources DiscoverResources] operation and to the [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA]'s !GetResources operation (sec. 6.2.4).
    193195
     
    213215==== Return Summary ====
    214216
    215 As with all AM API methods, the return is an XML-RPC struct, whose actual content is in the {{{value}} entry. For !ListResources, {{{value}} is an RSpec listing and describing resources at this aggregate. Depending on the arguments, this may be and advertisement RSpec showing all local resources, or one showing only available local resources, or a manifest RSpec of resources reserved for a particular slice.
     217For !ListResources, {{{value}} is an RSpec listing and describing resources at this aggregate. Depending on the arguments, this may be an advertisement RSpec showing all local resources, or one showing only available local resources, or a manifest RSpec of resources reserved for a particular slice.
    216218
    217219The details page has details on !ListResources arguments, [wiki:DRAFT_GAPI_AM_API_V2_Details#Return1 returns], and semantics.
     
    229231}}}
    230232
    231 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    232 
    233 {{{
    234 {
    235   struct code = {
    236        int geni_code;
    237        [optional: string am_type;]
    238        [optional: int am_code;]
    239          }
    240   string value;
    241   string output;
    242 }
    243 }}}
    244 
    245233This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#CreateSliver CreateSliver] operation and to the [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA]'s !CreateSlice operation (sec. 6.2.1).
    246234
     
    259247==== Return Summary ====
    260248!CreateSliver reserves the requested resources if possible. The aggregate then (asynchronously) starts those resources.
    261 As with all AM API methods, the return is an XML-RPC struct. The !CreateSliver method returns in the {{{value}} entry a manifest RSpec matching the [http://www.protogeni.net/trac/protogeni/wiki/RSpec GENI standard] manifest RSpec [http://www.geni.net/resources/rspec/3/manifest.xsd schema] listing and describing the resources that were allocated to the slice.
     249As with all AM API methods, the return is an XML-RPC struct (see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page]). The !CreateSliver method returns in the {{{value}} entry a manifest RSpec matching the [http://www.protogeni.net/trac/protogeni/wiki/RSpec GENI standard] manifest RSpec [http://www.geni.net/resources/rspec/3/manifest.xsd schema] listing and describing the resources that were allocated to the slice.
    262250
    263251For details on !CreateSliver arguments, returns, and semantics see the [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#CreateSliverDetails V2 details page].
     
    271259}}}
    272260
    273 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    274 
    275 {{{
    276 {
    277   struct code = {
    278        int geni_code;
    279        [optional: string am_type;]
    280        [optional: int am_code;]
    281          }
    282   boolean value;
    283   string output;
    284 }
    285 }}}
    286 
    287261This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#DeleteSliver DeleteSliver] operation and to the [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA]'s !DeleteSlice operation (sec. 6.2.3).
    288262
     
    296270==== Return Summary ====
    297271
    298 As with all AM API methods, the return is an XML-RPC struct. !DeleteSliver stops all the slice's resources and removes the reservation. It returns in the {{{value}} slot {{{true}}} or {{{false}}} indicating whether it did this successfully.
     272As with all AM API methods, the return is an XML-RPC struct (see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page]). !DeleteSliver stops all the slice's resources and removes the reservation. It returns in the {{{value}} slot {{{true}}} or {{{false}}} indicating whether it did this successfully.
    299273
    300274For details on !DeleteSliver arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_Details#DeleteSliverDetails the V2 details page].
     
    308282}}}
    309283
    310 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    311 
    312 {{{
    313 {
    314   struct code = {
    315        int geni_code;
    316        [optional: string am_type;]
    317        [optional: int am_code;]
    318          }
    319   struct value;
    320   string output;
    321 }
    322 }}}
    323 
    324284This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#SliverStatus,WaitForStatus SliverStatus] operation. The [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA] specification does not include this operation.
    325285
     
    334294==== Return Summary ====
    335295
    336 As with all AM API methods, the return is an XML-RPC struct. !SliverStatus returns the status of the overall reservation, and of each addressable resource within the reservation in an XML-RPC struct in the {{{value}}} entry.
     296As with all AM API methods, the return is an XML-RPC struct (see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page]). !SliverStatus returns the status of the overall reservation, and of each addressable resource within the reservation in an XML-RPC struct in the {{{value}}} entry.
    337297
    338298{{{
     
    363323}}}
    364324
    365 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    366 
    367 {{{
    368 {
    369   struct code = {
    370        int geni_code;
    371        [optional: string am_type;]
    372        [optional: int am_code;]
    373          }
    374   boolean value;
    375   string output;
    376 }
    377 }}}
    378 
    379325This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#RenewSlice RenewSlice] operation. The [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA] specification does not include this operation.
    380326
     
    391337==== Return Summary ====
    392338
    393 As with all AM API methods, the return is an XML-RPC struct. The actual return in {{{value}}} is {{{true}}} or {{{false}}} indicating whether the reservation was successfully extended to the requested date and time.
     339As with all AM API methods, the return is an XML-RPC struct (see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page]). The actual return in {{{value}}} is {{{true}}} or {{{false}}} indicating whether the reservation was successfully extended to the requested date and time.
    394340
    395341For details on !RenewSliver arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#RenewSliverDetails the V2 details wiki page].
     
    403349}}}
    404350
    405 The result is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:
    406 
    407 {{{
    408 {
    409   struct code = {
    410        int geni_code;
    411        [optional: string am_type;]
    412        [optional: int am_code;]
    413          }
    414   boolean value;
    415   string output;
    416 }
    417 }}}
    418 
    419351This operation is similar to ProtoGENI's [http://www.protogeni.net/trac/protogeni/wiki/ComponentManagerAPIV2#Shutdown Shutdown] operation. The [http://svn.planet-lab.org/attachment/wiki/WikiStart/sfa.pdf SFA] specification does not include this operation.
    420352
     
    429361==== Return Summary ====
    430362
    431 As with all AM API methods, the return is an XML-RPC struct. The {{{value}} return is a boolean indicating whether the resources associated with this reservation were successfully shut down to a state suitable for forensics.
     363As with all AM API methods, the return is an XML-RPC struct (see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ReturnStruct the Details page]). The {{{value}} return is a boolean indicating whether the resources associated with this reservation were successfully shut down to a state suitable for forensics.
    432364
    433365For details on Shutdown arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ShutdownDetails the V2 details wiki].