dubzland.minio.minio_alias module – Manages Minio Client (mc) aliases

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_alias.

Synopsis

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

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

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

Requirements

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

  • python >= 3.8

  • Minio client binary (mc)

Parameters

Parameter

Comments

access_key

string / required

Access key used to authenticate with the Minio server located at url.

name

string / required

Name of the alias to be managed.

secret_key

string / required

Secret key used to authenticate with the Minio server located at url.

state

string

Indicates the desired alias state.

present ensures the alias is present.

absent ensures the alias is absent.

Choices:

  • "present" ← (default)

  • "absent"

url

string / required

Minio server url to be associated with this alias.

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 alias

Documentation for the mc alias command.

Examples

- name: Add alias for Minio server
  dubzland.minio.minio_alias:
    name: localhost
    url: http://localhost:9000
    access_key: myuser
    secret_key: supersekret
    state: present

Authors

  • Josh Williams (@t3hpr1m3)