List Services

This command returns the list of configurable services available on the storage appliance along with their enabled status. HTTP Status 200 (OK) is returned for a successful command.

Example Request:

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

Example Response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
X-Zfssa-Service-Api: 1.0

{
    "services": [{
        "<status>": "disabled",
        "href": "/api/service/v1/services/ad",
        "name": "ad"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/smb",
        "log": {
            "href": "/api/log/v1/logs/network-smb:default",
            "size": 2
        },
        "name": "smb"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/dns",
        "log": {
            "href": "/api/log/v1/logs/network-dns-client:default",
            "size": 4
        },
        "name": "dns"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/dynrouting",
        "log": {
            "href": "/api/log/v1/logs/network-routing-route:default",
            "size": 81
        },
        "name": "dynrouting"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/ftp",
        "log": {
            "href": "/api/log/v1/logs/network-ftp:proftpd",
            "size": 40
        },
        "name": "ftp"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/http",
        "name": "http"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/identity",
        "log": {
            "href": "/api/log/v1/logs/system-identity:node",
            "size": 4
        },
        "name": "identity"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/idmap",
        "log": {
            "href": "/api/log/v1/logs/system-idmap:default",
            "size": 15
        },
        "name": "idmap"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/ipmp",
        "log": {
            "href": "/api/log/v1/logs/network-ipmp:default",
            "size": 3
        },
        "name": "ipmp"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/iscsi",
        "log": {
            "href": "/api/log/v1/logs/network-iscsi-target:default",
            "size": 3
        },
        "name": "iscsi"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/ldap",
        "name": "ldap"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/ndmp",
        "log": {
            "href": "/api/log/v1/logs/system-ndmpd:default",
            "size": 11
        },
        "name": "ndmp"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/nfs",
        "log": {
            "href": "/api/log/v1/logs/appliance-kit-nfsconf:default",
            "size": 6
        },
        "name": "nfs"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/nis",
        "log": {
            "href": "/api/log/v1/logs/network-nis-domain:default",
            "size": 3
        },
        "name": "nis"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/ntp",
        "name": "ntp"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/replication",
        "name": "replication"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/rest",
        "log": {
            "href": "/api/log/v1/logs/appliance-kit-akrestd:default",
            "size": 10
        },
        "name": "rest"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/scrk",
        "name": "scrk"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/sftp",
        "name": "sftp"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/shadow",
        "name": "shadow"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/smtp",
        "log": {
            "href": "/api/log/v1/logs/network-smtp:sendmail",
            "size": 6
        },
        "name": "smtp"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/snmp",
        "name": "snmp"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/srp",
        "name": "srp"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/ssh",
        "log": {
            "href": "/api/log/v1/logs/network-ssh:default",
            "size": 3
        },
        "name": "ssh"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/syslog",
        "name": "syslog"
    }, {
        "<status>": "online",
        "href": "/api/service/v1/services/tags",
        "name": "tags"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/tftp",
        "name": "tftp"
    }, {
        "<status>": "disabled",
        "href": "/api/service/v1/services/vscan",
        "log": {
            "href": "/api/log/v1/logs/vscan",
            "size": 0
        },
        "name": "vscan"
    }]
}