Commit 0a9d2bfd authored by Youri Bonnaffé's avatar Youri Bonnaffé
Browse files

DOC-205 createns() CLI example

parent 6f01fd37
......@@ -68,4 +68,24 @@ The client usage is also available using the +-h+ parameter as shown below:
-ulon,--unlocknodes <node1-url node2-url ...> | Unlock specified nodes |
-X,--debug | Print error messages (includes normal stack trace) |
-z,--silent | Runs the command-line client in the silent mode |
|===
\ No newline at end of file
|===
==== Command Line Examples
===== Deploy ProActive Nodes
====== In non-interactive mode
[source]
----
$ PROACTIVE_HOME/bin/proactive-client -cn 'moreLocalNodes' -infrastructure 'org.ow2.proactive.resourcemanager.nodesource.infrastructure.LocalInfrastructure' './config/authentication/rm.cred' 4 60000 '' -policy org.ow2.proactive.resourcemanager.nodesource.policy.StaticPolicy 'ALL' 'ALL'
----
====== In interactive mode
[source]
----
$ PROACTIVE_HOME/bin/proactive-client
> createns( 'moreLocalNodes', ['org.ow2.proactive.resourcemanager.nodesource.infrastructure.LocalInfrastructure', './config/authentication/rm.cred', 4, 60000, ''], ['org.ow2.proactive.resourcemanager.nodesource.policy.StaticPolicy', 'ALL', 'ALL'])
----
......@@ -190,7 +190,7 @@ host2.mydomain.com 4
Then using this file create a Node Source either from the *Resource Manager Web Interface* or from the command line:
[source]
----
$ PROACTIVE_HOME/bin/proactive-client -createns SSH_node_source --infrastructure org.ow2.proactive.resourcemanager.nodesource.infrastructure.SSHInfrastructure SCHEDULER_ADDRESS HOSTS_FILE 60000 3 \"\" /home/user/jdk/bin/java PROACTIVE_HOME Linux \"\" config/authentication/rm.cred
$ PROACTIVE_HOME/bin/proactive-client -createns SSH_node_source --infrastructure org.ow2.proactive.resourcemanager.nodesource.infrastructure.SSHInfrastructure HOSTS_FILE 60000 3 \"\" /home/user/jdk/bin/java PROACTIVE_HOME Linux \"\" config/authentication/rm.cred
----
Don't forget to replace +SCHEDULER_ADDRESS+, +HOSTS_FILE+ and +PROACTIVE_HOME+ with the corresponding values.
......
The Scheduler client allows you to submit workflows, list jobs, pause/resume/kill jobs and retrieve results and logs.
The client has an interactive mode started if you do not provided any command.
The client usage is also available using the +-h+ parameter as shown below:
$ PROACTIVE_HOME/bin/proactive-client -h
[cols="1,2"]
|===
| Parameter | Description |
-c,--credentials <arg> | Path to the credentials (/home/ybonnaffe/.proactive/security/creds.enc). |
-cmd,--command | If mentionned, -submit argument becomes a command line, ie: -submit command
args... |
-cmdf,--commandf | If mentionned, -submit argument becomes a text file path containing command
lines to schedule |
-env,--environment <filePath> | Execute the given script as an environment for the interactive mode |
-freeze,--schedulerfreeze | Freeze the Scheduler (cause all non-running tasks to be paused) |
-h,--help | Display this help |
-jn,--jobname <jobName> | Used with -cmd or -cmdf, specify the job name |
-jo,--joboutput <jobId> | Get the output of the given job |
-jp,--jobpriority <jobId newPriority> | Change the priority of the given job (Idle, Lowest, Low, Normal, High,
Highest) |
-jr,--jobresult <jobId> | Get the result of the given job |
-js,--jobstate <jobId> | Get the current state of the given job (Also tasks description) |
-k,--key <sshkeyFilePath> | (Optional) The path to a private SSH key |
-kill,--schedulerkill | Kill the Scheduler |
-kj,--killjob <jobId> | Kill the given job (cause the job to finish) |
-kt,--killtask <jobId taskName> | Kill the given task. |
-l,--login <login> | The username to join the Scheduler |
-lj,--listjobs | Display the list of jobs managed by the scheduler |
-ll,--logs <jobId [taskName]> | Get server logs of given job or task |
-lrm,--linkrm <rmURL> | Reconnect a RM to the scheduler |
-ma,--myaccount | Display current user account information |
-p,--policy <fullName> | Change the current scheduling policy |
-pause,--schedulerpause | Pause the Scheduler (cause all non-running jobs to be paused) |
-pj,--pausejob <jobId> | Pause the given job (pause every non-running tasks) |
-pr,--policyreload | Reload the policy configuration |
-pt,--preempttask <jobId taskName delay> | Stop the given task and re-schedules it after specified delay. |
-rc,--reloadconfig | Reloads the scheduler permission policy and log4j config |
-resume,--schedulerresume | Resume the Scheduler |
-rj,--resumejob <jobId> | Resume the given job (restart every paused tasks) |
-rmj,--removejob <jobId> | Remove the given job |
-rt,--restarttask <jobId taskName delay> | Terminate the given task and re-schedules it after specified delay. |
-s,--submit <XMLDescriptor> | Submit the given job XML file |
-sa,--submitarchive <jobarchive> | Submit the given job archive |
-sf,--script <filePath arg1=val1 arg2=val2 ...> | Execute the given javascript file with optional arguments. |
-shutdown,--schedulershutdown | Shutdown the Scheduler |
-ss,--selectscript <selectScript> | Used with -cmd or -cmdf, specify a selection script |
-start,--schedulerstart | Start the Scheduler |
-stats,--statistics | Display some statistics about the Scheduler |
-stop,--schedulerstop | Stop the Scheduler |
-test | Test if the Scheduler is successfully started by committing some examples |
-to,--taskoutput <jobId taskName> | Get the output of the given task |
-tr,--taskresult <jobId taskName [inc]> | Get the result of the given task |
-u,--url <schedulerURL> | The scheduler URL |
-ua,--useraccount <username> | Display account information by username |
|===
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment