List Pools

Language:

This command lists the properties of all storage pools on the system. HTTP status 200 (OK) is returned for a successful command. The HTTP body contains a list of JSON objects describing each pool. The names of the properties are shown in the following table.

Note - The depth query parameter and the match_property-name=value query parameter are not supported.

Table 58 Storage Pool Properties

Property	Type	Description
`pool`	string	The target pool name
`profile`	string	Data device profile
`state`	string	Pool state: `online`, `offline`, `exported`)
`asn`	string	Serial number of the appliance that owns the pool
`peer`	string	In a clustered system, the ASN of the peer node
`owner`	string	Hostname of the system that owns the pool

Example Request:

GET /api/storage/v1/pools HTTP/1.1
Host: zfs-storage.example.com
Accept: application/json

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "pools": [{
        "profile": "mirror3",
            "name": "m1",
            "peer": "00000000-0000-0000-0000-000000000000",
        "state": "online",
        "owner": "zfs-storage",
        "asn": "2f4aeeb3-b670-ee53-e0a7-d8e0ae410749"
    }, {
        "profile": "raidz1",
        "name": "r1",
        "peer": "00000000-0000-0000-0000-000000000000",
        "state": "online",
        "owner": "zfs-storage",
        "asn": "2f4aeeb3-b670-ee53-e0a7-d8e0ae410749"
    }]
}