community.general.nomad_job_info module – Get Nomad Jobs info
Note
This module is part of the community.general collection (version 9.5.1).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.nomad_job_info
.
New in community.general 1.3.0
Synopsis
Get info for one Nomad job.
List Nomad jobs.
Requirements
The below requirements are needed on the host that executes this module.
python-nomad
Parameters
Parameter |
Comments |
---|---|
Path of certificate for TLS/SSL. |
|
Path of certificate’s private key for TLS/SSL. |
|
FQDN of Nomad server. |
|
Name of job for Get info. If not specified, lists all jobs. |
|
Namespace for Nomad. |
|
Port of Nomad server. Default: |
|
Timeout (in seconds) for the request to Nomad. Default: |
|
ACL token for authentication. |
|
Use TLS/SSL connection. Choices:
|
|
Enable TLS/SSL certificate validation. 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 |
See Also
See also
- Nomad jobs documentation
Complete documentation for Nomad API jobs.
Examples
- name: Get info for job awx
community.general.nomad_job_info:
host: localhost
name: awx
register: result
- name: List Nomad jobs
community.general.nomad_job_info:
host: localhost
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List with dictionary contains jobs info Returned: success Sample: |