mirror of
https://github.com/Fishwaldo/rundeck-api-java-client.git
synced 2025-07-07 13:38:23 +00:00
text fix naming RunDeck to Rundeck
This commit is contained in:
Greg Schueler
parent
19527ea325
commit
d612f3c88b
5 changed files with 70 additions and 70 deletions
|
|
@ -1,5 +1,5 @@
|
|||
|
||||
h1. Using the RunDeck API from Groovy scripts
|
||||
h1. Using the Rundeck API from Groovy scripts
|
||||
|
||||
Here are some examples of what you can do with this lib and a few lines of [Groovy|http://groovy.codehaus.org/].
|
||||
|
||||
|
|
@ -16,11 +16,11 @@ import org.rundeck.api.RundeckClient
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
|
||||
println "All RunDeck projects : ${rundeck.projects}"
|
||||
println "All RunDeck nodes : ${rundeck.nodes}"
|
||||
println "All RunDeck jobs : ${rundeck.jobs}"
|
||||
println "All RunDeck running executions : ${rundeck.runningExecutions}"
|
||||
println "Rundeck uptime : ${rundeck.systemInfo.uptime}"
|
||||
println "All Rundeck projects : ${rundeck.projects}"
|
||||
println "All Rundeck nodes : ${rundeck.nodes}"
|
||||
println "All Rundeck jobs : ${rundeck.jobs}"
|
||||
println "All Rundeck running executions : ${rundeck.runningExecutions}"
|
||||
{code}
|
||||
|
||||
You can also [download|./download.html] the lib and all its dependencies in 1 big jar file, and add it to your classpath before running your script : save the following script in a file named "{{rundeck.groovy}}", and execute it with "{{groovy -cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.groovy}}".
|
||||
|
|
@ -30,18 +30,18 @@ import org.rundeck.api.RundeckClient
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
println "RunDeck uptime : ${rundeck.systemInfo.uptime}"
|
||||
println "All RunDeck projects : ${rundeck.projects}"
|
||||
println "All RunDeck nodes : ${rundeck.nodes}"
|
||||
println "All RunDeck jobs : ${rundeck.jobs}"
|
||||
println "All RunDeck running executions : ${rundeck.runningExecutions}"
|
||||
println "Rundeck uptime : ${rundeck.systemInfo.uptime}"
|
||||
println "All Rundeck projects : ${rundeck.projects}"
|
||||
println "All Rundeck nodes : ${rundeck.nodes}"
|
||||
println "All Rundeck jobs : ${rundeck.jobs}"
|
||||
println "All Rundeck running executions : ${rundeck.runningExecutions}"
|
||||
{code}
|
||||
|
||||
h2. Authentication
|
||||
|
||||
Starting with RunDeck API 2, there are 2 ways to authenticate :
|
||||
Starting with Rundeck API 2, there are 2 ways to authenticate :
|
||||
* the *login-based authentication* : with your login and password
|
||||
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
|
||||
* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
|
||||
|
||||
{code}
|
||||
// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
|
||||
|
|
@ -82,7 +82,7 @@ h2. Running an ad-hoc command
|
|||
import org.rundeck.api.RundeckClient
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of the "uptime" command on the RunDeck server
|
||||
// trigger the execution of the "uptime" command on the Rundeck server
|
||||
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
|
||||
|
||||
// run the "uptime" command on all unix nodes
|
||||
|
|
@ -95,7 +95,7 @@ h2. Running an ad-hoc script
|
|||
import org.rundeck.api.RundeckClient
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of a custom bash script on the RunDeck server
|
||||
// trigger the execution of a custom bash script on the Rundeck server
|
||||
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
|
||||
|
||||
// run a bash script (with options) on all unix nodes
|
||||
|
|
@ -124,5 +124,5 @@ println "${result.succeededJobs.size} jobs successfully imported, ${result.skipp
|
|||
|
||||
h2. And more...
|
||||
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
|
||||
h1. Using the RunDeck API from JRuby scripts
|
||||
h1. Using the Rundeck API from JRuby scripts
|
||||
|
||||
Here are some examples of what you can do with this lib and a few lines of [Ruby|http://www.jruby.org/] (for the rubyist that don't fear running on the JVM !)
|
||||
|
||||
|
|
@ -16,11 +16,11 @@ import org.rundeck.api.RundeckClient
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
puts "RunDeck uptime : #{rundeck.systemInfo.uptime}"
|
||||
puts "All RunDeck projects : #{rundeck.projects}"
|
||||
puts "All RunDeck nodes : #{rundeck.nodes}"
|
||||
puts "All RunDeck jobs : #{rundeck.jobs}"
|
||||
puts "All RunDeck running executions : #{rundeck.runningExecutions}"
|
||||
puts "Rundeck uptime : #{rundeck.systemInfo.uptime}"
|
||||
puts "All Rundeck projects : #{rundeck.projects}"
|
||||
puts "All Rundeck nodes : #{rundeck.nodes}"
|
||||
puts "All Rundeck jobs : #{rundeck.jobs}"
|
||||
puts "All Rundeck running executions : #{rundeck.runningExecutions}"
|
||||
{code}
|
||||
|
||||
You can also add the library to the classpath : save the following script in a file named "{{rundeck.rb}}", and execute it with "{{jruby -rjava -J-cp /path/to/rundeck-api-java-client-VERSION-jar-with-dependencies.jar rundeck.rb}}".
|
||||
|
|
@ -30,18 +30,18 @@ import org.rundeck.api.RundeckClient
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
puts "RunDeck uptime : #{rundeck.systemInfo.uptime}"
|
||||
puts "All RunDeck projects : #{rundeck.projects}"
|
||||
puts "All RunDeck nodes : #{rundeck.nodes}"
|
||||
puts "All RunDeck jobs : #{rundeck.jobs}"
|
||||
puts "All RunDeck running executions : #{rundeck.runningExecutions}"
|
||||
puts "Rundeck uptime : #{rundeck.systemInfo.uptime}"
|
||||
puts "All Rundeck projects : #{rundeck.projects}"
|
||||
puts "All Rundeck nodes : #{rundeck.nodes}"
|
||||
puts "All Rundeck jobs : #{rundeck.jobs}"
|
||||
puts "All Rundeck running executions : #{rundeck.runningExecutions}"
|
||||
{code}
|
||||
|
||||
h2. Authentication
|
||||
|
||||
Starting with RunDeck API 2, there are 2 ways to authenticate :
|
||||
Starting with Rundeck API 2, there are 2 ways to authenticate :
|
||||
* the *login-based authentication* : with your login and password
|
||||
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
|
||||
* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
|
||||
|
||||
{code}
|
||||
// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
|
||||
|
|
@ -87,7 +87,7 @@ import org.rundeck.api.NodeFiltersBuilder
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of the "uptime" command on the RunDeck server
|
||||
// trigger the execution of the "uptime" command on the Rundeck server
|
||||
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
|
||||
|
||||
// run the "uptime" command on all unix nodes
|
||||
|
|
@ -103,7 +103,7 @@ import org.rundeck.api.NodeFiltersBuilder
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of a custom bash script on the RunDeck server
|
||||
// trigger the execution of a custom bash script on the Rundeck server
|
||||
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
|
||||
|
||||
// run a bash script (with options) on all unix nodes
|
||||
|
|
@ -132,5 +132,5 @@ puts "#{result.succeededJobs.size} jobs successfully imported, #{result.skippedJ
|
|||
|
||||
h2. And more...
|
||||
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
|
||||
h1. Using the RunDeck API from Jython scripts
|
||||
h1. Using the Rundeck API from Jython scripts
|
||||
|
||||
Here are some examples of what you can do with this lib and a few lines of [Python|http://www.jython.org/] (for the pythonist that don't fear running on the JVM !)
|
||||
|
||||
|
|
@ -14,18 +14,18 @@ from org.rundeck.api import RundeckClient
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
print("RunDeck uptime : %s" % rundeck.systemInfo.uptime)
|
||||
print("All RunDeck projects : %s" % rundeck.projects)
|
||||
print("All RunDeck nodes : %s" % rundeck.nodes)
|
||||
print("All RunDeck jobs : %s" % rundeck.jobs)
|
||||
print("All RunDeck running executions : %s" % rundeck.runningExecutions)
|
||||
print("Rundeck uptime : %s" % rundeck.systemInfo.uptime)
|
||||
print("All Rundeck projects : %s" % rundeck.projects)
|
||||
print("All Rundeck nodes : %s" % rundeck.nodes)
|
||||
print("All Rundeck jobs : %s" % rundeck.jobs)
|
||||
print("All Rundeck running executions : %s" % rundeck.runningExecutions)
|
||||
{code}
|
||||
|
||||
h2. Authentication
|
||||
|
||||
Starting with RunDeck API 2, there are 2 ways to authenticate :
|
||||
Starting with Rundeck API 2, there are 2 ways to authenticate :
|
||||
* the *login-based authentication* : with your login and password
|
||||
* the *token-based authentication* : with a unique token that you can generate from the RunDeck webUI
|
||||
* the *token-based authentication* : with a unique token that you can generate from the Rundeck webUI
|
||||
|
||||
{code}
|
||||
// using login-based authentication (admin/admin is the default login/password for a new Rundeck instance) :
|
||||
|
|
@ -71,7 +71,7 @@ from org.rundeck.api import NodeFiltersBuilder
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of the "uptime" command on the RunDeck server
|
||||
// trigger the execution of the "uptime" command on the Rundeck server
|
||||
execution = rundeck.triggerAdhocCommand("my-project", "uptime")
|
||||
|
||||
// run the "uptime" command on all unix nodes
|
||||
|
|
@ -87,7 +87,7 @@ from org.rundeck.api import NodeFiltersBuilder
|
|||
|
||||
rundeck = RundeckClient.builder().url("http://localhost:4440").login("admin", "admin").build()
|
||||
|
||||
// trigger the execution of a custom bash script on the RunDeck server
|
||||
// trigger the execution of a custom bash script on the Rundeck server
|
||||
execution = rundeck.triggerAdhocScript("my-project", "/tmp/my-script.sh")
|
||||
|
||||
// run a bash script (with options) on all unix nodes
|
||||
|
|
@ -116,5 +116,5 @@ print("%s jobs successfully imported, %s jobs skipped, and %s jobs failed" % (re
|
|||
|
||||
h2. And more...
|
||||
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your RunDeck instance...
|
||||
See the API documentation of the [RundeckClient|./apidocs/reference/org/rundeck/api/RundeckClient.html] class for more interactions with your Rundeck instance...
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
|
||||
h1. Status of the implementation of the RunDeck API
|
||||
h1. Status of the implementation of the Rundeck API
|
||||
|
||||
h2. RunDeck API version 1
|
||||
h2. Rundeck API version 1
|
||||
|
||||
[Documentation of the RunDeck API version 1|http://rundeck.org/1.2.1/RunDeck-Guide.html#rundeck-api]
|
||||
[Documentation of the Rundeck API version 1|http://rundeck.org/1.2.1/Rundeck-Guide.html#rundeck-api]
|
||||
|
||||
* Login-based authentication - OK
|
||||
* System Info - OK
|
||||
|
|
@ -26,67 +26,67 @@ h2. RunDeck API version 1
|
|||
* Listing Resources - OK
|
||||
* Getting Resource Info - OK
|
||||
|
||||
h2. RunDeck API version 2
|
||||
h2. Rundeck API version 2
|
||||
|
||||
[Documentation of the RunDeck API version 2|http://rundeck.org/1.3.2/api/index.html]
|
||||
[Documentation of the Rundeck API version 2|http://rundeck.org/1.3.2/api/index.html]
|
||||
|
||||
* Token-based authentication - OK
|
||||
* Listing Jobs for a Project - *TODO*
|
||||
* Updating and Listing Resources for a Project - *TODO*
|
||||
* Refreshing Resources for a Project - *TODO*
|
||||
|
||||
h2. RunDeck API version 3
|
||||
h2. Rundeck API version 3
|
||||
|
||||
[Documentation of the RunDeck API version 3|http://rundeck.org/1.4.2/api/index.html]
|
||||
[Documentation of the Rundeck API version 3|http://rundeck.org/1.4.2/api/index.html]
|
||||
|
||||
* (only updates to Resource endpoints) - *TODO*
|
||||
|
||||
h2. RunDeck API version 4
|
||||
h2. Rundeck API version 4
|
||||
|
||||
[Documentation of the RunDeck API version 4|http://rundeck.org/1.4.3/api/index.html]
|
||||
[Documentation of the Rundeck API version 4|http://rundeck.org/1.4.3/api/index.html]
|
||||
|
||||
* Running Adhoc Script URLs - *TODO*
|
||||
|
||||
h2. RunDeck API version 5
|
||||
h2. Rundeck API version 5
|
||||
|
||||
[Documentation of the RunDeck API version 5|http://rundeck.org/1.4.4/api/index.html]
|
||||
[Documentation of the Rundeck API version 5|http://rundeck.org/1.4.4/api/index.html]
|
||||
|
||||
* Bulk Job Delete - OK
|
||||
* Execution Output - OK
|
||||
* Execution Query - OK
|
||||
* History list query - OK
|
||||
|
||||
h2. RunDeck API version 6
|
||||
h2. Rundeck API version 6
|
||||
|
||||
[Documentation of the RunDeck API version 6|http://rundeck.org/1.5/api/index.html]
|
||||
[Documentation of the Rundeck API version 6|http://rundeck.org/1.5/api/index.html]
|
||||
|
||||
* Execution Output format fixed - OK
|
||||
|
||||
h2. RunDeck API version 7
|
||||
h2. Rundeck API version 7
|
||||
|
||||
[Documentation of the RunDeck API version 7|http://rundeck.org/1.5.3/api/index.html]
|
||||
[Documentation of the Rundeck API version 7|http://rundeck.org/1.5.3/api/index.html]
|
||||
|
||||
* Incubator for cluster mode job takeover - *TODO*
|
||||
|
||||
h2. RunDeck API version 8
|
||||
h2. Rundeck API version 8
|
||||
|
||||
[Documentation of the RunDeck API version 8|http://rundeck.org/1.6.0/api/index.html]
|
||||
[Documentation of the Rundeck API version 8|http://rundeck.org/1.6.0/api/index.html]
|
||||
|
||||
* scriptInterpreter addition to run script and run url - OK
|
||||
* project parameter added to jobs import - OK
|
||||
|
||||
|
||||
h2. RunDeck API version 9
|
||||
h2. Rundeck API version 9
|
||||
|
||||
[Documentation of the RunDeck API version 9|http://rundeck.org/1.6.1/api/index.html]
|
||||
[Documentation of the Rundeck API version 9|http://rundeck.org/1.6.1/api/index.html]
|
||||
|
||||
* list running executions across all projects - OK
|
||||
* include project name in execution results - OK
|
||||
* Add uuidOption parameter to allow removing imported UUIDs to avoid creation conflicts - OK
|
||||
|
||||
h2. RunDeck API version 10
|
||||
h2. Rundeck API version 10
|
||||
|
||||
[Documentation of the RunDeck API version 10|http://rundeck.org/2.0.0/api/index.html]
|
||||
[Documentation of the Rundeck API version 10|http://rundeck.org/2.0.0/api/index.html]
|
||||
|
||||
* Execution State - Retrieve workflow step and node state information - OK
|
||||
* Execution Output with State - Retrieve log output with state change information - OK
|
||||
|
|
@ -95,9 +95,9 @@ h2. RunDeck API version 10
|
|||
* Deprecation: Remove methods deprecated until version 10. - OK
|
||||
|
||||
|
||||
h2. RunDeck API version 11
|
||||
h2. Rundeck API version 11
|
||||
|
||||
[Documentation of the RunDeck API version 11|http://rundeck.org/2.1.0/api/index.html]
|
||||
[Documentation of the Rundeck API version 11|http://rundeck.org/2.1.0/api/index.html]
|
||||
|
||||
* Project creation - OK
|
||||
* Get Project configuration - OK
|
||||
|
|
@ -116,7 +116,7 @@ h2. RunDeck API version 11
|
|||
|
||||
h2. Rundeck API version 12
|
||||
|
||||
[Documentation of the RunDeck API version 12|http://rundeck.org/2.2.0/api/index.html]
|
||||
[Documentation of the Rundeck API version 12|http://rundeck.org/2.2.0/api/index.html]
|
||||
|
||||
* Bulk delete executions - OK
|
||||
* Delete execution - OK
|
||||
|
|
|
|||
|
|
@ -28,8 +28,8 @@
|
|||
</skin>
|
||||
<body>
|
||||
<breadcrumbs>
|
||||
<item name="RunDeck" href="http://rundeck.org" />
|
||||
<item name="RunDeck API - Java Client" href="" />
|
||||
<item name="Rundeck" href="http://rundeck.org" />
|
||||
<item name="Rundeck API - Java Client" href="" />
|
||||
</breadcrumbs>
|
||||
<menu name="${project.name}">
|
||||
<item name="Introduction" href="index.html" />
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
<item name="Jython" href="jython.html" />
|
||||
</menu>
|
||||
<!-- <menu name="Older versions">
|
||||
<item name="1.x (RunDeck 1.2)" href="1.x/index.html" />
|
||||
<item name="1.x (Rundeck 1.2)" href="1.x/index.html" />
|
||||
</menu> -->
|
||||
<menu ref="reports" />
|
||||
</body>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue