role_info – List Sensu roles

Retrieve information about Sensu roles.

For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles.

New in version 1.0.0.

Requirements

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

  • python >= 2.7

Examples

- name: List all Sensu roles
  sensu.sensu_go.role_info:
  register: result

- name: Retrieve a specific Sensu role
  sensu.sensu_go.role_info:
    name: my-role
  register: result

See Also

See also

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
namespace (optional)

RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.

type: str
default: default

Return Values

roles

List of Sensu roles.

sample:

- metadata:
    name: namespaced-resources-all-verbs
    namespace: default
  rules:
  - resource_names: []
    resources:
    - assets
    - checks
    verbs:
    - create
    - update
    - delete