secrets_provider_info – List Sensu secrets providers

Retrieve information about Sensu Go secrets providers.

For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/.

New in version 1.6.0.

Requirements

The below requirements are needed on the host that executes this module:

• python >= 2.7

Examples

- name: List all Sensu secrets providers
  sensu.sensu_go.secrets_provider_info:
  register: result

- name: List the selected Sensu secrets provider
  sensu.sensu_go.secrets_provider_info:
    name: my_provider
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.metadata.name }}"

See Also

See also

• secrets_provider_env – Manage Sensu Env secrets provider

• secrets_provider_vault – Manage Sensu VaultProvider secrets providers

• secret – Manage Sensu Go secrets

• secret_info – List available Sensu Go secrets

Parameters

auth (optional)

Authentication parameters. Can define each of them with ENV as well.

type: dict

api_key (optional)

The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.

This replaces auth.user and auth.password parameters.

For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.

type: str

ca_path (optional)

Path to the CA bundle that should be used to validate the backend certificate.

If this parameter is not set, module will use the CA bundle that python is using.

It is also possible to set this parameter via the SENSU_CA_PATH environment variable.

type: path

password (optional)

The Sensu user’s password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str

default: P@ssw0rd!

url (optional)

Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.

type: str

default: http://localhost:8080

user (optional)

The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.

This parameter is ignored if the auth.api_key parameter is set.

type: str

default: admin

verify (optional)

Flag that controls the certificate validation.

If you are using self-signed certificates, you can set this parameter to false.

ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.

It is also possible to set this parameter via the SENSU_VERIFY environment variable.

type: bool

default: True

name (optional)

Retrieve information about this specific object instead of listing all objects.

type: str

Return Values

objects

List of Sensu secrets providers.

sample:

- client:
    address: https://vaultserver.example.com:8200
    max_retries: 2
    rate_limiter:
      burst: 100
      limit: 10
    timeout: 20s
    tls:
      ca_cert: /etc/ssl/certs/vault_ca_cert.pem
    token: VAULT_TOKEN
    version: v1
  metadata:
    name: vault