Skip to content
HotKVDocs

Ask the HotKV docs

Answers come only from these docs and can be wrong; check the linked pages before you rely on them.

TENANT.SUSPEND

Last updated 
TENANT.SUSPEND id
Group
Tenancy
Complexity
O(1)
Arity
2 (exactly, counting the command name)
Flags
admin, write
HotKV Cloud
Scale
On-Premise
requires the multi-tenancy license feature

TENANT.SUSPEND sets a tenant’s state to suspended on every node and records when it happened. TENANT.INFO shows the state, and TENANT.RESUME sets it back to active. Suspending records a state for your own tooling; it does not block the commands of users bound to the tenant. To lock a tenant’s users out, turn them off with ACL SETUSER off.

Return value

Section titled “Return value”

Simple string OK in RESP2 and RESP3, or one of these errors:

Case Error
No such tenant ERR tenant not found or already suspended
No license that includes multi-tenancy NOLICENSE multi-tenancy requires a HotKV license. Contact sales@hotkv.com

Suspending a tenant that is already suspended replies OK and records the new time.

Examples

Section titled “Examples”
127.0.0.1:6379> TENANT.SUSPEND acme
OK
127.0.0.1:6379> TENANT.SUSPEND nosuch
(error) ERR tenant not found or already suspended

Compatibility

Section titled “Compatibility”

HotKV-only command.

See also

Section titled “See also”

TENANT.RESUME, TENANT.INFO