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 62 Storage Pool Properties

Type	Name	Description
string	pool	The target pool name
string	profile	Data device profile
string	state	The pool state ("online", "offline", "exported")
string	asn	The appliance serial number that owns the pool
string	peer	In a clustered system, the ASN of the peer node
string	owner	The 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": "platinum",
            "peer": "00000000-0000-0000-0000-000000000000",
        "state": "online",
        "owner": "zfs-storage",
        "asn": "2f4aeeb3-b670-ee53-e0a7-d8e0ae410749"
    }, {
        "profile": "raidz1",
        "name": "gold",
        "peer": "00000000-0000-0000-0000-000000000000",
        "state": "online",
        "owner": "zfs-storage",
        "asn": "2f4aeeb3-b670-ee53-e0a7-d8e0ae410749"
    }]
}