Table of Contents
$ . ~legion/setup.sh
or
$ source ~legion/setup.cshThe following style conventions are used in these tutorials:
Calls on objects

legion_exports_interface
{-l <LOID> | -c <context path>}
{-w <well-known class type> | -f <function signature>}+
[-debug] [-help]
| 1 | if the interface of the object contains the entire interface of functions specified by the user |
| 0 | if any one or more of the functions are not exported by the object |
| -1 | (without contacting the specified object) if the user creates a malformed argument list |
For the purposes of this tool, "ClassObject" is a well-known class string. "CommandLineClass" and "BootstrapMetaClass" are not considered well-known classes because they do not have any special member functions, as shown in the examples below.
$ legion_exports_interface -c LegionClass -w ClassObject
1
$
$ legion_exports_interface -c /class/LegionClass \
-w CommandLineObject
"CommandLineObject" is not a well known class. Exiting.
usage: legion_exports_interface
{-l <class loid> | -c <legion space path>}
{-w <well known class type> | -f <function signature>}+
-1
$
$ legion_exports_interface -c LegionClass -w LegionClass \
-w ClassObject
1
$
$ legion_exports_interface -c /hosts/BootstrapHost \
-w UnixHostClass
1
$
$ legion_exports_interface -c /hosts/BootstrapHost \
-w ClassObject
0
$
$ legion_exports_interface -c /class/LegionClass \
-f " LegionLOID ping();"
1
$
$ legion_exports_interface -c /hosts/BootstrapHost \
-f " LegionLOID ping();" -w UnixHostClass
1
$
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_interface
{-l <class LOID> | -c <context path>}
[-debug] [-help]This example returns the interface of the LegionClass (the metaclass for all Legion classes).
$ legion_get_interface -c class/LegionClass
Getting the interface of object:1.01.01..000001fc0b325...
Object Interface:
void deactivate();
RestoreStateReply restoreState();
SaveStateReply saveState(SaveStateRequest);
LegionLOID ping();
LegionObjectInterface getInterface();
int exportsInterface(LegionObjectInterface);
int addAttribute(ObjectAttribute);
int addAttributes(ObjectAttributeList);
int replaceAttribute(ObjectAttribute, ObjectAttribute);
int replaceAttribute_s(ObjectAttribute,
ObjectAttribute);
int replaceAttributes(ObjectAttributeList,
ObjectAttributeList);
int replaceAttributes_s(ObjectAttributeSignatureList,
ObjectAttributeList);
int removeAttribute(ObjectAttribute);
int removeAttribute_s(ObjectAttributeSignature);
int removeAttributes(ObjectAttributeList);
int removeAttributes_s(ObjectAttributeSignatureList);
LegionAttributeList retrieveAttributes(
ObjectAttributeList);
LegionAttributeSignatureList retrieveAttributes_s(
ObjectAttributeSignatureList);
LegionAttributeList retrieveAllAttributes();
$
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_ping
{-l <object LOID> | -c <context path>} [-timeout <seconds>]
[-debug] [-help]$ legion_ping -c foo Pinging: 1.01.66000000.14000000.00... Returned: 1.01.66000000.14000000.00... $
| -timeout <seconds> | The time-out flag specifies a maximum number of seconds to wait for the ping to complete successfully. If the object does not respond to the ping within that amount of time, legion_ping will exit. Please note that legion_ping failing due to a user-specified time-out does not necessarily mean that the object is inactive or otherwise unreachable. There is no default time-out setting. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_attributes
{-l <object LOID> | -c <context path>} [-L] [<attribute name>]
[-debug] [-help]| -L | Lists the LOID of each attribute |
| <attribute name> | Specify the attribute to be listed (more than one attribute can be listed) |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
$ legion_list_attributes -c Foo
Foo:
(ALL)
Total attributes retrieved 1
favoritecolors('puce', 'apricot')
$
legion_list_invocations
{-l <object LOID> | -c <object context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_object_info
{-l <object LOID> | -c <object context path>} [-v]
[-debug] [-help]| -v | Print additional details about the specified object (host machine name and context name, OPA, and vault context name). |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_update_attributes
{-l <object LOID> | -c <context path>}
[{-a | -d | -t} <attribute description>] [-u]
[-debug] [-help]Optional parameters do the following:
| -a | Add an attribute |
| -d | Delete an attribute |
| -t | Test an attribute |
| <attribute description> | Specify an attribute to be updated |
| -u | Update an object's attributes |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
$ legion_update_attributes -c foo \ -a "favoritenames(bob, fred)" IN make_attr_from_input - favoritenames(bob, fred) ** ADDED 1 attributes(s) to object $
$ legion_update_attributes -c foo \
-d "favoritenames(bob)"
IN make_attr_from_input - favoritenames(bob)
** WARNING - DELETED 0 attributes(s) from object
instead of 1 specified
$ legion_update_attributes -c foo \
-d "favoritenames(bob, fred)"
IN make_attr_from_input - favoritename(bob, fred)
** DELETED 1 attributes(s) from object
$
Calls on Class Objects

legion_activate_object
{-l <object LOID> | -c <context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_object
{-l <class LOID> | -c <class context path>}
<new object context path>
[-h <host name on which to place new object>]
[-v <vault on which to place new object>]
[-H <context path of preferred host class>]
[-V <context path of preferred vault class>]
[-Ch <context containing list of preferred hosts>]
[-Cv <context containing list of preferred vaults>]
[-d <recorder context path> <debug session name>]
[-debug] [-help]If the -h flag isn't used, the host is selected by the class in which you are creating an instance. Similarly, the class will choose a vault if the -v flag isn't used. Normally, this means that a random host is selected, but some classes may act differently. If the -Ch or -Cv flag is used, the class will randomly choose a host or vault from the hosts or vaults listed in the specified context. In both cases, the system will not return the LOID of the randomly chosen host. The legion_host_vault_list and legion_vault_host_list commands will allow users to limit the placement of a given class's instances (i.e., any instances of class Foo can only be placed on hosts X, Y, and Z).
The following options are supported:
| -h | Specify a host for the new object |
| -v | Specify a vault for the new object |
| -H | Specify the preferred host class's context path |
| -V | Specify the context path of the preferred vault |
| -Ch | Specify a context which contains a list of the preferred hosts |
| -Cv | Specify a context which contains a list of the preferred vaults |
| -d | Automatically start a legion_record session for the newly created object. This allows you to debug server objects. The object's relevant activity will be recorded by a previously started Legion recorder object, named in <recorder context path>. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_object_r
{-l <class LOID> | -c <class context path>}
<context path> <host name> <host architecture>
<$LEGION> <$LEGION_OPR> <$LEGION_OPA> <binary path>
[<user id>]
[-debug] [-help]The additional arguments specify information for the rsh environment.
| <host name> | Specifies the host upon which the new object should be placed. Note that this should be a DNS name |
| <host architecture> | Specifies the host's architecture |
| <$LEGION> | Specifies the Legion environment variable on the rsh host |
| <$LEGION_OPR> | Specifies LEGION_OPR for host |
| <$LEGION_OPA> | Specifies the OPR address for the object, i.e, a unique directory in which the object will maintain its persistent representation on the remote host |
| <binary path> | Binary executable path for the object on the remote host |
Optional parameters do the following:
| <user id> | Specifies the appropriate user name on the rsh host |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_deactivate_object
{-l <object LOID> | -c <context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_destroy_object
{-l <object LOID> | -c <context path>}
[-debug] [-help]This command will not remove an object's context name: you must use the legion_rm command to remove the context name(s) or you will get binding errors in that context. (You can use legion_ls -A to check for multiple context names.)
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_host {-l <object LOID> | -c <object context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_vault {-l <object LOID> | -c <object context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_implementations [-v] {-l <class LOID> | -c <class context path>}
[-debug] [-help]The following options are supported:
| -v | Run the command in a verbose setting |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Note that if the -v flag is used Legion will use one extra method invocation per implementation object.
legion_list_instances {-l <class LOID> | -c <context path>}
[-debug] [-help]$ legion_list_instances -c /class/BasicFileClass
Class 1.01.66000000..000001fc0d63e97... knows about
the following instances:
LOID: 1.01.66000000.01000000.000001fc0a00...
Current oa : [xxx.xxx.xxx.xxx : 2020]
Current host : 1.01.07.30232908.000001fc0...
Current vault: 1.01.03.2e232908.000001fc0...
Status : object-running
LOID: 1.01.66000000.02000000.000001fc0edd...
Current oa : [xxx.xxx.xxx.xxx : 1895]
Current host : 1.01.07.31232908.000001fc0...
Current vault: 1.01.03.2e232908.000001fc0...
Status : object-running
$
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_host {-l <instance LOID> | -c <instance context path>}
{-l <host LOID> | -c <host context path>}
[-debug] [-help]In the example below, object Foo's host is changed from BootstrapHost to newHost.
$ legion_set_host -c Foo -c /hosts/newHost
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_vault {-l <instance LOID> | -c <instance context path>}
{-l <vault LOID> | -c <vault context path>}
[-permanent] [-debug] [-help]The following options are supported:
| -permanent | Makes the migration permanent. I.e., the object's acceptable vault list will be change to list only the new vault. No further migration can occur without user intervention (via the legion_instance_vault_list command) |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Be careful with the -permanent flag. If none of the instance's acceptable hosts match the chosen vault (i.e., there are no compatible host-vault pairs) the instance cannot be reactivated. Alternatively, the chosen vault may be compatible only with hosts for which the class has no implementation.
Please note that this command can fail for many reasons, including:
The class object will enforce the current restrictions on its instance's acceptable vaults before it migrates the object's state. You may need to change the instance's list of acceptable vaults (via the legion_instance_vault_list command) to include the target vault before running legion_set_vault. This command is not exactly the equivalent of a true object migration, since the object is not reactivated after its state is moved. Where the object reactivates depends on the scheduling decision made at the time the reactivation occurs. If the -permanent flag is not used and the instance's acceptable vault list is not otherwise altered, future activations of the instance may be on different vaults. If the -permanent flag is used, all future activations must use the specified vault, until the acceptable vault list is altered.
Calls on LegionClass

legion_add_class_mapping <metaclass LOID> <class LOID>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_combine_domains [-v] <list of domain cookie files>
[-debug] [-help]Non-transitive or non-reflexive joins would allow communication of LOIDs for which an object could not obtain a binding. For example, object X in domain A might be able to bind to object Y in domain B and pass a method to it, but object Y might not be able to bind to object X to pass it the return value.
In addition to joining the binding trees of the involved domains, legion_combine_domains also creates context links in the current domain's context space to all of the remote domains' root contexts. These links appear in local context space in the following path: /domain/LegionDomain.<domain-id>.
If the command is run on domains that are already connected, it has no affect and is harmless.
There is currently no mechanism supporting "unjoining" of domains. However, Legion security mechanisms (e.g., ACLs) can be used to effectively forbid any use of the current domain by outside domains.
The following options are supported:
| -v | Provide a verbose output as the command is running. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
The example below combines two domains. If either had previously been connected to another domain, three cookie files would be listed.
$ legion_combine_domains LegionDomainCookie.35d82a07 \
LegionDomainCookie.c8
Created 2 new domain interconnections.
$
legion_create_implementation
<binary path name> <architecture>
[-l <class LOID> | -c <class context path>]
[-c <object context path>] [-nc] [-v] [-a <attribute>]
[-debug] [-help]The following options are supported:
| -c <context path> | Specify a context path for the new object. Default is /impls/<binary_name>.<architecture>.<#>. |
| -nc | Specify that the new object have no context name. |
| -v | Run the command in verbose mode. |
| -a <attribute> | Assign the new object an extra attribute. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_generate_domain_cookie
[-o <cookie output filename>]
[-debug] [-help]In a secure environment, you must be logged in as /users/admin for the current domain. This ensures that the required credentials can be generated and saved in the cookie file.
The following options are supported:
| -o <cookie output filename> | Specify the local pathname of the resulting output cookie file. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_init_arch
[-debug] [-help]$ legion_init_arch
Initializing Legion implementations for "linux"
Creating an implementation (ContextObject) for
ContextClass
Continue (y=yes, Y=yes to all, n=no, N=no to all,
v=verbose, V=verbose all)? Y
Creating an implementation (MetaClassObject) for
LegionClass
Creating an implementation (ClassObject) for
VanillaMetaClass
Creating an implementation (BindingAgent) for
BindingAgentClass
Creating an implementation (BasicFileObject) for
BasicFileClass
Creating an implementation (ttyObject) for
ttyObjectClass
Creating an implementation (StatTreeObject) for
StatTreeClass
$The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_domains
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |

legion_print_domain_cookie
[-i <cookie input file>]
[-debug] [-help]The following options are supported:
| -i <cookie input filename> | Specify the path of the cookie file to print. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Calls on File and Context Objects

legion_activate_instances
{-l <class LOID> | -c <class context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_cat <context path1> <context path2> ... <context pathN>
[-debug] [-help]$ legion_cat newFileObject This is a test, just a test, nothing more. $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_cd <context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_context_add <object LOID> <context name>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_context_create <context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_cp
[-r] [-v] [-m] [-p] [-localsrc] [-localdest]
[-V <vault context path>] <source file> <destination file>
[-debug] [-help]The following optional parameters are supported:
| -v | Verbose mode. Prints information about which files and directories the command is currently working on. |
| -r | Recursive mode. If the <source path> is a directory, all of its contents are copied recursively. Only files and contexts/directories are handled. If other objects are encountered, they are skipped and legion_cp prints a warning message. Note that recursive mode automatically detects cycles in context space and prevents the recursive copy from revisiting context nodes in the cycle. A warning message is printed in the event that cycles are detected. |
| -localsrc | Indicates that the source path (<source path>) is in the local files system |
| -localdest | Indicates that the target path (<destination path>) is in the local file system. |
| -V <vault context path> | Specify a vault restriction for new objects created by this command. Supply the context path of the vault that should manage new objects created as legion_cp runs. |
| -m | Match-class mode. This mode indicates that when files or contexts are created by this command, they should match the class of their source context or file. By default, new files and contexts are created using the default file and context classes for your current Legion environment. This mode can only be used when copying within Legion context space (i.e., when no -localsrc or -localdest options are specified). |
| -p | Print out the size, transfer time, and transfer rate for each file copied. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_deactivate_instances
{-l <class LOID> | -c <class context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_destroy_instances
{-l <class LOID> | -c <class context path>}
[-debug] [-help]This command will remove the LOIDs of the specified class' instances in all contexts, not just the current context. However, it will not remove the context names: you must use the legion_rm command to the object's name(s), or you will get binding errors. (You can use legion_ls -A to check for multiple context names).
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_direct_output {-l <LOID> | -c <object path>}
{-l <tty LOID> | -c <tty context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_export_dir [-v] [-fc] [-cc]
<local base directory path> <target base context path>
[-debug] [-help]Use of exported files and directories while the command is not active will cause binding errors. The context space will not be automatically removed when the command is paused or stopped. To delete an exported directory tree's context space, use legion_rm -r while legion_export_dir is active.
For best results, do make any changes to the exported directory tree or to the tree's context. Any changes that you make to the context, such as changing or removing context names, will not be reflected in the local directory tree (and vice versa). For this same reason you should delete the tree's context space when you are finished.
Optional parameters do the following:
| -v | Verbose mode. Prints information about which files and directories the command is currently exporting. |
| -fc | Specify the context path of the class to use for file objects. This class should be an instance of the metaclass "/class/ProxyBindingMetaClass", since the style of file object used by legion_export_dir requires specialized binding services. The default is "/class/ContextProxyClass". |
| -cc | Specify the context path of the class to use for context objects. This class should also be an instance of "/class/ProxyBindingMetaClass". The default used is "/class/FileProxyClass". |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_host {-l <object LOID> | -c <object context path>}
[-debug] [-help]$ legion_get_host -c Foo 1.01.07.d49d1a40.000001fc0c04724... $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_vault {-l <object LOID> | -c <object context path>}
[-debug] [-help]$ legion_get_vault -c Foo 1.01.03.d49d1a40.000001fc0a69cbb8... $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_import_tree [<unix directory path> [<legion context path>]]
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_names {-l <object LOID> | -c <object context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_ln <context path> <new alias>
[-debug] [-help]An object can have multiple context names, assigned by one or more users. The same context name can be assigned to different objects or to the same object so long as the contexts names are in different contexts (just as the same file names can be used in different levels of a Unix directory).
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_ls [-laLRAdqv] [<context path>]
[-debug] [-help]$ legion_ls /hosts BootstrapHost my.host.DNS.name $
Optional parameters do the following:
| -l | List object type and information, if available. Objects of unknown type will be listed as object and faulty objects will be listed as not available. |
| -a | List "hidden" objects in the context, i.e. those objects whose names begin with a "." character. Examples would be the "." (current) and ".." (parent) contexts. |
| -L | Lists LOIDs associated with names. |
| -R | Print a recursive listing of the current context. |
| -A | List all known context aliases for each listed object. |
| -d | List contexts like other objects, rather than listing their contents. |
| -q | When creating a long listing, do not activate inactive objects. |
| -v | Run command in verbose mode. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
You can get more information about the objects in the current or a selected object or about a particular object by including one or more flags and a context path name. The output below combines the -l, -a, and -A flags to get a list of all objects in the /hosts context, their type, and all of their context names.
$ legion_ls -laA /hosts
. (context)
/hosts
.. (context)
/class/..
/hosts/..
/vaults/..
/home/..
BootstrapHost (object)
/hosts/BootstrapHost
/hosts/stonesoup01.cs.virginia.edu
stonesoup01.cs.virginia.edu (object)
/hosts/BootstrapHost
/hosts/stonesoup01.cs.virginia.edu
$According to this, there are four names listed in /hosts, two referring to contexts and two to objects. We can see from the alternative context names, though, that BootstrapHost and my.host.DNS.name refer to the same object.
legion_mkdir <context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mv <context path> <new context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_pwd
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_rm [-r] [-f] [v] <context path list>
[-debug] [-help]If the context path listed is the last (i.e., only) name mapped to a given object, the object will be destroyed. If there are other names mapped to the object, the object will be removed.
Optional parameters do the following:
| -r | Recursively remove one or more contexts and all of their contents. |
| -f | Force faulty objects (those with bad bindings) to be removed. |
| -v | Run this command in a verbose setting. This will indicate when objects are destroyed and when only names are being destroyed. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_context <context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_tty <tty context path>
[-debug] [-help]$ legion_set_tty /context_path/my-tty
Note that program output does not have to be directed to the same window in which the program is run. By setting a new current tty object, the output can be redirected to any window, or even a file. For example:
$ legion_create_object -c /class/ttyObjectClass \ /context_path/my-tty $ legion_set_tty /log-file
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_tty <tty context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_tty_off
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_tty_redirect <object context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_tty_unredirect <object context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_tty_watch [-l <tty LOID> | -c <tty context path>]
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Start-Up and Shutdown Functions

legion_add_host_account
{-l <host object LOID> | [-c] <host object context path>}
{[-f <mapping file name>] | [<Unix user id> [-l <owner LOID> | -c <owner context path>]]}
[-debug] [-help]The following optional parameters are supported:
| -f <mapping file name> | Names a mapping file. The mapping file contains a list of Unix user id-Legion user name mappings for that PCD host object. There is no limit on the number of mappings that can be listed. One mapping per line. If a Unix id is listed but not mapped to a Legion user id, the account will be a guest account. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_class [-c <context path>]
[-sc <scheduler context path>] [-sl <scheduler LOID>]
[-debug] [-help]| -c | Assign the new object the name given in <context path> |
| -sc <scheduler context path> | Specify the context path of the default scheduler object that the new class should use. |
| -sl <scheduler LOID> | Specify the LOID of the default scheduler object that the new class should use. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_destroy_host [-v]
{-l <host LOID> | -c <host context path>}
[-debug] [-help]| -v | Run in verbose mode. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_destroy_vault {-l <vault LOID> | -c <vault context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_initialize
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_host_accounts
{-l <host object LOID> | [-c ]<host object context path>}
<user id> [-debug] [-help]-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_make_setup_script [-o <script basename>] [-OPR <OPR dir name>]
[-L <$LEGION dir name>]
[-debug] [-help]The following options are supported:
| -o <script basename> | Specify the basename for the resulting setup scripts (default is /home/xxxx/OPR/setup). This command will generate two setup scripts, one for /bin/sh derivative users and one for csh-derivative users. The scripts will be named <script basename>.sh and <script basename>.csh, respectively. |
| -OPR <OPR dir name> | Specify the OPR directory name that will be set up when the resulting scripts are run. This directory will contain the user's local copy of Legion-Class.config (default is "Legion-OPR"). The user's local version of the directory will be placed in the user's $HOME. |
| -L <$LEGION dir name> | Specify the value of $LEGION, which is the directory where the resulting scripts are run. The default is the current value of $LEGION. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_print_config
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_remove_host_account
[-l <host object LOID> | [-c] <host object context path>]
[-debug] [-help]-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_setup_state [-i]
[-debug] [-help]
The following options are supported:
| -i | Run the command in an interactive mode. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_shutdown [-local] [-f] [-i] [-h]
[-debug] [-help]Optional parameters do the following:
| -local | Shuts down only a local host or vault. |
| -f | Forces the termination of a system, may leave processes running and prevent a system restart. |
| -i | Puts the shutdown in an interactive mode, which will provide prompts for user actions. |
| -h | Returns the command's complete syntax. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_shutdown_class
{-l <class LOID> | -c <context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_starthost
[-L <$LEGION>] [-O <$LEGION_OPR>] [-A <$LEGION_ARCH>]
[-B <path>] [-N <context name>] [-U <user id>]
<new host name> [<compatible vault list>]
[-debug] [-help]| <$LEGION_OPA> | = $LEGION_OPR/Host-$HOST.OPA |
| <binary path> | = $LEGION/bin/$LEGION_ARCH/UnixHostObject |
| -L <$LEGION> | Specify $LEGION for host (default is "/home/Legion") |
| -O <$LEGION_OPR> | Specify $LEGION_OPR for host (default is current $LEGION_OPR) |
| -A <$LEGION_ARCH> | Specify the architecture type for the host (default is current $LEGION_ARCH) |
| -B <path> | Specify the basename of the host binary (default is "UnixHostObject") |
| -N <context name> | Specify the context name for the host object (default is "/hosts/<host name>") |
| -U <user id> | Specify the user id for host (default is current user id) |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_startup [-local]
[-debug] [-help]The following optional parameters are supported:
| -local | starts up only a local host or vault |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_startvault
[-L <$LEGION>] [-O <$LEGION_OPR>] [-A <$LEGION_ARCH>]
[-N <context name>] [-U <user id>] <host name>
[<compatible host list>]
[-debug] [-help]The following optional parameters are supported:
| -L <$LEGION> |
Specify $LEGION for the vaults host (default is "/home/Legion") |
| -O <$LEGION_OPR> |
Specify $LEGION_OPR for the vaults host (default is "/home/OPR") |
| -A <$LEGION_ARCH> |
Specify the architecture of the vaults host (default is current $LEGION_ARCH) |
| -N <context name> |
Specify the context name for the vault object (default is "/vaults/vault-<host name>") |
| -U <user id> |
Specify the user id to use on the vaults host (default is current user id) |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Scheduling Support

legion_class_host_list
[-l <class LOID> | -c <class context path>]
[{-a | -d | -t} <host1> <host2> ... <hostn>] [-p] [-u]
[-debug] [-help]The following optional parameters are supported:
| -c | Use context paths to specify class and host |
| -l | Use dotted hex LOIDs to specify class and host |
| -a | Add named host to the class's acceptable host list |
| -d | Delete named host from the class's acceptable host list |
| -t | Test whether or not a host is on the class's acceptable host list |
| -p | Display the class's acceptable host list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
The example below adds a new host to the list of acceptable hosts of BasicFileClass, using the -a flag.
$ legion_class_host_list -c /class/BasicFileClass \ -a /hosts/newHost ** ADDED 1 host(s) to class's acceptable host set
$ legion_class_host_list -c /class/BasicFileClass -p ** ACCEPTIBLE HOST LISTING: ** 1.01.07.d59d1a40.000001fc094e23... $
$ legion_class_host_list -c /class/myClass \ -t 1.01.07.d59d...
legion_class_vault_list
{-l <class LOID> | -c <class context path>}
[{-a | -d | -t} <vault1> <vault2> ... <vaultn>] [-p] [-u]
[-debug] [-help]| -c | Use context paths to specify class and vault |
| -l | Use LOIDs to specify class and vault |
| -a | Add named vault to the class's acceptable vault list |
| -d | Delete named vault from the class's acceptable vault list |
| -t | Test whether or not a vault is on the class's acceptable vault list |
| -p | Display the class's acceptable vault list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
You can use the -a, -d, and -t flags more than once when running the command but regardless of how you list them on the command line Legion will process them in a specific order when you run the command: first adding any new vaults, then deleting old vaults, then testing any vaults, and finally printing out the results. Note also that if you give the class's context name in the first parameter (i.e., with the -c flag) you must use the vaults' context names in the <vault1>, <vault2>, ...<vaultn> parameter. Similarly, if you give the class's LOID (with the -l flag) you must use the vaults' LOIDs. In other words, if you were to enter:
$ legion_class_vault_list -c /class/myClass \ -t 1.01.07.01000...
legion_config_scheduler
{-l <Scheduler LOID> | -c <Scheduler context path>}
[-get_enactor] [-get_collection]
[-set_enactor {-l <Enactor LOID> | -c <Enactor path>}]
[-set_collection {-l <Collection LOID> | -c <Collection path>}]
[-debug] [-help]The following optional parameters are supported:
| -get_enactor | Print the LOID of a basic Legion Scheduler's currently assigned Enactor helper object |
| -get_collection | Print the LOID of a basic Legion Scheduler's currently assigned Collection helper object |
| -set_enactor | Set the Enactor named in <Enactor LOID> or <Enactor path> to the Scheduler |
| -set_collection | Set the Collection named in <Collection LOID> or <Collection path> to the Scheduler |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_host_vault_list
{-l <host LOID> | -c <host context path>}
[{-a | -d | -t} <vault1> <vault2> ... <vaultn>] [-p] [-u]
[-debug] [-help]The following optional parameters are supported:
| -c | Use context paths to specify host and vault |
| -l | Use dotted hex LOIDs to specify host and vault |
| -a | Add named vault to the host's acceptable vault list |
| -d | Delete named vault from the host's acceptable vault list |
| -t | Test whether or not a vault is on the host's acceptable vault list |
| -p | Display the host's acceptable vault list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
To list the vaults that a host can operate on, for instance, you would type in:
$ legion_host_vault_list -c /hosts/HostName -p ** COMPATIBLE VAULT LISTING: ** 1.01.03.d49d1a40.000001fc0a69cbb845... $
$ legion_host_vault_list -c /host/HostName \ -t 1.01.03.d49...
legion_instance_host_list
{-l <instance LOID> | -c <instance context path>}
[{-a | -d | -t} <host1> <host2> ... <hostn>] [-p] [-u]
[-debug] [-help]The following optional parameters are supported:
| -c | Use context paths to specify instance and host |
| -l | Use LOIDs to specify instance and host |
| -a | Add named host to the instance's acceptable host list |
| -d | Delete named host from the instance's acceptable host list |
| -t | Test whether or not a host is on the instance's acceptable host list |
| -p | Display the instance's acceptable host list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
You can use the -a, -d, and -t flags more than once when running the command but regardless of how you list them on the command line Legion will process them in a specific order when you run the command: first adding any new hosts, then deleting old hosts, then testing any hosts, and finally printing out the results. Note also that if you give the instance's context name in the first parameter (i.e., with the -c flag) you must use the hosts' context names in the <host1>, <host2>, ...<hostn> parameter. Similarly, if you give the instance's LOID (with the -l flag) you must use the hosts' LOIDs. In other words, if you were to enter:
$ legion_instance_host_list -c myInstance \ -t 1.01.07.01000...
legion_instance_vault_list
{-l <instance LOID> | -c <instance context path>}
[{-a | -d | -t} <vault1> <vault2> ... <vaultn>] [-p] [-u]
[-debug] [-help]The following optional parameters are supported:
| -c | Use context paths to specify instance and vault |
| -l | Use LOIDs to specify instance and vault |
| -a | Add named vault to the instance's acceptable vault list |
| -d | Delete named vault from the instance's acceptable vault list |
| -t | Test whether or not a vault is on the instance's acceptable vault list |
| -p | Display the instance's acceptable vault list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
You can use the -a, -d, and -t flags more than once when running the command but regardless of how you list them on the command line Legion will process them in a specific order when you run the command: first adding any new vaults, then deleting old vaults, then testing any vaults, and finally printing out the results. Note also that if you give the instance's context name in the first parameter (i.e., with the -c flag) you must use the vaults' context names in the <vault1>, <vault2>, ...<vaultn> parameter. Similarly, if you give the instance's LOID (with the -l flag) you must use the vaults' LOIDs. In other words, if you were to enter:
$ legion_instance_vault_list -c myInstance \ -t 1.38736c78.03.01000000.000...
legion_join_collection
{-l <Collection LOID> | -c <Collection path>}
{-l <member LOID> | -c <member path>}
[-debug] [-help]Use the legion_query_collection command to get information (in the form of object attributes) about the given collection.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_leave_collection
{-l <Collection LOID> | -c <Collection path>}
{-l <member LOID> | -c <member path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_oprs {-l <vault LOID> | -c <vault context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_make_schedule
{-c <class context path> | -l <class LOID>}
[-n <number of nodes>] [-f <specification file>]
[-q <query>] [-help]The following options are available:
| -n <number of nodes> | Specify the number of nodes required for this run. Default is 1. |
| -f <specification file> | Name a specification file that contains relative performance ratios for different architectures. E.g., the specification file could contain the lines:
|
| -q <query> | Specify a MESSIAHS query that can be used to prune the list of hosts on which the run can be scheduled. |
| -help | Print command syntax and exit. |
legion_query_collection
{-l <Collection LOID> | -c <Collection path>} <query>
[-debug] [-help]Examples of query strings are:
| 'true' | This query would return the list of all objects contained in the Collection. |
| 'match($host_os_name,"SunOS")' | This query would return the list of all objects contained in the Collection with an attribute of the form (host_os_name,"SunOS"). |
| 'match($host_os_name,"SunOS")' or 'match($host_os_name,"Linux")' | This collection would return the list of all objects contained in the Collection with an attribute of either (host_os_name,"SunOS") or (host_os_name,"Linux"). |
The following options are available:
| -v | Run in verbose mode. The resulting list of objects matching the query will be displayed along with the attributes of each object. Otherwise, only the list of matching objects (without their attributes) will be displayed. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
The example below uses the default Collection (found in the /etc context), would be:
$ legion_query_collection -c /etc/Collection true 2 hits: 1.36ab9e4a.03.01000000.000001fc099204... 1.36ab9e4a.07.01000000.000001fc0d6e07...
legion_set_default_placement
{-l <class LOID> | -c <class context name>}
{-l <host LOID> | -c <host context name>}
{-l <vault LOID> | -c <vault context name>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_scheduler
{-l <class LOID> | -c <class context path>}
{-l <Scheduler LOID> | -c <Scheduler context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_scheduler_policy
{-l <class LOID> | -c <class context path>}
<policy> [-debug] [-help]The legal values for <policy> are:
| 0 | This policy value specifies that the class named in <class LOID> or <class context path> should use its default scheduler if the scheduler is currently active. It is intended to protect bootstrap classes, which may be involved in activating Schedulers and Scheduler helper objects. Typically, this policy is not recommended for user class objects.
Classes using this policy should have a default placement available. See legion_set_default_placement. |
| 1 | This policy value specifies that the class should always use its default Scheduler, even if the Scheduler is not active. This is recommended for user classes, which usually require help from a Scheduler object when making placement decisions. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_varch
{-l <host LOID> | -c <host context path>} <arch>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_vrun
{-l <host LOID> | -c <host context path>} <path>
[-debug] [-help]To configure a T3E virtual host object, you could run something like this:
$ legion_set_vrun -c /hosts/my_T3E $LEGION/src/T3E/SDSC
This tells Legion that the scripts are in $LEGION/src/T3E/SDSC.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_vault_host_list
{-l <vault LOID> | -c <vault context path>}
[{-a | -d | -g} <host1> <host2> ... <hostn>] [-p] [-u]
[-debug] [-help]The following optional parameters are supported:
| -c | use context paths to specify vault and host |
| -l | Use LOIDs to specify vault and host |
| -a | Add named host to the vault's acceptable host list |
| -d | Delete named host from the vault's acceptable host list |
| -t | Test whether or not a host is on the vault's acceptable host list |
| -p | Display the vault's acceptable host list |
| -u | Print usage |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
To view the list of hosts that a given vault can operate on, you could use something like the example below.
$ legion_vault_host_list -c /vaults/VaultName -p ** COMPATIBLE HOST LISTING: ** 1.01.07.d49d1a40.000001fc0c04724... ** 1.01.07.d59d1a40.000001fc094e23c... ** 1.01.07.d69d1a40.000001fc0b68108... $
$ legion_vault_host_list -c /vaults/VaultName \ -t 1.01.07...
General Functions about the State of the System

legion_check_system [-v] [-q] [-fix CommandLine | -fix Contexts]
[-debug] [-help]The following options are supported:
| -v | Run the command in a verbose mode. |
| -q | Run the command in a quiet mode, i.e., print only the summary of warnings and errors. |
| -fix CommandLine | Report any errors in a command-line object then delete the object. |
| -fix Contexts | Report any errors in a context object then delete the object. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_classof
{-l <object LOID> | -c <context path>}
[-debug] [-help]$ legion_classof -c Foo The class of 1.01.66000000.01000000.000001fc0... is 1.01.66000000..000001fc0d085b2c33... $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_stat_tree <base context path>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_host_stats {-l <host loid> | -c <host context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_list_objects
{-l <host LOID> | -c <host context path>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_version
[-debug] [-help]$ legion_version VaL Legion version 1.3.5 $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_wellknown_class <wellknown class name>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_whereis
{-l <object LOID> | -c <object context path>}
[-debug] [-help]$ legion_whereis -c Foo Host : /hosts/BootstrapHost Vault : /vaults/BootstrapVault $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_whoami
[-debug] [-help]$ legion_whoami /users/nemo $
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |

Security

legion_add_acl [-l <object LOID> | -c <object context name>] {-s | <filename>}
[-debug] [-help]The following options are supported:
| -s | Read from stdin |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_add_implicit_params
[-l <AuthenticationObject LOID> | -c <AuthenticationObject context path>]
{-s | <filename>}
[-debug] [-help]The following options are supported:
| -s | Read from stdin |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_change_permissions [+-rwx] [-v]
<group/user context path> <target context path>
[-debug] [-help]
This command works on common Legion object types: context, file, class, tty, implementation, host, and vault objects all fall into this category.
The following optional parameters are supported:
| -r | Deny read permissions to the target object. |
| +r | Grant read permissions to the target object. |
| -w | Deny write permissions to the target object. |
| +w | Grant write permissions to the target object. |
| -x | Deny execute permissions to the target object (note that this option is for class objects only). |
| +x | Grant execute permissions to the target object (note that this option is for class objects only). |
| -v | Run the command in verbose mode. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_user [-a <admin path>] [-z <password>]
[-h <new home context>] [-c <AuthenticationClass path>]
<user id path> [-debug] [-help]The user id is the context name of an AuthenticationObject: the legion_create_object utility creates the object and assigns it the context name given in <user id path>. Please note that this argument is a full path (relative or absolute). Note also that the user id's context has nothing to do with that user's privileges in that context.
Once a user is created, the legion_login command is used to log in. The command will prompt for a password for the new user (unless you use the -z option), and will return the new object's LOID.
The following options are supported:
| -a <admin path> | Specify the admin object's context path. Default is /users/admin. |
| -z <password> | Specify the new user id's password. The default setting will prompt for the password after the command has been run. This option is not recommended for casual use, since the password will be visible on the command line. |
| -h <new home context> | Specify the new user's home context. Default is /home/<user id>. |
| Specify the AuthenticationClass which you wish to instantiate. Default is /class/AuthenticationClass. | |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_create_user_object {-l <class LOID> | -c <class context path>}
[-h <host for new object> | -v <vault for new object>]
[-f <implicit parameter file>] [-z <password>] <user name>
[-debug] [-help]The following optional parameters are supported:
| -h <host for new object> | Specify where the new object should be created. |
| -v <vault for new object> | Specify which vault should store the new object's persistent state. |
| -f <implicit parameter file> | This option names a file containing implicit parameters to be stored in the newly created AuthenticationObject (handed out on legion_login). The filename can be "-", in which case the command reads the parameters from the standard input.
Note that these are *not* the implicit parameters that control the behavior of the new AuthenticationObject. Upon login, the user's environment will be set to contain the latter set of implicit parameters, and they will affect the creation of all subsequent objects. This option is intended to make it easier to administer the system. In particular, admin can create user accounts that include implicit parameters that by default give the admin access rights to all of the users' subsequently created objects. |
| -z <password> | Include the user id's password in the command line arguments. This option is not recommended for casual use, as the password is potentially visible to other users in the system while the command is executing. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_acl [-l <object LOID> | -c <object context name>]
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_get_implicit_params [-l <object LOID> | -c <object context name>]
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_init_security
[-debug] [-help]After running legion_init_security you must login as admin in order to use the system. Use the legion_login command, with /user/admin as the <user name> parameter. This command only needs to be run once, when the system is first started. Only one /user/admin should exist in a system.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_login [-l <user LOID> | <user id>]
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_logout
[-debug] [-help]We strongly recommend that users insert this command into a .logout file or some other script that is run when a user logs out. This ensures that credential files do not remain in the system for unnecessarily long periods.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_passwd {-l <user LOID> | <user name>}
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_acl [-l <object LOID> | -c <object context path>]
{-s | <filename>}
[-debug] [-help]The following option is supported:
| -s | Read from standard input |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_set_implicit_params
[-l <object LOID> | -c <object context path>]
{-s | <filename>}
[-debug] [-help]The following option is supported:
| -s | Read from standard input |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Application Development

legion_bfs <file> [-o <out file>] [-BackEnd] [-help]
The following options are used:
| -o <out file> | Name of the file containing the resulting Fortran or MPL output |
| -BackEnd | Instructs the legion_bfs compiler to produce output for IDL files included in the Fortran input file (ignored when the input is a BFS IDL file) |
| -help | Print command syntax and exit. |
legion_generate_idl [<flags>] <input file local path>
[-debug] [-help]$ legion_generate_idl your_file_in.idl
$ legion_generate_idl -trans -client_stubs -header your_file_in.idl
| -A... | Provide an implementation-specific escape. |
| -D<name> | Define a name for the preprocessor. |
| -E | Run the input file on the preprocessor only, print results to stdout. |
| -Idir <directory name> | Specify a directory to included in the search path for the preprocessor. |
| -U<name> | Undefine a name for the preprocessor. |
| -v | Run the command in a verbose setting. This will show the compilation stages. |
| -w | Suppress any IDL compiler warnings. |
| -trans | Generate trans code. |
| -client_stubs | Generate client-side stubs only (i.e., not server-side stubs). |
| -header | Generate header files. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_java <java options>
[-debug] [-help]The <java options> argument can include any command-line options accepted by the locally installed "java" interpreter. This set of options will always include the Java class to be executed.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_make [-v] [-a <architecture>] [-h <host context path>]
[-e <make command>] [-OUT <remote file>] [<arg1> <arg2> ... <argn>]
[-debug] [-help]If no remote host or architecture is specified (with the -h or -a flags) the command will run on a random host. For example, the following command would build the tar file on a random Alpha Linux host:
$ legion_make -a alpha_linux
$ legion_make -h /hosts/HostFoo
| -v | Run in verbose mode (up to four of these flags may be used). |
| -a <architecture> | Specify what kind of platform should be used to execute the command. |
| -h <host context path> | Specify which host should execute the programd. |
| -e <make command> | Specify an executable command (other than make) to be run on the remote host |
| -OUT <result file> | Specifies the local path name of a file that should be copied out of the remote program's current working directory after the program terminates. The default setting does not copy anything back to your current directory. |
| <arg1> <arg2> ... <argn> | Optional arguments passed to the make commands: they can specify make targets or other build parameters. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_make_idl [-notrans] [-noclient] [-v] [-noreg]
[-s <suffix string>] [-run] <application name>
[-debug] [-help]The following options are supported:
| -notrans | Make client-side code only. |
| -noclient | Make class code only. |
| -v | Run command in verbose mode. |
| -noreg | Specify that the resulting binary executable should not be registered with Legion. |
| -s <suffix string> | Attach a suffix to the client and/or class names (i.e., a date, run number, etc.). |
| -run | Run the application in Legion. Note that this will override the -noreg option. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_make_multi [-v] [-a <architecture>][-e <make command>]
[<arg1> <arg2> ... <argn>]
[-debug] [-help]The following options are supported:
| -v | Verbose mode. Print actions as command executes. |
| -a <architecture> | Specify an architecture on which to run make. This option can be specified multiple times to request concurrent builds on multiple platforms. If no architectures are specified, a remote make for the current architecture ($LEGION_ARCH) is performed. |
| -e <make command> | Specify the make-command for the remote build (default is "make"). |
| <arg1> <arg2> ... <argn> | These optional arguments are passed to the remote "make" command. They can specify make targets or other build parameters. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mplc
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mplc_reg_impl <class name> <binary path>
<stateless | stateful | sequential> <arch>
[-debug] [-help]In the example below, MentatObject is a stateful Mentat object in the local path /home/legion/bin on a linux or alpha_linux machine. To register it as belonging to a class with the context path name /ClassObject/MentatObject in linux or alpha_linux architectures, you would enter:
$ legion_mplc_reg_impl /ClassDirectory/MentatObject \ /home/legion/bin/MentatObject stateful linux
$ legion_mplc_reg_impl /ClassDirectory/MentatObject \ /home/legion/bin/MentatObject stateful alpha_linux
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_output_state
{-l <object loid> | -c <object context path>} | StartupState
[-debug] [-help] Warnings
Information
Low Level Debug
High Level Debug
Errors
Fatal Errors
There are two ways to use this command. You can dynamically change which of a specified object's output types are filtered out and which are displayed. This option also allows the user to change the location of the output (from stderr, stdout, and any Unix file they want).
Or, you can use the StartupState option, in which case the command will print instructions for bringing up a new system with the desired output state.
Please note: if you use StartupState, legion_output_state does not contact Legion and therefore does not run as a Legion program. I.e., you can execute it outside of a running Legion system. Otherwise, it runs as a normal Legion command-line tool.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_record
{-uf <local storage file name> | -c <recorder context path>}
[-name <debug session name> ] [-t <interval>]
<client application> [<arg1> <arg2> ... <argN>]
[-debug] [-help]Only one execution of the application will be recorded in the storage file at a time. If you record again to the same storage file you will overwrite previous data.
If you wish to use a Legion recorder object to record your application's activity, you must start the recorder object separately (i.e., legion_create_object -c /class/RecorderObject).
If you wish to record a server object (i.e., one that is not created by the client application, but instead exists on its own), you must start the server object in record mode independently of the client application.
The following options are supported:
| -name <session name> | Specify a name for the debug session. If this option is not used, a random name will be chosen. |
| -t <interval> | Specifies how much time (in seconds) the legion_record utility waits between health checks on its objects. These health checks are used to poll the recorder object to learn about object death. The default setting is 30 seconds. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_replay {-uf <local storage file name> |
-c <recorder context path> -name <debug session name>}
{-list | [-cmd <debugger name>] [-local] <session number>}
[-debug] [-help]The following options are supported:
| -list | Display the sessions in the storage file. |
| -cmd <debugger name> | Specify a debugging program (i.e. gdb, xdb, etc.) to run on the storage file. Default is gdb. |
| -local | Indicates that the debugging session should be replayed on your local machine. The default will start a remote session on the machine which executed the original object. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_stateless_add_workers <class name>
<worker name1> <worker name2> ... <worker nameN>
[-debug] [-help]The <class name> parameter should be the stateless class object's context name. The <worker name> parameters should be the desired context name of the new worker objects. Note that you can use full or relative path names.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_stateless_configure <stateless class context path>
[-n <number of replicas>] [-Ch <host context path>]
[-w <max number work requests>] [-FlUsH]
[-debug] [-help]The current version of the proxy object uses a self-scheduling algorithm. When N work requests have been farmed out, the proxy will store any pending requests in an internal queue: when a worker is available, the proxy assigns it a request from the queue. N here is given by the following formula:
N = <number of replicas> * <max number of workers>
| -n <number of replicas> | Specify the number of workers to be used. Default is 1. |
| -Ch <context containing list of hosts> | Name a host where the work requests should be executed. |
| -w <max number of work requests> | Specify the maximum number of work requests that each worker should service at a time. Default is 5. |
| -update | Tell the proxy object that the worker interface has changed. |
| -Flush | Remove all work requests for this class. |
| -status | Display the command's status information (a tty must be on). |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_stateless_remove_workers <class name>
<worker name1> <worker name2> ... <worker nameN>
[-debug] [-help]The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Program Support

legion_link [-CC <compiler>] [-Fortran] [-pvm] [-mpi] [-L<library path>]
[-l<library>] [-v] [-o <output file>] [-bfs] <object file list>
[-debug] [-help]The following options are available with this command:
| -CC <compiler> | Select a C++ compiler to perform linkage. The default value is based on the default compiler used by the Legion system on your platform. |
| -Fortran | If any Fortran object files are linked, the -Fortran flag must be included. |
| -pvm | Link the produced executable to the Legion PVM compatibility library. |
| -mpi | Link the produced executable to the Legion MPI compatibility library. |
| -l<library path> | Include the |
| -l<library> | Link against the specified library. |
| -v | Provide a verbose output as the command is running |
| -o <output path> | Specify the local path of the resulting program. The default is a.out. |
| -bfs | Link the produced executable to the Legion Basic Fortran Support (BFS) library. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mpi_debug [-q] {-c <instance context path>}
[-debug] [-help]There are a few limitations in legion_mpi_debug: If an MPI object doesn't respond, it will hang, and it won't go on to query additional objects. An MPI object can only respond when it enters the MPI library; if it is in an endless computational loop, it will never reply.
The following options are available with this command:
| -q | List the contents of the queues. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mpi_register
<class name> <binary local path name> <platform type>
[-debug] [-help]The command can be executed several times, if you have compiled your program on several architecture.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_mpi_run
{-f <options file> [<flags>]} |
{-n <number of hosts> [<flags>] <command> [<arguments>]}
[-debug] [-help]| -f <options file> | Allows users to run multiple MPI binaries with a common MPI_COMM_WORLD. |
| -n <number of processes> | Specify the number of hosts on which the program will run. |
Supported <flags> are (a set of special flags for running in a fault tolerant mode is listed below):
| -v | Verbose option (up to four can be specified for increased detail). |
| -h <host set context path> | Specify the set of hosts on which the program will run. The context path should not resolve to a particular host but to a context containing the names of one or more hosts. The default setting is the system's default placement: i.e., the system will pick a compatible host pick and try to run the object. If it fails the system will try another compatible host. |
| -0 <host context name> | Runs the first process (i.e., process zero) on this node. |
| -d <Unix path name> | Specify that all children change to the specified directory before they begin to run. |
| -hf <context path> | Reads the Legion basic file object named in <context path>. This file must contain a list of hosts and optional integers indicating the number of Legion objects that can be scheduled on those hosts. You must use a specific format when creating this file (see below for an example). This list is then used for scheduling the objects from the current execution of a Legion MPI program. All of the objects from this Legion MPI run will be created using vector creates. |
| -A | Pass the files named in the -std*/-STD* parameters to all nodes. The default setting gives these files only to node 0. |
| -a | Pass the files named in the -in/-out/-IN/-OUT parameters to all nodes. The default setting gives these files only to node 0.
Files named in the -out/-OUT parameters will be copied to files that use the following conventions: <name>.<mpi object id>, where <name> is either the <context path> or <local file name> given in the -out/-OUT parameters. |
| -in <context path> | Context path of a Legion basic file object whose contents should be copied into the remote program's current working directory before execution begins. The local file will have the same name as the basic file object. This flag can be used multiple times to indicate multiple input files. |
| -out <context path> | Context path of a Legion basic file object whose contents should be copied out of the remote program's current working directory after the program terminates. The new local file will have the same context name as the original file object unless the -a flag is used, in which case the name will be <context path>.<mpi object id>. This flag can be used multiple times.
The output files will be copied out when the program calls MPI_Finalize or MPI_Abort. Output files that are not found in the program's current working directory will be copied but will appear as empty files. If the program crashes, the files will be left in the program's current working directory. |
| -stdin <context path> | Map stdin to the Legion file object named in <context path>. |
| -stdout <context path> | Map stdout to the Legion file object named in <context path>. The local object will have the same context name as the original file object unless the -A flag is used, in which case the name will be <context path>.<mpi object id>. |
| -stderr <context path> | Map stderr to the Legion file object named in <context path>. The local object will have the same context name as the original file object (<context path>.<unique id>) unless the -A flag is used, in which case the name will be <context path>.<mpi object id>. |
| -HF <local file name> | Reads the local file named in <local file name>. This file must contain a list of hosts and optional integers indicating the number of Legion objects that can be scheduled on those hosts. You must use a specific format when creating this file. You can use legion_make_schedule to create the file or do it by hand (see below).
This list is then used for scheduling the objects from the current execution of a Legion MPI program. All of the objects from this Legion MPI run will be created using vector creates. |
| -IN <local file name> | Similar to the -in option, but operates on a file in the local execution environment of legion_mpi_run (i.e., the file named in <local file name>). This flag can be repeated. |
| -OUT <local file name> | Similar to the -out option, but operates on a file in the local execution environment of legion_mpi_run (i.e., the file named in <local file name>). This flag can be repeated. |
| -STDIN <local file name> | Map stdin to the local file named in <local file name>. |
| -STDOUT <local file name> | Map stdout to the local file named in <local file name>. |
| -STDERR <local file name> | Map stderr to the local file named in <local file name>. |
| -S | Print statistics at exit. |
| -p <PID context> | Specify a context name for PIDs. Default is /mpi/instances/ program_name unless security is enabled, in which case the default is /home/<user_name>/mpi/in-stances/<program_name>. If the context does not exist it will be created. |
| Set the environment variable named in <variable_name> to a specified value on all MPI processes after they have called MPI_Init(). This option may be repeated multiple times to set additional environment variables. | |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
/hosts/BootstrapHost 5 /hosts/slowMachine1 /hosts/bigPBSqueue 100 /hosts/slowMachine2 1
If you use the -f flag, Legion will ignore the -n flag, program name, and any arguments. Any <flags> used with -f will be treated as defaults and applied to all processes executed by this command, unless otherwise specified in the options file. The legion_mpi_run utility will expect one binary per line in the options file, each line including any necessary arguments as they would appear on the command line. Each line can also contain any of the legion_mpi_run flags except the -f flag. If the -f flag is not used, the MPI application named in the legion_mpi_run command will then be started with the given flags.
An example, here running MPI program vdelay on two hosts, would be:
$ legion_mpi_run -n 2 /mpi/programs/vdelay
Use legion_ls to examine the running objects of your application . The /mpi/instances/<program_name> context will have an entry for each object in your application. E.g.,
$ legion_ls /mpi/instances/vdelay
There is a set of special legion_mpi_run flags that can be used when running in a fault tolerant mode. These flags are used in specific combinations. You must use the -ft in all cases and you must use either -s or -R. The -g and -r flags are optional.
| -ft | Turn on fault tolerance. |
| -s <checkpoint server> | Specifies the checkpoint server to use. |
| -R | Recovery mode. |
| -g <pingInterval> | Specify a ping interval. Default is 90 seconds. |
| -r <reconfigurationInterval> | Specify a period (in seconds) for detecting failure. If an object does not respond within the specified period, the application restarts from the last consistent checkpoint. Default value is 360 seconds. |
Please see section 10.1.10 in the Basic User Manual for more information on running in fault tolerant mode.
legion_native_mpi_config_host [<wrapper>] [-debug] [-help]
| <wrapper> | Specify a wrapper script that locates mpirun on the host. The default specifies the legion_native_mpich_wrapper script, which is for an MPICH implementation. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_native_mpi_init [<architecture>] [-debug] [-help]
| <architecture> | Specify an architecture for which an implementation for this class can be registered. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_native_mpi_register <class name> <binary path> <architecture>
[-debug] [-help]$ legion_native_ mpi_register charmm /myMPIprograms/charmm linux
You can run register a program multiple times, perhaps with different architectures or different platforms. If you have not registered this program before, this will create a context in the current context path (the context's name will be the program's class name -- in this case, charmm) and registers the name in Legion context space.
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_native_mpi_run
[-v] [-a <architecture>] [-h <host context path>]
[-IN <local input file>] [-OUT <local result file>]
[-in <Legion input file>] [-out <Legion result file>]
[-n <nodes>] [-t <minutes>]
[-legion] [-debug] [-help]
<program context path>
[<arg 1> <arg 2> ... <arg n>]| -h <host context path> | Specify the host on which the program will run. The default setting is the system's default placement, which is to pick a compatible host and try to run the object. If the host fails, the system will try another compatible host. |
| -v | Verbose option. |
| -a <architecture> | Specify the architecture on which to run. |
| -IN <local input file> | Specify an input file that should be copied to the remote run from the local file system. |
| -OUT <local result file> | Specify a result file that should be copied back from the remote run to the local file system. |
| -in <Legion input file> | Specify an input file that should be copied to the remote run from the Legion context space. |
| -out <Legion result file> | Specify a result file that should be copied out from the remote run into Legion context space. |
| -n <nodes> | Specify the number of nodes for the remote MPI run. |
| -t <minutes> | Specify the amount of time requested for the remote MPI run. This option is only meaningful if the host selected to run the remote program enforces time limits for jobs. |
| -legion | Indicate whether the application makes Legion calls (see section section 10.2.5 on page 64 in the Basic User manual). |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
| <arg1> <arg2> ... <argn> | Arguments to be passed to the remote MPI program. |
legion_pvm_register
<class path name> <binary local path name> <platform type>
[-debug] [-help]Once you've registered an application, you can run it. If necessary, you can examine Legion context space with either
$ legion_ls /pvm
$ legion_ls /pvm/tasks
To register a Linux binary named matmult in Legion, enter:
$ legion_pvm_register /pvm/tasks/matmult matmult linux
The following options are supported:
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_register_program
<program class> <executable path> <legion arch>
[-debug] [-help]Programs registered through legion_register_program can be executed with the legion_run command. See also legion_register_runnable for information about registering Legion programs.
The following parameters are used with this command:
| <program class> | The Legion context path name of the class with which the registered program should be associated |
| <executable path> | The local file path of the executable program to register. This can be any program that could be run from the shell command prompt, including scripts, and binary executable generated by any programming language. |
| <legion arch> | The platform type that the program should be executed. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_register_runnable
<program class> <executable path> <legion arch>
[-debug] [-help]The following parameters are used with this command:
| <program class> | The Legion context space path of the class with which the registered program should be associated |
| <executable path> | The local file path of the executable program to register. This program should be a valid Legion object implementation that has been linked with the Legion library, and that exports the Legion "runnable" interface. |
| <legion arch> | The platform type on which the program should be executed. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_run [-w] [-v] [a <architecture>]
[-h <host context path name>]
[-in <context path name>] [-out <context path name>]
[-IN <local file name>] [-OUT <local file name>]
[-f <options file>] <program class>
[-t <minutes>] [-n <nodes>]
[<arg1> <arg2> ... <argn>]
[-debug] [-help]Note that any number of input and output files may be specified for a single execution of legion_run (i.e., the -in/-out and -IN/-OUT options can be repeated). The -f flag can be used to specify legion_run options in the file named in <options file>, rather than on the command line.
The following parameter is used with this command:
| <program class> | Specifies the program class of which an instance should be executed. This program class should have been previously created with the legion_register_program or legion_register_runnable command. |
| The following optional parameters are supported: | |
| -w | Directs legion_run's output to your current tty object. If you have not created and set a tty object for your current window you will not be able to see any output and an error message will appear. |
| -v | Run command in verbose mode. |
| -a <architecture> | Allows users to specify what kind of architecture the program should be executed on. |
| -h <host context path name> | Specify which host should execute program. |
| -in <context path name> | Context path of a Legion file object whose contents should be copied into the remote program's current working directory before execution begins. The local file will have the same name as the <context path name> basename. |
| -out <context path name> | Context path of a Legion file object whose contents should be copied out of the remote program's current working directory after the program terminates. The local source file will have the same name as the <context path name> basename. Note that output files are copied out regardless of the cause of program termination. Partial results will be available if the program crashes. Output files that are not found in the program's current working directory are skipped. |
| -IN <local file name> | Similar to the -in option, but operates on a file in the local execution environment of legion_run (i.e., the file named in <local file name>). |
| -OUT <local file name> | Similar to the -out option, but operates on a file in the local execution environment of legion_run (i.e., the file named in <local file name>). |
| -f <options file> | Allows users to specify options for running legion_run in a separate file rather than listing them on the command line. This is useful for programs that make extensive use of the -in/-out or -IN/-OUT options. The file can contain one or more options, delimited by spaces, tabs, or blank lines. The program class name and arbitrary command-line arguments may not be included in this file. No other information should be included. |
| -t <minutes> | Specifies the amount of time (in minutes) needed to run the program. If this option is not used, the host will assign the job its default time block. This option is only meaningful if the host selected to run the remote program enforces time limits for jobs: otherwise this option is not required. |
| -n <nodes> | If the remote program is a native parallel job (e.g., a program written to use the local vendor MPI implementation), use this option to specify the number of nodes that should be allocated to the job. This option is not meaningful if the host selected to run the remote program is a uniprocessor or does not support multi-node allocations. |
| <arg1> <arg2>... <argn> | Allows users to provide arbitrary command-line arguments for the program. |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
legion_run_multi [-v] {-n <number of processors>}
[-s <schedule file name>]
{-f <specification file name>} <program class name>
[<arg1> <arg2> ... <argn>]
[-debug] [-help]The specification file might look something like this:
IN in.dat in.dat.* constant const.dat OUT out.dat
The keywords' case determines the file's location:
| CONSTANT/IN/OUT/stdout/stderr/stdin | local file space | |
| constant/in/out | Legion context space* |
Note that if your program prints to standard output you must direct your output to a Legion tty object with the legion_tty_watch command (if you have not yet created a tty object, see the tty tutorial).
The following parameters are used with this command:
| <program class name> | The program's Legion context path (created when the program was registered in Legion). |
| -n <number of processors> | The number of processors that should run the program. |
| -f <specification file name> | The specification file's Unix path name. |
The following options are available with this command:
| -s <schedule file name> | Specify a Legion schedule for running the program. The schedule contains a list of Legion host context names, followed by an integer specifying how many jobs can be run at once on a host (e.g., /hosts/Foo 3 to run up to three jobs on host object Foo). |
| -v | Provide a verbose output as the command is running (you can use up to four of these to get increasing levels of detail) |
| <arg1> <arg2> ... <argn> | Allows users to include arbitrary command-line arguments for the program |
| -debug | Catch and print Legion exceptions. |
| -help | Print command syntax and exit. |
Alphabetical list of Legion commands

Other relevant on-line documents:
Last modified: Thu Apr 27 09:50:10 2000
|
[Testbeds] [Et Cetera] [Map/Search]
legion@Virginia.edu
|