PowerScaleOneFS CLI Command Reference

Syntax

 isi snapshot schedules modify <schedule-name>
        [{--alias | -a} <string> | --clear-alias]
        [--name <string>]
        [--path <path>]
        [--pattern <pattern>]
        [--schedule <schedule>]
        [{--duration | -x} <duration> | --clear-duration]
        [{--verbose | -v}]
        [{--help | -h}]

Required Privileges

ISI_PRIV_SNAPSHOT

Options

<schedule-name>

Modifies the specified snapshot schedule.

Specify as a snapshot schedule name or ID.

--name <name>

Specifies a new name for the schedule.

Specify as any string.

{--alias | -a} <name>

Specifies an alias for the latest snapshot generated based on the schedule. The alias enables you to quickly locate the most recent snapshot that was generated according to the schedule. If specified, the specified alias will be applied to the next snapshot generated by the schedule, and all subsequently generated snapshots.

Specify as any string.

--path <path>

Specifies a new directory path for this snapshot schedule. If specified, snapshots generated by the schedule will contain only this directory path.

Specify as a directory path.

--pattern <naming-pattern>

Specifies a pattern by which snapshots created according to the schedule are named.

--schedule <schedule>

Specifies how often snapshots are created.

Specify in the following format:

"<interval> [<frequency>]"

Specify <interval> in one of the following formats:

• Every [{other | <integer>}] {weekday | day}

• Every [{other | <integer>}] week [on <day>]

• Every [{other | <integer>}] month [on the <integer>]

• Every [<day>[, ...] [of every  [{other | <integer>}] week]]

• The last {day | weekday | <day>} of every [{other | <integer>}] month

• The <integer> {weekday | <day>} of every [{other | <integer>}] month

• Yearly on <month> <integer>
  

• Yearly on the {last | <integer>} [weekday | <day>] of <month>
  

Specify <frequency> in one of the following formats:

• at <hh>[:<mm>] [{AM | PM}]

• every [<integer>] {hours | minutes} [between <hh>[:<mm>] [{AM | PM}] and <hh>[:<mm>] [{AM | PM}]]

• every [<integer>] {hours | minutes} [from <hh>[:<mm>] [{AM | PM}] to <hh>[:<mm>] [{AM | PM}]]

You can optionally append "st", "th", or "rd" to <integer>. For example, you can specify "Every 1st month"

Specify <day> as any day of the week or a three-letter abbreviation for the day. For example, both "saturday" and "sat" are valid.

{--duration | -x} <duration>

Specifies how long snapshots generated according to the schedule are stored on the cluster before OneFS automatically deletes them.

Specify in the following format:

<integer><units>

The following <units> are valid:

Y

Specifies years

M

Specifies months

W

Specifies weeks

D

Specifies days

H

Specifies hours

--clear-duration

Removes the duration period for snapshots created according to the schedule. If specified, generated snapshots will exist on the cluster indefinitely.

{--verbose | -v}

Displays more detailed information.

{--help | -f}

Display help for this command.