W3cubDocs

/Ansible

rundeck_project - Manage Rundeck projects.

New in version 2.4.

Synopsis

  • Create and remove Rundeck projects through HTTP API.

Options

parameter required default choices comments
api_version
 no 14
Sets the API version used by module.
API version must be at least 14.
name
 yes
Sets the project name.
state
 no present
  • present
  • absent
Create or remove Rundeck project.
token
 yes
Sets the token to authenticate against Rundeck API.
url
 yes
Sets the rundeck instance URL.

Examples

- name: Create a rundeck project
  rundeck_project:
    name: "Project_01"
    api_version: 18
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: present

- name: Remove a rundeck project
  rundeck_project:
    name: "Project_02"
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: absent

Return Values

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

name description returned type sample
rundeck_response
Rundeck response when a failure occurs
 failed string
after
dictionnary containing project informations after modification
 success dict
before
dictionnary containing project informations before modification
 success dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/rundeck_project_module.html