Changes between Version 35 and Version 36 of AaronHelsinger/GAPI_AM_API_DRAFT
- Timestamp:
- 03/30/12 11:12:11 (12 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
AaronHelsinger/GAPI_AM_API_DRAFT
v35 v36 552 552 `geni_operational_status` MUST be the current operational status of the sliver after this action (as would be returned by !SliverStatus). An optional `geni_resource_status` field MAY be returned for each sliver which contains a resource-specific status that may be more nuanced than the options for `geni_operational_status`. 553 553 554 Calling this method with a slice_urn functions as if all the child sliver_urn had been passed in - specifically the action is performed on all slivers and all sliver_urnand their statuses are returned. No status is returned for the slice as a whole.554 Calling this method with a slice_urn functions as if all the child sliver_urn's had been passed in - specifically the action is performed on all slivers and all sliver_urn's and their statuses are returned. No status is returned for the slice as a whole. 555 555 556 556 This is a fast synchronous operation, and MAY start long-running sliver transitions whose status can be queried using !SliverStatus. … … 1125 1125 Form 2: 1126 1126 {{{ 1127 struct Renew(string sliver_urn [],1127 struct Renew(string sliver_urns[], 1128 1128 struct credentials[], 1129 1129 dateTime.rfc3339 expiration_time, … … 1166 1166 Form 2: 1167 1167 {{{ 1168 struct UpdateAllocations(string sliver_urn [], struct credentials[], geni.rspec rspec,1168 struct UpdateAllocations(string sliver_urns[], struct credentials[], geni.rspec rspec, 1169 1169 struct options) 1170 1170 }}} … … 1210 1210 Form 2: 1211 1211 {{{ 1212 struct ProvisionSlivers(string sliver_urn [], struct credentials[],1212 struct ProvisionSlivers(string sliver_urns[], struct credentials[], 1213 1213 struct options) 1214 1214 }}} … … 1248 1248 This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical. 1249 1249 1250 {{{ 1251 struct UpdateSlivers(string urn[], struct credentials[], geni.rspec rspec, 1250 Form 1: 1251 {{{ 1252 struct UpdateSlivers(string slice_urn, struct credentials[], geni.rspec rspec, 1252 1253 struct options) 1253 1254 }}} 1254 1255 1255 Where credentials is the standard argument defined above. 1256 Form 2: 1257 {{{ 1258 struct UpdateSlivers(string sliver_urns[], struct credentials[], geni.rspec rspec, 1259 struct options) 1260 }}} 1261 1262 `credentials` is the standard argument defined above. 1256 1263 1257 1264 Options include: … … 1272 1279 ... 1273 1280 ] 1274 <others that are AM specific>1275 1281 } 1276 1282 }}} … … 1279 1285 The manifest is a manifest of only referenced provisioned slivers. 1280 1286 1281 FIXME: Split Update(slice) from Update(slivers)1282 1287 FIXME: Is this the same method as for updating allocated slivers? 1283 1288 FIXME: Return both a manifest and a delta RSpec? … … 1289 1294 This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical. 1290 1295 1291 {{{ 1292 struct SliversStatus(string urn[], struct credentials[], struct options) 1293 }}} 1294 1295 Where credentials is the standard argument defined above. 1296 Form 1: 1297 {{{ 1298 struct SliversStatus(string slice_urn, struct credentials[], struct options) 1299 }}} 1300 1301 Form 2: 1302 {{{ 1303 struct SliversStatus(string sliver_urns[], struct credentials[], struct options) 1304 }}} 1305 1306 `credentials` is the standard argument defined above. 1296 1307 1297 1308 Return: … … 1316 1327 }}} 1317 1328 1318 FIXME: Split Status(slice) from Status(slivers)1319 1320 1329 == !PerformOperationalAction == 1321 1330 Perform the named operational action on the named slivers, possibly changing the `geni_operational_status` of the named slivers. … … 1323 1332 This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical. 1324 1333 1325 {{{ 1326 struct PerformOperationalAction (string urn[], struct credentials[], string action, 1334 Form 1: 1335 {{{ 1336 struct PerformOperationalAction (string slice_urn, struct credentials[], string action, 1327 1337 struct options={}) 1328 1338 }}} 1329 1339 1330 Where credentials is the standard argument defined above. 1340 Form 2: 1341 {{{ 1342 struct PerformOperationalAction (string sliver_urns[], struct credentials[], string action, 1343 struct options={}) 1344 }}} 1345 1346 `credentials` is the standard argument defined above. 1331 1347 1332 1348 Options include: {{{geni_best_effort}}} … … 1345 1361 }}} 1346 1362 1347 FIXME: Split Perform(slice) from Perform(slivers)1348 1349 1363 == !DeleteSlivers == 1350 1364 Delete the named slivers, making them `geni_unallocated`. Resources are de-provisioned. No further AM API operations may be performed on slivers that have been deleted. … … 1352 1366 This method has two forms: one takes a single slice URN, the other takes a list of one or more sliver URNs, all contained in the same slice. When a slice URN is supplied, the method operates on all slivers contained in that slice at this aggregate. All other arguments and returns are identical. 1353 1367 1354 {{{ 1355 struct DeleteSlivers(string urn[], struct credentials[], struct options) 1356 }}} 1357 1358 Where credentials is the standard argument defined above. 1368 Form 1: 1369 {{{ 1370 struct DeleteSlivers(string slice_urn, struct credentials[], struct options) 1371 }}} 1372 1373 Form 2: 1374 {{{ 1375 struct DeleteSlivers(string sliver_urns[], struct credentials[], struct options) 1376 }}} 1377 1378 `credentials` is the standard argument defined above. 1359 1379 1360 1380 Options include: {{{geni_best_effort}}} … … 1378 1398 }}} 1379 1399 1380 Where credentialsis the standard argument defined above.1400 `credentials` is the standard argument defined above. 1381 1401 1382 1402 Return: XML-RPC boolean