Content Software for File CLI Reference

Version: 4.0.x
Audience: anonymous
Part Number: MK-HCSF001-02

Managing the system using the Content Software for File CLI
Commands hierarchy
Connecting to another host
CLI auto-completion
Cluster status
Getting started with Weka REST API
Obtaining an access token
Calling the REST API
Run first IOs with WekaFS
Create the first filesystem
Mount the first filesystem
Write to the filesystem
Validate the configuration
Managing object stores, filesystem groups, and filesystems
Managing object stores using the CLI
Viewing object stores using the CLI
Editing an object store using the CLI
Viewing object store buckets
Adding an object store bucket using the CLI
Editing an object store bucket using the CLI
Deleting an object store bucket using the CLI
Managing filesystem groups
Viewing filesystem groups using the CLI
Adding a filesystem group using the CLI
Editing a filesystem group using the CLI
Deleting a filesystem group using the CLI
Managing filesystems
Viewing filesystems using the CLI
Adding a filesystem using the CLI
Add a filesystem when thin-provisioning is used
Editing a filesystem using the CLI
Deleting a filesystem using the CLI
Attach or detach object store buckets using the CLI
Attaching an object stores bucket to a filesystem using the CLI
Detaching an object store bucket from a filesystem using the CLI
Mounting filesystems
Overview
Mounting a filesystem using the traditional method
Mounting a filesystem using the stateless clients feature
Mount command options
For all clients types
Remount of general options
Additional mount options using the stateless clients feature
Remount of stateless clients options
Set mount option default values
Advanced network configuration using mount options
IP, subnet, gateway, and virtual functions
Multiple physical network devices for performance and HA
Using multiple physical network devices for better performance
Using multiple physical network devices for HA configuration
Advanced mounting options for multiple physical network devices
UDP mode
Mounting filesystems using fstab
Mounting filesystems using autofs
Manual fetch and release of data using the CLI
Pre-fetching API for data lifecycle management using the CLI
Fetching files from an object store using the CLI
Fetching a directory containing many files using the CLI
Release API for data lifecycle management
Releasing files from SSD to an object store using the CLI
Releasing a directory containing many files using the CLI
Managing clients
Joining the cluster using the CLI
Configuring the host as client using the CLI
Configuring client networking using the CLI
Applying the host configuration using the CLI
Managing snapshots
Viewing snapshots using the CLI
Creating a snapshot using the CLI
Deleting a snapshot using the CLI
Restoring a filesystem or snapshot from another snapshot using the CLI
Updating a snapshot using the CLI
Uploading a snapshot using the CLI
Creating a filesystem from a snapshot using the CLI
Managing SMB
Showing an SMB cluster using the CLI
Showing an SMB domain configuration using the CLI
Creating an SMB cluster using the CLI
Checking status of SMB host readiness using the CLI
Joining an SMB cluster to an Active Directory using the CLI
Deleting an SMB cluster using the CLI
Configuring trusted domains using the CLI
Listing trusted domains using the CLI
Adding trusted domains using the CLI
Removing trusted domains using the CLI
Listing SMB shares using the CLI
Adding SMB shares using the CLI
Updating SMB shares using the CLI
Controlling SMB shares users lists using the CLI
Showing SMB share user lists using the CLI
Adding SMB share user to list using the CLI
Removing SMB share user from lists using the CLI
Resetting SMB share user lists using the CLI
Removing SMB shares using the CLI
Managing NFS
User groups resolution
Set up the hosts to retrieve user's group-IDs information
Supported NFS client mount options
Non-coherent mount options
Coherent mount options
Common mount options
Fixed mount options
Manage NFS networking using the CLI
Creating interface groups using the CLI
Setting interface group ports using the CLI
Setting interface group IPs using the CLI
Configuring the service mountd port
Manage NFS access (client access groups) using the CLI
Defining client access groups using the CLI
Managing client access groups using the CLI
Adding or deleting an IP using the CLI
Managing NFS client permissions using the CLI
Managing alerts
Displaying alert types using the CLI
Describing alerts using the CLI
Viewing alerts using the CLI
Muting alerts using the CLI
Unmuting alerts using the CLI
Managing events
Viewing events using the CLI
Listing local events using the CLI
Triggering a custom event using the CLI
Managing statistics
Listing statistic types using the CLI
Viewing statistics in realtime using the CLI
Viewing statistics over time using the CLI
Setting statistic retention using the CLI
Security management
Obtaining authentication tokens
KMS management using the CLI
Adding or updating a KMS using the CLI
Viewing the KMS using the CLI
Removing the KMS using the CLI
Re-wrapping filesystem keys using the CLI
Setting-up Vault configuration
Enabling transit secret engine in vault
Setting-up the master key for the Content Software for File system
Creating a policy for master key permissions
Obtaining an API token from Vault
Obtaining a certificate for a KMIP-based KMS
Getting started with REST API
Obtain an access token
Call the REST API
Managing the TLS certificate using the CLI
Setting the TLS certificate using the CLI
Replacing the TLS certificate using the CLI
Unsetting the TLS certificate
Downloading the TLS certificate using the CLI
Viewing the TLS certificate status using the CLI
Managing the CA certificate using the CLI
Managing the account lockout threshold policy using CLI
Managing the login banner using the CLI
Managing users
Creating users using the CLI
Changing user passwords using the CLI
Revoking user access using the CLI
Updating a local user using the CLI
Deleting users using the CLI
User sign in
Authenticating users from an LDAP user directory using the CLI
Configuring an LDAP server using the CLI
Viewing a configured LDAP user directory using the CLI
Disabling or enabling a configured LDAP user directory using the CLI
Managing organizations
Managing organizations
Creating an organization using the CLI
Viewing organizations using the CLI
Renaming organizations using the CLI
Updating the quota of an organization using the CLI
Deleting an organization using the CLI
Mount authentication for organization filesystems
Mounting a filesystem using the CLI
Mount authentication‌
Expansion of specific resources
Dynamic modifications using the CLI
Memory modifications
Network modifications
Host IPs modifications
Local resources editing commands using the CLI
Addition of CPU cores
Expansion of only SSDs
Managing clusters
Shrinking a cluster using the CLI
Options for shrinking a cluster
Listing drives and their states using the CLI
Deactivating a drive using the CLI
Removing a drive using the CLI
Deactivating an entire host using the CLI
Removing a host using the CLI
Managing background tasks
Viewing background tasks using the CLI
Limiting background tasks using the CLI
Pause/Resume/Abort a background task
Running cluster diagnostics
Managing diagnostics using the CLI
Container storage interface (CSI) plugin
CSI plugin overview
Interoperability
Prerequisites
Capabilities
Supported capabilities
Unsupported capabilities
Deployment
Download
Installation
Provision usage
Storage class example
Storage class parameters
Dynamic provisioning
Persistent volume claim example
Persistent volume claim parameters
Static provisioning
Persistent volume example
Persistent volume parameters
Persistent volume claim for static provisioning example
Launching an application using CSF as the POD's storage
Troubleshooting
Known issues

Back to home page