Changes between Version 7 and Version 8 of GeniGet


Ignore:
Timestamp:
11/13/13 15:48:53 (7 years ago)
Author:
Aaron Helsinger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • GeniGet

    v7 v8  
    4040
    4141== commands ==
    42 This gives a list of all commands that you can issue at this server - kinds of information you can get. The return is a JSON list. Each of the commands listed below should be supported, but additional commands are allowed.
     42Return a list of all commands that you can issue at this server - kinds of information you can get. The return is a JSON list. Each of the commands listed below should be supported, but additional commands are allowed.
    4343
    4444Example:
     
    6363== client_id ==
    6464
    65 The `client_id` from the RSpec for this node. This can be used to identify which node this is from your RSpec.
     65Return the `client_id` from the RSpec for this node. This can be used to identify which node this is from your RSpec. The return is a string.
    6666
    6767Example:
     
    7373== control_mac ==
    7474
    75 The MAC address for the control plane interface on this node.
     75Return the MAC address for the control plane interface on this node. The return is a string.
    7676
    7777Example:
     
    131131== manifest ==
    132132
    133 The manifest RSpec for the slice, in standard GENI Rpec XML format.
     133Return the manifest RSpec for the slice, in standard GENI RSpec XML format.
    134134
    135135'''FIXME: For only this node? For only this AM?'''
     
    147147== slice_email ==
    148148
    149 The email address of the slice (from the slice certificate).
     149Return the email address of the slice (from the slice certificate) as a string.
    150150
    151151'''NB: Does not work for slices from the GENI GPO Clearinghouse / Portal'''
     
    159159== slice_urn ==
    160160
    161 The URN of the slice that owns the current compute resource
     161Return the URN of the slice that owns the current compute resource as a string.
    162162
    163163Example:
     
    169169== sliverstatus ==
    170170
    171 The AM API v2 return from `sliverstatus` for this slice
     171Return the AM API v2 return from `sliverstatus` for this slice (see http://groups.geni.net/geni/wiki/GAPI_AM_API_V2#SliverStatus), a JSON struct.
    172172
    173173Example:
     
    178178
    179179== status ==
    180 The AM API v3 `status` return. Only supported if the AM supports AM API v3.
     180Return the AM API v3 `status` return. Only supported if the AM supports AM API v3. See http://groups.geni.net/geni/wiki/GAPI_AM_API_V3#Status
    181181''' FIXME: For only the current sliver? Or for all resources at this AM?'''
    182182
     
    189189== user_email ==
    190190
    191 This is the email address of the user who reserved the node (from the user certificate).
     191Return the email address of the user who reserved the node (from the user certificate) as a string.
    192192
    193193Example:
     
    199199== user_urn ==
    200200
    201 This is the URN of the user who reserved the node, from the user certificate.
     201Return the URN of the user who reserved the node, from the user certificate as a string.
    202202
    203203Example:
     
    208208
    209209== --version ==
    210 The server side of this software's code version.
     210Return the server side of this software's code version.
     211
     212'''FIXME: A string? An int? Float?'''
    211213
    212214Example:
     
    217219
    218220== --client-version ==
    219 The version of this script (`geni-get`).
     221Return the version of this script (`geni-get`).
     222
     223''' FIXME: A string? A float?'''
    220224
    221225Example: