You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

sensu.sensu_go.cluster_role_binding module – Manage Sensu cluster role bindings

Note

This module is part of the sensu.sensu_go collection (version 1.13.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install sensu.sensu\_go. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: sensu.sensu_go.cluster_role_binding.

New in sensu.sensu_go 1.0.0

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis 

Create, update or delete Sensu cluster role binding.
For more information, refer to the Sensu documentation at https://docs.sensu.io/sensu-go/latest/reference/rbac/#role-bindings-and-cluster-role-bindings.

Requirements 

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

python >= 2.7

Parameters 

Parameter	Comments
auth dictionary	Authentication parameters. Can define each of them with ENV as well.
api_key string added in sensu.sensu_go 1.3.0	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/.
ca_path path added in sensu.sensu_go 1.5.0	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.
password string	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. Default: `"P@ssw0rd!"`
url string	Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked. Default: `"http://localhost:8080"`
user string	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. Default: `"admin"`
verify boolean added in sensu.sensu_go 1.5.0	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. Choices: `false` `true` ← (default)
cluster_role string	Name of the cluster role. Required if state is `present`.
groups list / elements=string	List of groups to bind to the cluster role. Note that at least one of users and groups must be specified when creating a cluster role binding.
name string / required	The Sensu resource’s name. This name (in combination with the namespace where applicable) uniquely identifies the resource that Ansible operates on. If the resource with selected name already exists, Ansible module will update it to match the specification in the task. Consult the name metadata attribute specification in the upstream docs on https://docs.sensu.io/sensu-go/latest/reference/ for more details about valid names and other restrictions.
state string	Target state of the Sensu object. Choices: `"present"` ← (default) `"absent"`
users list / elements=string	List of users to bind to the cluster role. Note that at least one of users and groups must be specified when creating a cluster role binding.

Examples 

- name: Create a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    cluster_role: cluster-admin
    groups:
      - cluster-admins
    users:
      - alice

- name: Delete a cluster role binding
  sensu.sensu_go.cluster_role_binding:
    name: all-cluster-admins
    state: absent

Return Values 

Common return values are documented here, the following are the fields unique to this module:

Key	Description
object dictionary	Object representing Sensu cluster role binding. Returned: success Sample: `{"metadata": {"name": "cluster-admin"}, "role_ref": {"name": "cluster-admin", "type": "ClusterRole"}, "subjects": [{"name": "cluster-admins", "type": "Group"}]}`

Authors

Paul Arthur (@flowerysong)
Manca Bizjak (@mancabizjak)
Aljaz Kosir (@aljazkosir)
Tadej Borovsak (@tadeboro)

Collection links

Issue Tracker Repository (Sources)

sensu.sensu_go.cluster_role_binding module – Manage Sensu cluster role bindings

Synopsis

Requirements

Parameters

See Also

Examples

Return Values