1
0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Files
docs/source/reference/deprecated/mc-ilm-rm.rst
Andrea Longo 091a321e32 Improve mc deprecated reference: cleanup, move mc admin top (#1019)
First batch of mc deprecation cleanup:

[x] Reorder section TOC: `mc` alphabetical, then `mc admin`
alphabetical.
[x] Standardize deprecation notice format and wording.
[x] Move `mc admin top` to deprecated section.

Staged

http://192.241.195.202:9000/staging/DOCS-896-cleanup-mc-admin-top/linux/reference/minio-mc-deprecated.html

Partially addresses https://github.com/minio/docs/issues/896
2023-10-05 10:29:02 -06:00

131 lines
2.9 KiB
ReStructuredText

.. _minio-mc-ilm-rm:
=============
``mc ilm rm``
=============
.. default-domain:: minio
.. contents:: Table of Contents
:local:
:depth: 2
.. mc:: mc ilm remove
.. mc:: mc ilm rm
.. versionchanged:: RELEASE.2022-12-24T15-21-38Z
``mc ilm rm`` replaced by :mc-cmd:`mc ilm rule rm`.
Syntax
------
.. start-mc-ilm-rm-desc
The :mc:`mc ilm rm` command removes an object lifecycle management rule from a
MinIO Bucket.
.. end-mc-ilm-rm-desc
The :mc:`mc ilm remove` command has equivalent functionality to :mc:`mc ilm rm`.
.. tab-set::
.. tab-item:: EXAMPLE
The following command removes a single lifecycle management rule from
the ``mydata`` bucket on the ``myminio`` MinIO deployment:
.. code-block:: shell
:class: copyable
mc ilm rm --id "bgrt1ghju" myminio/mydata
.. tab-item:: SYNTAX
The command has the following syntax:
.. code-block:: shell
:class: copyable
mc [GLOBALFLAGS] ilm rm \
--id "string" | (--all --force) \
ALIAS \
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-syntax
:end-before: end-minio-syntax
Parameters
~~~~~~~~~~
.. mc-cmd:: ALIAS
*Required* The :ref:`alias <alias>` and full path to the bucket on the MinIO
deployment to which to remove the object lifecycle management rule. For
example:
.. code-block:: none
mc ilm rm myminio/mydata
.. mc-cmd:: all
*Required* Removes all rules in the bucket. Mutually exclusive with
:mc:`mc ilm rm id`.
Mutually exclusive with :mc:`mc ilm rm id`
Requires including :mc-cmd:`~mc ilm rm force`.
.. mc-cmd:: force
Required if specifying :mc-cmd:`~mc ilm rm all`.
.. mc-cmd:: id
*Required* The unique ID of the rule. Use :mc:`mc ilm rule ls` to list bucket
rules and retrieve the ``id`` for the rule you want to remove.
Mutually exclusive with :mc:`mc ilm rm all`
Global Flags
~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-globals
:end-before: end-minio-mc-globals
Examples
--------
Remove a Bucket Lifecycle Management Rule
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Use :mc:`mc ilm rm` to remove a bucket lifecycle management rule:
.. code-block:: shell
:class: copyable
mc ilm rm --id "RULE" ALIAS/PATH
- Replace :mc-cmd:`RULE <mc ilm rm id>` with the unique name of the lifecycle
management rule.
- Replace :mc-cmd:`ALIAS <mc ilm rm ALIAS>` with the
:mc:`alias <mc alias>` of the S3-compatible host.
- Replace :mc-cmd:`PATH <mc ilm rm ALIAS>` with the path to the bucket on the
S3-compatible host.
Behavior
--------
S3 Compatibility
~~~~~~~~~~~~~~~~
.. include:: /includes/common-minio-mc.rst
:start-after: start-minio-mc-s3-compatibility
:end-before: end-minio-mc-s3-compatibility