PowerScaleOneFS CLI Command Reference

Syntax

isi worm domains modify <domain> 
  [--compliance]
  [{--autocommit-offset <duration> | --clear-autocommit-offset}] 
  [{--override-date <timestamp> | --clear-override-date}] 
  [{--privileged-delete {true | false}]
  [--disable-privileged-delete]
  [{--default-retention {<duration> | forever | use_min 
  | use_max} | --clear-default-retention}] 
  [{--min-retention {<duration> | forever} | --clear-min-retention}]
  [{--max-retention | -x} (<duration> | forever) | --clear-max-retention]
  [{--exclude | -x} <string>]
  [--set-pending-delete]
  [{--force | -f}]
  [{--verbose | -v}]
  [{--help | -h}]

Options

<domain>

Modifies the specified SmartLock directory.

Specify as a directory path, ID, or LIN of a SmartLock directory.

{--compliance | -C}

Specifies the SmartLock directory as a SmartLock compliance directory. This option is valid only on clusters running in SmartLock compliance mode.

{--autocommit-offset | -a} <duration>

Specifies an autocommit time period. After a file exists in a SmartLock directory without being modified for the specified length of time, the file automatically committed to a WORM state.

Specify <duration> in the following format:

<integer><units>

Specify <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

m

Specifies minutes

s

Specifies seconds

To specify no autocommit time period, specify none. The default value is none.

--clear-autocommit-offset

Removes the autocommit time period for the given SmartLock directory.

{--override-date | -o} <timestamp>

Specifies an override retention date for the directory. Files committed to a WORM state are not released from a WORM state until after the specified date, regardless of the maximum retention period for the directory or whether a user specifies an earlier date to release a file from a WORM state.

Specify <timestamp> in the following format:

<YYYY>-<MM>-<DD>[T<hh>:<mm>[:<ss>]]

--clear-override-date

Removes the override retention date for the given SmartLock directory.

{--privileged-delete | -p} {true | false}

Determines whether files in the directory can be deleted through the isi worm files delete command. This option is available only for SmartLock enterprise directories.

The default value is false.

--disable-privileged-delete

Permanently prevents WORM committed files from being deleted from the SmartLock directory.

NOTE:

If you specify this option, you can never enable the privileged delete functionality for the SmartLock directory. If a file is then committed to a WORM state in the directory, you will not be able to delete the file until the retention period expiration date has passed.

{--default-retention | -d} {<duration> | forever | use_min | use_max}

Specifies a default retention period. If a user does not explicitly assign a retention period expiration date, the default retention period is assigned to the file when it is committed to a WORM state.

Specify <duration> in the following format:

<integer><units>

Specify <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

m

Specifies minutes

s

Specifies seconds

To permanently retain WORM committed files by default, specify forever. To assign the minimum retention period as the default retention period, specify use_min. To assign the maximum retention period as the default retention period, specify use_max.

--clear-default-retention

Removes the default retention period for the given SmartLock directory.

{--min-retention | -m} {<duration> | forever}

Specifies a minimum retention period. Files are retained in a WORM state for at least the specified amount of time.

Specify <duration> in the following format:

<integer><units>

Specify <units> as one of the following values:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

m

Specifies minutes

s

Specifies seconds

To permanently retain all WORM committed files, specify forever.

--clear-min-retention

Removes the minimum retention period for the given SmartLock directory.

{--max-retention | -x} {<duration> | forever}

Specifies a maximum retention period. Files cannot be retained in a WORM state for more than the specified amount of time, even if a user specifies an expiration date that results in a longer retention period.

Specify <duration> in the following format:

<integer><units>

Specify <units> as one of the following values:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

m

Specifies minutes

s

Specifies seconds

To specify no maximum retention period, specify forever.

--clear-max-retention

Removes the maximum retention period for the given SmartLock directory.

{--exclude | -x} <string>

Path excluded from the WORM domain. Specify --exclude for each additional path.

--set-pending-delete

Mark a compliance domain for deletion. This action is irreversible.

{--force | -f}

Does not prompt you to confirm the creation of the SmartLock directory.

{--verbose | -v}

Displays more detailed information.