Support for list=true parameter in the path

[faster-now]

When using vault_read to try and perform a list operation it seems the only exposed attribute is path however adding ?list=true to the end of the path results in an error stating the path doesnt seem to exist:

Example:

    - name: Check if the role exists
      community.hashi_vault.vault_read:
        url: "https://127.0.0.1:8200"
        path: 'pki/roles?list=true'
        token: "{{ token }}"
        token_validate: false
      register: roles_list_result

Response:

["msg": "The path 'pki/roles?list=true' doesn't seem to exist."](fatal: [127.0.0.1]: FAILED! => {"changed": false, "msg": "The path 'pki/roles\\?list=true' doesn't seem to exist."})

Despite experimenting and googling I cannot see how to use the vault_read to perform a list operation.
What am I missing?

[briantist]

Hi @faster-now !

I hadn't really considered using vault_read for LIST operations, but I suppose it is possible in theory with ?list=true.

One thing to consider is that the error message you're receiving occurs when the response from Vault didn't raise an exception, or when the hvac library swallowed the exception (as it does for 404 errors); specifically, when return value from the call to hvac is None:

https://github.com/ansible-collections/community.hashi_vault/blob/main/plugins/modules/vault_read.py#L121-L122

To me this indicates that the path is likely incorrect, or you don't have list access to the path.

I looked up the API path and pki/roles looks correct in your example, so I would guess it's permissions.

I did my own test with a path of my own (not PKI engine though) and was able to get the vault_read module working for a LIST operation by adding ?list=true.

---

To help you troubleshoot, try using curl so you can see exactly what the server is giving you.

curl -H "X-Vault-Token: $(cat ~/.vault-token)" https://127.0.0.1:8200/v1/pki/roles?list=true

---

I do expect to have a general vault_list at some point (see also #295) and then hopefully dedicated listing content for various backends. If you're interested in contributing something like that please see the Contributor guide and let me know.