Skip to content

Example text was missing in slcli block access-authorise, slcli block access-list, slcli block access-revoke, slcli block disaster-recovery-failover #2012

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 12, 2023 · 0 comments · Fixed by #2053
Assignees
Labels

Comments

@ramkishor-ch
Copy link
Contributor

The Example text was missing, please add it in slcli block access-authorize command.

  1. slcli block access-authorize
    EXAMPLE:
    slcli block access-authorize 12345678 --virtual-id 87654321
    This command authorizes virtual server with ID 87654321 to access volume with ID 12345678.

Expected:

./slcli block access-authorize --help
Usage: slcli block access-authorize [OPTIONS] VOLUME_ID

        Authorize hosts to access a given volume.

EXAMPLE:
   slcli block access-authorize 12345678 --virtual-id 87654321
   This command authorizes virtual server with ID 87654321 to access volume with ID 12345678.

┌────┬─────────────────┬───────────────────────────────────────────────────────────────────────────────────┐
│    │ volume_id       │                                                                                   │
│ -d │ --hardware-id   │ The ID of one hardware server to authorize. (Multiple allowed)                    │
│ -i │ --ip-address-id │ The ID of one SoftLayer_Network_Subnet_IpAddress to authorize. (Multiple allowed) │
│    │ --ip-address    │ An IP address to authorize. (Multiple allowed)                                    │
│ -v │ --virtual-id    │ The ID of one virtual server to authorize. (Multiple allowed)                     │
│ -h │ --help          │ Show this message and exit.                                                       │
└────┴─────────────────┴───────────────────────────────────────────────────────────────────────────────────┘
  1. sl block access-list
    EXAMPLE:
    slcli block access-list 12345678 --sortby id
    This command lists all hosts that are authorized to access volume with ID 12345678 and sorts them by ID.

Expected:

./slcli block access-list --help
Usage: slcli block access-list [OPTIONS] VOLUME_ID

        List hosts that are authorized to access the volume.

EXAMPLE:
   slcli block access-list 12345678 --sortby id 
   This command lists all hosts that are authorized to access volume with ID 12345678 and sorts them by ID.

┌────┬───────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│    │ volume_id │                                                                                                                                    │
│    │ --columns │ Columns to display. Options are: id, name, type, private_ip_address, source_subnet, host_iqn, username, password, allowed_host_id. │
│    │ --sortby  │ Column to sort by. Options are: id, name, type, private_ip_address, source_subnet, host_iqn, username, password, allowed_host_id.  │
│ -h │ --help    │ Show this message and exit.                                                                                                        │
└────┴───────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
  1. sl block access-revoke
    EXAMPLE:
    slcli block access-revoke 12345678 --virtual-id 87654321
    This command revokes access of virtual server with ID 87654321 to volume with ID 12345678.
./slcli block access-revoke --help  
Usage: slcli block access-revoke [OPTIONS] VOLUME_ID

        Revoke authorization for hosts that are accessing a specific volume.

EXAMPLE:
   slcli block access-revoke 12345678 --virtual-id 87654321
   This command revokes access of virtual server with ID 87654321 to volume with ID 12345678.

┌────┬─────────────────┬───────────────────────────────────────────────────────────────────────────┐
│    │ volume_id       │                                                                           │
│ -d │ --hardware-id   │ The ID of one SoftLayer_Hardware to revoke authorization.                 │
│ -i │ --ip-address-id │ The ID of one SoftLayer_Network_Subnet_IpAddress to revoke authorization. │
│    │ --ip-address    │ An IP address to revoke authorization.                                    │
│ -v │ --virtual-id    │ The ID of one SoftLayer_Virtual_Guest to revoke authorization.            │
│ -h │ --help          │ Show this message and exit.                                               │
└────┴─────────────────┴───────────────────────────────────────────────────────────────────────────┘
  1. ./slcli block disaster-recovery-failover

a. Should remove this text: Failover an inaccessible block volume to its available replicant volume. before this text: If a volume... because we already have same text in description.
b. Should add Example text:
EXAMPLE:
slcli block disaster-recovery-failover 12345678 87654321
This command performs failover operation for volume with ID 12345678 to replica volume with ID 87654321.

Expected:

./slcli block disaster-recovery-failover --help
Usage: slcli block disaster-recovery-failover [OPTIONS] VOLUME_ID

        Failover an inaccessible block volume to its available replicant volume.

EXAMPLE:
	${COMMAND_NAME} sl block disaster-recovery-failover 12345678 87654321
	This command performs failover operation for volume with ID 12345678 to replica volume with ID 87654321.

┌────┬────────────────┬─────────────────────────────┐
│    │ volume-id      │                             │
│    │ --replicant-id │ ID of the replicant volume. │
│ -h │ --help         │ Show this message and exit. │
└────┴────────────────┴─────────────────────────────┘
If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for failback via API. After using this method, to failback to the original volume, please open a support ticket. If you wish to test failover, please use replica-failover.
  1. ./slcli block duplicate-convert-status
    text: storage is missing in between block and duplicate

Get status for split or move completed percentage of a given block storage duplicate volume.

Expected:

./slcli block duplicate-convert-status --help

Usage: slcli block duplicate-convert-status [OPTIONS] VOLUME_ID

        Get status for split or move completed percentage of a given block storage duplicate volume.

┌────┬───────────┬─────────────────────────────┐
│    │ volume-id │                             │
│ -h │ --help    │ Show this message and exit. │
└────┴───────────┴─────────────────────────────┘
Get status for split or move completed percentage of a given block duplicate volume.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
1 participant