Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Broke out the intro into a new chapter. Made minor tweaks. Fleshed ou…
…t examples.
- Loading branch information
Showing
6 changed files
with
170 additions
and
2,077 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"> | ||
| <head> | ||
| <title>RD-QUEUE(1) RunDeck User Manuals | Version 1.0</title> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> | ||
| <meta name="generator" content="pandoc" /> | ||
| <meta name="author" content="Greg Schueler" /> | ||
| <meta name="author" content="Alex Honor" /> | ||
| <meta name="date" content="November 20, 2010" /> | ||
| </head> | ||
| <body> | ||
| <h1 class="title">RD-QUEUE(1) RunDeck User Manuals | Version 1.0</h1> | ||
| <h1 id="name" | ||
| >NAME</h1 | ||
| ><p | ||
| >rd-queue - execute commands across nodes</p | ||
| ><h1 id="synopsis" | ||
| >SYNOPSIS</h1 | ||
| ><p | ||
| >rd-queue [<em | ||
| >action</em | ||
| >] [-h] [-e]</p | ||
| ><h1 id="description" | ||
| >DESCRIPTION</h1 | ||
| ><p | ||
| >The rd-queue command is used to query the Central Dispatcher for a list of currently running Executions, or to Kill a currently running execution.</p | ||
| ><p | ||
| >The tool provides two actions:</p | ||
| ><ul | ||
| ><li | ||
| ><p | ||
| ><code | ||
| >list</code | ||
| > : list the currently running executions on the server (default action)</p | ||
| ></li | ||
| ><li | ||
| ><p | ||
| ><code | ||
| >kill</code | ||
| > : kill the execution specified by ID</p | ||
| ></li | ||
| ></ul | ||
| ><h1 id="options" | ||
| >OPTIONS</h1 | ||
| ><p | ||
| >-h, --help : Print usage message.</p | ||
| ><p | ||
| >-e, --eid : ID of the execution to kill</p | ||
| ><h1 id="list-action" | ||
| >LIST ACTION</h1 | ||
| ><p | ||
| >This is the default action of the tool, so to list all running Executions, simply use:</p | ||
| ><pre | ||
| ><code | ||
| >rd-queue | ||
| </code | ||
| ></pre | ||
| ><p | ||
| >The output will display the number of executions, and their IDs and identifying names or descriptions, as well as a link to the RunDeck page to follow the output.</p | ||
| ><p | ||
| ><em | ||
| >Example</em | ||
| ></p | ||
| ><pre | ||
| ><code | ||
| >rd-queue | ||
| Queue: 1 items | ||
| [160] adhoc script job <http://localhost:8080/rundeck/execution/follow/160> | ||
| </code | ||
| ></pre | ||
| ><h1 id="kill-action" | ||
| >KILL ACTION</h1 | ||
| ><p | ||
| >This action allows you to specify the Execution ID of a currently running execution that you want to stop.</p | ||
| ><p | ||
| ><em | ||
| >Example</em | ||
| ></p | ||
| ><pre | ||
| ><code | ||
| >rd-queue kill -e 160 | ||
| rd-queue kill: success. [160] Job status: killed | ||
| </code | ||
| ></pre | ||
| ><h1 id="see-also" | ||
| >SEE ALSO</h1 | ||
| ><p | ||
| ><code | ||
| >dispatch</code | ||
| > (1), <code | ||
| >run</code | ||
| > (1).</p | ||
| ><p | ||
| >The RunDeck source code and all documentation may be downloaded from <a href="https://github.com/dtolabs/rundeck/" | ||
| ><code | ||
| >https://github.com/dtolabs/rundeck/</code | ||
| ></a | ||
| >.</p | ||
| > | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| .TH RD-QUEUE 1 "November 20, 2010" "RunDeck User Manuals" "Version 1.0" | ||
| .SH NAME | ||
| .PP | ||
| rd-queue - execute commands across nodes | ||
| .SH SYNOPSIS | ||
| .PP | ||
| rd-queue [\f[I]action\f[]] [-h] [-e] | ||
| .SH DESCRIPTION | ||
| .PP | ||
| The rd-queue command is used to query the Central Dispatcher for a | ||
| list of currently running Executions, or to Kill a currently | ||
| running execution. | ||
| .PP | ||
| The tool provides two actions: | ||
| .IP \[bu] 2 | ||
| \f[C]list\f[] : list the currently running executions on the server | ||
| (default action) | ||
| .IP \[bu] 2 | ||
| \f[C]kill\f[] : kill the execution specified by ID | ||
| .SH OPTIONS | ||
| .PP | ||
| -h, --help : Print usage message. | ||
| .PP | ||
| -e, --eid : ID of the execution to kill | ||
| .SH LIST ACTION | ||
| .PP | ||
| This is the default action of the tool, so to list all running | ||
| Executions, simply use: | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| rd-queue | ||
| \f[] | ||
| .fi | ||
| .PP | ||
| The output will display the number of executions, and their IDs and | ||
| identifying names or descriptions, as well as a link to the RunDeck | ||
| page to follow the output. | ||
| .PP | ||
| \f[I]Example\f[] | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| rd-queue\ | ||
| Queue:\ 1\ items | ||
| [160]\ adhoc\ script\ job\ <http://localhost:8080/rundeck/execution/follow/160> | ||
| \f[] | ||
| .fi | ||
| .SH KILL ACTION | ||
| .PP | ||
| This action allows you to specify the Execution ID of a currently | ||
| running execution that you want to stop. | ||
| .PP | ||
| \f[I]Example\f[] | ||
| .IP | ||
| .nf | ||
| \f[C] | ||
| rd-queue\ kill\ -e\ 160 | ||
| rd-queue\ kill:\ success.\ [160]\ Job\ status:\ killed | ||
| \f[] | ||
| .fi | ||
| .SH SEE ALSO | ||
| .PP | ||
| \f[C]dispatch\f[] (1), \f[C]run\f[] (1). | ||
| .PP | ||
| The RunDeck source code and all documentation may be downloaded | ||
| from <https://github.com/dtolabs/rundeck/>. | ||
| .SH AUTHORS | ||
| Greg Schueler; Alex Honor. |
Oops, something went wrong.