dubzland.minio.minio_user module – Manages Minio users

Note

This module is part of the dubzland.minio collection (version 1.2.0).

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 dubzland.minio. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: dubzland.minio.minio_user.

Synopsis

  • When the user does not exist, it will be created.

  • When the user does exist and state=absent, the user will be deleted.

  • When changes are made to the user, the user will be updated.

Requirements

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

  • python >= 3.8

  • minio >= 7.1.4

Parameters

Parameter

Comments

access_key

string / required

Access key (username) for the user.

auth

dictionary / required

Connection information for the Minio instance being managed.

access_key

string / required

Minio access key to use to authenticate with the Minio instance.

secret_key

string / required

Minio secret key used to connect to the Minio instance.

url

string / required

Minio Server URL.

force

boolean

When set to true, the secret_key will always be updated (and the module will always return changed to true).

Choices:

  • false ← (default)

  • true

policy

string

An existing policy to apply to this user.

secret_key

string / required

Secret key (password) for the user.

state

string

Indicates the desired user state.

present ensures the user is present.

absent ensures the user is absent.

enabled ensures the user is enabled.

disabled ensures the user is disabled.

Choices:

  • "present" ← (default)

  • "absent"

  • "enabled"

  • "disabled"

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

See Also

See also

mc mb

Documentation for the mc mb command.

Examples

- name: Add a Minio user
  dubzland.minio.minio_user:
    access_key: testuser
    secret_key: supersekret
    auth:
      access_key: minioadmin
      secret_key: minioadmin
      url: http://minio-server:9000
    state: present
  delegate_to: localhost

Authors

  • Josh Williams (@t3hpr1m3)