Follow

About this task

InfiniShell provides on-line auto-completion help as-you-type.

Typing a command name + TAB

Type a part of the command name (and press TAB)

Type the following string
po
The string auto completes to
The first part of the command name, followed by a dot (.)
pool.
Meaning: all of the commands that start with "pool."

Type the command initial part (and press TAB)

Type the following string
pool.
The string auto completes to
All of the commands that start with "pool.":
Commands:
cache delete query resize unlock
create lock rename set_thresholds user_query

Type a command name (and press TAB)

Type
pool.create
The string auto completes to
All of the parameters that the command pool.create accepts.
  • Mandatory parameters are not bracketed.
  • Optional parameters are bracketed.
name physical_capacity [virtual_capacity] [ssd_cache] [auto_extend]

Typing a query command + TAB

Type
pool.query
The string auto completes to
[name] [unit] [--detailed] [--columns] [--sort] [--format]

Querying for a detailed output

Displays the query results with all of the queried object’s fields:

pool.query pool=1855 --detailed
Name                     1855                                                                       
State                    NORMAL                                                                     
Physical Total           20.00 TB                                                                   
Physical Allocated       2.19 TB                                                                    
Physical Free            17.80 TB                                                                   
Virtual Total            20.00 TB                                                                   
Virtual Allocated        2.19 TB                                                                    
Virtual Free             17.80 TB                                                                   
Emergency Buffer         UNLIMITED                                                                  
Used Emergency Buffer    -                                                                          
Warning Threshold        80%                                                                        
Critical Threshold       90%                                                                        
Volumes QoS Policy       -                                                                          
Filesystems QoS Policy   -                                                                          
Compressed               yes                                                                        
Data Reduction           1.00 : 1                                                                   
SSD Cache Default        yes   


Controlling the columns of the displayed query output

Displays a list of attributes that can be included as columns in the query result:

pool.query --columns=

name, state, physical_total, physical_allocated, physical_free, 
virtual_total, virtual_allocated, virtual_free, auto_extend,
used_emergency_buffer, warning_threshold, critical_threshold or
ssd_cache_default (multiple values, separated by commas)

Sorting the query output

Displays a list of attributes that the query can be sorted by:

vol.query --columns=name,pool --sort=    

Names of sortable columns: e.g, size: sort by ascending order, -size: sort by descending order.
name, serial, size, wp, mapped, ssd_cache, created_at, updated_at, -name, -serial, -size, -wp, 
-mapped, -ssd_cache, -created_at or -updated_at (multiple values, separated by commas)
-created_at  -name        -size        -updated_at  created_at   name         size         updated_at
-mapped      -serial      -ssd_cache   -wp          mapped       serial       ssd_cache    wp   


Another example:

pool.query --sort=size

NAME  STATE  PHYSICAL TOTAL PHYSICAL ALLOCATED VIRTUAL TOTAL  VIRTUAL ALLOCATED  AUTO EXTEND
pool1 NORMAL 7.00 TB        0                  7.00 TB        0                  UNLIMITED                                                                                          
pool2 NORMAL 6.00 TB        0                  6.00 TB        0                  UNLIMITED                                                                                           
pool3 NORMAL 5.00 TB        0                  5.00 TB        0                  UNLIMITED

Displaying the output in CSV format

pool.query --format=csv

NAME,STATE,PHYSICAL TOTAL,PHYSICAL ALLOCATED,VIRTUAL TOTAL,VIRTUAL ALLOCATED,AUTO EXTEND                     
pool1,NORMAL,7.00 TB,0,7.00 TB,0,UNLIMITED                                                                   
pool2,NORMAL,6.00 TB,0,6.00 TB,0,UNLIMITED                                                                   
pool3,NORMAL,5.00 TB,0,5.00 TB,0,UNLIMITED 

Displaying the output in JSON format

pool.query --format=json

Displays the output in JSON format:

{                                                                                                                                                                                             
	"command": "pool.query --format=json",                                                                                                                                                       
	"result": [                                                                                                                                                                                   
		{                                                                                                                                                                                             
    		"allocated_physical_space": "0",                                                                                                                                                          
    		"allocated_virtual_space": "10.78 TB",                                                                                                                                                   
    		"max_extend": "DISABLED",                                                                                                                                                                 
    		"name": "pool_acc3d07cb0b011e48cda00505699a571",                                                                                                                                     
    		"physical_capacity": "10.99 TB",                                                                                                                                                         
    		"state": "NORMAL",                                                                                                                                                                       
    		"virtual_capacity": "10.99 TB"                                                                                                                                                            
		}                                                                                                                                                                                           
	]                                                                                                                                                                                            
}    

Querying for any string

Querying for a single string

*.query --grep=STRING

Returns query results only for entities that contain the searched string.

pool.query --grep=er --columns=name
uberpool_0000
uberpool_0001    

Querying for more than one string

*.query  --grep="STRING1|STRING2"

Returns query results for entities that contain either of the searched strings.

pool.query --grep=er|re --columns=name                                  
replica_0000
replica_0001
uberpool_0000                                                
uberpool_0001    

Approving a warning message

Some InfiniShell commands require user approval. The approval message always provides a reason, and can be either approved or rejected. For example, deleting a pool requires user approval:

pool.delete name=pool1                                                                                           
Deleting pool 'pool1' might prevent the pool's administrator from creating new volumes.                                             
Are you sure? [y/n]

If the warning message is approved, the pool is deleted:

Are you sure? [y/n] y                                                                                                                 
Pool "pool1" deleted

If the warning message is disapproved, the command is aborted and the pool is not deleted:

Are you sure? [y/n] n                                                                                                                 
Command aborted   


GUI shortcuts

Press on a question mark (?) anywhere on the GUI to get a list of GUI shortcuts.
 

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

0 out of 0 found this helpful

Comments