Logo

Zextras Suite
3.20.0

  • Introduction
    • Additional resources
      • Documentation Types and Users
      • Docs.zextras.com
      • Community
      • Administrator
    • Try and Install Zextras
    • Compatibility list
    • Internationalization
      • Product Localisation
      • Available Languages
      • Volunteer Translators
    • Zextras Theme for the Zimbra Webclient
      • Availability
      • Installation Guide
      • Enabling the theme
    • Services and Service management
      • Services
      • Service Management
    • How to report an issue
      • Step by step guide
      • Definition of “issue”
      • Tools of the trade
      • What information to include in your report
      • Help us improve Zextras Suite
  • Zextras Suite Installation Guide
    • Basic Information
      • Prerequisites
      • Minimum Requirements and Tweaking
      • Installation possibilities
      • Components
      • Other Zextras Zimlets
      • Where to get the Zextras Suite package
    • Setup Information
      • ZAL - an Abstraction Layer for Zimbra
      • The Zimbra DoS Filter
        • How the DoS Filter can affect your Zextras Suite experience
        • Managing the DoS Filter
      • OIP Logging and non-Zimbra Proxies
      • Modify Nginx Templates Files for Correct OIP Logging
      • Zimbra Upgrade
      • Zimbra Patches
    • Quick Installation Guide
      • Zextras Suite on Multiserver infrastructures
        • Installing Zextras Suite on a Single-store infrastructure
        • Installing Zextras Suite on a Multistore infrastructure
    • Detailed Instructions
      • Zextras Suite Full Installation
      • Zextras Suite Core Installation
      • Zextras Suite Zimlet Installation
      • Zextras Suite Full Upgrade
      • Upgrading Zextras Suite on a Multiserver infrastructure
      • Zextras Suite Uninstallation
    • Post-Install and Post-Uninstall
    • Additional Components
      • Zextras Client
        • Deploy the Zextras Client
      • Enable the Zextras Client
      • Update the Zextras Client
      • Remove the Zextras Client
  • Zextras Suite Licensing
    • Zextras Suite License Plans
      • Trial Mode
    • The new Zextras Store
    • Purchase a New Zextras Suite License
    • Options to Modify a License Plan
      • Renew a Zextras Suite License Plan
      • Upgrade a Zextras Suite License Plan
      • Change a Zextras Suite License Plan
      • Add a Maintenance Service to a Perpetual License
    • How to redeem a BID
    • Requirements
      • Zextras Suite licensing has to cover the whole infrastructure
      • How to find out the appropriate number of mailboxes
  • License File Management
    • How to install a License File
      • CLI installation
    • License Upgrades
    • License Warning recipient
    • Module Activation and Initialization
    • How to remove a License
  • Zextras Backup
    • Zextras Backup Common Tasks
      • How to Activate Zextras Backup
    • Architecture of Zextras Backup
      • Item
      • Transaction
      • SmartScan and Real Time Scan
        • When to Disable Scan Operations
      • Backup Path
        • Setting the Backup Path
      • Retention Policy
      • Backup Purge
      • Coherency Check
      • How Zextras Backup Works
        • Structure of an Item
      • Backup of Team Database
    • SmartScan
      • What is the SmartScan?
      • How Does it Work?
      • When is a SmartScan Executed?
      • Running a SmartScan
        • Checking the Status of a Running Scan
    • Real Time Scan
      • What is the Real Time Scanner?
      • How Does it Work?
      • Managing the Real Time Scanner
        • Enabling the Real Time Scanner
        • Disabling the Real Time Scanner
        • Limitations and Safety Scan
    • Backup Purge
      • What is the Backup Purge?
      • How Does it Work?
      • When is a Backup Purge Executed?
      • Running a Backup Purge
        • Checking the Status of a Running Backup Purge
    • Limitations and Corner Cases of the Backup
    • Troubleshooting LDAP Backup
      • Increase Log Verbosity
      • Missing root credentials
      • Disable LDAP Backup
    • Backup on external storage
      • How the Backup on external storage works
        • Goals and benefits
      • Data stored in the external storage
      • External storages
        • NFS/Fuse external storage
        • S3 external storage
        • S3 Backup in a multi-mailbox environment
      • Activate backup on the external storage
    • Zextras Backup CLI
  • Restore Strategies
    • Restore Deleted Account
      • What is the Restore Deleted Account?
      • How Does it Work?
        • From the Zextras Backup tab
    • Single Item Restore
      • What is the Single Item Restore?
      • How Does it Work?
      • Running a Single Item Restore
    • Restore on New Account
      • What is the Restore on New Account?
      • How Does it Work?
      • Running a Restore on New Account
    • Time-range Undelete
      • What is Time-range Undelete?
      • How Does it Work?
        • Corner cases
      • Running a Time-range Undelete
    • External Restore
      • What is the External Restore?
      • How Does it Work?
        • Skip Domain Provisioning
        • Folder restore
      • Before You Start
      • Running an External Restore
      • Speeding up the Restore through Multithreading
      • After the Restore: Message Deduplication
  • Advanced Techniques
    • Disaster Recovery
      • The Disaster
        • What Can go Wrong
        • Minimizing the Chances
      • The Recovery
        • How to Recover Your System
        • How can Zextras Backup Help with Recovery?
        • The Recovery Process
        • Settings and Configs
      • VMs and Snapshots
        • Disaster Recovery from a Previous VM State
      • The Aftermath
        • What Now?
    • Unrestorable Items
      • How can I check if all of my items have been restored?
        • Skipped Items vs. Unrestored Items
      • Why have some of my items not been restored?
      • How Can I Identify Unrestored Items?
      • How Can I Restore Unrestored Items?
        • Items Not Restored because of a Read Error
        • Items Not Restored because Identified as Broken Items
        • Items Not Restored because Identified as Invalid Items
    • Taking Additional and Offsite Backups of Zextras Backup’s Datastore
      • Who Watches the Watchmen?
      • Making an Additional Backup of Zextras Backup’s Datastore
      • Storing Your Zextras Backup’s Datastore Backup Offsite
      • Additional/Offsite Backup F.A.Q.
    • Multistore Information
      • Zextras Backup in a Multistore Environment
        • Command Execution in a Multistore Environment
        • Backup and Restore
        • Export and Import
        • The doCheckShares and doFixShares Commands
    • Operation Queue and Queue Management
      • Zextras Backup’s Operation Queue
      • Operation Queue Management
    • COS-level Backup Management
      • What is COS-level Backup Management?
      • How Does COS-level Backup Management Work?
        • What happens if I disable the Zextras Backup Module for a Class of Service?
        • How is the backup enabled/backup disabled information saved?
  • Zextras Mobile
    • Enable Zextras Mobile Synchronization for a COS
      • How to Enable Zextras Mobile for all Users in a Class Of Service
      • How to Disable Zextras Mobile for all Users in a Class Of Service
      • Note about Settings Hierarchy
    • Enable Zextras Mobile for a Single User
      • How to Enable Zextras Mobile for a Single User
      • How to Disable Zextras Mobile for a Single User
    • The Mobile Password Feature
      • Mobile Passwords and You
      • How to Set a Mobile Password for a Mailbox
    • Mobile Device Management a.k.a. Mobile Provisioning
      • What is Mobile Device Management?
        • Provisioning Features Available on Your Client
      • Zextras Suite and MDM
        • Provisioning Options
        • Enforceable Policies
        • Mobile Password
    • SyncStates
      • Zextras Mobile and the SyncState
        • Sync Request
      • Managing the SyncStates
    • Advanced Settings
      • Zextras Mobile DoS Filter
        • Configuration
        • How Mobile DoS Filter works
      • Zextras Autodiscover
        • How to enable Zextras Autodiscover
      • Zextras Mobile Performance Tuning
        • When to Edit the Performance Tuning Settings
    • Shared Folders
      • Shared Folders and You (and Your Mobile)
      • How to Sync a Shared Folder to Your Mobile Devices
        • Enable Mobile Synchronization for a Shared Folder
        • Disable Mobile Synchronization for a Shared Folder
      • Restrictions
    • EAS Filters
      • Anatomy of an EAS Filter
      • Managing EAS Filters
    • Mobile Account Loggers
      • Account Logger Management
    • ABQ - Allow/Block/Quarantine device control
      • ABQ Service
        • Components
        • ABQ Modes
        • ABQ Mode Control
        • Dummy data
        • Custom ABQ emails
        • Notifications
        • ABQ CLI
    • Zextras Mobile CLI
  • The Address Book Service
    • Accessing the LDAP Address Book
    • Contacts and Address Books
    • Additional Address Books
    • Outlook setup
    • Address Book naming
  • Zextras Mobile Troubleshooting
    • Account Loggers and Mobile Troubleshooting
      • Example
    • Outlook
      • Outlook Advanced Logging
      • Outlook Sync Issues folder
  • Zextras Powerstore
    • Introduction
    • Zimbra Stores
      • The Basics: Types of Stores and Their Uses
        • Primary and Secondary Data Stores
        • Volumes
    • Centralized Storage
      • Setting up Centralized Storage
      • Centralized Storage Structure
    • Volume Management
      • Zimbra Volumes
        • Volume Properties
        • Local Volumes
        • Current Volumes
        • Volume Management with Zextras Powerstore
    • Hierarchical Storage Management
      • The Hierarchical Storage Management Technique
        • Stores, Volumes and Policies
      • Moving Items between Stores
      • doMoveBlobs
        • The doMoveBlobs Operation of Zextras Powerstore
        • Executing the doMoveBlobs Operation (a.k.a. Applying the HSM Policy)
        • doMoveBlobs Stats and Info
    • Policy Management
      • What is a Policy?
        • Policy Examples
      • Defining a Policy
    • Zextras Powerstore and S3 buckets
      • S3-compatible Services
      • Primary Volumes and the “Incoming” directory
      • Local Cache
      • Bucket Setup
      • Bucket Management
      • Bucket paths and naming
      • Creating Volumes with Zextras Powerstore
      • Editing Volumes with Zextras Powerstore
      • Deleting Volumes with Zextras Powerstore
      • Amazon S3 Tips
        • Bucket
        • User
        • Rights Management
        • Bucket Paths and Naming
        • Infrequent Access Storage Class
        • Intelligent Tiering Storage Class
    • Item Deduplication
      • What is Item Deduplication
        • Item Deduplication in Zimbra
      • Item Deduplication and Zextras Powerstore
        • Running a Volume Deduplication
        • doDeduplicate Stats
    • Advanced Volume Operations
      • Zextras Powerstore: More than Meets the Eye
      • Volume Operations at a Glance
    • Moving Mailboxes Between Mailstores
    • Zextras Powerstore CLI
  • Attachment Indexing
    • How Indexing Works
    • Indexed Formats
    • Parser Controls
  • External Content Extractor
    • Why use Tika Server as Content Extractor?
    • Switching to the Tika Server
    • Tika Server Management
    • Is the Tika Server Running?
  • Zextras Admin
    • Delegated Admin Provisioning
      • What is Delegated Admin Provisioning?
      • Granting Delegated Admin Rights to a User
        • From the Administration Zimlet
        • From the CLI
      • Editing the Rights of an Existing Delegated Admin
        • From the Administration Zimlet
        • From the CLI
      • Revoke Delegated Admin Rights from a User
        • From the Administration Zimlet
        • From the CLI
    • Quota Management
      • What is Quota Management?
        • The Grant Limit
        • The Domain Quota
      • Grant Limit vs Domain Quota
    • Domain Limits
      • What is Domain Limit Management (a.k.a. Domain Settings)?
        • Domain Limits
      • Edit the Limits of a Domain
        • From the Administration Zimlet
        • From the CLI
      • Reset the Limits of a Domain
        • From the Administration Zimlet
        • From the CLI
    • Zimbra Administration as a Delegated Admin
      • Accessing the Zimbra Administration Console as a Delegated Admin
      • Delegated Admin CAN and CAN’T Table
      • Overview of the Zimbra Administration Console for Delegated Admins
    • Delegated Admin Log Browsing
      • What is Delegated Admin Log Browsing?
      • The Zextras Admin Log Browser
        • The Action filter
    • Reports and Information
      • Zextras Admin Monthly Reports
      • How does the Monthly Report system work?
      • How to Access the Monthly Reports
        • From the Administration Zimlet
        • From the CLI
      • Partial Reports
      • The Zextras Admin Log Path
        • The Zextras Admin Log Path Structure and Contents
        • Changing the Zextras Admin Log Path
    • Configuration Reset
      • What is the Zextras Admin Configuration Reset?
        • What does the Admin Configuration Reset clear?
      • When should I use the Admin Config Reset?
      • How do I use the Admin Configuration Reset?
    • Zextras Admin CLI
  • Zextras Drive
    • Introduction
    • Features
      • Frontend
      • Backend
    • Differences between Briefcase and Drive
    • Zimlet Installation
    • Browser compatibility
    • Mobile App
    • Drive UI
    • Feature Description
      • Upload and Download
      • Navigation
      • Folder Creation
      • File and Folder naming
      • Sharing
      • Item Deletion
      • InfoBox
      • File Versioning
    • Technical information
      • File Storage
      • Volumes
      • URLs and Ports
    • Zextras Drive Backup and HSM
      • Backup
      • HSM
      • Setting the Drive Primary volume
      • Setting the Drive Secondary volume
    • Briefcase Migration
    • Zextras Drive CLI
  • Zextras Docs
    • Introduction
    • Components
      • Zextras Docs Server
      • Zextras Docs Extension
      • Zextras Docs Zimlet
    • Minimum System Requirements
    • Browser compatibility
    • Document Management Flow
    • Networking and ports
    • Installation and Configuration
      • Docs Nodes
      • Docs Server download links
        • Adding Custom Fonts to the Docs Server
      • Mailbox Nodes
      • Proxy Nodes
    • Licensing
    • Removal
    • Commands
      • Zextras Docs Server CLI - zdocs
      • Zextras Docs Extension CLI - zxsuite docs
    • Troubleshooting
    • Zextras Docs CLI
  • Zextras Auth
    • What is Zextras Auth
      • Supported Authentication Methods
        • Self Service Credentials Management
        • Custom Login Page
        • SAML
        • Two Factor Authentication
    • ZxAuth for Admins
      • Requirements
        • QR Code Requirements
        • 2FA Requirements
        • SAML Requirements
      • Installing the Zextras Auth Zimlet
      • Custom Login Page
        • Enabling the Login Page
        • Customizing the Login Page
        • Viewing the current configuration
      • Setting up Policy Management for 2FA
      • Setting up SAML Configuration
        • Import SAML Configuration Automatically
        • Import SAML Configuration Manually
        • Configure SAML Logout
        • Access a Service Using SAML
      • Temporary Auth Link
    • ZxAuth for users (Auth Zimlet)
      • Zextras Auth Zimlet overview
      • Change Password
      • Create New Credentials: EAS
      • Create New Credentials: Mobile Apps
      • Create New Credentials: OTP
      • Delete Credentials
    • Credential Management
      • Services supported
      • Add new credentials
      • List existing Credentials
      • Editing a Credential
    • Zextras Auth CLI
  • Zextras Team
    • What is Zextras Team
      • Frontend Features
      • Backend Features
    • Licensing
    • Zextras Team Zimlet installation
    • URLs and Ports
    • Zextras Team administration
    • Browser compatibility
    • Mobile App
      • Notifications on Android Devices
    • User Interface
      • Team Tab
      • Meetings on a New Browser Tab
        • Changing the Selected Mode
      • Textual Conversations (Chats) and Spaces
        • Minichats
      • Video Conversations (Video Chats) and Instant Meetings
        • Screen Sharing
    • Instant Messaging and Corporate Communication
      • Moderators in Rooms
      • Groups
        • Groups Features
      • Spaces
        • Spaces Features
        • Space Settings
      • Channels
        • Channels Features
      • Mute Notifications and Conversations
    • File sharing
    • Autocomplete
    • Presence
    • Unread Messages
    • Edit, Reply, Forward and Delete Messages
    • Chat History
    • STUN/TURN Server
      • Setting up Zextras Team to use a TURN server
    • Zextras Team CLI
  • Zextras Video Server
    • Requirements
    • Client Configuration
    • Installation
    • Architecture and Service Control
    • Video Server Scaling
      • CLI Commands
    • Bandwidth and Codecs
      • Video Bandwidth
      • Video Codecs
      • Audio Codec
    • Advanced settings
      • Audio Quality
        • Audio Sensitivity
  • CLI
    • ZxAdmin CLI Commands
    • ZxAuth CLI Commands
    • ZxBackup CLI Commands
    • ZxConfig CLI Commands
    • ZxCore CLI Commands
    • ZxDocs CLI Commands
    • ZxDrive CLI Commands
    • ZxMobile CLI Commands
    • ZxPowerstore CLI Commands
    • ZxTeam CLI Commands
    • ZxUpdate CLI Commands
  • Changelogs
    • Previous Releases
      • Release 3.19.0
      • Release 3.18.0
      • Release 3.17.0
      • Release 3.16.1
      • Release 3.16.0
      • Release 3.15.0
      • Release 3.14.0
      • Release 3.13.0
      • Release 3.12.0
      • Release 3.11.0
      • Release 3.10.0
      • Release 3.9.0
      • Release 3.8.0
      • Release 3.7.0
      • Release 3.6.0
      • Release 3.5.0
      • Release 3.4.0
      • Release 3.3.0
      • Release 3.2.0
      • 3.1.x Releases:
        • Zextras Suite 3.1.11
        • Zextras Suite 3.1.10
        • Zextras Suite 3.1.9
        • Zextras Suite 3.1.8
        • Zextras Suite 3.1.7
        • Zextras Suite 3.1.6
        • Zextras Suite 3.1.5
        • Zextras Suite 3.1.4
        • Zextras Suite 3.1.3
        • Zextras Suite 3.1.2
        • Zextras Suite 3.1.1
        • Zextras Suite 3.1.0
  • Back to Zextras Documentation hub
Zextras Suite
» CLI

CLI

  • ZxAdmin CLI Commands
  • ZxAuth CLI Commands
  • ZxBackup CLI Commands
  • ZxConfig CLI Commands
  • ZxCore CLI Commands
  • ZxDocs CLI Commands
  • ZxDrive CLI Commands
  • ZxMobile CLI Commands
  • ZxPowerstore CLI Commands
  • ZxTeam CLI Commands
  • ZxUpdate CLI Commands
Previous Next
Copyright © 2025: ZEXTRAS. Privacy & Legal