community.general.rundeck_job_executions_info module – Query executions for a Rundeck job
Note
This module is part of the community.general collection (version 8.6.4).
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 community.general 3.8.0
Synopsis
This module gets the list of executions for a specified Rundeck job.
Aliases: web_infrastructure.rundeck_job_executions_info
Parameters
Parameter |
Comments |
---|---|
Rundeck User API Token. |
|
Rundeck API version to be used. API version must be at least 14. Default: |
|
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, |
|
PEM formatted file that contains your private key to be used for SSL client authentication. If |
|
If Choices:
|
|
Credentials specified with Choices:
|
|
Header to identify as, generally appears in web server logs. Default: |
|
The job unique ID. |
|
Max results to return. Default: |
|
The start point to return the results. Default: |
|
The job status to filter. Choices:
|
|
Rundeck instance URL. |
|
The password for use in HTTP basic authentication. If the |
|
The username for use in HTTP basic authentication. This parameter can be used without |
|
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 NTLM authentication is not supported even if the GSSAPI mech for NTLM has been installed. Choices:
|
|
If Choices:
|
|
If This should only be used on personally controlled sites using self-signed certificates. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
Description |
---|---|
Job executions list. Returned: always Sample: |
|
Results pagination info. Returned: success Sample: |
|
Number of results in the response. Returned: success |
|
Maximum number of results per page. Returned: success |
|
Offset from first of all results. Returned: success |
|
Total number of results. Returned: success |