community.general.rundeck_job_executions_info – Query executions for a Rundeck job

Note

This plugin is part of the community.general collection (version 4.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.rundeck_job_executions_info.

New in version 3.8.0: of community.general

Synopsis

  • This module gets the list of executions for a specified Rundeck job.

Parameters

Parameter Choices/Defaults Comments
api_token
string / required
Rundeck User API Token.
api_version
integer
Default:
39
Rundeck API version to be used.
API version must be at least 14.
client_cert
path
PEM formatted certificate chain file to be used for SSL client authentication.
This file can also include the key as well, and if the key is included, client_key is not required.
client_key
path
PEM formatted file that contains your private key to be used for SSL client authentication.
If client_cert contains both the certificate and key, this option is not required.
force
boolean
    Choices:
  • no ←
  • yes
If yes do not get a cached copy.
Alias thirsty has been deprecated and will be removed in 2.13.

aliases: thirsty
force_basic_auth
boolean
    Choices:
  • no ←
  • yes
Credentials specified with url_username and url_password should be passed in HTTP Header.
http_agent
string
Default:
"ansible-httpget"
Header to identify as, generally appears in web server logs.
job_id
string / required
The job unique ID.
max
integer
Default:
20
Max results to return.
offset
integer
Default:
0
The start point to return the results.
status
string
    Choices:
  • succeeded
  • failed
  • aborted
  • running
The job status to filter.
url
string / required
Rundeck instance URL.
url_password
string
The password for use in HTTP basic authentication.
If the url_username parameter is not specified, the url_password parameter will not be used.
url_username
string
The username for use in HTTP basic authentication.
This parameter can be used without url_password for sites that allow empty passwords
use_gssapi
boolean
added in 2.11 of ansible.builtin
    Choices:
  • no ←
  • yes
Use GSSAPI to perform the authentication, typically this is for Kerberos or Kerberos through Negotiate authentication.
Requires the Python library gssapi to be installed.
Credentials for GSSAPI can be specified with url_username/url_password or with the GSSAPI env var KRB5CCNAME that specified a custom Kerberos credential cache.
NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed.
use_proxy
boolean
    Choices:
  • no
  • yes ←
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs
boolean
    Choices:
  • no
  • yes ←
If no, SSL certificates will not be validated.
This should only be used on personally controlled sites using self-signed certificates.

Examples

- name: Get Rundeck job executions info
  community.general.rundeck_job_executions_info:
    url: "https://rundeck.example.org"
    api_version: 39
    api_token: "mytoken"
    job_id: "xxxxxxxxxxxxxxxxx"
  register: rundeck_job_executions_info

- name: Show Rundeck job executions info
  ansible.builtin.debug:
    var: rundeck_job_executions_info.executions

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
executions
list / elements=dictionary
always
Job executions list.

Sample:
[{'argstring': '-exit_code 0', 'date-ended': {'date': '2021-10-06T13:05:18Z', 'unixtime': 1633525518386}, 'date-started': {'date': '2021-10-06T13:05:15Z', 'unixtime': 1633525515026}, 'description': 'Plugin[com.batix.rundeck.plugins.AnsiblePlaybookInlineWorkflowStep, nodeStep: false]', 'executionType': 'user', 'href': 'https://rundeck.example.org/api/39/execution/1', 'id': 1, 'job': {'averageDuration': 6381, 'description': '', 'group': '', 'href': 'https://rundeck.example.org/api/39/job/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a', 'id': '697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a', 'name': 'Test', 'options': {'exit_code': '0'}, 'permalink': 'https://rundeck.example.org/project/myproject/job/show/697af0c4-72d3-4c15-86a3-b5bfe3c6cb6a', 'project': 'myproject'}, 'permalink': 'https://rundeck.example.org/project/myproject/execution/show/1', 'project': 'myproject', 'serverUUID': '5b9a1438-fa3a-457e-b254-8f3d70338068', 'status': 'succeeded', 'user': 'admin'}]
paging
dictionary
success
Results pagination info.

Sample:
{'count': 20, 'max': 20, 'offset': 0, 'total': 100}
 
count
integer
success
Number of results in the response.

 
max
integer
success
Maximum number of results per page.

 
offset
integer
success
Offset from first of all results.

 
total
integer
success
Total number of results.



Authors

  • Phillipe Smith (@phsmith)