Skip to Content
Browse documentation

poolctl — Command Reference

List backup storage pools or test a selected pool connection in its owner scope.

List backup storage pools or test a selected pool connection in its owner scope.

Requirements

Run as root on the Eenos server. Choose one operation and exactly one owner scope: --root, --reseller USER or --user USER. Testing requires a configured pool ID and its backend access.

Usage

The following example uses the operation described below; replace example identities and paths before use:

/usr/local/eenos/scripts/poolctl --list --root

Arguments and options

Argument / optionUsage and meaning
-t, --test_poolValue: pool_id. Test storage pool connection
-l, --listFlag. List storage pools
--root, -rFlag. Root storage pool operations
--reseller, -reValue: RE. Reseller storage pool operations
--user, -uValue: U. User storage pool operations

-h, --help displays this parser's help. Selectors in the same mutually exclusive group cannot be combined. The installed version remains authoritative for available options.

Operational effects

Listing reads pool definitions. A pool test performs a storage connection check and is not a successful backup/upload test.

Verify the result

Review connection results for the intended pool and owner. Do not publish storage credentials from diagnostic output.

Check operation output and the relevant service/application state. Several legacy wrappers exit successfully after logging a handler failure, so a zero shell exit status alone is not proof of completion.

Back to Backup & Restore · All command-line tools