community.general.rundeck_project module – Manage Rundeck projects
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_project
.
Synopsis
Create and remove Rundeck projects through HTTP API.
Aliases: web_infrastructure.rundeck_project
Parameters
Parameter |
Comments |
---|---|
Sets the token to authenticate against Rundeck API. |
|
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: |
|
Sets the project name. |
|
Create or remove Rundeck project. Choices:
|
|
HTTP, HTTPS, or FTP URL in the form (http|https|ftp)://[user[:pass]]@host.domain[:port]/path |
|
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 |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create a rundeck project
community.general.rundeck_project:
name: "Project_01"
label: "Project 01"
description: "My Project 01"
url: "https://rundeck.example.org"
api_version: 39
api_token: "mytoken"
state: present
- name: Remove a rundeck project
community.general.rundeck_project:
name: "Project_01"
url: "https://rundeck.example.org"
api_token: "mytoken"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
dictionary containing project information after modification Returned: success |
|
dictionary containing project information before modification Returned: success |
|
Rundeck response when a failure occurs Returned: failed |