community.missing_collection.minio_bucket_info_module.rst

community.missing_collection.minio_bucket_info

Get Information about Minio Bucket.

Version added: 0.2.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get Information about Minio Bucket.
• https://docs.min.io/docs/python-client-api-reference.html

Requirements

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

• minio

Parameters

Parameter	Choices/Defaults	Comments
bucket string		name of the minio bucket.
endpoint string / required		minio api endpoint.
get_bucket_encryption boolean	Choices: no yes	do you want to get bucket encryption for given bucket?
get_bucket_lifecycle boolean	Choices: no yes	do you want to get bucket lifecycle for given bucket?
get_bucket_notification boolean	Choices: no yes	do you want to get bucket notification for given bucket?
get_bucket_policy boolean	Choices: no yes	do you want to get bucket policy for given bucket?
get_bucket_replication boolean	Choices: no yes	do you want to get bucket replication for given bucket?
get_bucket_tags boolean	Choices: no yes	do you want to get bucket tags for given bucket?
get_bucket_versioning boolean	Choices: no yes	do you want to get bucket versioning for given bucket?
list_buckets boolean	Choices: no yes	do you want to get list of available buckets?
password string / required		minio api endpoint password. aliases: secret_key
secure boolean	Choices: no ← yes	do you want to enable https/tls connection?
username string / required		minio api endpoint username. aliases: access_key

Examples

- name: get list of sort buckets
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    list_buckets: true

- name: get version status of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_versioning: true
    bucket: 'test'

- name: get replication status of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_replication: true
    bucket: 'test'

- name: get lifecycle rules & their status of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_lifecycle: true
    bucket: 'test'

- name: get tags of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_tags: true
    bucket: 'test'

- name: get policy of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_policy: true
    bucket: 'test'

- name: get notification details of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_notification: true
    bucket: 'test'

- name: get encryption details of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_bucket_encryption: true
    bucket: 'test'

- name: get encryption details of given bucket
  community.missing_collection.minio_bucket_info:
    endpoint: "localhost:9000"
    username: minioadmin
    password: minioadmin
    get_object_lock_config: true
    bucket: 'test'

Return Values

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

Key	Returned	Description
buckets list	when `list_buckets` is defined and success.	list of buckets.
encryption dictionary	when `get_encryption` is defined and success.	status of bucket encryption.
lifecycle_rules list	when `get_bucket_lifecycle` is defined and success.	list of bucket lifecycle rules.
notification dictionary	when `get_bucket_notification` is defined and success.	list of bucket notification.
object_lock_config dictionary	when `get_object_lock_config` is defined and success.	status of bucket object locking.
policy dictionary	when `get_bucket_policy` is defined and success.	list of bucket policy.
replication_rules list	when `get_bucket_replication` is defined and success.	list of bucket replication rules.
status string	when `get_bucket_versioning` is defined and success.	status of bucket versioning.
tags dictionary	when `get_bucket_tags` is defined and success.	bucket tags.

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>