ansible.builtin.rundeck_acl_policy (v2.9.27) — module

Manage Rundeck ACL policies.

| "added in version" 2.4 of ansible.builtin"

Authors: Loic Blot (@nerzhul)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Create, update and remove Rundeck ACL policies through HTTP API.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove a rundeck system policy
  rundeck_acl_policy:
    name: "Project_02"
    url: "https://rundeck.example.org"
    token: "mytoken"
    state: absent

Inputs

    
url:
    description:
    - Sets the rundeck instance URL.
    required: true

name:
    description:
    - Sets the project name.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Create or remove Rundeck project.

token:
    description:
    - Sets the token to authenticate against Rundeck API.
    required: true

policy:
    description:
    - 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:
    description:
    - Sets the project which receive the ACL policy.
    - If unset, it's a system ACL policy.

api_version:
    default: 14
    description:
    - Sets the API version used by module.
    - API version must be at least 14.

Outputs

after:
  description: Dictionary containing ACL policy informations after modification.
  returned: success
  type: dict
before:
  description: Dictionary containing ACL policy informations before modification.
  returned: success
  type: dict
rundeck_response:
  description: Rundeck response when a failure occurs.
  returned: failed
  type: str