mc ilm rule edit
The mc ilm rule edit
command modifies an existing object lifecycle management rule on an AIStor bucket.
Syntax
Parameters
ALIAS
Required
The alias and full path to the bucket on the AIStor deployment to which to modify the object lifecycle management rule. For example:
mc ilm rule edit myminio/mydata
--id
Required
The unique ID of the rule.
Use mc ilm rule ls
to list bucket rules and retrieve the id
for the rule you want to modify.
--disable
Optional
Stop using the rule, but retain the rule for future use. Objects do not transition or expire when a rule is disabled.
--enable
Optional
Use a rule to transition or expire objects.
--prefix
Optional
Restrict the management rule to a specific bucket prefix.
For example:
mc ilm rule edit --prefix "meetingnotes/" myminio/mydata --expire-days "90"
The command modifies a rule that expires objects in the mydata
bucket of the myminio
ALIAS after 90 days for any object with the meetingnotes/
prefix.
--expire-days
Optional
The number of days to retain an object after being created. AIStor marks the object for deletion after the specified number of days pass.
Exercise caution when using this option, as its behavior can result in immediate expiration of uploaded objects. Any objects created after the specified expiration date are automatically eligible for expiration. Similarly, specifying a calendar date that is prior to the current system host datetime marks all objects covered by the rule for deletion. Consider immediately removing any ILM rule using this option once the specified calendar date has passed.
For versioned buckets, the expiry rule applies only to the current object version.
Use the --noncurrent-expire-days
option to apply expiration behavior to noncurrent object versions.
AIStor uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.
Mutually exclusive with the following options:
--expire-delete-marker
Optional
Specify this option to direct AIStor to remove delete markers for objects with no remaining object versions. Specifically, the delete marker is the only remaining “version” of the given object.
This option is mutually exclusive with the following options:
AIStor uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner and Object Deletion for more information.
--noncurrent-expire-days
Optional
The number of days to retain an object version after becoming non-current (that is, a different version of that object is now the HEAD
).
AIStor marks noncurrent object versions for deletion after the specified number of days pass.
This option has the same behavior as the S3 NoncurrentVersionExpiration
action.
AIStor uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.
--noncurrent-expire-newer
Optional
The number of non-current versions of an object to retain before applying expiration. Older non-current versions beyond the specified number expire.
By default, AIStor does not retain any non-current versions when an expiration rule applies.
--noncurrent-transition-days
Optional
The number of days an object has been non-current (i.e.
replaced by a newer version of that same object) after which AIStor marks the object version as eligible for transition.
AIStor transitions the object to the configured remote storage tier specified to the --transition-tier
once the system host datetime passes that calendar date.
This option has no effect on non-versioned buckets.
Requires specifying --noncurrent-transition-tier
.
This option has the same behavior as the S3 NoncurrentVersionTransition
action.
If the remote tier is another AIStor deployment, you can set the value to 0
to mark new objects as immediately eligible for transition to the remote tier.
AIStor uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.
--noncurrent-transition-tier
Optional
The remote storage tier to which AIStor transitions noncurrent objects versions.
Specify a remote storage tier created by mc ilm tier add
.
AIStor does not automatically migrate objects from the previously specified remote tier to the new remote tier. AIStor continues to route requests for objects stored on the old remote tier.
--tags
Optional
One or more ampersand &
-delimited key-value pairs describing the object tags to which to apply the lifecycle configuration rule.
This option is mutually exclusive with the following option:
--transition-days
Optional
The number of calendar days from object creation after which AIStor marks an object as eligible for transition.
AIStor transitions the object to the configured remote storage tier specified to the --transition-tier
.
Specify the number of days as an integer, e.g. 30
for 30 days.
If the remote tier is another AIStor deployment, you can set the value to 0
to mark new objects as immediately eligible for transition to the remote tier.
For versioned buckets, the transition rule applies only to the current object version.
Use the --noncurrent-transition-days
option to apply transition behavior to noncurrent object versions.
Requires specifying --transition-tier
.
AIStor uses a scanner process to check objects against all configured lifecycle management rules. Slow scanning due to high IO workloads or limited system resources may delay application of lifecycle management rules. See Lifecycle Management Object Scanner for more information.
--transition-tier
Optional
The remote storage tier to which AIStor transition objects.
Specify a remote storage tier created by mc ilm tier add
.
Required if specifying --transition-days
.
AIStor does not automatically migrate objects from the previously specified remote tier to the new remote tier. AIStor continues to route requests for objects stored on the old remote tier.
Global Flags
This command supports any of the global flags.
Examples
Modify an Existing Lifecycle Management Rule
Use mc ilm rule edit
with --id
to modify
an existing object expiration rule:
mc ilm rule edit ALIAS/PATH --id "RULEID" [FLAGS]
- Replace
ALIAS
with thealias
of the S3-compatible host. - Replace
PATH
with the path to the bucket on the S3-compatible host. - Replace
RULEID
with the unique ID of the object lifecycle management rule. Usemc ilm rule ls
to find theRULEID
. - Specify any additional flags to add or modify the lifecycle management rule.
For example, specify
--transition-days
to override the existing transition days value for the rule.
Disable a Lifecycle Management Rule
Use mc ilm rule edit
with --disable
to stop using an existing management rule.
mc ilm rule edit --id "RULEID" --disable myminio/mybucket
- Replace
RULEID
with the unique ID of the object lifecycle management rule. Usemc ilm rule ls
to find theRULEID
. - Replace
myminio
with the ALIAS of the deployment where the rule exists. - Replace
mybucket
with the bucket for the rule.
Required Permissions
For permissions required to edit a rule, refer to the required permissions on the parent command.
Behavior
S3 Compatibility
The mc
commandline tool is built for compatibility with the AWS S3 API and is tested with AIStor and AWS S3 for expected functionality and behavior.
AIStor provides no guarantees for other S3-compatible services, As their S3 API implementation is unknown and therefore unsupported.
While mc
commands may work as documented, any such usage is at your own risk.