W E K A
4.4
4.4
  • WEKA v4.4 documentation
    • Documentation revision history
  • WEKA System Overview
    • Introduction
      • WEKA system functionality features
      • Converged WEKA system deployment
    • Cluster capacity and redundancy management
    • Filesystems, object stores, and filesystem groups
    • WEKA networking
    • Data lifecycle management
    • WEKA client and mount modes
    • WEKA containers architecture overview
    • Glossary
  • Planning and Installation
    • Prerequisites and compatibility
    • WEKA cluster installation on bare metal servers
      • Plan the WEKA system hardware requirements
      • Obtain the WEKA installation packages
      • Install the WEKA cluster using the WMS with WSA
      • Install the WEKA cluster using the WSA
      • Manually install OS and WEKA on servers
      • Manually prepare the system for WEKA configuration
        • Broadcom adapter setup for WEKA system
        • Enable the SR-IOV
      • Configure the WEKA cluster using the WEKA Configurator
      • Manually configure the WEKA cluster using the resources generator
        • VLAN tagging in the WEKA system
      • Perform post-configuration procedures
      • Add clients to an on-premises WEKA cluster
    • WEKA Cloud Deployment Manager Web (CDM Web) User Guide
    • WEKA Cloud Deployment Manager Local (CDM Local) User Guide
    • WEKA installation on AWS
      • WEKA installation on AWS using Terraform
        • Terraform-AWS-WEKA module description
        • Deployment on AWS using Terraform
        • Required services and supported regions
        • Supported EC2 instance types using Terraform
        • WEKA cluster auto-scaling in AWS
        • Detailed deployment tutorial: WEKA on AWS using Terraform
      • WEKA installation on AWS using the Cloud Formation
        • Self-service portal
        • CloudFormation template generator
        • Deployment types
        • AWS Outposts deployment
        • Supported EC2 instance types using Cloud Formation
        • Add clients to a WEKA cluster on AWS
        • Auto scaling group
        • Troubleshooting
    • WEKA installation on Azure
      • Azure-WEKA deployment Terraform package description
      • Deployment on Azure using Terraform
      • Required services and supported regions
      • Supported virtual machine types
      • Auto-scale virtual machines in Azure
      • Add clients to a WEKA cluster on Azure
      • Troubleshooting
      • Detailed deployment tutorial: WEKA on Azure using Terraform
    • WEKA installation on GCP
      • WEKA project description
      • GCP-WEKA deployment Terraform package description
      • Deployment on GCP using Terraform
      • Required services and supported regions
      • Supported machine types and storage
      • Auto-scale instances in GCP
      • Add clients to a WEKA cluster on GCP
      • Troubleshooting
      • Detailed deployment tutorial: WEKA on GCP using Terraform
      • Google Kubernetes Engine and WEKA over POSIX deployment
    • WEKA installation on OCI
  • Getting Started with WEKA
    • Manage the system using the WEKA GUI
    • Manage the system using the WEKA CLI
      • WEKA CLI hierarchy
      • CLI reference guide
    • Run first IOs with WEKA filesystem
    • Getting started with WEKA REST API
    • WEKA REST API and equivalent CLI commands
  • Performance
    • WEKA performance tests
      • Test environment details
  • WEKA Filesystems & Object Stores
    • Manage object stores
      • Manage object stores using the GUI
      • Manage object stores using the CLI
    • Manage filesystem groups
      • Manage filesystem groups using the GUI
      • Manage filesystem groups using the CLI
    • Manage filesystems
      • Manage filesystems using the GUI
      • Manage filesystems using the CLI
    • Attach or detach object store buckets
      • Attach or detach object store bucket using the GUI
      • Attach or detach object store buckets using the CLI
    • Advanced data lifecycle management
      • Advanced time-based policies for data storage location
      • Data management in tiered filesystems
      • Transition between tiered and SSD-only filesystems
      • Manual fetch and release of data
    • Mount filesystems
      • Mount filesystems from Single Client to Multiple Clusters (SCMC)
      • Manage authentication across multiple clusters with connection profiles
    • Snapshots
      • Manage snapshots using the GUI
      • Manage snapshots using the CLI
    • Snap-To-Object
      • Manage Snap-To-Object using the GUI
      • Manage Snap-To-Object using the CLI
    • Snapshot policies
      • Manage snapshot policies using the GUI
      • Manage snapshot policies using the CLI
    • Quota management
      • Manage quotas using the GUI
      • Manage quotas using the CLI
  • Additional Protocols
    • Additional protocol containers
    • Manage the NFS protocol
      • Supported NFS client mount parameters
      • Manage NFS networking using the GUI
      • Manage NFS networking using the CLI
    • Manage the S3 protocol
      • S3 cluster management
        • Manage the S3 service using the GUI
        • Manage the S3 service using the CLI
      • S3 buckets management
        • Manage S3 buckets using the GUI
        • Manage S3 buckets using the CLI
      • S3 users and authentication
        • Manage S3 users and authentication using the CLI
        • Manage S3 service accounts using the CLI
      • S3 lifecycle rules management
        • Manage S3 lifecycle rules using the GUI
        • Manage S3 lifecycle rules using the CLI
      • Audit S3 APIs
        • Configure audit webhook using the GUI
        • Configure audit webhook using the CLI
        • Example: How to use Splunk to audit S3
        • Example: How to use S3 audit events for tracking and security
      • S3 supported APIs and limitations
      • S3 examples using boto3
      • Configure and use AWS CLI with WEKA S3 storage
    • Manage the SMB protocol
      • Manage SMB using the GUI
      • Manage SMB using the CLI
  • Security
    • WEKA security overview
    • Obtain authentication tokens
    • Manage token expiration
    • Manage account lockout threshold policy
    • Manage KMS
      • Manage KMS using GUI
      • Manage KMS using CLI
    • Manage TLS certificates
      • Manage TLS certificates using GUI
      • Manage TLS certificates using CLI
    • Manage Cross-Origin Resource Sharing
    • Manage CIDR-based security policies
    • Manage login banner
  • Secure cluster membership with join secret authentication
  • Licensing
    • License overview
    • Classic license
  • Operation Guide
    • Alerts
      • Manage alerts using the GUI
      • Manage alerts using the CLI
      • List of alerts and corrective actions
    • Events
      • Manage events using the GUI
      • Manage events using the CLI
      • List of events
    • Statistics
      • Manage statistics using the GUI
      • Manage statistics using the CLI
      • List of statistics
    • Insights
    • System congestion
    • User management
      • Manage users using the GUI
      • Manage users using the CLI
    • Organizations management
      • Manage organizations using the GUI
      • Manage organizations using the CLI
      • Mount authentication for organization filesystems
    • Expand and shrink cluster resources
      • Add a backend server
      • Expand specific resources of a container
      • Shrink a cluster
    • Background tasks
      • Set up a Data Services container for background tasks
      • Manage background tasks using the GUI
      • Manage background tasks using the CLI
    • Upgrade WEKA versions
    • Manage WEKA drivers
  • Drivers distribution service
  • Monitor the WEKA Cluster
    • Deploy monitoring tools using the WEKA Management Station (WMS)
    • WEKA Home - The WEKA support cloud
      • Local WEKA Home overview
      • Deploy Local WEKA Home v3.0 or higher
      • Deploy Local WEKA Home v2.x
      • Explore cluster insights
      • Explore performance statistics in Grafana
      • Manage alerts and integrations
      • Enforce security and compliance
      • Optimize support and data management
      • Export cluster metrics to Prometheus
    • Set up WEKAmon for external monitoring
    • Set up the SnapTool external snapshots manager
  • Kubernetes
    • Composable clusters for multi-tenancy in Kubernetes
    • WEKA Operator deployment
      • Deploy the WEKA client on Amazon EKS
    • WEKA Operator day-2 operations
  • WEKApod
    • WEKApod Data Platform Appliance overview
    • WEKApod servers overview
    • Rack installation
    • WEKApod initial system setup and configuration
    • WEKApod support process
  • AWS Solutions
    • Amazon SageMaker HyperPod and WEKA Integrations
      • Deploy a new Amazon SageMaker HyperPod cluster with WEKA
      • Add WEKA to an existing Amazon SageMaker HyperPod cluster
    • AWS ParallelCluster and WEKA Integration
  • Azure Solutions
    • Azure CycleCloud for SLURM and WEKA Integration
  • Best Practice Guides
    • WEKA and Slurm integration
      • Avoid conflicting CPU allocations
    • Storage expansion best practice
  • Support
    • Get support for your WEKA system
    • Diagnostics management
      • Traces management
        • Manage traces using the GUI
        • Manage traces using the CLI
      • Protocols debug level management
        • Manage protocols debug level using the GUI
        • Manage protocols debug level using the CLI
      • Diagnostics data management
  • Appendices
    • WEKA CSI Plugin
      • Deployment
      • Storage class configurations
      • Tailor your storage class configuration with mount options
      • Dynamic and static provisioning
      • Launch an application using WEKA as the POD's storage
      • Add SELinux support
      • NFS transport failback
      • Upgrade legacy persistent volumes for capacity enforcement
      • Troubleshooting
    • Convert cluster to multi-container backend
    • Create a client image
    • Update WMS and WSA
    • BIOS tool
Powered by GitBook
On this page
  • weka agent
  • weka alerts
  • weka cloud
  • weka cluster
  • weka dataservice
  • weka diags
  • weka driver
  • weka events
  • weka fs
  • weka interface-group
  • weka local
  • weka mount
  • weka nfs
  • weka org
  • weka s3
  • weka security
  • weka smb
  • weka stats
  • weka status
  • weka umount
  • weka upgrade
  • weka user
  • weka version
  1. Getting Started with WEKA
  2. Manage the system using the WEKA CLI

WEKA CLI hierarchy

Explore the hierarchical structure of WEKA Command-Line Interface (CLI) commands for easy reference.

New commands in V4.4.6 CLI, compared to V4.3.5, are marked with **.

weka agent

weka agent
   |autocomplete
      |export
      |install
      |uninstall
   |install-agent
   |update-containers
   |uninstall

weka alerts

weka alerts
   |describe
   |mute
   |types
   |unmute

weka cloud

weka cloud
   |disable
   |enable
   |proxy
   |status
   |update
   |upload-rate   
      |set

weka cluster

weka cluster
    |bucket
    |client-target-version
       |reset
       |set
       |show
    |container
       |activate
       |add
       |apply
       |auto-remove-timeout
       |bandwidth
       |clear-failure
       |cores
       |deactivate
       |deactivation-check **
       |dedicate
       |failure-domain
       |info-hw
       |join-secret **
       |management-ips
       |memory
       |net
          |add
          |remove
       |remove
       |requested-action **
       |resources
       |restore
    |add
    |default-net
        |reset
        |set
        |update  
    |drive
        |activate
        |add
        |deactivate
        |remove
        |scan 
    |failure-domain
    |hot-spare
    |license
        |reset
        |set
    |task
        |pause
        |resume
        |abort
        |limits
            |set
    |mount-defaults
        |reset
        |set
        |show   
    |process
    |servers
        |list
        |show
    |start-io
    |stop-io
    |task
        |abort
        |bucket **
        |limits
        |pause
        |resume
        |throttle **§
    |update

weka dataservice

weka dataservice
    |global-config
        |set
        |show

weka diags

weka diags
    |collect
    |list
    |rm
    |upload

weka driver

weka driver **
   |build
   |download
   |export
   |import
   |install
   |kernel
   |pack
   |ready
   |sign

weka events

weka events
    |list-local
    |list-types
    |trigger-event

weka fs

weka fs
    |add
    |remove
    |download
    |group
        |add
        |remove
        |update
    |kms-rewrap **
    |protection **
        |snapshot-policy
            |attach
            |add
            |remove
            |detach
            |duplicate
            |export
            |list
            |run-once **
            |show
            |update
     |quota
        |list
        |list-default
        |set
        |set-default
        |reset
        |unset-default
    |reserve
        |set
        |status
        |reset
    |restore
    |security **
        |policy
            |attach
            |detach
            |list
            |reset
            |set
    |snapshot
        |access-point-naming-convention
            |status
            |update
        |copy
        |add
        |remove
        |download
        |update
        |upload
     |tier
        |capacity
        |fetch
        |location
        |obs
            |update
        |ops
        |release
        |s3
            |add
            |attach
            |remove
            |detach
            |snapshot
                |list
            |update
     |update

weka interface-group

weka interface-group **
    |add
    |assignment
    |remove
    |ip-range
        |add
        |remove
    |port
        |add
        |remove
    |update

weka local

weka local
    |diags
    |disable
    |enable
    |events
    |install-agent
    |monitoring
    |ps
    |reset-data
    |resources
        |apply
        |auto-remove-timeout **
        |bandwidth
        |base-port
        |cores
        |dedicate
        |export
        |failure-domain
        |fqdn **
        |import
        |join-ips
        |join-secret **
        |management-ips
        |memory       
        |net
            |add
            |remove
        |restore    
    |restart
    |rm
    |run
    |setup
        |client **
        |container
        |envoy **
        |services **
        |taskmon **
        |weka
    |start  
    |status
    |stop  
    |upgrade

weka mount

weka mount

weka nfs

weka nfs 
    |client-group
        |add
        |remove
    |clients **
        |show
    |debug-level
        |set
        |show
    |global-config
        |set
        |show
    |interface-group
        |add
        |assignmment **
        |remove
        |ip-range
            |add
            |remove
        |port
            |add
            |remove    
        |update
    |kerberos
        |registration
            |setup-ad
            |setup-mit
            |show
        |reset
        |service
            |setup
            |show
     |ldap
        |export-openldap **
        |import-openldap **
        |reset
        |setup-ad
        |setup-ad-nokrb **
        |setup-openldap
        |show
    |permission
        |add
        |remove
        |update
    |rules
        |add
           |dns
           |ip
        |remove
           |dns
           |ip

weka org

weka org
   |add
   |remove
   |rename
   |security **
      |policy
         |attach
         |detach
         |list
         |reset
         |set
      |revoke-tokens
   |set-quota

weka s3

weka s3
   |bucket
      |add
      |remove     
      |lifecycle-rule
         |add
         |list
         |remove
         |reset
      |list
      |policy
         |get
         |get-json
         |set
         |set-custom
         |reset
      |quota
         |set
         |reset
   |cluster
      |audit-webhook
         |disable
         |enable
         |show
      |container
         |add
         |list
         |remove
      |add
      |remove
      |status
      |update
  |log-level
      |get
  |policy
      |add
      |attach
      |detach
      |list
      |remove
      |show
   |service-account
      |add
      |list
      |remove
      |show
    |sts
      |assume-role

weka security

weka security
   |ca-cert
      |download
      |set
      |status
      |reset
   |cors-trusted-sites
      |add
      |list
      |remove
      |remove-all
   |kms
      |rewrap
      |set
      |reset
   |lockout-config
      |reset
      |set
      |show
   |login-banner
      |disable
      |enable
      |reset
      |set
      |show
   |policy **
      |add
      |remove
      |duplicate
      |join
          |attach
          |detach
          |list
          |reset
          |set
      |list
      |show
      |test
      |update     
   |tls
      |download
      |local **
         |set
         |reset
      |set
      |status
      |reset
   |token-expiry **
      |set
      |show

weka smb

weka smb
   |cluster
      |container
         |add
         |remove
      |add
      |debug
      |remove
      |status
      |trusted-domains
         |add
         |remove
      |update
      |wait
   |domain
      |join
      |leave         
   |share
      |add
      |host-access
         |add
         |list
         |remove
         |reset
      |list
         |add
         |remove
         |reset
         |show
      |remove
      |update

weka stats

weka stats
   |list-types
   |realtime
   |retention
      |restore-default
      |set
      |status

weka status

weka status
   |rebuild

weka umount

weka unmount

weka upgrade

weka upgrade **
   |pause
   |resume
   |supported-features

weka user

weka user
   |add
   |change-role
   |remove
   |generate-token
   |ldap
      |disable
      |enable
      |reset
      |setup
      |setup-ad
      |update
   |login
   |logout
   |passwd
   |revoke-tokens
   |update
   |whoami

weka version

weka version
   |current
   |get
   |prepare
   |rm
   |set
   |reset
PreviousManage the system using the WEKA CLINextCLI reference guide

Last updated 1 month ago