acl-cat.3valkey - Man Page
Lists the ACL categories, or the commands inside a category.
Synopsis
ACL CAT
[category]
Description
The command shows the available ACL categories if called without arguments. If a category name is given, the command shows all the Valkey commands in the specified category.
ACL categories are very useful in order to create ACL rules that include or exclude a large set of commands at once, without specifying every single command. For instance, the following rule will let the user karin
perform everything but the most dangerous operations that may affect the server stability:
ACL SETUSER karin on +@all -@dangerous
We first add all the commands to the set of commands that karin
is able to execute, but then we remove all the dangerous commands.
Checking for all the available categories is as simple as:
> ACL CAT 1) "keyspace" 2) "read" 3) "write" 4) "set" 5) "sortedset" 6) "list" 7) "hash" 8) "string" 9) "bitmap" 10) "hyperloglog" 11) "geo" 12) "stream" 13) "pubsub" 14) "admin" 15) "fast" 16) "slow" 17) "blocking" 18) "dangerous" 19) "connection" 20) "transaction" 21) "scripting"
Then we may want to know what commands are part of a given category:
> ACL CAT dangerous 1) "flushdb" 2) "acl" 3) "slowlog" 4) "debug" 5) "role" 6) "keys" 7) "pfselftest" 8) "client" 9) "bgrewriteaof" 10) "replicaof" 11) "monitor" 12) "restore-asking" 13) "latency" 14) "replconf" 15) "pfdebug" 16) "bgsave" 17) "sync" 18) "config" 19) "flushall" 20) "cluster" 21) "info" 22) "lastsave" 23) "slaveof" 24) "swapdb" 25) "module" 26) "restore" 27) "migrate" 28) "save" 29) "shutdown" 30) "psync" 31) "sort"
Reply
One of the following:
- valkey-protocol(7) Array reply: an array of valkey-protocol(7) Bulk string reply elements representing ACL categories or commands in a given category.
- valkey-protocol(7) Simple error reply: the command returns an error if an invalid category name is given.
Complexity
O(1) since the categories and commands are a fixed set.
Acl Categories
@slow
History
- Available since: 6.0.0
See Also
acl(3valkey), acl-deluser(3valkey), acl-dryrun(3valkey), acl-genpass(3valkey), acl-getuser(3valkey), acl-help(3valkey), acl-list(3valkey), acl-load(3valkey), acl-log(3valkey), acl-save(3valkey), acl-setuser(3valkey), acl-users(3valkey), acl-whoami(3valkey), bgrewriteaof(3valkey), bgsave(3valkey), command(3valkey), command-count(3valkey), command-docs(3valkey), command-getkeys(3valkey), command-getkeysandflags(3valkey), command-help(3valkey), command-info(3valkey), command-list(3valkey), config(3valkey), config-get(3valkey), config-help(3valkey), config-resetstat(3valkey), config-rewrite(3valkey), config-set(3valkey), dbsize(3valkey), debug(3valkey), failover(3valkey), flushall(3valkey), flushdb(3valkey), info(3valkey), lastsave(3valkey), latency(3valkey), latency-doctor(3valkey), latency-graph(3valkey), latency-help(3valkey), latency-histogram(3valkey), latency-history(3valkey), latency-latest(3valkey), latency-reset(3valkey), lolwut(3valkey), memory(3valkey), memory-doctor(3valkey), memory-help(3valkey), memory-malloc-stats(3valkey), memory-purge(3valkey), memory-stats(3valkey), memory-usage(3valkey), module(3valkey), module-help(3valkey), module-list(3valkey), module-load(3valkey), module-loadex(3valkey), module-unload(3valkey), monitor(3valkey), psync(3valkey), replconf(3valkey), replicaof(3valkey), restore-asking(3valkey), role(3valkey), save(3valkey), shutdown(3valkey), slowlog(3valkey), slowlog-get(3valkey), slowlog-help(3valkey), slowlog-len(3valkey), slowlog-reset(3valkey), swapdb(3valkey), sync(3valkey), time(3valkey)