Changes between Version 4 and Version 5 of DRAFT_GAPI_AM_API_V2
- Timestamp:
- 12/06/11 11:44:57 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
DRAFT_GAPI_AM_API_V2
v4 v5 176 176 }}} 177 177 178 The resultis an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members:178 As with all AM API methods, the return is an [http://www.xmlrpc.com/spec XML-RPC] struct with at least the following members: 179 179 180 180 {{{ … … 190 190 }}} 191 191 192 For 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 192 194 This 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). 193 195 … … 213 215 ==== Return Summary ==== 214 216 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 andadvertisement RSpec showing all local resources, or one showing only available local resources, or a manifest RSpec of resources reserved for a particular slice.217 For !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. 216 218 217 219 The details page has details on !ListResources arguments, [wiki:DRAFT_GAPI_AM_API_V2_Details#Return1 returns], and semantics. … … 229 231 }}} 230 232 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 245 233 This 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). 246 234 … … 259 247 ==== Return Summary ==== 260 248 !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.249 As 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. 262 250 263 251 For details on !CreateSliver arguments, returns, and semantics see the [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#CreateSliverDetails V2 details page]. … … 271 259 }}} 272 260 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 287 261 This 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). 288 262 … … 296 270 ==== Return Summary ==== 297 271 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.272 As 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. 299 273 300 274 For details on !DeleteSliver arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_Details#DeleteSliverDetails the V2 details page]. … … 308 282 }}} 309 283 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 324 284 This 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. 325 285 … … 334 294 ==== Return Summary ==== 335 295 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.296 As 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. 337 297 338 298 {{{ … … 363 323 }}} 364 324 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 379 325 This 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. 380 326 … … 391 337 ==== Return Summary ==== 392 338 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.339 As 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. 394 340 395 341 For details on !RenewSliver arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#RenewSliverDetails the V2 details wiki page]. … … 403 349 }}} 404 350 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 419 351 This 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. 420 352 … … 429 361 ==== Return Summary ==== 430 362 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.363 As 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. 432 364 433 365 For details on Shutdown arguments, returns, and semantics, see [wiki:DRAFT_GAPI_AM_API_V2_DETAILS#ShutdownDetails the V2 details wiki].