Skip to content
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

Example and some sub features were missing in slcli file volume-order, slcli file volume-refresh, slcli file volume-set-note #2031

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

Comments

@ramkishor-ch
Copy link
Contributor

  1. slcli file volume-order
    a. Example was missing, please add it.
    EXAMPLE:
    slcli file volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09
    This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.
    slcli file volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500
    This command orders an endurance volume with size is 500GB, tier level is 4 IOPS per GB, OS type is XEN, located at dal09, and additional snapshot space size is 500GB.

b. Options: --force was missing, please add it.
-f, --force Force operation without confirmation

Expected:

./slcli file volume-order --help  
Usage: slcli file volume-order [OPTIONS]

EXAMPLE:
       slcli file volume-order --storage-type performance --size 1000 --iops 4000 --os-type LINUX -d dal09
       This command orders a performance volume with size is 1000GB, IOPS is 4000, OS type is LINUX, located at dal09.
       slcli file volume-order --storage-type endurance --size 500 --tier 4 --os-type XEN -d dal09 --snapshot-size 500
       This command orders an endurance volume with size is 500GB, tier level is 4 IOPS per GB, OS type is XEN, located at dal09,   and additional snapshot space size is 500GB.

        Order a file storage volume.

Valid size and iops options can be found here:
https://cloud.ibm.com/docs/FileStorage/index.html#provisioning-considerations

┌────┬────────────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│    │ --storage-type     │ Type of file storage volume  [required] Choices: performance, endurance                                                            │
│    │ --size             │ Size of file storage volume in GB  [required]                                                                                      │
│    │ --iops             │ Performance Storage IOPs. Options vary based on storage size.                                                                      │
│    │                    │ [required for storage-type performance]                                                                                            │
│    │ --tier             │ Endurance Storage Tier (IOP per GB) [required for storage-type endurance] Choices: 0.25, 2, 4, 10                                  │
│    │ --location         │ Datacenter short name (e.g.: dal09)  [required]                                                                                    │
│    │ --snapshot-size    │ Optional parameter for ordering snapshot space along with endurance file storage; specifies the size (in GB) of snapshot space to  │
│    │                    │ order                                                                                                                              │
│    │ --service-offering │ The service offering package to use for placing the order.                                                                         │
│    │                    │ [optional, default is 'storage_as_a_service']. enterprise and performance are depreciated Choices: storage_as_a_service,           │
│    │                    │ enterprise, performance                                                                                                            │
│    │ --billing          │ Optional parameter for Billing rate (default to monthly) Choices: hourly, monthly                                                  │
│ -f │ --force          │  Force operation without confirmationy                                                  │       
│ -h │ --help             │ Show this message and exit.                                                                                                        │
└────┴────────────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
  1. slcli file volume-refresh
    a. Example was missing, please add it.
    EXAMPLE:
    slcli file volume-refresh VOLUME_ID SNAPSHOT_ID
    Refresh a duplicate VOLUME_ID with a snapshot from its parent SNAPSHOT_ID.

Expected:

./slcli file volume-refresh --help
Usage: slcli file volume-refresh [OPTIONS] VOLUME_ID SNAPSHOT_ID

EXAMPLE:
        slcli file volume-refresh VOLUME_ID SNAPSHOT_ID
        Refresh a duplicate VOLUME_ID with a snapshot from its parent SNAPSHOT_ID.

        Refresh a duplicate volume with a snapshot from its parent.

┌────┬─────────────────┬───────────────────────────────────────────────────────────────┐
│    │ volume_id       │                                                               │
│    │ snapshot_id     │                                                               │
│ -f │ --force-refresh │ Cancel current refresh process and initiates the new refresh. │
│ -h │ --help          │ Show this message and exit.                                   │
└────┴─────────────────┴───────────────────────────────────────────────────────────────┘
  1. slcli file volume-set-note
    Example was missing, please add it.
    EXAMPLE:
    slcli file volume-set-note 12345678 --note 'this is my note'

Expected:

./slcli file volume-set-note --help
Usage: slcli file volume-set-note [OPTIONS] VOLUME_ID

EXAMPLE:
   slcli file volume-set-note 12345678 --note 'this is my note'

        Set note for an existing file storage volume.

┌────┬───────────┬──────────────────────────────────────────────────────┐
│    │ volume-id │                                                      │
│ -n │ --note    │ Public notes related to a Storage volume  [required] │
│ -h │ --help    │ Show this message and exit.                          │
└────┴───────────┴──────────────────────────────────────────────────────┘
@JayasilanJibm JayasilanJibm self-assigned this Jul 21, 2023
JayasilanJibm pushed a commit that referenced this issue Jul 27, 2023
Example and sub feature for slcli file volume-order, volume-refresh, volume-set-note command
allmightyspiff added a commit that referenced this issue Jul 27, 2023
Example and sub feature for slcli file volume-order, volume-refresh, volume-set-note command #2031
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants