Pool commands allow you to create a pool, to lock it for writes, to rename and resize it, to enable SSD cache, to set size thresholds for notifications and to query the InfiniBox on pools and their administrators.
pool.add_admin
Roles: Admin
Description | Grant pool provisioning privileges to a pool administrator. | |
---|---|---|
Syntax |
| |
Arguments |
| Name of an existing local user or ldap group, with PoolAdmin role (multiple values, separated by commas) |
| Name of an existing pool | |
Example |
| |
|
pool.assign_qos
Roles: Admin
Description | Assign pool to policy. | |
---|---|---|
Syntax |
| |
Arguments |
| QoS policy |
| Name of an existing pool (multiple values, separated by commas) | |
Example |
| |
|
pool.create
Roles: Admin
Description | Create a new pool. Set the pool physical capacity, virtual capacity and emergency buffer. The emergency buffer determines whether the pool is allowed to extend without limitation, to extend within a predefined limitation, or not allowed to extend at all. The pool will extend into the emergency buffer once it passes its physical size. Then, the pool enters a Limited state where no new volumes can be created, but the existing volumes can be written into. If the pool can no longer expand, it enters a Locked state and its entities can no longer accept writes. When the pool is locked, no entity can be created and volumes cannot be resized. Release the Locked state (unlock the pool) using the pool.unlock command. | |
---|---|---|
Syntax |
| |
Arguments | physical_capacity | A positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000 |
name | A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. | |
virtual_capacity | A positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000 | |
emergency_buffer | DISABLED, UNLIMITED, or a positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000 | |
ssd_cache | Either yes, or no | |
compression | Either yes, or no | |
type | STANDARD or VVOL | |
Example | Creating a pool: minimal required configuration | |
| ||
Pool pool1 created | ||
Example | Creating an overprovisioned pool.
| |
pool.create name=pool2 physical_capacity=10t virtual_capacity=20t emergency_buffer=UNLIMITED | ||
Pool pool2 created | ||
Example | Creating a pool with an emergency buffer. | |
pool.create name=pool4 physical_capacity=10t emergency_buffer=1t | ||
Emergency buffer for pool pool4 was rounded up to 932.00 GiB (1.00 TB) Pool pool4 created | ||
Example | Creating a vVols pools which serves as a Storage Container for VMware Virtual Volumes. | |
pool.create name=vvols1 physical_capacity=20t type=VVOL | ||
Pool vvols1 created |
pool.delete
Roles: Admin
Description | Delete pool. Prior to the deletion of the pool, it has to be emptied.
| |
---|---|---|
Syntax |
| |
Arguments |
| Name of an existing pool (multiple values separated by commas) |
Example |
| |
|
pool.lock
Roles: Admin
Description | Lock pool, revoking write access to its volumes. When the pool is locked, no entity can be created and volumes cannot be resized. Release the Locked state (unlock the pool) using the pool.unlock command | |
---|---|---|
Syntax |
| |
Arguments |
| Name of an existing pool |
Example |
| |
|
pool.query
Roles: All Roles
Description | List existing pools. Run the command with no arguments in order to list all of the pools on the InfiniBox. Run the command with a pool name as an input, in order to list only this pool. | |
---|---|---|
Syntax |
| |
Arguments | pool | Name of an existing pool (multiple values, separated by commas) |
unit | B, G (or GB), GiB, T (or TB), TiB or block | |
Example | pool.query | |
| ||
Example | To set the capacity units, run the command with the unit argument. | |
pool.query unit=block | ||
| ||
Example | Querying for pools and the QoS policy they are assigned toCreating a pool with an emergency buffer. | |
pool.query --columns=name,volumes_qos_policy,filesystems_qos_policy | ||
|
pool.remove_admin
Roles: Admin
Description | Revoke pool provisioning privileges from a pool administrator. | |
---|---|---|
Syntax |
| |
Arguments |
| Name of an existing local user or ldap group, with PoolAdmin role (multiple values, separated by commas) |
| Name of an existing pool | |
Example |
| |
|
pool.rename
Roles: Admin
Description | Rename pool. | |
---|---|---|
Syntax |
| |
Arguments |
| A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. |
| Name of an existing pool | |
Example |
| |
|
pool.resize
Roles: Admin
Description | Resize pool. Change the pool physical capacity, virtual capacity or emergency buffer. See the documentation of pool.create for the way the emergency buffer can be configured. | |
---|---|---|
Syntax |
| |
Arguments |
| A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped. |
| Name of an existing pool | |
emergency_buffer | DISABLED, UNLIMITED, or a positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000 | |
virtual_capacity | A number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000. When preceded by a plus or minus sign, represents a delta; e.g. 3000000m (absolute size), +2000GB (positive delta), -1.5T (negative delta) | |
Example | Resizing the pool's physical capacity. | |
| ||
Pool pool1 resized | ||
Example | Resizing the pool's emergency buffer. | |
pool.resize name=pool2 emergency_buffer=1t | ||
Emergency buffer for pool pool2 was rounded up to 932.00 GiB (1.00 TB) Pool pool2 created |
pool.set_compression
Roles: Admin, Pool Admin
Description | Set the pool capacity to be compressed. | |
---|---|---|
Syntax |
| |
Arguments |
| Name of an existing pool |
| Either yes or no | |
Example | Set the pool to compress its capacity. | |
| ||
Pool "p1" Compression was enabled | ||
Example | Set the pool to stop compressing its capacity | |
pool.set_compression name=p1 compression=no | ||
Pool "p1" Compression was disabled |
pool.set_thresholds
Roles: Admin, Pool Admin
Description | Set pool capacity notification thresholds. Set the InfiniBox to issue events whenever the pool exceeds a capacity threshold. You may set two thresholds for each pool: Warning and Critical. The size of the Warning threshold cannot exceed the size of the Critical threshold. | |
---|---|---|
Syntax |
| |
Arguments |
| An integer between 0 and 100, optionally followed by a percent symbol |
warning | An integer between 0 and 100, optionally followed by a percent symbol | |
| Name of an existing pool | |
Example |
| |
|
pool.unassign_qos
Roles: Admin
Description | Remove pool from policy. | |
---|---|---|
Syntax |
| |
Arguments |
| QoS policy |
| Name of an existing pool | |
Example |
| |
|
pool.unlock
Roles: Admin
Description | Unlock pool, granting write access to its volumes. | |
---|---|---|
Syntax |
| |
Argument |
| Name of an existing pool |
Example |
| |
|
pool.user_query
Roles: All Rolls
Description | List existing pools with respective administrators. | |
---|---|---|
Syntax |
| |
Argument |
| Name of an existing pool |
Example |
| |
|
Last edited: 2022-08-06 08:31:33 UTC
Comments