rundeck_project – Manage Rundeck projects

From Get docs
Ansible/docs/2.8/modules/rundeck project module


rundeck_project – Manage Rundeck projects

New in version 2.4.


Synopsis

  • Create and remove Rundeck projects through HTTP API.

Parameters

Parameter Choices/Defaults Comments

api_version

-

Default:

14

Sets the API version used by module.

API version must be at least 14.

name

- / required

Sets the project name.

state

-

  • present

  • absent

Create or remove Rundeck project.

token

- / required

Sets the token to authenticate against Rundeck API.

url

- / required

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, the following are the fields unique to this module:

Key Returned Description

after

dictionary

success

dictionary containing project information after modification


before

dictionary

success

dictionary containing project information before modification


rundeck_response

string

failed

Rundeck response when a failure occurs





Status

Authors

  • Loic Blot (@nerzhul)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


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