Skip to content

Example was missing in slcli file snapshot-create, slcli file snapshot-disable, slcli file snapshot-enable #2027

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ramkishor-ch opened this issue Jul 14, 2023 · 0 comments · Fixed by #2074
Assignees
Labels

Comments

@ramkishor-ch
Copy link
Contributor

  1. slcli file snapshot-create
    Example was missing, please add it.

EXAMPLE:
slcli file snapshot-create 12345678 --note snapshotforibmcloud
This command creates a snapshot for volume with ID 12345678 and with addition note as snapshotforibmcloud.

Expected:

./slcli file snapshot-create --help
Usage: slcli file snapshot-create [OPTIONS] VOLUME_ID

EXAMPLE:
       slcli file snapshot-create 12345678 --note snapshotforibmcloud
       This command creates a snapshot for volume with ID 12345678 and with addition note as snapshotforibmcloud.

        Creates a snapshot on a given volume

┌────┬───────────┬──────────────────────────────────┐
│    │ volume_id │                                  │
│ -n │ --notes   │ Notes to set on the new snapshot │
│ -h │ --help    │ Show this message and exit.      │
└────┴───────────┴──────────────────────────────────┘
  1. slcli file snapshot-disable
    Example was missing, please add it.

EXAMPLE:
slcli file snapshot-disable 12345678 -s DAILY
This command disables daily snapshot for volume with ID 12345678.

Expected:

./slcli file snapshot-disable --help
Usage: slcli file snapshot-disable [OPTIONS] VOLUME_ID

EXAMPLE:
       slcli file snapshot-disable 12345678 -s DAILY
       This command disables daily snapshot for volume with ID 12345678.

        Disables snapshots on the specified schedule for a given volume

┌────┬─────────────────┬──────────────────────────────────────────────────────────────┐
│    │ volume_id       │                                                              │
│    │ --schedule-type │ Snapshot schedule [INTERVAL|HOURLY|DAILY|WEEKLY]  [required] │
│ -h │ --help          │ Show this message and exit.                                  │
└────┴─────────────────┴──────────────────────────────────────────────────────────────┘
  1. slcli file snapshot-enable
    Example was missing, please add it.

EXAMPLE:
slcli file snapshot-enable 12345678 -s WEEKLY -c 5 -m 0 --hour 2 -d 0
This command enables snapshot for volume with ID 12345678, snapshot is taken weekly on every Sunday at 2:00, and up to 5 snapshots are retained.

Expected:

./slcli file snapshot-enable --help
Usage: slcli file snapshot-enable [OPTIONS] VOLUME_ID

EXAMPLE:
       slcli file snapshot-enable 12345678 -s WEEKLY -c 5 -m 0 --hour 2 -d 0
       This command enables snapshot for volume with ID 12345678, snapshot is taken weekly on every Sunday at 2:00, and up to 5 snapshots are retained.

        Enables snapshots for a given volume on the specified schedule

┌────┬───────────────────┬──────────────────────────────────────────────────────────────┐
│    │ volume_id         │                                                              │
│    │ --schedule-type   │ Snapshot schedule [INTERVAL|HOURLY|DAILY|WEEKLY]  [required] │
│    │ --retention-count │ Number of snapshots to retain  [required]                    │
│    │ --minute          │ Minute of the day when snapshots should be taken             │
│    │ --hour            │ Hour of the day when snapshots should be taken               │
│    │ --day-of-week     │ Day of the week when snapshots should be taken               │
│ -h │ --help            │ Show this message and exit.                                  │
└────┴───────────────────┴──────────────────────────────────────────────────────────────┘
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
1 participant