Scrub

create has one required property, pool, and four optional properties (see Create Properties below). The value for pool is the pool id number. Use storage pool query to find the id for the selected pool and enter this integer.

Enter the full command string along with any optional properties you want to configure, or accept the default values, and then press Enter. create returns an empty line when successful. Use query to confirm the task is created correctly.

From the CLI prompt, enter:

storage scrub create pool=1

Where 1 is the id number for the selected pool. Press Enter.

storage scrub create pool=2 threshold=30 description="tank scrub" schedule={} enabled=true

delete has one required property, id. Use query to find the id number of the scrub task you want to remove.

Enter the command string and then press Enter. delete returns an empty line when successful. Use query or get_instance to confirm the task is deleted.

From the CLI prompt, enter:

storage scrub delete id=1

Where 1 is the scrub task id. Press Enter.

storage scrub delete id=1

get_instance has one required property, id. Use query to find the id number of the scrub task you want to view.

Enter the command string and then press Enter. get_instance returns a table containing configured settings for that scrub task.

From the CLI prompt, enter:

storage scrub get_instance id=1

Where 1 is the id number for the selected scrub task. Press Enter.

storage scrub get_instance id=1
+-------------+------------+
|          id | 1          |
|   threshold | 30         |
| description | tank scrub |
|     enabled | true       |
|        pool | 2          |
|   pool_name | tank       |
|    schedule | <dict>     |
+-------------+------------+

query does not require entering properties or arguments.

Enter the command string and then press Enter. query returns a table containing configured settings for all existing scrub tasks.

From the CLI prompt, enter:

storage scrub query

Press Enter.

storage scrub query
+----+-----------+-------------+---------+------+-----------+----------+
| id | threshold | description | enabled | pool | pool_name | schedule |
+----+-----------+-------------+---------+------+-----------+----------+
| 1  | 35        |             | true    | 2    | tank      | <dict>   |
+----+-----------+-------------+---------+------+-----------+----------+

run has one required property, name, and one optional property, threshold. To find the name of the pool you want to scrub, use storage pool query or storage dataset query id to return the paths of all pools and child datasets on the system.

threshold defaults to 35 days. To preserve system resources, the scrub runs only if time since the pool was last scrubbed is greater than the threshold value. To override the threshold and run immediately, you can use threshold=0.

Enter the full command string and then press Enter. run returns an empty line. To check if the scrub starts successfully, you can use system alert list to view system alerts.

From the CLI prompt, enter:

storage scrub run name="tank"

Where tank is the name of the pool you want to scrub. Press Enter.

storage scrub run name="tank" threshold=35

scrub has two required properties, name and action. To find the name of the pool you want to scrub, use storage pool query or storage dataset query id to return the paths of all pools and child datasets on the system.

There are three possible values for action:

• START
• PAUSE
• STOP

Enter the full command string and then press Enter. Returns the percentage status of action.

From the CLI prompt, enter:

storage scrub scrub name="tank" action=START

Where tank is the name of the selected pool and START is one of the three possible actions. Press Enter.

storage scrub scrub name="tank" action=START
[0%] ...
[0%] Scrubbing...
[1%] Scrubbing...
[4%] Scrubbing...
...
[98%] Scrubbing...
[99%] Scrubbing...
[100%] Scrub finished...

storage scrub scrub name="tank" action=PAUSE
[0%] ...
[100%] ...

storage scrub scrub name="tank" action=STOP
[100%] ...

update has one required property, id, and eight optional properties. Use query to view the id numbers for existing scheduled scrub tasks. For optional properties, see the create properties.

Enter the command string with any optional properties you want to update and then press Enter.

From the CLI prompt, enter:

storage scrub update id=1 property=value

Where 1 is the id of the scrub task to update, property is one of the configuration properties, and value is the new setting for that property. Press Enter.

update returns an empty line. Use query or get_instance to confirm the new settings are applied.