sensu.sensu_go.cluster_role (1.14.0) — module

Install collection

Install with ansible-galaxy collection install sensu.sensu_go:==1.14.0

Add to requirements.yml

  collections:
    - name: sensu.sensu_go
      version: 1.14.0

Description

Create, update or delete Sensu role.

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

Requirements

• python >= 2.7

Usage examples

Scanned by Steampunk Spotter

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

- name: Create a cluster role
  sensu.sensu_go.cluster_role:
    name: readonly
    rules:
      - verbs:
          - get
          - list
        resources:
          - checks
          - entities

Scanned by Steampunk Spotter

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

- name: Delete a cluster role
  sensu.sensu_go.cluster_role:
    name: readonly
    state: absent

Inputs

    
auth:
    description:
    - Authentication parameters. Can define each of them with ENV as well.
    suboptions:
      api_key:
        description:
        - 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 I(auth.user) and I(auth.password) parameters.
        - For more information about the API key, refer to the official Sensu documentation
          at U(https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/).
        type: str
        version_added: 1.3.0
        version_added_collection: sensu.sensu_go
      ca_path:
        description:
        - 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 I(SENSU_CA_PATH) environment
          variable.
        type: path
        version_added: 1.5.0
        version_added_collection: sensu.sensu_go
      password:
        default: P@ssw0rd!
        description:
        - 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 I(auth.api_key) parameter is set.
        type: str
      url:
        default: http://localhost:8080
        description:
        - Location of the Sensu backend API. If this is not set the value of the SENSU_URL
          environment variable will be checked.
        type: str
      user:
        default: admin
        description:
        - 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 I(auth.api_key) parameter is set.
        type: str
      verify:
        default: true
        description:
        - Flag that controls the certificate validation.
        - If you are using self-signed certificates, you can set this parameter to C(false).
        - ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates
          in production, see the I(auth.ca_path) parameter.
        - It is also possible to set this parameter via the I(SENSU_VERIFY) environment
          variable.
        type: bool
        version_added: 1.5.0
        version_added_collection: sensu.sensu_go
    type: dict

name:
    description:
    - 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 I(name) metadata attribute specification in the upstream docs on U(https://docs.sensu.io/sensu-go/latest/reference/)
      for more details about valid names and other restrictions.
    required: true
    type: str

rules:
    description:
    - Rules that the cluster role applies.
    - Must be non-empty if I(state) is C(present).
    elements: dict
    suboptions:
      resource_names:
        description:
        - Names of specific resources the rule has permission to access.
        - Note that for the C(create) verb, this argument will not be taken into account
          when enforcing RBAC, even if it is provided.
        elements: str
        type: list
      resources:
        description:
        - Types of resources the rule has permission to access.
        elements: str
        required: true
        type: list
      verbs:
        choices:
        - get
        - list
        - create
        - update
        - delete
        description:
        - Permissions to be applied by the rule.
        elements: str
        required: true
        type: list
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Target state of the Sensu object.
    type: str

Outputs

object:
  description: Object representing Sensu cluster role.
  returned: success
  sample:
    metadata:
      name: cluster-role
    rules:
    - resource_names:
      - sample-name
      resources:
      - assets
      - checks
      verbs:
      - get
      - list
  type: dict

See also

• sensu.sensu_go.cluster_role_info
• sensu.sensu_go.cluster_role_binding
• sensu.sensu_go.role
• sensu.sensu_go.role_binding