Velocity • Durability

7. Command Summary

Every PanCTL command described in the Command Reference chapter that follows, grouped the same way as its sections. Each command links to its group’s own section. The auth commands are covered in Chapter 3, the profiles commands in Chapter 4, and completion in Chapter 9; they are not repeated in the table below.

Command Purpose
realm get Show realm-wide state and configuration
nodes list List all nodes
nodes get <dataserial> Show one node’s details
nodes reboot <dataserial> Reboot a node
storagesets list List all storage sets
storagesets get <id> Show one storage set
storagesets create --name <name> [--spares-requested <n>] Create a storage set
storagesets update <id> -f <file> Update a storage set
storagesets delete <id> Delete a storage set
storagesets add-storage --storageset-id <id> --dataserials <a,b,c> [options] Add nodes to a storage set
tenants list List all tenants
tenants get <tenant_id> Show one tenant
tenants create --name <name> --short-name <name> --email <addr> [options] Create a tenant
tenants update <tenant_id> -f <file> Update a tenant
tenants delete <tenant_id> Delete a tenant (cascades to its volumes)
tenants assign-storagesets --tenant <ref> --storageset-id <id> --quota <size> Grant/resize a tenant’s capacity in a storage set
tenants unassign-storagesets --tenant <ref> --storageset-id <id> Remove a tenant’s access to a storage set
tenants list-storagesets --tenant <ref> List storage sets assigned to a tenant
tenants get-storageset --tenant <ref> --storageset-id <id> Show one tenant/storage-set assignment
volumes list List volumes
volumes get <volume_id> Show one volume
volumes create --name <path> --storageset-id <id> --hard-quota <size> [options] Create a volume
volumes update <volume_id> -f <file> Update quotas, recovery priority, etc.
volumes rename <volume_id> -f <file> Rename (change the path of) a volume
volumes delete <volume_id> Delete a volume
subnets list [--tenant <ref>] List subnets
subnets get <subnet_id> Show one subnet
subnets create --tenant <ref> --name <name> --cidr <addr/prefix> [options] Create a subnet
subnets update <subnet_id> [options] Update a subnet
subnets delete <subnet_id> Delete a subnet
subnets attachments list <subnet_id> List client attachments on a subnet
subnets attachments get <subnet_id> <attachment_id> Show one attachment
subnets attachments create <subnet_id> --underlay-ip <ip> [options] Attach a client
subnets attachments delete <subnet_id> <attachment_id> Remove an attachment
users list [--tenant <ref>] List users in a tenant
users get <user_id> [--tenant <ref>] Show one user
users create --tenant <ref> --username <name> [options] Create a user
users update <user_id> --tenant <ref> -f <file> Update a user
users delete <user_id> --tenant <ref> Delete a user
users get-roles --user-id <id> --tenant <ref> Show a user’s roles
users set-roles --user-id <id> --tenant <ref> --roles <a,b> Replace a user’s roles
service-accounts list List service accounts
service-accounts get <id> Show one service account
service-accounts create --name <name> [--display-name <name>] [--description <text>] Create a service account
service-accounts update <id> [options] Update display name/description
service-accounts delete <id> Delete a service account
service-accounts get-roles --sa-id <id> Show a service account’s roles
service-accounts set-roles --sa-id <id> --roles <a,b> Replace a service account’s roles
service-accounts tokens create --sa-id <id> --name <label> --expires-in-days <n> Mint an API token for the service account
service-accounts tokens list --sa-id <id> [--active-only] List a service account’s tokens
service-accounts tokens revoke <token_id> --sa-id <id> [--reason <text>] Revoke a token
roles list Show all roles and their permitted actions
s3 enabled get / s3 enabled set <true\|false> Enable/disable the S3 gateway realm-wide
s3 port-range get / s3 port-range set <start> <end> View/set the gateway’s port range
s3 prefix get / s3 prefix set <path> View/set the realm-wide path prefix
s3 get-config --tenant <ref> Show a tenant’s S3 configuration
s3 set-config --tenant <ref> [options] Update a tenant’s S3 configuration
s3 dns <mode> --tenant <ref> Set how S3 DNS is published for a tenant
s3 tls renew --tenant <ref> Renew a tenant’s S3 TLS certificate
s3 instances list --tenant <ref> List S3 gateway instances
s3 instances create <iid> <dataserial> --tenant <ref> Create an S3 gateway instance on a node
s3 instances start <iid> --tenant <ref> Start an S3 gateway instance
s3 instances stop-all --tenant <ref> Stop every S3 gateway instance for a tenant
s3 instances delete-all --tenant <ref> --yes Delete every S3 gateway instance for a tenant
s3 buckets create <name> --tenant <ref> Create an S3 bucket
s3 buckets list --tenant <ref> List S3 buckets
s3 credentials reveal <access_key> --tenant <ref> Show the current secret for an access key
s3 credentials rotate <access_key> --tenant <ref> Rotate the secret for an access key
events list [--limit <n>] [--tenant <ref>] List recent system events
alerts list List currently active alerts
audit list [options] List administrative audit log entries
audit get <request_id> Show one audit log entry’s detail