community.general.cyberarkpassword (8.5.0) — lookup

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Get secrets from CyberArk AIM.

Requirements

• CyberArk AIM tool installed

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: passing options to the lookup
    ansible.builtin.debug:
        msg: '{{ lookup("community.general.cyberarkpassword", cyquery) }}'
    vars:
      cyquery:
        appid: "app_ansible"
        query: "safe=CyberArk_Passwords;folder=root;object=AdminPass"
        output: "Password,PassProps.UserName,PassProps.Address,PasswordChangeInProcess"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: used in a loop
    ansible.builtin.debug:
        msg: "{{item}}"
    with_community.general.cyberarkpassword:
        appid: 'app_ansible'
        query: 'safe=CyberArk_Passwords;folder=root;object=AdminPass'
        output: 'Password,PassProps.UserName,PassProps.Address,PasswordChangeInProcess'

Inputs

    
appid:
    description: Defines the unique ID of the application that is issuing the password
      request.
    required: true

query:
    description: Describes the filter criteria for the password retrieval.
    required: true

_extra:
    description: for extra_params values please check parameters for clipasswordsdk in
      CyberArk's "Credential Provider and ASCP Implementation Guide"

output:
    default: password
    description:
    - Specifies the desired output fields separated by commas.
    - 'They could be: Password, PassProps.<property>, PasswordChangeInProcess'

_command:
    default: /opt/CARKaim/sdk/clipasswordsdk
    description: Cyberark CLI utility.
    env:
    - name: AIM_CLIPASSWORDSDK_CMD

Outputs

_result:
  contains:
    passprops:
      description: properties assigned to the entry
      type: dictionary
    password:
      description:
      - The actual value stored
    passwordchangeinprocess:
      description: did the password change?
  description: A list containing one dictionary.
  elements: dictionary
  type: list