WEKA REST API and equivalent CLI commands
To maximize your success with the REST API, it's essential to familiarize yourself with the comprehensive documentation. This valuable resource provides in-depth insights into the subject matter. Moreover, each REST API method corresponds to a CLI command. Additionally, many parameters accessible through the CLI are equally accessible when using the REST API. Run the CLI command help for details. This ensures a smooth and consistent experience across both interfaces.
Active directory
Related information: User management
Update the Active Directory configuration: Configures the integration with an Active Directory server for user management. This allows for authenticating users and mapping their group memberships to the cluster user roles.
weka user ldap setup-ad
Alerts
Related information: Alerts
Get all cluster alerts: Returns a list of active cluster alerts to monitor the system's health. The list includes silenced alerts and can be filtered by severity level.
weka alerts
List all possible alert types: Returns a comprehensive list of all possible alert types that the system can generate.
weka alerts types
List alert descriptions and recommended actions: Returns detailed descriptions and recommended troubleshooting actions for all possible alert types.
weka alerts describe
Mute a specific alert type: Creates a rule to temporarily mute a specific type of alert. This is useful for preventing notifications during maintenance or for known, non-critical issues.
weka alerts mute <alert-type> <duration>
Unmute alerts by type: Removes all active mute rules for a specific alert type, causing it to generate notifications again.
weka alerts unmute <alert-type>
WEKA Home
Related information: WEKA Home - The WEKA support cloud
Get WEKA Home configuration: Returns the current configuration for the WEKA Home cloud service..
weka cloud status
Get WEKA Home proxy URL: Returns the configured proxy URL for accessing WEKA Home.
weka cloud proxy
Set WEKA Home proxy URL: Sets or updates the proxy URL used for accessing WEKA Home.
weka cloud proxy --set <proxy_url>
Get WEKA Home upload rate: Returns the current data upload rate limit for WEKA Home.
weka cloud upload-rate
Set WEKA Home upload rate: Sets the maximum data upload rate to WEKA Home in bytes per second.
weka cloud upload-rate set --bytes-per-second <bps>
Get WEKA Home URL: Returns the base URL for the WEKA Home cloud service.
weka cloud status
Enable WEKA Home: Enables and configures the connection to the WEKA Home cloud service.
weka cloud enable --cloud-url <cloud> --cloud-stats <on/off>
Disable WEKA Home: Disables the connection to the WEKA Home cloud service.
weka cloud disable
Cluster
Related information: WEKA cluster installation on bare metal servers
Create a cluster: Forms a new WEKA cluster from a list of specified servers.
weka cluster add <host-hostnames>
Update cluster configuration: Modifies the configuration settings of an existing cluster.
weka cluster update
Get cluster status: Returns a comprehensive status report for the cluster, including health, performance metrics, and capacity.
weka status --json
Get capacity reduction details: Returns data reduction statistics for the cluster, including the total saved bytes and the reduction ratio.
weka status reduction
Set a requested action on containers: Sets a requested action, such as STOP or RESTART, to be performed on one or more containers.
weka cluster requested-action set <requested_action> [<container-ids>]...
Containers
Related information: Expand and shrink cluster resources
Get containers: Returns a list of all containers in the cluster.
weka cluster container
Add a container: Adds a new container to the cluster. The container configuration must be applied to activate it.
weka cluster container add <hostname>
Get container details: Returns the details, including resources and state, for a specific container.
weka cluster container <container-ids>
Update container configuration: Updates the staged configuration for a specific container. Any resource configuration change, such as memory or cores, requires an apply action to take effect.
weka cluster container <container-ids> <subcommand>
Perform action on protocol containers: Performs an action, such as a restart, on specified protocol containers.
weka local restart <container>
Remove a container: Deactivates and removes a container from the cluster.
weka cluster container remove <container-ids>
Apply configuration updates to multiple containers: Applies staged configuration changes to a specified list of containers.
weka cluster container apply
Apply configuration updates to a container: Applies staged configuration changes to a specific container.
weka cluster container apply <container-ids>
Clear last failure for a container: Resets the last failure reason for a specific container.
weka cluster container clear-failure<container-ids>
Get container resources: Returns the resource allocation (CPU, memory) for a specific container.
weka cluster container resources <container-ids>
Activate containers: Activates a list of specified containers, bringing them online.
weka cluster container activate
Activate a container: Activates a specific container, bringing it online.
weka cluster container activate <container-ids>
Deactivate containers: Deactivates a list of specified containers.
weka cluster container deactivate
Perform container deactivation check: Simulates container deactivation to assess whether the operation can be performed safely without impacting the cluster.
weka cluster container deactivation-check <container-ids>
Deactivate a container: Deactivates a specific container.
weka cluster container deactivate <container-ids>
Get network devices for all containers: Returns the network device configurations for all containers in the cluster.
weka cluster container net
Get network devices for a container: Returns the network device configurations for a specific container.
weka cluster container net <container-ids>
Add a dedicated network device to a container: Allocates a dedicated network device to a specific container. The change must be applied to take effect.
weka cluster container net add <container-ids>
Remove a dedicated network device: Removes a dedicated network device from a container. The change must be applied to take effect.
weka cluster container net remove <container-ids>
Get container hardware information: Returns hardware information for one or more containers, specified by IP or hostname.
weka cluster container info-hw
DataService
Related information: Set up a Data Services container for background tasks
Get Data Service features: Returns a list of background tasks managed by the Data Services container. Currently, this includes only quota coloring.
N/A
Default network
Related information: 6. Configure default data networking (optional)
Get default network settings: Returns the predefined network properties for container deployments, including the IP address range, gateway, and subnet mask.
weka cluster default-net
Set default network settings: Defines the IP address range, gateway, and subnet mask for future container network assignments.
weka cluster default-net set
Update default network settings: Modifies existing default network settings, such as the IP range, gateway, or subnet mask.
weka cluster default-net update
Reset default network settings: Removes custom default network settings and reverts to the initial system baseline.
weka cluster default-net reset
Drive
Related information: Expand and shrink cluster resources
List all drives: Returns a list of all SSD drives in the cluster and provides details such as size, UUID, and status.
weka cluster drive
Add a drive: Attaches an SSD drive to a specific container to expand its resources.
weka cluster drive add <container-id> <device-paths>
Get drive details: Returns detailed information for a specific SSD drive.
weka cluster drive <uuids>
Remove a drive: Detaches a specified SSD drive from the cluster, making it unavailable.
weka cluster drive remove <uuids>
Activate drives: Activates one or more inactive SSD drives, making them available for use.
weka cluster drive activate <uuids>
Deactivate drives: Deactivates one or more SSD drives, preventing their use while preserving the data on them.
weka cluster drive deactivate <uuids>
Events
Related information: Events
List events: Returns a list of all cluster events, with options to filter by severity, category, and time range.
weka events
List event types and descriptions: Returns a list of all event types and provides a detailed description for each, including its meaning and potential causes.
weka events list-types
Aggregate events by time: Aggregates events over a specified time interval to show event frequency and trends.
weka events --start-time <start> --end-time <end> --show-internal
List local server events: Returns a list of events generated only by the server that receives the API request, which is useful for targeted troubleshooting.
weka events list-local
Create a custom event: Creates and records a custom event with a user-defined message for enhanced monitoring and logging.
weka events trigger-event
Failure domains
Related information: Cluster capacity and redundancy management
List failure domains: Returns a list of failure domains in the cluster. A failure domain is a set of hardware components that can fail together from a single root cause.
weka cluster failure-domain
Get failure domain details: Returns details for a specific failure domain, including its resources and capacity.
weka cluster container <container-ids>
Filesystem
Related information:
Get filesystem details: Returns detailed information about a specific filesystem, such as its size, quota, and usage.
weka fs --name <name>
Update a filesystem: Updates the settings of an existing filesystem.
weka fs update <name>
Remove a filesystem: Removes a specified filesystem and its data from the cluster.
weka fs remove <name>
Attach an object store bucket: Links an object store bucket to a filesystem, allowing tiered data access.
weka fs tier s3 attach <fs-name>
Get path by inode ID: Returns the full path of a file or directory using its inode ID.
GET /fileSystems/{inode_id}/getPath ** Replaces GET/fileSystems/{inode_context}/getPath
weka debug fs resolve-inode
Detach object store bucket from filesystem: Disconnects an object store bucket from a filesystem, separating their data access.
weka fs tier s3 detach <fs-name> <obs-name>
Download filesystem from object store: Creates a new filesystem based on a saved snapshot stored in an object store bucket.
weka fs download
Get thin-provisioning reserve status: Returns the existing allocated thin-provisioning space reserved for your organization within the cluster.
weka fs reserve status
Reserve guaranteed SSD for your organization: Set the thin-provisioning space for your organization's filesystems.
weka fs reserve set <ssd-capacity>
Remove thin-provisioning reserve: Removes the existing reserved thin-provisioning space allocated for your organization's filesystems.
weka fs reserve unset --org <org>
Remove all security policies from a filesystem: Detaches all security policies from a specific filesystem.
weka fs security policy reset
Get security policies for a filesystem: Returns a list of all security policies attached to a specific filesystem.
weka fs security policy list
Set filesystem security policies: Replaces all security policies on a filesystem with a new, specified set of policies.
weka fs security policy set
Attach security policies to a filesystem: Adds one or more security policies to a filesystem's existing policy list.
weka fs security policy attach
Detach security policies from a filesystem: Removes one or more specified security policies from a filesystem.
weka fs security policy detach
Quota
Related information Quota management
List directory quotas: Returns all quotas for directories within a specific filesystem..
weka fs quota list <fs-name>
List default directory quotas: Returns all default quotas for directories within a specific filesystem.
weka fs quota list-default
Get directory quota details: Returns the quota parameters for a specific directory.
weka fs quota list <fs-name> --path <path>
Set a quota for a directory: Sets a quota for a directory. If Data Service is not enabled, use the CLI to set a quota for a non-empty directory.
weka fs quota set <path>
Update directory quota: Modifies specific settings, such as the grace period or limits, for an existing directory quota.
weka fs quota set <path> --soft <soft> --hard <hard> --grace <grace> --owner <owner>
Remove directory quota: Removes a quota from a specific directory. If the Data Service is not enabled, use the CLI to remove a quota from a non-empty directory.
weka fs quota unset <path>
Set or update a default directory quota: Establishes or changes the default quota that applies to all newly created subdirectories within a specified parent directory.
PUT /fileSystems/quota/{inode_id} ** Replaced PUT/fileSystems/quota/{inode_context}
weka fs quota set-default <path>
Remove default quota from a directory: Removes the default quota from a directory, preventing new subdirectories from inheriting its settings.
weka fs quota unset-default <path>
Resolve path to inode ID: ReturnsReturns the unique inode ID for a specified file or directory path.
N/A
Filesystem group
Related information: Manage filesystem groups
Get filesystem groups: Returns a list of all filesystem groups in the cluster.
weka fs group
Create a filesystem group: Creates a new group to manage policies and settings for a collection of filesystems.
weka fs group add
Get a specific filesystem group: Returns the properties of a specific filesystem group by providing its UID.
N/A
Update a filesystem group: Modifies the properties of an existing filesystem group.
weka fs group update <name>
Delete a filesystem group: Removes a filesystem group from the cluster.
weka fs group remove <name>
Health
Related information: Cluster Protection and Availability widget
Interface group
Related information: Manage the NFS protocol
Get interface groups: Returns a list of all interface groups that manage floating IPs for NFS server resiliency.
weka nfs interface-group
Create an interface group: Creates an interface group to manage floating IPs for NFS resiliency. An interface group defines a collection of servers, network ports, and floating IPs that work together to ensure continuous service.
weka nfs interface-group add
Get interface group details: Returns the details of a specific interface group, including its assigned servers, ports, and floating IP ranges.
weka nfs interface-group --name <name>
Delete an interface group: Removes an interface group, including its collection of servers, ports, and floating IPs.
weka nfs interface-group remove <name>
Update an interface group: Modifies the gateway and subnet of an existing interface group.
weka nfs interface-group update <name>
Add an IP range to an interface group: Adds a range of floating IP addresses to an interface group. These IPs can migrate between servers in the group to maintain service availability.
weka nfs interface-group ip-range add <name> <ips>
Add a port to an interface group: Assigns a network port from a specific container to an interface group, making that container a potential host for the group's floating IPs.
weka nfs interface-group port add <name> <server-id> <port>
Remove an IP range from an interface group: Removes a container's network port from an interface group, preventing it from hosting the group's floating IPs.
weka nfs interface-group port remove <name> <port>
Remove an IP range from an interface group: Removes a floating IP address range from an interface group.
weka nfs interface-group ip-range remove <name> <ips>
Get floating IPs: Returns a list of all floating IPs and shows which container and port in the interface group currently host each IP.
weka nfs interface-group assignment
Add a port to an interface group: Assigns a port to be accessible by the specified interface group.
weka nfs interface-group port add <name>
<server-id> <port>
KMS
Related information: Manage KMS
Get KMS configuration: Returns the Key Management Service (KMS) configuration.
weka security kms
Set KMS configuration: Sets a new Key Management Service (KMS) configuration (Hashicorp Vault or KMIP).
weka security kms set <type> <address> <key-identifier>
Delete KMS configuration: Removes the KMS configuration if it is not used by any encrypted filesystems.
weka security kms unset
Get KMS type: Returns the configured KMS type (HashiCorp Vault or KMIP).
weka security kms
Rewrap KMS key: Updates the encryption keys for existing filesystems with a new KMS master key.
weka security kms rewrap
LDAP
Related information: User management
Update LDAP configuration: Modifies the configuration for connecting to your LDAP server.
weka user ldap setup
Disable LDAP: Deactivates the integration with your LDAP server for user authentication.
weka user ldap disable
License
Related information: License overview
Get license details: Returns details about the configured cluster license, including resource usage and validity.
weka cluster license
Set license: Installs a new cluster license for continued operation. The license is a text-based file generated via get.weka.io for a specific cluster.
weka cluster license set <license>
Remove license: Deactivates the existing license and returns the cluster to unlicensed mode.
weka cluster license reset
Lockout policy
Related information: Manage account lockout threshold policy
Get lockout policy: Returns the account lockout threshold policy details
weka security lockout-config show
Update lockout policy: Modifies the account lockout threshold policy.
weka security lockout-config set
Reset lockout policy: Clears the failed login attempts counter and unlocks any currently locked accounts.
weka security lockout-config reset
Login
Related information: Obtain authentication tokens
Log in to the cluster: Authenticates and grants access to the cluster using valid credentials. Securely save user credentials in the user's home directory upon successful login.
weka user login
Retrieve access token: Obtains a new access token using an existing refresh token. The system creates an authentication token file and saves it in ~/.weka/auth-token.json. The token file contains both the access token and the refresh token.
weka user login
Mounts Defaults
Related information:
Get default mount options: Returns the configured default mount options applied to all filesystems across the cluster.
weka cluster mount-defaults show
Set default mount options: Configures default mount options applied to all filesystems across the cluster.
weka cluster mount-defaults set
Reset default mount options: Reverts the default mount options to initial settings for all filesystems in the cluster.
weka cluster mount-defaults reset
NFS
Related information: Manage the NFS protocol
Get all permissions: Returns a list of NFS permissions for client groups across all filesystems.
weka nfs permission
Create an NFS permission: Grants a client group access to an NFS share by creating a new permission rule.
weka nfs permission add <fs_name> <client-group-name>
Get a specific NFS permission: Returns the access control rules for a specific NFS permission, identified by its unique identifier (UID).
weka nfs permission --filesystem <fs_name>
Update an NFS permission: Modifies an existing NFS permission to change access controls for a client group.
weka nfs permission update <fs_name> <client-group-name>
Remove and NFS permission: Revokes a client group's access to a filesystem by removing a specific NFS permission.
weka nfs permission delete <fs_name> <client-group-name>
Get all client groups: Returns a list of all client groups used for managing NFS access controls.
weka nfs client-group
Create an NFS client group: Create a new client group to manage access controls for NFS mounts.
weka nfs client-group add <group-name>
Get a specific NFS client group: Returns the details of a specific NFS client group.
weka nfs client-group --name <client-group-name>
Remove an NFS client group: Removes an existing NFS client group.
weka nfs client-group delete <client-group-name>
Create a rule for an NFS client group: Adds a DNS or IP-based rule to a client group. Clients matching the rule are granted access.
weka nfs rules add dns <client-group-name> <dns-rule>
Remove a rule from an NFS client group: Removes a DNS or IP-based rule from an NFS client group.
weka nfs rules delete dns <client-group-name> <dns-rule>
Update the global NFS configuration: Modifies cluster-wide NFS parameters, including ports, the configuration filesystem, supported versions, and ACL settings.
weka nfs global-config set
Get the global NFS configuration: Returns the cluster-wide NFS configuration, including ports, the configuration filesystem, and supported versions.
weka nfs global-config show
Get the NFS debug level: Returns the logging verbosity level for the container processes in the NFS cluster.
weka nfs debug-level show
Set the NFS debug level: Adjusts the logging verbosity for container processes in the NFS cluster to control the level of detail in logs.
weka nfs debug-level set <debug-level>
Set up the NFS-Kerberos service: Configures the NFS-Kerberos service. Integrating NFS with Kerberos enhances security by allowing mounts only from clients with valid Kerberos tickets.
weka nfs kerberos service setup
Get the NFS-Kerberos service configuration: Returns the NFS-Kerberos service configuration details. Integrating NFS with Kerberos enhances security by allowing mounts only from clients with valid Kerberos tickets.
weka nfs kerberos service show
Register NFS with MIT Kerberos: Registers NFS Kerberos service with MIT KDC. Running this endpoint with the restart option can disrupt the IO service for connected NFS clients.
weka nfs kerberos registration setup-mit
Register NFS with Active Directory Kerberos: Registers NFS Kerberos service with Microsoft Active Directory (AD). Running this endpoint with the restart option can disrupt the IO service for connected NFS clients.
weka nfs kerberos registration setup-ad
Get the NFS-Kerberos registration configuration: Returns the NFS-Kerberos service registration details.
weka nfs kerberos registration show
Reset the Kerberos configuration for NFS: Removes the Kerberos service configuration data, allowing for a new integration to be set up.
weka nfs kerberos reset
Set up NFS with OpenLDAP: Configures NFS to use an OpenLDAP service for user and group information, typically used with an MIT Kerberos integration..
weka nfs ldap setup-openldap
Set up NFS with Active Directory LDAP: Configures NFS to use the LDAP service within Active Directory (AD) for user and group lookups.
weka nfs ldap setup-ad
Set up Active Directory LDAP for ACLs (without Kerberos): Configures NFS to use LDAP for ACLs when Kerberos authentication is not in use.
weka nfs ldap setup-ad-nokrb
Get the LDAP configuration: Returns the LDAP configuration for the NFS service.
weka nfs ldap show
Reset the LDAP configuration: Removes the NFS-LDAP configuration from the system.
weka nfs ldap reset
Import an LDAP configuration: Imports an OpenLDAP configuration from a file and applies it to the NFS service.
weka nfs ldap import-openldap
Export the LDAP configuration: Exports the OpenLDAP configuration for the NFS service to a file for backup or migration.
weka nfs ldap export-openldap
Object store
Related information: Manage object stores
Update a specific object store: Updates the connection details for an existing object store. Use this to manage download bandwidth and simplify adding new buckets.
weka fs tier obs update <obs-name>
Object store bucket
Related information: Manage object stores
Get S3 object store bucket configurations: Returns a list of all S3 object store bucket configurations and status.
weka fs tier s3
Create an object store bucket configuration:
Establishes a new S3 object store bucket configuration. This allows the system to use the external bucket as a cost-effective storage tier for warm (infrequently accessed) data, complementing the high-performance SSDs used for hot data.
weka fs tier s3 add <obs-name>
Get a specific S3 object store bucket configuration: Returns a specific S3 object store bucket configuration and status.
weka fs tier s3 --obs-name <obs-name> --name <bucket-name>
Delete an object store bucket configuration: Removes an existing S3 object store bucket configuration if the bucket is not attached to a filesystem.
weka fs tier s3 delete <obs-name>
Update an object store bucket configuration: Modifies an existing object store bucket configuration.
weka fs tier s3 update <bucket-name>
Get object store bucket operations: Returns a list of live, low-level I/O operations (such as uploads and downloads) for a specific object store bucket.
weka fs tier s3 snapshot list <bucket-name>
Organization
Related information: Organizations management
Check if multiple organizations exist: Checks if more than one organization is configured in the cluster. This is useful for determining if multi-tenancy is active.
weka org
Get a list of all organizations: Returns a list of all organizations configured in the cluster.
weka org
Create a new organization: Creates a new organization within the cluster. An organization is a logical partition that isolates users and data for multi-tenancy.
weka org add
Get a specific organization: Returns the details of a specific organization, identified by its UID.
weka org <org name or ID>
Delete a specific organization: Removes a specific organization from the cluster. This operation is only possible if the organization does not contain any resources.
weka org delete <org name or ID>
Rename an organization: Updates the name of a specific organization.
weka org rename <org name or ID> <new-org-name>
Set or update organization quotas: Sets or updates the storage capacity quotas for a specific organization.
weka org set-quota <org name or ID>
Revoke all user tokens for an organization: Immediately invalidates all active login sessions (GUI, CLI, API) for all users within a specific organization.
weka org security revoke-tokens
Reset security policies for an organization: Removes all attached security policies from a specific organization.
weka org security reset
Get security policies for an organization: Returns a list of all security policies attached to a specific organization.
weka org security list
Set security policies for an organization: Replaces all existing security policies on an organization with a new set. Any policies not included in the request will be detached.
weka org security set
Attach security policies to an organization: Attaches one or more security policies to a specific organization without affecting existing attachments.
weka org security attach
Detach security policies from an organization: Detaches one or more security policies from a specific organization.
weka org security detach
Processes
Related information: WEKA containers architecture overview
Get a list of all processes: Returns information about all running processes within the cluster. The list can be filtered by type, container, process ID, or role.
weka cluster process
Get a specific process: Returns information about a specific running process, identified by its UID.
weka cluster process <process-ids>
S3
Related information: Manage the S3 protocol
Get S3 cluster information: Returns details about the S3 cluster managed by the system.
weka s3 cluster
Update an S3 cluster: Modifies the configuration of an existing S3 cluster.
weka s3 cluster update
Get S3 buckets: Returns a list of all buckets within an S3 cluster.
weka s3 bucket list
Get S3 user policies: Returns a list of S3 user policies.
weka s3 bucket policy
Delete an S3 bucket: Removes a specified S3 bucket.
weka s3 bucket delete <bucket-name>
Get S3 IAM policy details: Returns details about a specific S3 IAM policy.
weka s3 policy show <policy-name>
Delete an S3 IAM policy: Removes an S3 IAM policy.
weka s3 policy remove <policy-name>
Attach an S3 IAM policy to a user: Assigns an S3 IAM policy to a user.
weka s3 policy attach <policy> <user>
Detach an S3 IAM policy from a user: Unassigns an S3 IAM policy from a user.
weka s3 policy detach <user>
Get service accounts: Returns the S3 service accounts added by the S3 user, including their access keys.
weka s3 service-account list
Add an S3 service account: Adds a new S3 service account.
weka s3 service-account add <policy-file>
Get S3 service account details: Returns a specific S3 service account.
weka s3 service-account show <access-key>
Delete an S3 service account: Removes an S3 service account.
weka s3 service-account remove <access-key>
Create an S3 STS token: Creates an S3 STS token with an assumed role.
weka s3 sts assume-role
Add lifecycle rule: Creates a new lifecycle rule for an S3 bucket.
weka s3 bucket lifecycle-rule add <bucket-name>
Delete lifecycle rules: Removes all lifecycle rules for an S3 bucket.
weka s3 bucket lifecycle-rule reset <bucket-name>
Get lifecycle rules: Returns a list of all lifecycle rules for an S3 bucket.
weka s3 bucket lifecycle-rule list <bucket-name>
Delete lifecycle rule: Removes a specific lifecycle rule from an S3 bucket.
weka s3 bucket lifecycle-rule remove <bucket-name> <rule-name>
Get S3 bucket policy: Returns the policy attached to an S3 bucket.
weka s3 bucket policy get <bucket-name>
Set S3 bucket policy: Assigns a policy to an S3 bucket.
weka s3 bucket policy set <bucket-name> <bucket-policy>
Get S3 bucket policy (JSON): Returns the bucket policy in JSON format.
weka s3 bucket policy get-json <bucket-name>
Set S3 bucket policy (JSON): Sets the bucket policy using a JSON file.
weka s3 bucket policy set-custom <bucket-name> <policy-file>
Set S3 bucket quota: Defines a storage quota for an S3 bucket.
weka s3 bucket quota set <bucket-name> <hard-quota>
Unset S3 bucket quota: Removes a storage quota from an S3 bucket.
weka s3 bucket quota unset <bucket-name>
Get container readiness: Returns the readiness status of containers within the S3 cluster.
weka s3 cluster status
Add container to S3 cluster: Adds a container to the S3 cluster.
weka s3 cluster container add <container-ids>
Remove containers: Removes containers from the S3 cluster.
weka s3 cluster container remove <container-ids>
Get logging verbosity: Returns the logging level for container processes within the S3 cluster.
weka s3 log-level get
Set logging verbosity: Adjusts the logging level for container processes within the S3 cluster.
weka s3 log-level set <log-level>
Enable S3 audit webhook: Activates the S3 audit webhook.
weka s3 cluster audit-webhook enable
Disable S3 audit webhook: Deactivates the S3 audit webhook.
weka s3 cluster audit-webhook disable
Get S3 audit webhook configuration: Returns details about the S3 audit webhook configuration.
weka s3 cluster audit-webhook show
SMB
Related information: Manage the SMB protocol
Get SMB cluster configuration:
Returns comprehensive details about the existing SMB cluster, including domain membership status, container assignments, ID mapping configuration, encryption settings, and feature enablement flags.
Use this endpoint to audit the current cluster state or verify configuration changes.
weka smb cluster
Create a new SMB cluster: Creates a new SMB cluster and establishes its foundational configuration. This includes setting the domain association, assigning containers to serve the SMB protocol, and defining security policies.
This operation creates the cluster structure but does not join it to an Active Directory domain. After the cluster is created, use the POST /smb/activeDirectory endpoint to complete the domain integration.
weka smb cluster add <netbios-name> <domain> <config-fs-name>
Modify SMB cluster settings: Updates cluster-wide configuration parameters for an existing SMB deployment.Supports modification of encryption policy and floating IP address assignments. Changing the encryption policy affects new connections. Existing connections maintain their original encryption state until reconnection.
weka smb cluster update
Remove SMB cluster configuration: Disables the SMB cluster and removes its configuration. This action terminates all active client sessions, removes associated floating IPs, and automatically disconnects the cluster from its Active Directory domain, if joined.
The underlying filesystem data is preserved. This operation only removes network access through the SMB protocol.
weka smb cluster destroy
Get trusted domain list:
Returns all trusted domains configured within the SMB cluster.
Trusted domains enable cross-domain authentication and resource access in multi-domain Active Directory environments. Each domain includes ID mapping range specifications.
weka smb cluster trusted-domains
Add trusted domain to cluster: Registers a new trusted domain with the SMB cluster and configures its ID mapping range. Trusted domains allow users and groups from additional Active Directory domains to access SMB resources. This operation automatically restarts SMB services to apply the new trust configuration, which may cause a brief service interruption. Ensure the specified ID mapping range (mapping_from_id–mapping_to_id) does not overlap with existing domain ranges.
weka smb cluster trusted-domains add
Get filesystem mount options: Returns the array of mount options applied to SMB cluster filesystem operations. These options control caching behavior (readcache, writecache), coherence modes, and other performance characteristics affecting data access patterns.
N/A
Get all SMB shares: Returns a comprehensive list of all shares configured within the SMB cluster. Each share includes access permissions, encryption settings, filesystem mappings, user access lists, and configuration parameters.
weka smb share
Add SMB share: Provisions a new share within the SMB cluster, mapping a filesystem path to a network-accessible share. The share becomes immediately available to authorized users upon creation. For access control, use the user_list_type and users parameters to define initial access permissions. After creating a user, additional users can be added using the POST /smb/users endpoint. For ACL options, use the map_acls parameter to determine how Windows ACLs are translated to filesystem permissions (posix, windows, or hybrid mode).
weka smb share add <share-name> <fs-name>
Join Active Directory domain: Joins the SMB cluster to the Active Directory domain specified during the initial cluster creation. This operation creates the necessary computer account in Active Directory, establishes trust, and enables authentication for domain users and groups.
Before using this endpoint, you must first create the SMB cluster using POST /smb.
weka smb domain join <username> <password>
Disconnect from Active Directory domain: Disconnects the SMB cluster from the Active Directory domain. This action deletes the cluster account from Active Directory and terminates domain-based authentication, making shares immediately inaccessible to all domain users.
Before leaving the domain, configure an alternative authentication method if you require continued access to the shares. Administrator credentials may be necessary to complete the operation.
weka smb domain leave <username>
Configure SMB container logging verbosity:
Adjusts the debug logging level for SMB container processes on specified containers. Higher debug levels increase logging verbosity, which is useful for troubleshooting but may impact performance.
weka smb cluster debug <level>
Modify share configuration: Updates operational parameters for an existing SMB share. Changes take effect immediately and apply to new client connections. Active sessions may need to reconnect to observe changes. Only a subset of share properties can be modified after creation. To change immutable properties (for example, filesystem, sub_path), delete and recreate the share.
weka smb share update <share-id>
Remove SMB share: Removes an SMB share from the cluster, terminating network access to the associated filesystem path. Active client connections to this share are forcibly disconnected. Underlying filesystem data remains intact. Only the SMB network share configuration is removed.
weka smb share remove <share-id>
Remove trusted domain: Removes a trusted domain from the SMB cluster, revoking authentication and access rights for all users and groups within that domain.
This operation triggers a background restart of the SMB services, which may cause a brief service interruption. Before removing a domain, ensure no active share permissions reference its users or groups.
weka smb cluster trusted-domains remove
Grant share access to users:
Adds specified users or groups to a share's access control list with designated permission level.
Users can be Active Directory users, groups, or domain aliases.
weka smb share lists add <share-id> <user-list-type> --users <users>
Remove all users from the access list: Removes all users and groups from the specified access permission category for a given share. This is a bulk operation that clears the entire user list for the specified category.
Useful when reconfiguring share permissions from scratch or removing all entries before applying a new access control policy. To remove individual users, use DELETE /smb/users/{share_uid}/{user_type}/{user} instead.
weka smb share lists reset <share-id> <user-list-type>
Remove specific user from share access:
Removes an individual user or group from the specified access permission category.
The user immediately loses the associated permissions, but may retain access through other permission categories or group memberships.
weka smb share lists remove <share-id> <user-list-type> --users <users>
Verify SMB container readiness: Checks the operational readiness of all containers participating in the SMB cluster.
The response indicates whether each container's SMB process is fully operational and ready to serve client requests. Use this endpoint to monitor cluster health or to verify that configuration changes have been applied successfully.
weka smb cluster status
Add SMB cluster containers:
Expands the SMB cluster by adding containers to distribute the SMB service load.
Newly added containers immediately handle SMB requests and participate in HA failover.
Requires properly configured hosts and sufficient floating IPs.
Used to scale SMB capacity for increased load or improved fault tolerance.
weka smb cluster containers add --containers-id <containers-id>
Remove containers from SMB cluster:
Removes specified containers from the SMB cluster. Client connections on the removed containers migrate to the remaining active containers in the cluster.
Use this operation to decommission containers for maintenance or to reduce the cluster size during periods of low demand.
Before proceeding, ensure that at least one container remains in the cluster and that the removal does not violate the cluster's minimum redundancy requirements.
weka smb cluster containers remove --containers-id <containers-id>
Security
Related information: WEKA security overview
Get token expiration configuration: Returns the configured default and maximum expiration times for access and refresh tokens. Token expiration ensures authentication credentials remain valid for a limited time, reducing risks such as unauthorized access and token misuse.
weka security token-expiry show
Configure token expiration setting: Configures the default and maximum expiration times for access and refresh tokens to maintain a secure, policy-aligned authentication environment. Best practices recommend setting access tokens to 5 minutes and refresh tokens to 2 weeks to balance security and usability.
weka security token-expiry set
Get login banner configuration: Returns the current login banner text and enabled status. The login banner displays a customizable legal or security message on the GUI sign-in page to warn against unauthorized access and inform authorized users of their responsibilities and acceptable use policies.
weka security login-banner show
Set or update the login banner: Creates or modifies the login banner containing a security statement or legal message displayed on the sign-in page. The statement can warn potential intruders about illegal activities while advising authorized users of their obligations regarding acceptable system use.
weka security login-banner set <login-banner>
Enable the login banner:
Activates the login banner so it displays on the GUI sign-in page, presenting the configured security or legal message to all users attempting to access the system.
weka security login-banner enable
Disable the login banner: Deactivates the login banner so it no longer displays on the GUI sign-in page. The banner text is preserved and can be re-enabled at any time.
weka security login-banner disable
Upload custom CA certificate for cluster authentication: Uploads a custom Certificate Authority (CA) certificate to be used for secure cluster authentication with external services such as Vault. This certificate enables the cluster to verify the identity of external systems using TLS/SSL. If a certificate is already configured, this operation replaces it.
weka security ca-cert set
Remove custom CA certificate from cluster: Removes the configured custom CA certificate from the cluster. After removal, the cluster will revert to using the default certificate validation mechanism.
weka security ca-cert unset
Get CA certificate details and status: Returns comprehensive information about the cluster's currently configured CA certificate, including its status, certificate metadata, and content. Use this endpoint to verify certificate configuration and expiration dates.
weka security ca-cert status
Create a CIDR-based security policy: Creates a new security policy to regulate access to cluster management and POSIX data services. These policies strengthen security by permitting or blocking connections from specific client IP address ranges without requiring user authentication. Policies are evaluated in order of attachment, and updates do not affect active connections.
weka security policy create
List all security policies: Returns a comprehensive list of all CIDR-based security policies defined in the cluster. These policies control access to cluster management and POSIX data services based on client IP ranges.
weka security policy list
Get a specific security policy: Returns detailed configuration information for a specific security policy identified by its UUID. This includes the policy's name, description, action, roles, IP ranges, and read-only status.
weka security policy show
Delete a security policy: Permanently removes a security policy from the system. This operation does not affect currently active connections. The policy will no longer be evaluated for new connection attempts.
weka security policy delete
Update an existing security policy: Modifies the configuration of an existing security policy. You can replace entire role or IP lists, or incrementally add/remove specific entries. Changes take effect immediately for new connections but do not impact existing active sessions.
weka security policy update
Duplicate an existing security policy: Creates a new security policy by copying all configuration settings from an existing policy. The new policy requires a unique name but inherits all other properties including description, action, roles, IP ranges, and read-only status.
weka security policy duplicate
Test security policy evaluation: Simulates how one or more security policies would evaluate a connection attempt for API access or cluster joining. Returns the resulting action (Allow/Deny), whether it was explicitly matched, and details of the matched policy. Use this endpoint to validate policy configurations before deployment.
weka security policy test
Remove all security policies from cluster join configuration: Removes all security policies currently applied to the cluster join process for the specified mode (backend or client). This allows any container to join the cluster without IP-based security policy restrictions. The join secret authentication, if configured, remains active.
weka security policy join reset
Get security policies for cluster joining: Returns the list of security policies currently applied when containers or clients attempt to join the cluster for the specified mode. These policies work in conjunction with join secret authentication to secure cluster membership.
weka security policy join list
Set cluster join security policies: Configures the complete set of security policies for containers or clients joining the cluster, replacing any existing policy configuration. These policies are evaluated to determine whether a join attempt from a specific IP address should be allowed or denied. Works in conjunction with join secret authentication.
weka security policy join set
Attach security policies to cluster join configuration: Adds one or more security policies to the existing list of policies applied during cluster joining for the specified mode. The new policies are appended to the end of the evaluation order. Use this endpoint to incrementally build up join security without replacing the entire policy set.
weka security policy join attach
Detach security policies from cluster join configuration: Removes specific security policies from the list of policies applied during cluster joining for the specified mode. Other policies in the join configuration remain active and continue to be evaluated in their original order.
weka security policy join detach
Servers
Related information: Expand and shrink cluster resources
Get cluster server inventory:
Returns a comprehensive list of all servers within the cluster. Supports optional filtering by server role to narrow results to specific server types or functions within the cluster topology.
weka cluster servers list
Get individual server information: Returns detailed configuration, status, and operational information for a specific server identified by its unique identifier.
weka cluster servers show
Snapshot policy
Related information: Snapshot policies
Create snapshot policy: Creates a new snapshot policy with specified scheduling parameters, retention rules, and configuration settings for automated point-in-time data copies.
weka fs protection snapshot-policy add
Get all snapshot policies: Returns a complete list of all snapshot policies configured in the cluster with their current settings and status.
weka fs protection snapshot-policy list
Get a snapshot policy:
Returns detailed configuration for a specific snapshot policy, including schedule definitions, retention parameters, and attached filesystem associations.
weka fs protection snapshot-policy show
Update snapshot policy: Updates configuration settings for an existing snapshot policy, including name, description, schedule parameters, retention rules, and activation status.
weka fs protection snapshot-policy update
Delete snapshot policy: Permanently removes a snapshot policy from the system. All filesystems must be detached from the policy before deletion can proceed.
weka fs protection snapshot-policy remove
List filesystems attached to a snapshot policy: Returns a list of all filesystem identifiers currently associated with a specific snapshot policy.
weka fs protection snapshot-policy show
Attach filesystems to snapshot policy: Associates one or more filesystems with a snapshot policy, applying the policy's scheduling and retention rules to the specified filesystems.
weka fs protection snapshot-policy attach
Detach filesystems from snapshot policy: Removes the association between a snapshot policy and one or more filesystems, discontinuing automated snapshot operations for those filesystems.
weka fs protection snapshot-policy detach
Duplicate a snapshot policy: Creates a copy of an existing snapshot policy with its configuration settings, optionally including filesystem associations. Useful for establishing similar policies with minor variations.
weka fs protection snapshot-policy duplicate
Run the snapshot policy schedule once: Runs a specified schedule type immediately, creating snapshots for all attached filesystems without waiting for the scheduled time.
weka fs protection snapshot-policy run-once
Snapshots
Related information:
List all snapshots: Returns a list of all filesystem snapshots in the system. Snapshots are point-in-time copies used for backup, archiving, and testing. Filter results by filesystem using the query parameter.
weka fs snapshot
Create a new snapshot:
Creates a point-in-time snapshot of an existing filesystem. Snapshots are read-only by default and do not impact system performance. Writable snapshots enable data modification for testing environments.
Snapshots consume minimal space based on 4KB granularity differences. Once created as writable, a snapshot cannot be converted to read-only.
weka fs snapshot add <file-system> <snapshot-name>
Get snapshot details: Returns detailed information about a specific snapshot, including creation timestamp, parent filesystem, size, and writability status.
weka fs snapshot --name <snapshot-name>
Update snapshot configuration: Modifies snapshot name or access point. The snapshot's data and point-in-time state remain unchanged.
weka fs snapshot update <file-system> <snapshot-name>
Delete a snapshot:
Permanently removes a snapshot from the system and frees storage space consumed by its unique data.
If the snapshot has been downloaded to another filesystem, deletion may cause that filesystem to malfunction. Ensure downloaded snapshots are un-tiered or migrated before deletion.
weka fs snapshot remove <file-system> <snapshot-name>
Create a copy of a snapshot:
Creates a duplicate of an existing snapshot within the same filesystem.
Useful for creating multiple versions or preserving snapshot state.
weka fs snapshot copy <file-system> <source-name> <destination-name>
Upload snapshot to object store: Transfers a snapshot to object storage using the Snap-To-Object feature.
Consolidates all snapshot data, including filesystem metadata and files, for backup, archiving, or disaster recovery.
Only read-only snapshots can be uploaded. Upload snapshots in chronological order for optimal efficiency.
weka fs snapshot upload <file-system> <snapshot-name>
Download snapshot from object store: Downloads a previously uploaded snapshot from object storage to a filesystem. Enables data restoration, disaster recovery, and filesystem migration.
Snapshots are incrementally reconstructed on the target filesystem.
Apply snapshots in chronological order for optimal consistency. Use the locator obtained during snapshot upload.
Downloading snapshots from object stores within the same cluster is not supported.
weka fs snapshot download
Restore filesystem from snapshot: Restores a filesystem to a previous state using a specified snapshot. This operation overwrites the current filesystem content.
Warning: This operation is destructive. Ensure appropriate backups exist before proceeding. Consider creating a snapshot of the current filesystem state first.
weka fs snapshot download <file-system> <snapshot-locator>
Get snapshot metadata from object store: Returns detailed metadata about a snapshot stored in object storage using its locator string. Queries the object store directly without requiring the snapshot to be downloaded.
N/A
Initialize snapshot differential analysis: Prepares the system for computing differences between two snapshots by generating processing tokens (cookies).
This is the first step in a two-phase operation for identifying changed, added, or deleted files.
The operation divides the comparison workload into parallel chunks based on the requested parallelism.
Use the returned cookies in subsequent getResults calls.
N/A
Get snapshot differential results: Retrieves the actual differences between two snapshots, including changed, added, and deleted files.
Must be called after preparing the differential analysis using the prepare endpoint.
Supports efficient pagination through resume and stop tokens. Use resume_token from previous responses to continue where you left off.
N/A
Stats
Related information: Statistics
Get statistics: Returns statistics related to the cluster's performance and resource usage.
weka stats
Get statistic descriptions: Returns detailed information about the statistics.
weka stats list-types
Get real-time statistics: Returns live statistics for the cluster.
weka stats realtime
Get statistics retention and disk usage: Returns the retention period of statistics and the estimated disk space required for their storage.
weka stats retention status
Set statistics retention: Sets the duration for which statistics are retained in storage.
weka stats retention set --days <num-of-days>
System IO
Related information: Perform post-configuration procedures
Start cluster IO services: Initiates IO services across the entire cluster.
weka cluster start-io
Stop cluster IO services: Shuts down IO services across the entire cluster.
weka cluster stop-io
Tasks
Related information: Background tasks
Get background tasks: Returns all background tasks currently running in the cluster, with optional filtering for waiting tasks.
weka cluster task
Resume paused task: Resumes execution of a previously paused background task.
weka cluster task resume <task-id>
Pause a running task: Temporarily pauses a running background task. The task can be resumed later without losing progress.
weka cluster task pause <task-id>
Abort a running task: Permanently terminates a background task and discards any incomplete work. This action cannot be undone.
weka cluster task abort <task-id>
Get task resource limits: Returns the current CPU resource limits configured for background task execution.
weka cluster task limits
Update task resource limits: Configures the maximum CPU resources that can be allocated to background tasks cluster-wide.
weka cluster task limits set
Telemetry
Related information: Audit and forwarding management
Get telemetry configuration: Returns the cluster-wide telemetry configuration, including audit and forwarding settings.
weka audit cluster status
Update telemetry configuration: Modifies cluster-wide telemetry settings, including enabling/disabling audit logging and configuring tracked operations.
weka audit cluster enable
weka audit cluster disable
Get all telemetry exports: Returns all configured export destinations for telemetry data (for example, Splunk, S3, Kafka).
weka telemetry exports list
Create a telemetry export: Configures a new export destination to forward telemetry events to an external system.
weka telemetry exports add
Get a telemetry export: Returns the configuration and status of a specific export destination.
weka telemetry exports show <export-name>
Update a telemetry export: Modifies the configuration of an existing export destination (for example, endpoint URL, authentication credentials).
weka telemetry exports update <export-name>
Delete a telemetry export: Removes an export destination, stopping all telemetry forwarding to that endpoint.
weka telemetry exports remove
Attach data sources to export: Associates one or more data sources (for example, 'Audit') with an export destination to begin forwarding that data type.
weka telemetry exports attach --sources audit
Detach data sources from export: Removes one or more data sources from an export destination, stopping the forwarding of that data type.
weka telemetry exports detach <export-name> --sources audit
TLS
Related information: Manage TLS certificates
Get TLS status: Returns the current TLS configuration, including certificate details and status.
weka security tls status
Configure TLS certificate: Uploads and enables a new TLS certificate and key for the cluster.
weka security tls set
Disable TLS certificate: Removes the current TLS certificate configuration from the cluster.
weka security tls unset
Get TLS certificate: Returns the full TLS certificate configured for the cluster.
weka security tls download
Traces
Related information: Traces management
Get traces configuration: Returns the current trace collection settings, including status and storage limits for both server and client traces.
weka debug traces status
Set traces collection: Configures and initiates the collection of trace data.
weka debug traces start
Reset trace configuration to defaults: Restores all trace collection settings to their factory default values, including storage limits and collection status.
weka debug traces stop
Get trace freeze period: Returns the configured freeze period during which trace data is preserved and protected from automatic deletion to support troubleshooting and investigation activities.
weka debug traces freeze show
Set trace freeze period: Configures a time range during which trace data is preserved and protected from deletion. This ensures diagnostic data remains available for analysis and troubleshooting of specific incidents or issues.
weka debug traces freeze set
Clear frozen traces: Removes the active trace freeze configuration and allows frozen trace data to be subject to normal retention policies. This action clears all freeze period settings and releases preserved traces.
weka debug traces freeze reset
Set trace verbosity level: Adjusts the granularity of trace data collection. LOW level captures essential information suitable for routine troubleshooting with minimal storage impact. HIGH level captures comprehensive diagnostic details required for complex issue analysis and root cause investigation.
weka debug traces level set
User
Related information: User management
Create a new local user: Creates a new local user account with the specified credentials and permissions.
weka user add <username> <role> <password>
Update user details: Modifies role and POSIX settings for an existing local user.
weka user update <username>
Delete a local user: Permanently removes a local user account and associated data from the system.
weka user delete <username>
Set user password (admin): Assigns a new password to a local user without requiring the current password. Requires administrative privileges.
weka user passwd
Change user password: Updates a user's password. Users can change their own password with their current credentials. Administrators can change any user's password within their organization.
weka user passwd <username>
Get current user information: Returns profile information for the authenticated user making the request.
weka user whoami
Revoke user tokens: Immediately invalidates all active authentication tokens for the specified user, terminating all GUI, CLI, and API sessions.
weka user revoke-tokens
Related information
Last updated