Follow

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

pool.add_admin pool=POOL user=POOLADMIN[,POOLADMIN,...]

Arguments

user

Name of an existing local user or ldap group, with PoolAdmin role (multiple values, separated by commas)

pool

Name of an existing pool

Example

pool.add_admin name=pool1 admin=pool-admin-may-17

Granted provisioning privileges on pool pool1 to pool admins: local user pool-admin-may-17



pool.assign_qos

Roles: Admin 

Description

Assign pool to policy.

Syntax

pool.assign_qos pool=POOL[,POOL,...] policy=QOSPOOLVOLUMESPOLICY

Arguments

policy

QoS policy

pool

Name of an existing pool (multiple values, separated by commas)

Example

pool.assign_qos pool=p1 policy=q3

Pool 'p1' was assigned to policy 'q3'



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

pool.create name=NAME physical_capacity=SIZE [virtual_capacity=SIZE] [emergency_buffer={UNLIMITED|DISABLED|SIZE}] [ssd_cache=YES|NO|Y|N] [compression=YES|NO|Y|N] [type=STANDARD|VVOL]

Arguments

physical_capacityA positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000
nameA maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.
virtual_capacityA positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000
emergency_bufferDISABLED, UNLIMITED, or a positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000
ssd_cacheEither yes, or no
compressionEither yes, or no
typeSTANDARD or VVOL

Example

Creating a pool: minimal required configuration

pool.create name=pool1 physical_capacity=20t

Pool pool1 created
Example

Creating an overprovisioned pool.

  • The specific attributes that are relevant to the pool's physical and virtual capacity are visible through the pool.query command.
pool.create name=pool2 physical_capacity=10t virtual_capacity=20t emergency_buffer=UNLIMITED
Pool pool2 created
ExampleCreating 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
ExampleCreating 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.

  • All of its entities - volumes, filesystems and their snapshots - need to be moved to other pools.

Syntax

pool.delete pool=POOL[,POOL,...]

Arguments

pool

Name of an existing pool (multiple values separated by commas)

Example

pool.delete name=pool1

Pool pool1 deleted



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

pool.lock pool=POOL

Arguments

pool

Name of an existing pool 

Example

pool.lock name=pool1

Pool pool1 Locked



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.
Run the command with names of several pools, separated with a comma and no space, in order to list these pools. Entering a name of a pool
that does not exist fails the command even if other names are entered correctly. Use the unit argument to specify the units of the capacity fields of the output. 

Syntax

pool.query [pool=POOL[,POOL,...]] [unit=CAPACITYUNIT] 

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

NAME   STATE   PHYSICAL  PHYSICAL  VIRTUAL  VIRTUAL    EMERGENCY COMPRESSED  DATA
               TOTAL     ALLOCATED TOTAL    ALLOCATED  BUFFER                REDUCTION

pool1  NORMAL  3.23 TB   1.97 TB   3.23 TB  1.97 TB    DISABLED  yes         1.00:1 

Example

To set the capacity units, run the command with the unit argument. 

pool.query unit=block 

NAME   STATE   PHYSICAL           PHYSICAL           VIRTUAL            VIRTUAL  
               TOTAL              ALLOCATED TOTAL    TOTAL              ALLOCATED 
  EMERGENCY COMPRESSED DATA
  BUFFER               REDUCTION

pool-1 NORMAL  6314441472 blocks  3848399360 blocks  6314441472 blocks  3848399360 blocks 
  DISABLED  yes        1.00:1 

ExampleQuerying 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

NAME  VOLUMES     FILESYSTEMS 
      QoS POLICY  QoS POLICY

p1    q3          q4   


pool.remove_admin

Roles: Admin 

Description

Revoke pool provisioning privileges from a pool administrator.

Syntax

pool.remove_admin pool=POOL user=POOLADMIN[,POOLADMIN,...]

Arguments

user

Name of an existing local user or ldap group, with PoolAdmin role (multiple values, separated by commas)

pool

Name of an existing pool 

Example

pool.remove_admin name=pool1 admin=pool-admin-may-17

Revoked provisioning privileges on pool pool1 from pool admins: local user pool-admin-may-17



pool.rename 

Roles: Admin 

Description

Rename pool.

Syntax

pool.rename pool=POOL new_name=NAME

Arguments

new_name

A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.

pool

Name of an existing pool 

Example

pool.rename name=pool1 new_name=pool2

Pool pool1 renamed to pool2



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

pool.resize pool=POOL [physical_capacity=SIZEDELTA] [virtual_capacity=SIZEDELTA] [emergency_buffer={UNLIMITED|DISABLED|SIZE}]

Arguments

physical_capacity

A maximum of 65 Latin characters, numbers, spaces, and the following symbols: "^&'@()[]$=!-#{}%.+~_" (excluding quotation marks). Leading and trailing whitespace characters are stripped.

pool

Name of an existing pool 

emergency_bufferDISABLED, UNLIMITED, or a positive number (up to 2 digits beyond the decimal point), optionally followed by a unit; e.g. 1TB, 1000000000000
virtual_capacityA 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.resize name=pool1 physical_capacity=2t

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

pool.set_compression pool=POOL compression=YESNO

Arguments

pool

Name of an existing pool 

compression

Either yes or no

Example

Set the pool to compress its capacity.

pool.set_compression name=p1 compression=yes

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

pool.set_thresholds pool=POOL warning=PERCENT critical=PERCENT

Arguments

critical

An integer between 0 and 100, optionally followed by a percent symbol

warningAn integer between 0 and 100, optionally followed by a percent symbol

pool

Name of an existing pool 

Example

pool.set_thresholds name=pool1 warning=70% critical=80%

Pool pool1 updated



pool.unassign_qos 

Roles: Admin 

Description

Remove pool from policy. 

Syntax

pool.unassign_qos pool=POOL [policy=QOSPOOLVOLUMESPOLICY]

Arguments

policy

QoS policy

pool

Name of an existing pool 

Example

pool.unassign_qos pool=p1

Pool 'p1' was unassigned from policies 'q4', 'q3'



pool.unlock 

Roles: Admin 

Description

Unlock pool, granting write access to its volumes.

Syntax

pool.unlock pool=POOL

Argument

pool

Name of an existing pool 

Example

pool.unlock name=pool1

Pool pool1 unlocked



pool.user_query 

Roles: All Rolls

Description

List existing pools with respective administrators.

Syntax

pool.user_query [pool=POOL]

Argument

pool

Name of an existing pool 

Example

pool.user_query

NAME  ADMINS
pool1  admin.pooladmin_1
pool2  admin.pooladmin_2



Was this article helpful?
0 out of 0 found this helpful

0 out of 0 found this helpful

Last edited: 2022-08-06 08:31:33 UTC

Comments