Zextras Product Admin Documentation

https://github.com/zextras/tech-doc
Admin
Provides the source code for the Zextras product administration documentation, built with Python...
Tokens:295,856
Snippets:4,973
Trust Score:9.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### Start Powerstore Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxPowerstore/zxsuite_powerstore_doStartService.rst

A basic example of the command structure.

```bash
zxsuite powerstore doStartService
```

--------------------------------

### Start Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_doStartService.rst

A basic example of invoking the start service command.

```bash
zxsuite drive doStartService
```

--------------------------------

### Usage example for zxsuite auth saml get

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxAuth/zxsuite_auth_saml_get.rst

A simple execution example of the command.

```bash
zxsuite auth saml get
```

--------------------------------

### Set Backup Volume Default Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_setBackupVolume_Default.rst

Example of how to invoke the command with the start parameter.

```bash
carbonio backup setBackupVolume Default start
```

--------------------------------

### Usage Examples for iceServer get

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_iceServer_get.rst

Examples showing how to retrieve ICE server configurations with and without specific parameters.

```bash
zxsuite team iceServer get
```

```bash
zxsuite team iceServer get cos default
```

--------------------------------

### doStartService Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_doStartService.rst

A basic example of the command usage.

```bash
carbonio backup doStartService
```

--------------------------------

### Execute the installation script

Source: https://github.com/zextras/tech-doc/blob/devel/source/suite/videoserver.rst

Run the installation script from within the unpacked directory to install the Video Server and its dependencies.

```console
~/videoserver-installer# ./install.sh
```

--------------------------------

### SmartScan Get Server Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_scheduler_SmartScan_get_server.rst

An example of how to use the command to specify a target server.

```bash
carbonio backup scheduler SmartScan get server target_server mail.example.com
```

--------------------------------

### Install S3-benchmark

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/admincli/administration/s3bench.rst

Download and install the S3-benchmark binary to the system path.

```bash
# wget https://github.com/zextras/s3-benchmark/raw/master/build/linux-amd64/s3-benchmark
# mv ./s3-benchmark /usr/local/bin/s3-benchmark
# chmod +x /usr/local/bin/s3-benchmark
```

--------------------------------

### Get Skin Logo App Banner Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxAuth/zxsuite_auth_loginPage_getSkinLogoAppBanner_domain.rst

Example usage of the command for a specific domain.

```bash
zxsuite auth loginPage getSkinLogoAppBanner domain example.com
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_doBackupServerCustomizations.rst

A simple example of how to invoke the command.

```bash
carbonio backup doBackupServerCustomizations
```

--------------------------------

### Usage Example for doClearChatDB

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_doClearChatDB.rst

A basic example of executing the command.

```bash
zxsuite team doClearChatDB
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_migrateBackupVolume_CustomS3.rst

A simple example of invoking the migration command.

```bash
carbonio backup migrateBackupVolume CustomS3
```

--------------------------------

### Example usage of doStopService

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_doStopService.rst

A simple example showing the command structure.

```bash
zxsuite drive doStopService
```

--------------------------------

### Restart Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_doRestartService.rst

An example of the command usage.

```bash
carbonio config doRestartService
```

--------------------------------

### Log output examples

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_admincli/clamav-updater.rst

Example log entries showing the start and finish of the update process, including scenarios where no updates are required.

```text
Oct 18 09:28:25 srv2.example.com systemd[1]: Started Carbonio anti-virus updater
..
Oct 18 09:28:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:28.028 [AVDB Scheduler_Worker-1] INFO  com.zextras.avdb.jobs.AvdbJob - ********************* S T A R T I N G ********************
Oct 18 09:28:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:28.039 [pool-1-thread-1] INFO  c.z.a.client.networking.Downloader - download starting : /md5list.txt
Oct 18 09:28:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:28.343 [pool-1-thread-1] INFO  c.z.a.client.networking.Downloader - download finished : /md5list.txt
Oct 18 09:28:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:28.361 [ForkJoinPool.commonPool-worker-2] INFO  c.z.a.client.networking.Downloader - download starting : /securiteinfopdf.hdb
Oct 18 09:28:29 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:29.594 [ForkJoinPool.commonPool-worker-2] INFO  c.z.a.client.networking.Downloader - download finished : /securiteinfopdf.hdb
..
Oct 18 09:28:44 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:44.383 [pool-2-thread-1] INFO  c.z.a.client.networking.Downloader - download finished : /javascript.ndb
Oct 18 09:28:51 srv2.example.com carbonio-avdb-updater[2628063]: 09:28:51.582 [AVDB Scheduler_Worker-1] INFO  c.z.a.c.processing.ProcessExecutor - Added entry [/opt/zextras/bin/zmprov mcf +carbonioClamAVDat>
..
Oct 18 09:29:48 srv2.example.com carbonio-avdb-updater[2628063]: 09:29:48.930 [AVDB Scheduler_Worker-1] INFO  com.zextras.avdb.jobs.AvdbJob - ********************* F I N I S H E D ********************
```

```text
Oct 18 09:34:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:34:28.017 [AVDB Scheduler_Worker-1] INFO  com.zextras.avdb.jobs.AvdbJob - ********************* S T A R T I N G ********************
Oct 18 09:34:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:34:28.019 [pool-21-thread-1] INFO  c.z.a.client.networking.Downloader - download starting : /md5list.txt
Oct 18 09:34:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:34:28.035 [pool-21-thread-1] INFO  c.z.a.client.networking.Downloader - download finished : /md5list.txt
Oct 18 09:34:28 srv2.example.com carbonio-avdb-updater[2628063]: 09:34:28.039 [AVDB Scheduler_Worker-1] INFO  com.zextras.avdb.jobs.AvdbJob - ********************* F I N I S H E D ********************
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/core/carbonio_core_store-license.rst

A simple execution example of the store-license command.

```bash
carbonio core store-license
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_setABQMessage_domain.rst

An example of how to execute the command with specific parameters for a domain.

```bash
carbonio mobile setABQMessage domain example.com default u0@example.com admin@example.com "Email subject" "Email plain text body" "<h1>Email HTML body</h1>"
```

--------------------------------

### Usage example for ABQ allow

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_ABQ_allow.rst

A basic example of the command usage.

```bash
carbonio mobile ABQ allow
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/core/carbonio_core_activate-license.rst

A basic example of the command usage.

```bash
carbonio core activate-license
```

--------------------------------

### Usage Examples

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_doMoveAllRooms.rst

Examples demonstrating how to move rooms with notifications or by forcing the operation.

```bash
zxsuite --progress team doMoveAllRooms server3.example.com notifications
user1@example.com,
user2@example.com
```

```bash
zxsuite --progress team doMoveAllRooms server3.example.com force true
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_monitor.rst

A basic example of invoking the drive monitor command.

```bash
zxsuite drive monitor
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_policy_list_domain.rst

An example of how to list authentication policies for the domain example.com.

```bash
carbonio auth policy list domain example.com
```

--------------------------------

### Usage example for migrateBackupVolume Alibaba

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_migrateBackupVolume_Alibaba.rst

A basic example of how to invoke the migration command.

```bash
carbonio backup migrateBackupVolume Alibaba
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_doImportChannels.rst

A simple example of how to invoke the doImportChannels command.

```bash
zxsuite team doImportChannels
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_setBackupVolume_S3.rst

An example of setting the backup volume with a specific UUID.

```bash
carbonio backup setBackupVolume S3 123e4567-e89b-12d3-a456-556642440000
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxUpdate/zxsuite_update_start.rst

Example showing how to specify the version parameter for the update command.

```bash
zxsuite update start [version (latest|x.x.x)]
```

--------------------------------

### Restart Backup Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxBackup/zxsuite_backup_doRestartService.rst

An example of the command invocation.

```bash
zxsuite backup doRestartService
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doCreateVolume_FileBlob.rst

An example of creating a secondary volume with compression enabled.

```bash
carbonio powerstore doCreateVolume FileBlob volumeName secondary /path/to/store volume_compressed true compression_threshold_bytes 4096
```

--------------------------------

### SAML Import Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_saml_import.rst

A basic example of the command execution.

```bash
carbonio auth saml import
```

--------------------------------

### zxsuite mobile setProperty Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxMobile/zxsuite_mobile_setProperty.rst

Example of the command usage.

```bash
zxsuite mobile setProperty
```

--------------------------------

### Usage Examples

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_video-server_add.rst

Examples of adding a video server with default settings and with custom parameters.

```bash
zxsuite team video-server add videoserver.example.com
```

```bash
zxsuite team video-server add videoserver.example.com port 12003 secret
api-secret
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_setBackupVolume_Scality.rst

An example of setting the backup volume using a specific UUID.

```bash
carbonio backup setBackupVolume Scality 123e4567-e89b-12d3-a456-556642440000
```

--------------------------------

### Example of adding credentials

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxAuth/zxsuite_auth_credential_add.rst

A practical example showing how to add a password, label, and service configuration to an account.

```bash
zxsuite auth credential add john@example.com password myPassword label myLabel qrcode false service eas,mobileApp
```

--------------------------------

### doDeduplicate Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doDeduplicate.rst

Example of starting a deduplication process on a specific volume.

```bash
carbonio powerstore doDeduplicate secondvolume
```

--------------------------------

### Restart Mobile Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_doRestartService.rst

Example of the command usage.

```bash
carbonio mobile doRestartService
```

--------------------------------

### Start all main services

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_architecture/_systemd/guide.rst

Start all core product components on a node in the correct order.

```bash
# systemctl start carbonio.target
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_totp_generate.rst

An example showing the structure of the command with all available parameters.

```bash
carbonio auth totp generate generate {account} <algorithm> <pin> <secret_length> <period> <digits_length> <human_readable> <pin_prepend> <static_code> <label_prefix>
```

--------------------------------

### Get Volume Stats Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_carboniocli/carbonio_powerstore_getVolumeStats.rst

Example of retrieving statistics for a specific volume.

```console
zextras$ carbonio powerstore getVolumeStats volumeName
```

--------------------------------

### Restart Drive Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_doRestartService.rst

A basic example of the command execution.

```bash
zxsuite drive doRestartService
```

--------------------------------

### Simple Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_doSimulateSync.rst

Example of running the command with mandatory account and device ID parameters.

```bash
carbonio mobile doSimulateSync account@example.com android1365173312
```

--------------------------------

### Usage Example for doUpdateVolume ScalityS3

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doUpdateVolume_ScalityS3.rst

A basic example of invoking the command.

```bash
carbonio powerstore doUpdateVolume ScalityS3
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_migrateBackupVolume_S3.rst

A basic example of invoking the migrateBackupVolume S3 command.

```bash
carbonio backup migrateBackupVolume S3
```

--------------------------------

### Carbonio Powerstore doDeduplicate Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_carboniocli/carbonio_powerstore_doDeduplicate.rst

An example of how to start deduplication on a volume named secondvolume.

```console
zextras$ carbonio powerstore doDeduplicate secondvolume
```

--------------------------------

### Start Service Command Syntax

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_doStartService.rst

The basic command structure for starting a service.

```bash
zxsuite drive doStartService *service_name*
```

--------------------------------

### Build all documentation

Source: https://github.com/zextras/tech-doc/blob/devel/README.md

Execute the build script to compile all product manuals into HTML format.

```bash
./doc_build_all.sh
```

--------------------------------

### Get account statistics usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/core/carbonio_core_getAccountStats.rst

Example of retrieving statistics for a specific user account.

```bash
carbonio core getAccountStats John
```

--------------------------------

### Get domain usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_get_domain.rst

Example showing how to retrieve the teamChatEnabled status for a specific domain.

```bash
carbonio config get domain example.com teamChatEnabled
```

--------------------------------

### OpenIO Volume Creation Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxPowerstore/zxsuite_powerstore_doCreateVolume_OpenIO.rst

Example command demonstrating the creation of an OpenIO volume with specific port configurations.

```bash
zxsuite powerstore doCreateVolume OpenIO volumeName primary http://host/service accountName namespaceString proxy_port 6006 account_port 6009
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_getAvailableDomains.rst

Example command to list all domains present in the most recent backup.

```bash
carbonio backup getAvailableDomains last /opt/zextras/backup/export
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_scheduler_coherencyCheck_get_server.rst

Example of how to specify the target server for the coherency check.

```bash
carbonio backup scheduler coherencyCheck get server target_server mail.example.com
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doCreateVolume_Alibaba.rst

A practical example of creating an Alibaba volume with a specified name, type, and bucket configuration ID.

```bash
carbonio powerstore doCreateVolume Alibaba volumeName primary 123e4567-e89b-12d3-a456-556642440000
```

--------------------------------

### Usage example for migrateBackupVolume Scality

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_migrateBackupVolume_Scality.rst

A simple execution example of the migrateBackupVolume command.

```bash
carbonio backup migrateBackupVolume Scality
```

--------------------------------

### Usage example for doBackupLDAP

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_doBackupLDAP.rst

A simple execution example of the doBackupLDAP command.

```bash
carbonio backup doBackupLDAP
```

--------------------------------

### Usage example for migrateBackupVolume Cloudian

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_migrateBackupVolume_Cloudian.rst

A basic example of executing the migration command.

```bash
carbonio backup migrateBackupVolume Cloudian
```

--------------------------------

### Get Device List Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_getDeviceList.rst

Example of retrieving device IDs for a specific user account.

```bash
carbonio mobile getDeviceList john@example.com
```

--------------------------------

### Run Mesh Setup

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_admincli/mesh/othernodes.rst

Set the mesh password and execute the setup command to join the node to the mesh.

```console
# read -s -p "Insert Mesh Password:" MESH_SECRET
```

```console
# service-discover setup $(hostname -i) --password=$MESH_SECRET
```

```console
# unset MESH_SECRET
```

--------------------------------

### SAML Configuration Retrieval Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_saml_get.rst

A basic example of how to invoke the command.

```bash
carbonio auth saml get
```

--------------------------------

### Get server configuration usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_get_server.rst

An example showing how to retrieve the 'teamChatEnabled' attribute for the server 'mail.example.com'.

```bash
carbonio config get server mail.example.com teamChatEnabled
```

--------------------------------

### Launch Mesh Agent Setup Wizard

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_installation/mesh-agent.rst

Run this command to initiate the configuration process for the Mesh agent.

```console
# service-discover setup-wizard
```

--------------------------------

### Get backup map usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_getMap.rst

Example command to display a specific backup map file.

```bash
carbonio backup getMap /opt/zextras/backup/zextras/map_544d94c6-aaef-4736-8964-56a667f1fe12
```

--------------------------------

### Serve documentation locally

Source: https://github.com/zextras/tech-doc/blob/devel/README.md

Start a local HTTP server to view the generated HTML documentation in a browser.

```bash
python3 -m http.server --directory build 8000
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxBackup/zxsuite_backup_getMap.rst

An example of retrieving a backup map from a specific file path.

```bash
zxsuite backup getMap /opt/zimbra/backup/zextras/map_544d94c6-aaef-4736-8964-56a667f1fe12
```

--------------------------------

### doUndelete Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_doUndelete.rst

Example of restoring items for a specific account between a start date and the latest available data.

```bash
carbonio backup doUndelete john@example.com "08/10/2012 10:15:00" last
```

--------------------------------

### Usage example for addressBook add global

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_addressBook_add_global.rst

Example demonstrating the command with a specific user and folder ID.

```bash
carbonio mobile addressBook add global user@example.com 2
```

--------------------------------

### Usage Example for doCreateVolume OpenIO

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doCreateVolume_OpenIO.rst

A practical example demonstrating how to define mandatory and optional parameters for an OpenIO volume.

```bash
carbonio powerstore doCreateVolume OpenIO volumeName primary http://host/service accountName namespaceString proxy_port 6006 account_port 6009
```

--------------------------------

### Get account attribute usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_get_account.rst

Example command to retrieve the teamChatEnabled status for a specific user account.

```bash
carbonio config get account u0@example.net teamChatEnabled
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_retrieveMetadataFromArchive_S3.rst

An example command showing how to specify the destination, bucket configuration ID, and volume prefix.

```bash
carbonio backup retrieveMetadataFromArchive S3 /path/to/destination/directory bucket_configuration_id {uuid} volume_prefix {path}
```

--------------------------------

### Get Device Info Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxMobile/zxsuite_mobile_getDeviceInfo.rst

Example command to retrieve detailed information for a specific device using the verbose flag.

```bash
zxsuite mobile getDeviceInfo john@example.com Appl79032X2WA4S verbose true
```

--------------------------------

### Set Provisioning Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxMobile/zxsuite_mobile_setProvisioning.rst

Example of setting the AllowDesktopSync property to true for a specific user account.

```bash
zxsuite mobile setProvisioning account john@example.com AllowDesktopSync true
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_policy_set_Pop3_domain.rst

An example of setting the ip_can_change parameter to true for the example.com domain.

```bash
carbonio auth policy set Pop3 domain example.com ip_can_change true
```

--------------------------------

### Get Available Accounts Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxBackup/zxsuite_backup_getAvailableAccounts.rst

Example command to list accounts from the last backup at a specific path, including deleted accounts.

```bash
zxsuite backup getAvailableAccounts date last backup_path /opt/zimbra/backup/zextras/ hide_deleted false
```

--------------------------------

### Get domain attribute

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_domain.rst

Example of retrieving a specific attribute for a domain.

```bash
carbonio config domain get domainName attribute debranded
```

--------------------------------

### Add Delegation Settings Examples

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxAdmin/zxsuite_admin_doAddDelegationSettings.rst

Examples demonstrating how to assign delegation rights and quotas to a user for a specific domain.

```bash
zxsuite admin doAddDelegationSettings john@example.com example.com viewMail true adminQuota -1
```

```bash
zxsuite admin doAddDelegationSettings john@example.com example.com adminQuota 0
```

```bash
zxsuite admin doAddDelegationSettings john@example.com example.com adminQuota 10gb
```

--------------------------------

### Example usage of get cos

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/config/carbonio_config_get_cos.rst

Retrieves the value of the attribute 'teamChatEnabled' for the COS named 'example_cos'.

```bash
carbonio config get cos example_cos teamChatEnabled
```

--------------------------------

### Get Quota Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxDrive/zxsuite_drive_getQuota.rst

Executes the command to retrieve quota information without specific filters.

```bash
zxsuite drive getQuota
```

--------------------------------

### Usage example for setProvisioning

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_setProvisioning.rst

Example command to enable desktop synchronization for a specific user account.

```bash
carbonio mobile setProvisioning account john@example.com AllowDesktopSync true
```

--------------------------------

### Get delegation settings usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxAdmin/zxsuite_admin_getDelegationSettings.rst

A simple execution of the command to retrieve current delegation settings.

```bash
zxsuite admin getDelegationSettings
```

--------------------------------

### Example usage of doCreateBucket

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_carboniocli/carbonio_core_doCreateBucket.rst

A practical example showing how to create an S3 bucket with specific credentials and endpoint.

```console
zextras$ carbonio core doCreateBucket S3 MyBucketName \
X58Y54E5687R543 abCderT577eDfjhf My_New_Bucket url \
https://example_bucket_provider.com
```

--------------------------------

### Authenticated REST Request via cURL

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/develop/rest-api-auth.rst

Example of using the ZM_AUTH_TOKEN cookie to authenticate a GET request to the inbox.

```console
 curl -k -X GET "https://srv_carbonio.loc/service/home/user@example.com/inbox?fmt=json" \
  --cookie "ZM_AUTH_TOKEN=0_2dc8d8078893890e1233178d5803b44c7ddb76d9_69643d33363a32623030313437392d353832312d346433302d623861322d3030336433633235643536643b6578703d31333a313735393038373939373439323b76763d313a303b747970653d363a7a696d6272613b753d313a613b7469643d31303a313830333934363332363b76657273696f6e3d383a636172626f6e696f3b637372663d313a313b"
```

```console
curl -k -X GET "https://srv_carbonio.loc/service/home/user@example.com/inbox?fmt=json" \
    --cookie "ZM_AUTH_TOKEN=<your_authToken>"
```

```console
curl -k -X GET "https://srv_carbonio.loc/service/home/user@example.com/?id=260&fmt=txt" \
    --cookie "ZM_AUTH_TOKEN=<your_authToken>"
```

```console
curl -k "https://srv_carbonio.loc/service/home/user@example.com/?fmt=ics" \
    --cookie "ZM_AUTH_TOKEN=TOKEN"
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_ABQ_list.rst

A simple example of how to list mobile devices using the ABQ command.

```bash
carbonio mobile ABQ list
```

--------------------------------

### Retrieve COS attribute value

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxConfig/zxsuite_config_get_cos.rst

Example usage of the zxsuite config get cos command to fetch the value of a specific attribute.

```bash
zxsuite config get cos example_cos teamChatEnabled
```

--------------------------------

### Start a service using zxsuite team

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_doStartService.rst

Basic syntax for starting a service via the command line.

```bash
zxsuite team doStartService *service_name*
```

--------------------------------

### Manage Carbonio service targets

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_installation/zmcontrol-systemd.rst

Use these commands to start, stop, or restart specific Carbonio component targets. These must be executed on the node where the component is installed.

```console
# systemctl start/stop/restart carbonio-directory-server.target
# systemctl start/stop/restart carbonio-appserver.target
# systemctl start/stop/restart carbonio-mta.target
# systemctl start/stop/restart carbonio-proxy.target
```

--------------------------------

### Usage Examples

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxMobile/zxsuite_mobile_setSharedFolderSync.rst

Examples demonstrating how to enable shared folder synchronization using an email address or a unique identifier.

```bash
zxsuite mobile setSharedFolderSync user@example.com 300 TRUE
```

```bash
zxsuite mobile setSharedFolderSync 3da53b28-d96d-4966-ae79-907b8553c13e 300 TRUE
```

--------------------------------

### Install Carbonio Playbook

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/install/ansible.rst

Use this command to install or update the Carbonio installation collection from Ansible Galaxy.

```console
# ansible-galaxy collection install zxbot.carbonio_install -U
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_credential_add.rst

An example of adding a credential with password, label, QR code, and service parameters.

```bash
carbonio auth credential add john@example.com password myPassword label myLabel qrcode false service eas,mobileApp
```

--------------------------------

### Usage example for zxsuite backup monitor

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxBackup/zxsuite_backup_monitor.rst

A simple example of invoking the monitor command.

```bash
zxsuite backup monitor
```

--------------------------------

### Create Custom S3 Bucket Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxCore/zxsuite_core_doCreateBucket_CustomS3.rst

A concrete example of the command usage with required parameters.

```bash
zxsuite core doCreateBucket CustomS3 bucketName accessKey secretKey url
https://host/service
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxPowerstore/zxsuite_powerstore_runBulkDelete.rst

A simple example of how to invoke the runBulkDelete command.

```bash
zxsuite powerstore runBulkDelete
```

--------------------------------

### Stop Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doStopService.rst

An example of the command usage.

```bash
carbonio powerstore doStopService
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_retrieveMetadataFromArchive_Local.rst

A practical example showing how to specify the source and destination directories for the metadata retrieval.

```bash
carbonio backup retrieveMetadataFromArchive Local /path/to/source/directory /path/to/destination/directory
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mobile/carbonio_mobile_deleteABQMessage_domain.rst

A practical example of deleting messages for a domain.

```bash
carbonio mobile deleteABQMessage domain example.com default
```

--------------------------------

### promoteAccounts usage example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/mailreplica/carbonio_mailreplica_promoteAccounts.rst

Example of executing the promoteAccounts command without additional parameters.

```bash
carbonio MailReplica promoteAccounts
```

--------------------------------

### Setup First Mesh Instance

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_admincli/mesh/generatecredentials.rst

Initialize the mesh service as the first instance using the previously defined password.

```console
# service-discover setup LEADER_IP --first-instance --password=$MESH_SECRET
```

--------------------------------

### doRestartService Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/backup/carbonio_backup_doRestartService.rst

A basic example of the command usage.

```bash
carbonio backup doRestartService
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/auth/carbonio_auth_token_list.rst

Example of how to list tokens using specific account and credential parameters.

```bash
carbonio auth token list {account} credential_id j18ai credential_label myCredential
```

--------------------------------

### Install Tasks package

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/architecture/components/component-tasks.rst

Required package for the Tasks component installation.

```bash
carbonio-tasks
```

--------------------------------

### Install carbonio-memcached

Source: https://github.com/zextras/tech-doc/blob/devel/source/_includes/_upgrade/second-part-ce.rst

Install the required memcached package for the Proxy component.

```console
# apt install carbonio-memcached
```

```console
# dnf install carbonio-memcached
```

--------------------------------

### Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/carbonio/cli_commands/powerstore/carbonio_powerstore_doCreateVolume_Centralized.rst

A basic example of creating a centralized volume using a hostname and volume name.

```bash
carbonio powerstore doCreateVolume Centralized hostname volumeName
```

--------------------------------

### zxsuite powerstore setProperty Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxPowerstore/zxsuite_powerstore_setProperty.rst

Example of the command invocation.

```bash
zxsuite powerstore setProperty
```

--------------------------------

### Example Usage

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxCore/zxsuite_core_doUpdateBucket_EMC.rst

A practical example of updating a bucket's name and access key.

```bash
zxsuite core doUpdateBucket EMC bucketName access_key accessKey
```

--------------------------------

### Stop Mobile Service Usage Example

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxMobile/zxsuite_mobile_doStopService.rst

An example of the command execution.

```bash
zxsuite mobile doStopService
```

--------------------------------

### Usage example for zxsuite team monitor

Source: https://github.com/zextras/tech-doc/blob/devel/source/cli/ZxTeam/zxsuite_team_monitor.rst

Basic execution example for the monitor command.

```bash
zxsuite team monitor
```
Tokens:
Raw