Changes between Version 11 and Version 12 of TopdlLibrary


Ignore:
Timestamp:
Oct 8, 2012 9:11:31 AM (7 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TopdlLibrary

    v11 v12  
    166166 {{{name}}}::
    167167   A string, the unique name of the substrate.
    168  {{{capacity}}::
     168 {{{capacity}}}::
    169169   A [TopdlLibrary#CapacityClass Capacity object] that gives the default capacity of the substrate.  It may be None, incdicating that there is no default.
    170  {{{latency}}::
     170 {{{latency}}}::
    171171   A [TopdlLibrary#LatencyClass Latency object] that gives the default latency of the substrate.  It may be None, incdicating that there is no default.
    172172 {{{attribute}}}::
     
    317317The constructor will take the member names as named parameters.
    318318
     319== Testbed Class ==
     320
     321This class represents a testbed that has allocated resources or from which an allocation is requested.  While it is primarily used internally by the federation system, some other applications include a {{{Testbed}}} as a place to attach attributes that pertain to the whole topology.
     322
     323It includes the following members:
     324
     325 {{{uri}}}::
     326  A string containing the URI on which the testbed can be contacted.  Usually a fedd URI.
     327 {{{type}}::
     328  A string indicating the underlying type of the testbed.  Values include "deter," "emulab," and "protoGENI".
     329 {{{interface}}}::
     330   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the Testbed to communications substrates.  The list may be empty, meaning that the testbed is not connected to any substrates.
     331 {{{attribute}}}::
     332   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the Testbed.  The list may be empty.
     333 {{{localname}}}::
     334   A list of strings giving alternative names for the testbed. The list may be empty, meaning no such alternatives exist.
     335 {{{status}}}::
     336   A string indicating the current status of the Testbed (if any).  It may also be None, indicating no status is reported.  Valid values are
     337     * "empty" - no allocation of resources has been attempted - generally not applied to Testbeds
     338     * "active" - Testbed is functioning as part of an experiment
     339     * "inactive" - Testbed is allocated, but not functioning
     340     * "starting" - Testbed is transitioning from "inactive" to "active"
     341     * "terminating" - Testbed is transitioning from "active" to "inactive"
     342     * "failed" - an allocation of resources has failed - generally not applied to Testbed
     343 {{{service}}}::
     344   A list of [TopdlLibrary#ServiceClass Service objects] that describe the services this Testbed uses or supplies.  These are generally used by the federation system, and their definition is somewhat in flux. The list may be empty.
     345 {{{operation}}}::
     346   A list of strings that describe the valid operations on the Testbed.  These are generally used by the federation system, and their definition is somewhat in flux.The list may be empty.
     347
     348The constructor takes the member names as named parameters.
     349
     350== Segment Class ==
     351
     352This class represents a sub-experiment of a federated experiment about which the details are unknown except for its interfaces.  It is primarily used internally by teh federation system.
     353
     354It has the following members:
     355
     356 {{{id}}}::
     357  An [TopdlLibrary#IDClass ID object] that identifies this segment.
     358 {{{type}}}::
     359  A string indicating the underlying type of the testbed.  Values include "deter," "emulab," and "protoGENI".
     360 {{{interface}}}::
     361   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the segment to communications substrates.  The list may be empty, meaning that the segment is not connected to any substrates.
     362 {{{attribute}}}::
     363   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the segment.  The list may be empty.
     364
     365== ID Class ==
     366
     367This class represents a polymorphic identifier as used by the federation system.  At most one of its members is set.
     368
     369Those members are:
     370
     371 {{{fedid}}}::
     372   A fedid object, representing the hash of a principal key.  This represents a [FeddAbout#GlobalIdentifiers:Fedids fedid].
     373 {{{uuid}}}::
     374   A string holding a UUID URI.
     375 {{{uri}}}::
     376   A string holding a generic URI
     377 {{{localname}}}::
     378   A string holding a locally scoped name
     379 {{{kerberosUsername}}::
     380   A kerberos user name.
     381
     382The constructor accepts the member names as named parameters.
     383
     384== Other Class ==
     385
     386This class represents a topology element that is not captured above.  It is a set of interfaces and a place to hang attributes, for use encoding kinds of elements unknown when topdl was specified.
     387
     388The members are:
     389
     390 {{{interface}}}::
     391   A list of [TopdlLibrary#InterfaceClass Interface objects] that describe connections of the element to communications substrates.  The list may be empty, meaning that the element is not connected to any substrates.
     392 {{{attribute}}}::
     393   A list of [TopdlLibrary#AttributeClass Attribute objects] that are attached to the element.  The list may be empty.
     394
     395The constructor accepts the member names as named parameters.
    319396
    320397= Examples =