You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

rundeck_acl_policy - Manage Rundeck ACL policies.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Create, update and remove Rundeck ACL policies 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.
policy	no			Sets the ACL policy content. ACL policy content is a YAML object as described in http://rundeck.org/docs/man5/aclpolicy.html. It can be a YAML string or a pure Ansible inventory YAML object.
project	no			Sets the project which receive the ACL policy. If unset, it's a system ACL policy.
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 or update a rundeck ACL policy in project Ansible
  rundeck_acl_policy:
    name: "Project_01"
    api_version: 18
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: present
    project: "Ansible"
    policy:
      description: "my policy"
      context:
        application: rundeck
      for:
        project:
          - allow: read
      by:
        group: "build"

- name: Remove a rundeck system policy
  rundeck_acl_policy:
    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
after	dictionnary containing ACL policy informations after modification.	success	dict
before	dictionnary containing ACL policy informations before modification.	success	dict
rundeck_response	Rundeck response when a failure occurs.	failed	string

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.