Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Welcome to Bamboozle WIKI and Document Library, our single source for information about all our products and services.
Bamboozle is an ISO 27001-certified, environmental friendly cloud service provider. The company, which was established in 2015 and is run by its founders, offers premium cloud services with a focus on simplicity, efficiency and price/performance for all kinds of companies.
The guest operating systems listed below have been tested and are supported in virtual machines.
Only the x64 architecture is supported.
Windows Server 2022
Essentials
No
No
Standard, Datacenter
Yes
Yes
Windows Server 2019
Essentials
No
No
Standard, Datacenter
Yes
Yes
Windows Server 2016
Essentials
No
No
Standard, Datacenter
Yes*
Yes
Windows Server 2012 R2
Essentials, Standard, Datacenter
Yes
Yes
Windows Server 2012
Standard, Datacenter
Yes
Yes
Windows Server 2008 R2
Standard, Datacenter
No
No
Windows 10
Home, Professional, Enterprise, Enterprise 2016 LTSB
No
No
Windows 8.1
Home, Professional, Enterprise
No
No
* CPU hot plug does not work properly due to a Windows bug with a wrongly installed driver.
Rocky Linux
8.x, 9.x
Yes
Yes
AlmaLinux
8.x, 9.x
Yes
Yes
CentOS
8.x, 9.x
Yes
Yes
Red Hat Enterprise Linux
8.x, 9.x
Yes
Yes
Debian
12.x, 11.x, 10.x
Yes
Yes
Ubuntu
20.04.x, 22.04.x, 24.04.x
Yes
Yes
Oracle Linux
8.x, 9.x
Yes
Yes
You can change amount of CPU and RAM resources used by a virtual machine by applying another flavor to it. To be able to resize a running VM, you need to enable CPU and RAM hot plug for it first. You can change the hot plug settings for both new and existing VMs.
A running virtual machine has a resize limit, which defines the maximum number of vCPUs and the maximum amount of RAM you can allocate to the VM. The resize limit on vCPUs is static and equal to 64 for all VMs. The resize limit on RAM, on the contrary, is dynamic and depends on the amount of RAM a running VM is currently using. This limit is updated on a VM startup, and its values are listed in the table below.
1-4
16
5-8
32
9-16
64
17-32
128
33-64
256
65-128
512
129-256
1024
For example, you can resize a running VM with a flavor that has 16 GiB to a flavor with 256 GiB in two iterations:
Resize the VM to a flavor with 64 GiB.
Restart the VM to update the RAM size limit.
Resize the VM to a flavor with 256 GiB.
Limitations
You cannot change the flavor for shelved VMs. To resize such a VM, unshelve it first.
You cannot decrease the number of CPUs and the amount of RAM for running VMs.
[For all Linux guests] If a VM has no guest tools installed, new cores may be offline after CPU hot plugging
Prerequisites
Before changing a flavor, ensure that the node hosting the VM has at least as much free CPU and RAM resources as the new VM size. For example, to resize a VM to the large flavor, the host must have at least 4 vCPUs and 8 GiB of RAM free.
CPU and RAM hot plug is enabled by the system administrator.
Before resizing a running VM, ensure that the guest operating system supports CPU and RAM hot plug (refer to Supported guest operating systems). Note that otherwise the guest operating system may become unstable after a resize. To increase CPU or RAM resources for such a guest operating system, you need to stop the virtual machine first.
Before resizing a running VM, ensure that the guest operating system has the latest updates installed.
To enable or disable CPU and RAM hot plug for a virtual machine
On the Virtual machines screen, ensure that the required virtual machine in the "Shut down" state, and then click it.
On the Overview tab, click the pencil icon in the CPU and RAM hot plug field.
If you do not see this field, CPU and RAM hot plug is disabled in your project. To enable it, contact your system administrator.
Select or clear the Enable hot plug check box, and then click the tick icon to save the changes.
With CPU and RAM hot plug enabled, you can change the flavor of a running VM.
To change the virtual machine flavor
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click the pencil icon in the Flavor field.
In the Flavor window, select a new flavor, and then click Done.
Once you create a virtual machine, you can manage its CPU and RAM resources, as well as network interfaces and volumes.
Prerequisites
Virtual machines are created, as described in Creating virtual machines.
Changing virtual machine resources
Each virtual machine (VM) is an independent system with an independent set of virtual hardware. Its main features are the following:
A virtual machine resembles and works like a regular computer. It has its own virtual hardware. Software applications can run in virtual machines without any modifications or adjustment.
Virtual machine configuration can be changed easily, for example, by adding new virtual disks or memory.
Although virtual machines share physical hardware resources, they are fully isolated from each other (file system, processes, sysctl variables) and the compute node.
A virtual machine can run any supported guest operating system.
The following table lists the current virtual machine configuration limits:
RAM
1 TiB
CPU
64 virtual CPUs
Storage
15 volumes, 512 TiB each
Network
15 NICs
Supported guest operating systems
Connecting to virtual machines
Managing virtual machine power state
Attaching ISO images to virtual machines
Reconfiguring virtual machines
Virtual machines are created, as described in Creating virtual machines.
To be able to connect via SSH, the virtual machine must have cloud-init and OpenSSH installed.
Select a VM, and then click Console on its right pane. The console will open in a separate browser window. In the console, you can send a key combination to a VM, take a screenshot of the console window, and download the console log (refer to Troubleshooting virtual machines).
During the launch an instance, a default user will be created, and this user will have no password set. Instead, your SSH key is copied to the VM and you will be able to login to the machine via SSH using the default username. The default username varies between Operating Systems. Here are the usernames for our official distributions:
To access a Windows Instance, use the RDP protocol and an RDP client for your operating system:
Windows: Remote Desktop
macOS: Microsoft Remote Desktop
Linux: FreeRDP
Specify the Pubic or Elastic IP address in the client and provide the default username Administrator and the password specified during the deployment.
Specify the username and VM IP or Elastic IP address in the SSH terminal:
Linux cloud images have the default login, depending on the operating system, for example, centos
or ubuntu
. To connect to a Windows VM, enter the username that you specified during Cloudbase-Init installation.
If you have deployed a VM without specifying an SSH key, you also need to enter a password to log in to the VM.
Prerequisites
Virtual machines are created, as described in Creating virtual machines.
To manage the power state of a virtual machine
Click the virtual machine or the ellipsis button next to it to see the full list of actions available for the current state.
To power up a VM, click Run.
To gracefully shut down a running VM, click Shut down. The default shutdown timeout, after which a virtual machine will be powered off, is 10 minutes.
To forcibly cut off power from a VM, click Power off.
To softly reboot a running VM, click Reboot.
To reboot a VM without the guest OS graceful shutdown, click Hard reboot.
To save the current VM state to a file, click Suspend. This may prove useful, for example, if you need to restart the host but do not want to quit the applications currently running in the VM or restart its guest OS.
To restore a VM from the suspended state, click Resume.
You can add new volumes to your virtual machines, attach existing volumes, and detach unneeded volumes from virtual machines.
Limitations
You cannot change, detach, or delete the boot volume.
You can only attach and detach non-boot volumes.
You cannot manage volumes of shelved VMs.
Prerequisites
To be able to use volumes attached to VMs, they must be initialized inside the guest OS by standard means.
To attach a volume to a virtual machine
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click the pencil icon in the Disks field.
In the Volumes window:
Click Attach to attach an existing volume, and then select the volume in the Attach volume window.
Click Add to create a new volume, and then specify the volume name, size, and storage policy. The created volume will be automatically added to the VM disks.
Click Done to finish editing VM disks and save your changes.
To detach a volume from a virtual machine
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click the pencil icon in the Disks field.
In the Volumes window:
Click Detach to detach a volume from a stopped virtual machine.
Click Force detach to detach a volume from a running virtual machine.
There is a risk of data loss.
Click Done to finish editing VM disks and save your changes.
You can attach ISO images to running or stopped virtual machines, for example, to install additional software inside them or to restore their operating system in the rescue mode. To attach an ISO image, you need to convert it to a volume, and then attach this volume to a VM.
When you finish installing software from an ISO volume, you can detach it without stopping the VM first.
To create a volume from an ISO image
On the Images screen, click the required ISO image.
On the image right pane, click Create volume.
In the Create volume from image window, specify a name for the volume, and then click Create.
To attach an ISO volume to a virtual machine
On the Virtual machines screen, click the required VM.
On the Overview tab, click the pencil icon in the Volumes field.
In the Volumes window, click Attach.
In the Attach volume window, select the created volume, and then click Attach. The attached volume will be marked as ISO.
In the Volumes window, click Done to save your changes.
The attached volume will appear inside the VM operating system.
To detach an ISO volume from a virtual machine
On the Virtual machines screen, click the required VM.
On the Overview tab, click the pencil icon in the Volumes field.
In the Volumes window, click the ellipsis icon next to the ISO volume, and then click Force detach.
Click Done to save your changes.
Prerequisites
Virtual machines are created, as described in Creating virtual machines.
To monitor virtual machine’s CPU, storage, and network usage
Select the VM and open the Monitoring tab.
The default time interval for the charts is twelve hours. To zoom into a particular time interval, select the internal with the mouse; to reset zoom, double-click any chart.
The following performance charts are available:
CPU / RAMCPU and RAM usage by the VM.NetworkIncoming and outgoing network traffic.Storage read/writeAmount of data read and written by the VM.Read/write latencyRead and write latency. Hovering the mouse cursor over a point on the chart, you can also see the average and maximum latency for that moment, as well as the 95 and 99 percentiles.
Averaged values are calculated every five minutes.
You can unbind a stopped VM from the node it is hosted on and release its reserved resources such as CPU and RAM. A shelved VM remains bootable and retains its configuration, including the IP addresses.
Prerequisites
Virtual machines are created, as described in Creating virtual machines.
To shelve a virtual machine
Click the desired virtual machine.
If the VM is stopped, click Shelve on its right pane.
If the VM is running or suspended, click Shut down or Power off on its right pane, and then select Shelve virtual machine in the confirmation window.
To spawn a shelved VM on a node with enough resources to host it
Click a shelved virtual machine.
On the VM right pane, click Unshelve.
You can add new network interfaces to your virtual machines, edit IP addresses and security groups for the existing interfaces, and remove network interfaces by detaching them.
Limitations
You cannot manage network interfaces of shelved VMs.
A VM that is connected to a dual-stack network always receives an IPv6 address, if the IPv6 subnet is in the SLAAC or DHCPv6 stateless mode.
To attach a network interface to a virtual machine
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click Edit in the Network interfaces section.
In the Network interfaces window, click Add to attach a network interface.
In the Add network interface window, select a compute network to connect to, and then specify MAC address, IPv4 and/or IPv6 addresses, and security groups. By default, MAC and primary IP addresses are assigned automatically. To specify them manually, clear the Assign automatically check boxes, and enter the desired addresses. Optionally, assign additional IP addresses to the network interface in the Secondary IP addresses section. Note that a secondary IPv6 address is not available for an IPv6 subnet that works in the SLAAC or DHCPv6 stateless mode.
Secondary IP addresses, unlike the primary one, will not be automatically assigned to the network interface inside the virtual machine guest OS. You should assign them manually.
If you selected a virtual network with enabled IP address management
If you selected a virtual network with disabled IP address management
If you selected a shared physical network
After specifying the network interface parameters, click Add.
Click Done to finish editing VM network interfaces and save your changes.
To edit a network interface of a virtual machine
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click Edit in the Network interfaces section.
In the Network interfaces window, click the ellipsis button next to the interface you want to edit, and then click Edit.
In the Edit network interface window, modify the network interface parameters as follows:
Change the primary IP address. To update the address inside the VM guest OS, restart the network interface.
Add or remove secondary IP addresses.
Modify security groups assigned to the VM.
After updating the required parameters, click Save.
Click Done to finish editing VM network interfaces and save your changes.
To detach a network interface from a virtual machine
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click Edit in the Network interfaces section.
In the Network interfaces window, click the ellipsis button next to the interface you want to detach, and then click Remove.
Click Done to finish editing VM network interfaces and save your changes.
You have a guest OS source prepared, as described in Managing images.
One or more compute networks are created by using the instructions in Managing virtual networks.
Custom security groups are configured, as instructed in Managing security groups.
An SSH key is added, as outlined in Managing SSH keys. You can specify an SSH key only when creating VMs from a template or boot volume.
On the Virtual machines screen, click Create virtual machine. A window will open where you will need to specify the VM parameters.
Specify a name for the new VM.
Select the VM boot media:
If you have an ISO image or a template
If you have a compute boot volume
If you select an image or volume with an assigned placement, the created VM will also inherit this placement.
After selecting the boot media, volumes required for this media to boot will be automatically added to the Volumes section.
Configure the VM disks:
In the Volumes window, make sure the default boot volume is large enough to accommodate the guest OS. Otherwise, click the ellipsis icon next to it, and then Edit. Change the volume size and click Save.
Add more disks to the VM by creating or attaching volumes. To do this, click the pencil icon in the Volumes section, and then Add or Attach in the Volumes window.
Select volumes that will be removed during the VM deletion. To do this, click the pencil icon in the Volumes section, click the ellipsis icon next to the needed volume, and then Edit. Enable Delete on termination and click Save.
When you finish configuring the VM disks, click Done.
Choose the amount of RAM and CPU resources that will be allocated to the VM in the Flavor section. In the Flavor window, select a flavor, and then click Done.
When choosing a flavor for a VM, ensure it satisfies the hardware requirements of the guest OS.
To select a flavor with an assigned placement, you can filter flavors by placement. The VM created from such a flavor will also inherit this placement
Add network interfaces to the VM in the Networks section:
In the Network interfaces window, click Add to attach a network interface.
In the Add network interface window, select a compute network to connect to, and then specify MAC address, IPv4 and/or IPv6 addresses, and security groups. By default, MAC and primary IP addresses are assigned automatically. To specify them manually, clear the Assign automatically check boxes, and enter the desired addresses. Optionally, assign additional IP addresses to the network interface in the Secondary IP addresses section. Note that a secondary IPv6 address is not available for an IPv6 subnet that works in the SLAAC or DHCPv6 stateless mode.
Secondary IP addresses, unlike the primary one, will not be automatically assigned to the network interface inside the virtual machine guest OS. You should assign them manually.
If you selected a virtual network with enabled IP address management
If you selected a virtual network with disabled IP address management
If you selected a shared physical network
After specifying the network interface parameters, click Add. The network interface will appear in the Network interfaces list.
If required, edit IP addresses and security groups of newly added network interfaces. To do this, click the ellipsis icon, click Edit, and then set the parameters.
When you finish configuring the VM network interfaces, click Done.
If you have chosen to boot from a template or volume, which has cloud-init and OpenSSH installed:
As cloud images have no default password, you can access VMs deployed from them only by using the key authentication method with SSH.
Add an SSH key to the VM, to be able to access it via SSH without a password.
Add user data to customize the VM after launch, for example, change a user password.
Enable CPU and RAM hot plug for the VM in Advanced options, to be able to change its flavor when the VM is running. You can also enable hot plug after the VM is created.
If you do not see this option, CPU and RAM hot plug is disabled in your project. To enable it, contact your system administrator.
If you have chosen to boot from an ISO image, enable UEFI boot in Advanced options, to be able to boot the VM in the UEFI mode. This option cannot be configured after the VM is created.
You cannot configure UEFI boot if you have selected a template as the VM boot media. If your template has UEFI boot enabled, the option is automatically enabled for the VM, and vice versa.
After configuring all of the VM parameters, click Deploy to create and boot the VM.
If you are deploying the VM from an ISO image, you need to install the guest OS inside the VM by using the built-in VNC console. For VMs with UEFI boot enabled, open the VNC console, and then press any key to boot from the chosen ISO image. Virtual machines created from a template or a boot volume already have a preinstalled guest OS.
If a VM experiences boot problems, you can send it to the rescue mode to access its boot volume. When a VM in the “Active” state is sent to the rescue mode, it is shut down softly first. Once the VM is in the rescue mode, you can connect to it via SSH or via the console. Its previous boot disk is now attached as a secondary one. You can mount the disk and repair it.
Limitations
The rescue mode can use ISO images for booting both Linux and Windows virtual machines and QCOW2 images (templates) for booting Linux VMs.
You can send a VM to the rescue mode only if its current status is “Active” or “Shut down”.
There are only three actions available for the VM in the rescue mode: Console, Exit rescue mode, and Delete.
If a rescue image has cloud-init installed, then the VM booted from it can be accessed with the same SSH key that was used for its creation.
Prerequisites
To put a virtual machine to the rescue mode
On the Virtual machines screen, click the required VM on the list.
On the VM right pane, click the ellipsis button on the toolbar. Then, click Enter rescue mode.
In the Enter rescue mode window, select an image to rescue the VM with. By default, the initial image used for creating the VM is selected. Click Enter.
The machine status changes to “Rescue”.
To return a virtual machine to normal operation
On the Virtual machines screen, click the required VM on the list.
On the VM right pane, click Exit rescue mode.
In the Exit rescue mode window, click Exit. The VM will be automatically rebooted.
The VM status changes to “Active” and it boots from the original root disk.
If the VM status changes to “Error” when exiting the rescue mode, you can reset its status with the Reset state action. The VM should then return to the “Rescue” status again.
To exit the rescue mode for a Windows VM
There might be an issue of exiting the rescue mode for a Windows VM. If in the rescue mode you set the original system disk online, its ID becomes the same as that of the rescue disk. Then, when you try to exit the rescue mode, the boot loader cannot find the proper boot disk. To resolve the ID conflict, follow the steps:
With the VM in the rescue mode, open the Disk Management window and note the numbers of the original system disk (offline) and the rescue disk (online). Set the original system disk to Online.
To edit the boot configuration, enter the following command in the Command Prompt window:
Review the output and check that the rescue disk is the target for objects in the output (partition=<the rescue disk name>
).
If the objects do not point to drive C, fix it with the following commands:
To view the available disks, enter the following commands in the command line:
Match the disk number and name to those displayed in the Disk Management window.
To get the ID of the rescue disk, run the following commands:
Record the disk ID, you will need it later.
Change this ID by using the following command:
Make sure that the value has changed with the UNIQUEID DISK
command.
Assign the ID that you recorded previusly to the original system disk:
Make sure that the value has changed with the UNIQUEID DISK
command.
You should now be able to exit the rescue mode.
This section explains how to install and uninstall the guest tools. This functionality is required for creating consistent snapshots of a running VM’s disks.
Limitations
Guest tools rely on the QEMU guest agent that is installed alongside the tools. The agent service must be running for the tools to work.
Prerequisites
The virtual machine has a guest operating system installed.
Virtual machines are created, as described in .
Virtual machines are created, as described in .
If a virtual machine fails to deploy
Review the error message on the VM right pane. One of the possible root causes is that compute nodes lack free RAM or CPU resources to host the VM.
If a virtual machine is in the error state
Examine the VM history in the History tab on the VM right pane. The event log will contain all of the VM management operations performed by users in the user or command-line interface. You can expand each log entry to view operation details by clicking the arrow icon next to it. The details include the operation name, date and time, status, initiator, and request ID.
If a virtual machine is stuck in a failed or transitional state
Reset the VM to its last stable state: active, shut down or shelved:
Click the stuck VM.
On the VM right pane, click Reset state.
If a virtual machine fails to boot
Examine the VM console log by clicking Download console log on the VM right pane. The log will contain log messages only if logging is enabled inside the VM (refer to Enabling logging for virtual machines).
You cannot delete a security group if it is assigned to a VM.
On the Security groups screen, click Add security group.
In the Add security group window, specify a name and description for the group, and then click Add.
By default, the new security group will deny all incoming traffic and allow only outgoing traffic to assigned virtual machines.
On the Security groups screen, click the required security group.
On the group right pane, click Delete.
Click Delete in the confirmation window.
If you find out that the guest tools are incompatible with some software inside a virtual machine, you can uninstall them by doing the following:
Inside a Windows VM:
Remove the QEMU device drivers from the device manager.
Do not remove the VirtIO/SCSI hard disk driver and NetKVM network driver. Without the former, the VM will not boot; without the latter, the VM will lose network connectivity.
Uninstall the QEMU guest agent and guest tools from the list of installed applications.
Stop and delete Guest Tools Monitor:
Unregister Guest Tools Monitor from Event Log:
Delete the autorun registry key for RebootNotifier:
Delete the C:\Program Files\Qemu-ga\ directory.
If VzGuestToolsMonitor.exe is locked, close all the Event Viewer windows. If it remains locked, restart the eventlog
service:
After removing the guest tools, restart the virtual machine.
Inside a Linux VM:
Remove the packages:
On RPM-based systems (CentOS and other):
On DEB-based systems (Debian and Ubuntu):
If any of the packages listed above are not installed on your system, the command will fail. In this case, exclude these packages from the command and run it again.
Remove the files:
Reload the udev
rules:
After removing guest tools, restart the virtual machine.
Create a compute volume from the vz-guest-tools-win or vz-guest-tools-lin image, depending on the VM operating system:
On the Images screen, click the vz-guest-tools-win or vz-guest-tools-lin image.
On the image right pane, click Create volume.
In the Create volume from image window, specify a name for the volume, and then click Create.
Attach the volume with the guest tools to the virtual machine:
On the Virtual machines screen, click the required VM.
On the VM right pane, click the pencil icon in the Volumes field.
In the Volumes window, click Attach.
In the Attach volume window, select the created volume with the guest tools, and then click Attach. The attached volume will be marked as ISO.
In the Volumes window, click Done, to save your changes.
Log in to the virtual machine.
Inside the VM, do the following:
Inside a Windows VM, go to the mounted optical drive in Explorer and install the guest tools by running setup.exe. After the installation is complete, restart the VM.
Inside a Linux VM, create a mount point for the optical drive with the guest tools image and run the installer:
Limitations
A VM is removed along with its disks that have the Delete on termination option enabled during the VM deployment.
Prerequisites
Virtual machines are created, as described in Creating virtual machines.
To remove one virtual machine
Click the ellipsis button next to a VM you want to delete, and then click Delete.
Click Delete in the confirmation window.
To remove multiple virtual machines
Select the check boxes next to VMs you want to delete.
Over the VM list, click Delete.
Click Delete in the confirmation window.
A security group is a set of network access rules that control incoming and outgoing traffic to virtual machines assigned to this group. With security group rules, you can specify the type and direction of traffic that is allowed access to a virtual interface port. Traffic that does not satisfy any rule is dropped.
For each project, the default security group is automatically created in the compute cluster. This group allows all traffic on all ports for all protocols and cannot be deleted. When you attach a network interface to a VM, the interface is associated with the default security group, unless you explicitly select a custom security group.
You can assign one or more security groups to both new and existing virtual machines. When you add rules to security groups or remove them, the changes are enforced at runtime.
You can manage only IPv4 security group rules.
You can modify security groups by adding and removing rules. Editing rules is not available. If you need to change the existing rule, remove it and recreate with the required parameters.
You have a security group created, as described in Creating and deleting security groups.
On the Security groups screen, click the security group to add a rule to.
On the group right pane, click Add in the Inbound or Outbound section to create a rule for incoming or outgoing traffic.
Specify the rule parameters:
Select a protocol from the list or enter a number from 0 to 255.
Enter a single port or a port range. Some protocols already have a predefined port range. For example, the port for SSH is 22.
Select a predefined subnet CIDR or an existing security group.
Click the check mark to save the changes.
As soon as the rule is created, it is applied to all of the virtual machines assigned to the security group.
On the Security groups screen, click the required security group.
On the group right pane, click the bin icon next to a rule you want to remove.
As soon as the rule is removed, this change is applied to all of the virtual machines assigned to the security group.
When you create a VM, you select security groups for the VM network interfaces. You can also change assigned security groups later.
You cannot configure security groups if spoofing protection is disabled or IP address management is disabled for the selected network.
On the Security groups screen, click the required security group.
On the group right pane, navigate to the Assigned VMs tab. All the assigned virtual machines will be shown along with their status.
You can click the VM name to go to the VM Overview pane and change the security group assignment for its network interfaces.
On the Virtual machines screen, click the required virtual machine.
On the Overview tab, click the pencil icon in the Networks section.
Click the ellipsis icon next to the network interface to assign a security group to, and then click Edit.
In the Edit network interface window, go to the Security groups tab.
Select one or more security groups from the drop-down list, and then click Save.
The rules from chosen security groups will be applied at runtime.
Virtuozzo Hybrid Infrastructure allows you to upload ISO images and templates that can be used to create VM volumes:
Please note a lot of templates are already installed and ready to be deployed right away. Check first if a OS Image is already available before creating a new one.
An ISO image is a typical OS distribution that needs to be installed on disk. You can upload an ISO image to the compute cluster.
A template is a ready boot volume in the QCOW2 format with an installed operating system and applications. Many OS vendors offer templates of their operating systems under the name “cloud images”. You can upload a cloud image from the OS official repository or prepare your own template in the compute cluster.
Knowledge of the supported guest operating systems listed in Supported guest operating systems.
On the Images screen, click Add image.
In the Add image window, do the following:
Click Browse and select a file in one of the supported formats: .iso, .img, .qcow2, .raw.
Specify an image name to be shown in the admin panel.
Select the correct OS type from the drop-down list.
The OS type affects VM parameters such as hypervisor settings. VMs created from an image with an incorrect OS type may not work correctly, for example, they may crash
If you have chosen an image in the QCOW2, RAW, or IMG format, select the UEFI boot check box, to mark the image as UEFI bootable. This option cannot be configured after the image is uploaded.
Click Add to start uploading the image. The upload progress will be shown in the bottom right corner.
You can hide the pop-up window without interrupting the upload process. The upload progress will be available in the notification center.
You can create volumes from both ISO images and templates.
Go to the Images screen, and then click the required image.
On the image panel, click Create volume.
In the Create volume window, specify the volume name, size, and select a storage policy.
Click Create.
The new volume will appear on the Volumes screen.
To rescue a virtual machine
To create a VM accessible via SSH
To create a VM customizable with user data
Install cloud-init and OpenSSH Server in the virtual machine.
Enable logging for virtual machines that will be created from the template.
Convert the VM boot volume to the template, as described in Creating images from volumes.
As all Linux guests have OpenSSH Server preinstalled by default, you only need to make sure a Linux template has cloud-init installed.
The easiest way to get a Linux template with cloud-init installed is to obtain it from its official repository. You can also create a Linux template from an existing boot volume.
A volume in Bamboozle Cloud (Public and Private) is a virtual disk drive that can be attached to a virtual machine. The integrity of data in volumes is protected by the redundancy mode specified in the storage policy.
Attaching and detaching volumes
Windows guests have neither Cloudbase-Init nor OpenSSH Server preinstalled by default. You need to install and configure them manually.
Log in to a Windows VM.
Create a new administrator account that will be used for SSH connections and log in with it.
To install and configure OpenSSH Server:
Run Windows PowerShell with administrator privileges and set the execution policy to unrestricted to be able to run scripts:
Download OpenSSH Server (for example, from the GitHub repository), extract the archive into the C:\Program Files directory, and then install it by running:
Start the sshd
service and set its startup type to “Automatic”:
Open TCP port 22 for the OpenSSH service in the Windows Firewall:
On Windows 8.1, Windows Server 2012, and newer versions, run:
On Windows Server 2008/2008 R2, run:
Open the C:\ProgramData\ssh\sshd_config file:
Comment out the following lines at the end of the file:
Save the changes.
Create the .ssh directory in C:\Users\<current_user> and an empty authorized_keys file inside it:
Remove the .txt extension from the created file:
Modify the permissions for the created file to disable inheritance:
Download Cloudbase-Init from https://cloudbase.it/cloudbase-init/#download, and then install it by following the procedure from the Installation section at https://cloudbase.it/cloudbase-init/.
The password for the user specified during the Cloudbase-Init installation will be reset on the next VM startup. If this user does not exist, a new user account will be created. You will be able to log in with this account by using the key authentication method or you can set a new password with a customization script. If there are multiple Windows users at the image preparation time, the passwords for other users will not be changed.
When the Cloudbase-Init installation is complete, do not select the option to run Sysprep before clicking Finish. Otherwise, you will not be able to modify cloudbase-init.conf.
Run Windows PowerShell with administrator privileges and open the file C:\Program Files\Cloudbase Solutions\Cloudbase-Init\conf\cloudbase-init.conf:
Add metadata_services
and plugins
on two lines:
Make sure to remove all backslashes in the lines above.
Save the changes.
A volume is removed along with all of its snapshots.
On the Volumes screen, click Create volume.
In the Create volume window, specify a volume name and size in gigabytes, select a storage policy, and then click Create.
On the Volumes tab, check the status of the volume you want to remove.
If the status is "In use", click the volume, and then click Force detach.
If the status is "Available", click the volume, and then click Delete.
The console log of a virtual machine can be used for troubleshooting boot issues. The log contains messages only if logging is enabled inside the VM, otherwise the log is empty.
The logging can be turned on by enabling the TTY1 and TTYS0 logging levels in Linux VMs and Emergency Management Services (EMS) console redirection in Windows VMs. You may also enable driver status logging in Windows VMs, to see the list of loaded drivers. This can be useful for troubleshooting a faulty driver or long boot process.
Add the line GRUB_CMDLINE_LINUX_DEFAULT="console=tty1 console=ttyS0"
to the file /etc/default/grub.
Depending on the boot loader, run either
or
Reboot the VM.
Start Windows PowerShell by using administrator privileges.
In the PowerShell console, set the COM port and baud rate for EMS console redirection. As Windows VMs have only the COM1 port with the transmission rate of 9600 bps, run:
Enable EMS for the current boot entry:
Start System Configuration by using administrator privileges.
In the System Configuration windows, open the Boot tab, and select the check boxes OS boot information and Make all boot settings permanent.
Confirm the changes and restart the system.
You can change volume size only by increasing it. Volumes can be extended for both running (online resizing) and stopped (offline resizing) virtual machines. Online volume resizing allows users to avoid downtime and enables scaling VM storage capacity on the fly without service interruption.
You cannot shrink volumes.
During volume resizing, the file system inside the guest OS is not extended.
If you revert a volume to a snapshot that was taken before the volume extension, the new volume size will be retained.
A volume is created, as described in Creating and deleting volumes.
On the Volumes screen, click a volume.
Click the pencil icon in the Size field.
Enter the desired volume capacity, and then click the tick icon.
After the volume is extended, you will need to re-partition the disk inside the guest OS to allocate the added disk space.
Limitations
You can only attach and detach non-boot volumes.
Prerequisites
A volume is created, as described in Creating and deleting volumes.
To be able to use volumes attached to VMs, they must be initialized inside the guest OS by standard means.
To attach a volume to a virtual machine
On the Volumes screen, click an unused volume.
On the volume right pane, click Attach.
In the Attach volume window, select the VM from the drop-down list, and then click Done.
To detach a volume from a virtual machine
On the Volumes screen, click a volume that is in use.
If the VM is stopped, click Detach on the volume right pane.
If the VM is running, click Force detach on the volume right pane.
There is a risk of data loss.
To create multiple VMs with the same boot volume, you can create a template from an existing boot volume and deploy VMs from it.
Linux virtual machines have cloud-Init installed, as described in Preparing Linux templates.
Windows virtual machines have Cloudbase-Init and OpenSSH Server installed, as described in Preparing Windows templates.
Logging is enabled inside a virtual machine, as instructed in Enabling logging for virtual machines.
Power off the VM that the original volume is attached to.
Switch to the Volumes screen, click volume’s ellipsis button and select Create image.
In the Create image window, enter an image name, and then click Create
The new image will appear on the Images screen.
You can save the current state of a VM file system or user data by creating a snapshot of a volume. A snapshot of a boot volume may be useful, for example, before updating VM software. If anything goes wrong, you will be able to revert the VM to a working state at any time. A snapshot of a data volume can be used for backing up user data and testing purposes.
On the Volumes screen, click a volume.
In the volume right pane, switch to Snapshots, and then click Create snapshot.
Select a volume and open the Snapshots tab on its right pane.
You can do the following:
Create a new volume from the snapshot.
Create a template from the snapshot.
Discard all changes that have been made to the volume since the snapshot was taken. This action is available only for VMs with the "Shut down" and "Shelved offloaded" statuses.
As each volume has only one snapshot branch, all snapshots created after the snapshot you are reverting to will be deleted. If you want to save a subsequent snapshot before reverting, create a volume or an image from it first.
Change the snapshot name and description.
Reset the snapshot stuck in an "Error" state or transitional state to the "Available" state.
Remove the snapshot.
To perform these actions, click the ellipsis button next to a snapshot, and then click the corresponding action.
To create a consistent snapshot of a running VM’s volume, the guest tools must be installed in the VM, as described in . The QEMU guest agent included in the guest tools image automatically quiesces the filesystem during snapshotting.
You can clone volumes that are not attached to VMs or attached to stopped VMs.
A volume is created, as described in Creating and deleting volumes.
On the Volumes screen, click a volume.
On the volume right pane, click Clone.
In the Clone volume window, specify a volume name, size, and storage policy. Click Clone.
You can delete a compute network only if no VMs are connected to it.
On the Networks screen, click Create virtual network.
On the Network configuration step, do the following:
Enable or disable IP address management:
With IP address management enabled, VMs connected to the network will automatically be assigned IP addresses from allocation pools by the built-in DHCP server and use custom DNS servers. Additionally, spoofing protection will be enabled for all VM network ports by default. Each VM network interface will be able to accept and send IP packets only if it has IP and MAC addresses assigned. You can disable spoofing protection manually for a VM interface, if required.
With IP address management disabled, VMs connected to the network will obtain IP addresses from the DHCP servers in that network, if any. Also, spoofing protection will be disabled for all VM network ports, and you cannot enable it manually. This means that each VM network interface, with or without assigned IP and MAC addresses, will be able to accept and send IP packets.
In any case, you will be able to manually assign static IP addresses from inside the VMs.
Specify a name, and then click Next.
If you enabled IP address management, you will move on to the IP address management step, where you can add an IPv4 subnet:
In the Subnets section, click Add and select IPv4 subnet.
In the Add IPv4 subnet window, specify the network’s IPv4 address range and, optionally, specify a gateway. If you leave the Gateway field blank, the gateway will be omitted from network settings.
Enable or disable the built-in DHCP server:
With the DHCP server enabled, VM network interfaces will automatically be assigned IP addresses: either from allocation pools or, if there are no pools, from the network’s entire IP range. The DHCP server will receive the first two IP addresses from the IP pool. For example:
In a subnet with CIDR 192.168.128.0/24 and without a gateway, the DHCP server will be assigned the IP addresses 192.168.128.1 and 192.168.128.2.
In a subnet with CIDR 192.168.128.0/24 and the gateway IP address set to 192.168.128.1, the DHCP server will be assigned the IP addresses 192.168.128.2 and 192.168.128.3.
With the DHCP server disabled, VM network interfaces will still get IP addresses, but you will have to manually assign them inside VMs.
The virtual DHCP service will work only within the current network and will not be exposed to other networks.
Specify one or more allocation pools (ranges of IP addresses that will be automatically assigned to VMs).
Specify DNS servers that will be used by virtual machines. These servers can be delivered to VMs via the built-in DHCP server or by using the cloud-init network configuration (if cloud-init is installed in the VM).
Click Add.
On the Summary step, review the configuration, and then click Create virtual network.
On the Networks screen, click the required network.
On the network right pane, click the pencil icon next to the network name or IPv4 subnet.
Make changes and save them.
To delete a compute network
Click the ellipsis icon next to the required network, and then click Delete. To remove multiple compute networks at once, select them, and then click Delete.
After a VPN connection is created, you can change its endpoint groups and VPN settings at any time.
You cannot change the virtual router and security policies used to establish a VPN connection.
A VPN connection is created, as described in Creating VPN connections.
To edit a VPN connection
On the VPN screen, click a VPN connection to modify.
On the connection right pane, click Edit.
In the Edit VPN window, configure local and remote endpoints, if required, and then click Next.
On the next step, change VPN parameters such as the VPN connection name, peer IP address, and PSK key. If necessary, you can also configure additional settings by selecting Advanced settings and editing the required parameters.
Click Save to apply your changes.
After you update the connection parameters, its status will change to "Down". The connection will re-initiate once the parameters are similarly updated by the other VPN party.
The IKE and IPsec configuration must match for both communicating parties. Otherwise, the VPN connection between them will not be established.
You have a virtual router created, as described in Managing virtual routers.
The virtual router connects the physical network with virtual networks that you want to be exposed.
Networks that will be connected via a VPN tunnel must have non-overlapping IP ranges.
[For Virtuozzo Hybrid Infrastructure 5.4 Update 1 and earlier versions] If a virtual machine has a floating IP address assigned to its private network interface, configure static routes of a virtual router, for the VM traffic to be routed through a VPN tunnel.
On the VPN screen, click Create VPN.
On the Configure IKE step, specify parameters for the IKE policy that will be used to establish a VPN connection. You can choose to use an existing IKE policy or create a new one. For the new IKE policy, do the following:
Specify a custom name for the IKE policy.
Specify the key lifetime, in seconds, that will define the rekeying interval. The IKE key lifetime must be greater than that of the IPsec key.
Select the authentication algorithm that will be used to verify the data integrity and authenticity.
Select the encryption algorithm that will be used to ensure that data is not viewable while in transit.
Select the IKE version 1 or 2. Version 1 has limitations, for example, it does not support multiple subnets.
Select the Diffie-Hellman (DH) group that will be used to build the encryption key for the key exchange process. Higher group numbers are more secure but require additional time for the key to compute.
Click Next.
On the Configure IPsec step, specify parameters for the IPsec policy that will be used to encrypt the VPN traffic. You can choose to use an existing IPsec policy or create a new one. For the new IPsec policy, do the following:
Specify a custom name for the IPsec policy.
Specify the key lifetime, in seconds, that will define the rekeying interval. The IPsec key lifetime must not be greater than that of the IKE key.
Select the authentication algorithm that will be used to verify the data integrity and authenticity.
Select the encryption algorithm that will be used to ensure that data is not viewable while in transit.
Select the Diffie-Hellman (DH) group that will be used to build the encryption key for the key exchange process. Higher group numbers are more secure but require additional time for the key to compute.
Click Next.
On the Create endpoint groups step, select a virtual router and specify local and remote subnets that will be connected by the VPN tunnel. You can choose to use existing local and remote endpoints, or create new ones. For the new endpoints, do the following:
Specify a custom name for the local endpoint, and then select local subnets.
Specify a custom name for the remote endpoint, and then add remote subnets in the CIDR format.
Click Next.
On the Configure VPN step, specify parameters to establish the VPN connection with a remote gateway:
Specify a custom name for the VPN connection.
Specify the public IPv4 address of the remote gateway, that is, peer IP address.
Generate the pre-shared key that will be used for the peer authentication.
If necessary, you can also configure additional settings by selecting Advanced settings and specifying the following parameters:
The peer ID for authentication and the mode for establishing a connection.
The Dead Peer Detection (DPD) policy, interval, and timeout, in seconds.
Click Next.
On the Summary step, review the configuration, and then click Create.
When the VPN connection is created, its status will change from "Pending creation" to "Down". The connection will become active once the VPN tunnel is configured by the other VPN party and the IKE authorization is successful.
The IKE and IPsec configuration must match for both communicating parties. Otherwise, the VPN connection between them will not be established.
You can forcefully re-initiate a VPN connection by manually restarting it. When you delete a VPN connection, you also delete the IKE and IPsec policies and endpoint groups that were created during the VPN creation.
Prerequisites
A VPN connection is created, as described in Creating VPN connections.
To restart a VPN connection
On the VPN screen, click a VPN connection to restart.
On the connection right pane, click Restart.
Click Restart VPN in the confirmation window.
To delete a VPN connection
On the VPN screen, click a VPN connection to delete.
On the connection right pane, click Delete.
Click Delete in the confirmation window.
Virtual routers provide L3 services such as routing and Source Network Address Translation (SNAT) between virtual and physical networks, or different virtual networks:
A virtual router between virtual and physical networks provides access to public networks, such as the Internet, for VMs connected to this virtual network.
A virtual router between different virtual networks provides network communication for VMs connected to these virtual networks.
A virtual router has two types of ports:
An external gateway that is connected to a physical network.
An internal port that is connected to a virtual network.
With virtual routers, you can do the following:
Create virtual routers
Change external or internal router interfaces
Create, edit, and delete static routes
Change a router name
Delete a router
A router can only connect networks that have IP management enabled.
You can delete a virtual router if no floating IP addresses are associated with any network it is connected to.
Compute networks are created, as described in Managing virtual networks.
The compute networks that are to be connected to a router have a gateway specified.
Navigate to the Routers screen, and then click Add router.
In the Add router window:
Specify a router name.
From the Network drop-down menu, select a physical network through which external access will be provided via an external gateway. The new external gateway will pick an unused IP address from the selected physical network.
In the Add internal interfaces section, select one or more virtual networks to connect to a router via internal interfaces. The new internal interfaces will attempt to use the gateway IP address of the selected virtual networks by default.
Select or deselect the SNAT check box to enable or disable SNAT on the external gateway of the router. With SNAT enabled, the router replaces VM private IP addresses with the public IP address of its external gateway.
Click Create.
With Virtual Private Network (VPN) as a service, users can extend virtual networks across public networks, such as the Internet. To connect two or more remote endpoints, VPNs use virtual connections tunneled through physical networks. To secure VPN communication, the traffic that flows between remote endpoints is encrypted. The VPN implementation uses the Internet Key Exchange (IKE) and IP Security (IPsec) protocols to establish secure VPN connections and is based on the strongSwan IPsec solution.
VPN as a service can be used to establish a Site-to-Site VPN connection between a virtual network configured in Bamboozle Cloud and any other network with a VPN gateway that uses the IPsec and IKE protocols. With VPN as a service, you can connect the following workloads:
On-premises workloads with workloads hosted in Bamboozle Cloud
Workloads hosted in other clouds with workloads hosted in Bamboozle Cloud
Workloads hosted in different Bamboozle Cloud Locations
To better understand how a VPN works, consider the following example:
In the cluster 1, the virtual machine VM1 is connected to the virtual network privnet1 (192.168.10.0/24) via the network interface with IP address 192.168.10.10. The network privnet1 is exposed to public networks via the router router1 with the external port 10.10.10.5.
In the cluster 2, the virtual machine VM2 is connected to the virtual network privnet2 (192.168.20.0/24) via the network interface with IP address 192.168.20.20. The network privnet2 is exposed to public networks via the router router2 with the external port 10.10.10.4.
The VPN tunnel is created between the routers router1 and router2 that serve as VPN gateways, thus allowing mutual connectivity between the networks privnet1 and privnet2.
The virtual machines VM1 and VM2 are visible to each other at their private IP addresses. That is, VM1 can access VM2 at 192.168.20.20, and VM2 can access VM1 at 192.168.10.10.
For key exchange between communicating parties, two IKE versions are available: IKE version 1 (IKEv1) and IKE version 2 (IKEv2). IKEv2 is the latest version of the IKE protocol and it supports connecting multiple remote subnets.
In the example above:
VPN1 uses the IKEv1 and connects the network network1 with the network3.
VPN2 uses the IKEv2 and connects the network network2 with the two networks network4 and network5.
Currently, we support only Site-to-Site VPN connections. Point-to-Site VPN connections are not supported.
If you already have an external gateway, remove the existing one first.
On the Routers screen, click the router name. Open the Interfaces tab to view the list of its interfaces.
Click Add on the toolbar, or click Add interface if there are no interfaces to show.
In the Add interface window, do the following:
Select External gateway.
From the Network drop-down menu, select a physical network to connect to the router. The new interface will pick an unused IP address from the selected physical network. You can also provide a specific IP address from the selected physical network to assign to the interface in the IP address field.
Select or deselect the SNAT check box to enable or disable SNAT on the external gateway of the router. With SNAT enabled, the router replaces VM private IP addresses with the public IP address of its external gateway.
Click Add.
On the Routers screen, click the router name to open the list of its interfaces.
Click Add.
In the Add interface window, select a network to connect to the router from the Network drop-down menu. The new interface will attempt to use the gateway IP address of the selected virtual network by default. If it is in use, specify an unused IP address from the selected virtual network to assign to the interface in the IP address field.
Click Add.
Click the ellipsis icon next to the external interface, and then click Edit.
In the Edit interface window, change the IP address or configure SNAT.
Click Save to save your changes.
Select the interface you want to remove.
Click the ellipsis icon next to it, and then click Delete.
In the confirmation window, click Delete.
You have a virtual router created, as described in .
You can also configure static routes of a router by manually adding entries into its routing table. This can be useful, for example, if you do not need a mutual connection between two virtual networks and want only one virtual network to be accessible from the other.
Consider the following example:
The virtual machine VM1 is connected to the virtual network private1 (192.168.128.0/24) via the network interface with IP address 192.168.128.10.
The virtual machine VM2 is connected to the virtual network private2 (192.168.30.0/24) via the network interface with IP address 192.168.30.10.
The router router1 connects the network private1 to the physical network via the external gateway with the IP address 10.94.129.73.
The router router2 connects the network private2 to the physical network via the external gateway with the IP address 10.94.129.74.
To be able to access VM2 from VM1, you need to add a static route for router1, specifying the CIDR of private2, that is 192.168.30.0/24, as the destination subnet and the external gateway IP address of router2, that is 10.94.129.74, as the next hop IP address. In this case, when an IP packet for 192.168.30.10 reaches router1, it will be forwarded to router2 and then to VM2.
You have a virtual router created, as described in Managing virtual routers.
To create a static route for a router
On the Routers screen, click the router name. Open the Static routes tab, and then click Add on the right pane. If there are no routes to show, click Add static route.
In the Add static route window, specify the destination subnet range and mask in CIDR notation and the next hop’s IP address. The next hop’s IP address must belong to one of the networks that the router is connected to.
Click Add.
Click the ellipsis icon next to the required static route, and then click Edit.
In the Edit static route window, change the desired parameters, and then click Save.
Click the ellipsis icon next to the static route you want to remove, and then click Delete.
Sign up for an Instance in our Portal
Choose your package
Click the Activate button and confirm with Yes, activate. Deploying an Object Storage instance takes a few minutes.
Once the instance is created, follow the on how to access it.
Bamboozle Kubernetes is a managed Kubernetes service lets you deploy scalable and secure Kubernetes clusters without the complexities.
Bamboozle Kubernetes is a managed Kubernetes service lets you deploy scalable and secure Kubernetes clusters without the complexities of administrating the control plane. We manage the Kubernetes control plane and the underlying containerized infrastructure.
Clusters are compatible with standard Kubernetes toolchains and integrate natively with our Load Balancers and block storage volumes.
There are no restrictions on the API objects you can create as long as the underlying Kubernetes version supports them. We offer the latest version of Kubernetes as well as earlier patch levels of the latest minor version for special use cases. You can also install popular tools like Helm, metrics-server, and Istio.
Worker and Master nodes are built on instaces, but unlike standalone instances, worker nodes are managed with the Kubernetes command-line client kubectl and are not accessible with SSH. On both the control plane and the worker nodes, Flow maintains the system updates, security patches, operating system configuration and installed packages. Worker nodes are automatically deleted and respawned when needed, and you can manually rebuild worker nodes.
You can persist data in Kubernetes clusters to block storage volumes using the Flow CSI plugin, the CSI Plugin is already preinstalled and is used for the default storage class. You can also persist data to Flow object storage by using the S3 API to interact with the storage from your application.
The Flow Kubernetes Cloud Controller supports provisioning external Load Balancers.
Clusters are added to a VPC network for the datacenter region by default. This keeps traffic between clusters and other applicable resources from being routed outside the datacenter over the public internet.
The cost of a Kubernetes cluster is based on the cluster’s resources:
Nodes (Workers and Master / Control plane ) are built on Instances.
Integration Load Balancers is charged at the same rate as common Load Balancers.
Integration with block storage volumes is charged at the same rate as volumes.
All charges for Kubernetes clusters appear in the Kubernetes detail view section. For pricing details please consult our pricing page.
Kubernetes Clusters are available in all regions. They are region-specific resources and can only be assigned within the same region.
At the moment IPv6 is not supported.
The control plane is not highly available and may be temporarily unavailable during upgrades or maintenance. This does not affect running clusters and does not make the cluster workers or workloads unavailable if external load balancers are used.
You have a network that will interconnect the Kubernetes master and worker nodes. It can be either a shared physical network or a virtual network linked to a physical one via a virtual router. The virtual network needs to have a gateway and a DNS server specified.
An SSH key is added. It will be installed on both the master and worker nodes.
Youhave enough resources for all of the Kubernetes nodes, taking their flavors into account.
It is also required that the network where you create a Kubernetes cluster does not overlap with these default networks:
10.100.0.0/24—Used for pod-level networking
10.254.0.0/16—Used for allocating Kubernetes cluster IP addresses
Go to the Kubernetes clusters screen, and then click Create on the right. A window will open where you can set your cluster parameters
Enter the cluster name, and then select a Kubernetes version and an SSH key.
In the Network section, select a network that will interconnect the Kubernetes nodes in the cluster. If you select a virtual network, decide whether you need access to your Kubernetes cluster via a floating IP address:
If you select None, you will not have access to the Kubernetes API.
If you select For Kubernetes API, a floating IP address will be assigned to the master node or to the load balancer if the master node is highly available.
If you select For Kubernetes API and nodes, floating IP addresses will be additionally assigned to all of the Kubernetes nodes (masters and workers).
Then, choose whether or not to enable High availability for the master node. If you enable high availability, three master node instances will be created. They will work in the Active/Active mode.
In the Master node section, select a flavor for the master node. For production clusters, it is strongly recommended to use a flavor with at least 2 vCPUs and 8 GiB of RAM.
Optionally, enable Integrated monitoring to automatically deploy the cluster-wide monitoring solution, which includes the following components: Prometheus, Alertmanager, and Grafana.
** This feature is experimental and not supported in production environments. **
In the Container volume section, select a storage policy, and then enter the size for volumes on both master and worker nodes.
In the Default worker group section, select a flavor for each worker, and then decide whether you want to allow automatic scaling of the worker group:
With Autoscaling enabled, the number of workers will be automatically increased if there are pods stuck in the pending state due to insufficient resources, and reduced if there are workers with no pods running on them. For scaling of the worker group, set its minimum and maximum size.
With Autoscaling disabled, the number of worker nodes that you set will be permanent.
In the Labels section, enter labels that will be used to specify supplementary parameters for this Kubernetes cluster in the key=value format. For example: selinux_mode=permissive. Currently, only the selinux label is supported. You can use other labels at your own risk. To see the full list of supported labels, refer to the OpenStack documentation.
Click Create.
Creation of the Kubernetes cluster will start. The master and worker nodes will appear on the Virtual machines screen, while their volumes will show up on the Volumes screen.
After the cluster is ready, click Kubernetes access for instructions on how you can access the dashboard. You can also access the Kubernetes master and worker nodes via SSH, by using the assigned SSH key and the user name core.
Click the required Kubernetes cluster on the Kubernetes clusters screen and click Delete. The master and worker VMs will be deleted along with their volumes.
Bamboozle Object Storage is an S3-compatible object storage service that lets you store and serve large amounts of data. You can create them in a few seconds and use them immediately with no configuration. Data transfer is automatically secured with HTTPS, and the available storage capacity scales seamlessly.
Object Storage are ideal for storing static, unstructured data like audio, video, and images as well as large amounts of text. Use cases like databases, applications written in server-side languages, and mission-critical applications will work best with local storage (volumes).
Bamboozle Object Storage is an S3-compatible object storage service that lets you store and serve large amounts of data. The Bamboozle Object Storage API is inter-operable with the AWS S3 API, meaning you can use existing S3 tools and libraries with Spaces. A common use case is managing Bamboozle Object Storage programmatically with AWS’ S3 SDKs.
Install the AWS SDK using the package manager for your language of choice.
You are able to retrieve the access & secret keys in our customer portal:.
The examples below rely on environment variables to access these keys. Export ACCESS_KEY
and SECRET_KEY
to your environment (e.g. export ACCESS_KEY=DSJE2334BBZ
) to make them available to your code.
After you set up and configure an SDK, you can follow the examples below to see how to perform common Bamboozle Object Storage operations in JavaScript, Go, PHP, Python and Ruby.
To access Flow Object Storage with Cyberduck, please follow these steps:
Download (https://cyberduck.io) and install Cyberduck
Open CyberDuck and click Open Connection.
Specify your the credentials which are provided in our customer portal (https://portal.bamboozle.me):
Server: Insert the DNS name of the S3 endpoint (Your location is mentioned in your account in our portal): Location Dubai: dxb.bbzs3.com
Access Key ID: Insert the displayed Access Key from our portal.
Secret Access Key ID: Insert the displayed Secret Key from our portal.
Press the connect button
Example for DXB:
o access Flow Object Storage with Mountainduck, please follow these steps:
Download (https://mountainduck.io) and install Mountainduck
Open CyberDuck and click Open Connection.
Specify your the credentials which are provided in our customer portal (https://portal.bamboozle.me):
Server: Insert the DNS name of the S3 endpoint (Your location is mentioned in your account in our portal): Location Dubai: dxb.bbzs3.com
Access Key ID: Insert the displayed Access Key from our portal.
Secret Access Key ID: Insert the displayed Secret Key from our portal.
Press the connect button
Cyber Protect represents an all-in-one cyber protection solution that integrates backup and recovery, disaster recovery, malware prevention, security controls, remote assistance, monitoring, and reporting.
It protects your entire business and businesses of your customers through layered protection approach, an innovative combination of proactive, active, and reactive data protection technologies:
Proactive actions, such as vulnerability assessment/patch management, predictive analysis of hard drive health based on machine learning technologies, allow you to prevent any threats to your machines.
Active actions, such as protection against malware, self-protection, allow you to detect threats.
Reactive actions, such as backup and recovery (on-premises and cloud), disaster recovery (on-premises and cloud), allow you to respond to any failures.
Cyber Protect provides you with one protection agent, one service console that is easy to manage, and one protection plan that covers all security and data protection aspects.
Cyber Protect provides the following functionality:
Backup and recovery allows you to back up and recover physical machines, virtual machines, and applications.
Disaster recovery allows you to protect your local environment from disasters by launching the exact copies of machines in the cloud and switching the workload to the cloud servers.
Antimalware and web protection provides you with the top multi-layered protection based on four different antimalware technologies inside. You will also be able to manage Microsoft Security Essentials and Windows Defender Antivirus from the service console. The URL filtering functionality allows you to prevent malicious file download and block access to suspicious web resources.
Autodiscovery of machines provides you with an easy and automatic way to register a large number of machines and install a protection agent and additional components.
Vulnerability assessment allows you to scan Microsoft, Linux, macOS, Microsoft third-party products, and macOS third-party products for vulnerabilities.
Patch management integrated with backup provides you with the following capabilities: automatic and manual patch approval, scheduled and on-demand patch installation, flexible reboot and maintenance window options, staged deployment.
Hard drive health control allows you to track the status of hard disks and prevent their crash. Disk control uses a combination of machine learning and SMART reporting to predict disk failures.
Remote management and assistance allows you to connect and manage machines remotely.
#CyberFit Score provides you with a security assessment and scoring mechanism that evaluates the security posture of your machine.
Device control enables you to limit the user access to local and redirected peripheral devices, ports, and clipboard on machines under protection plans.
Cyber Protection has the following unique features:
Backup scanning in non-endpoint environments that ensures malware-free restores. It increases the potential of rootkits and bootkits detection and reduces loads on your machines.
Safe recovery based on integrated antimalware scanning and malware deletion to prevent recurrence of an infection.
Smart protection built on the basis of alarms received from Cyber Protection Operations Center (CPOC). This feature allows you to minimize business process downtime when facing issues like a malware attack, natural disaster, to reduce reaction time, and to avoid data loss.
Protection from bad patches by creating pre-update backups.
Continuous data protection that ensures that you will not lose your data changes made between scheduled backups. You can control what will be continuously backed up – Office documents, financial forms, graphic files, and so on. You get improved RPOs due to continuous backups.
A data protection map that ensures tracking data distribution across the machines, monitoring the protection status of files, and using the collected data as the basis for compliance reports.
Forensic backup that allows you to collect digital evidence data, include them in a disk-level backup, and use them for future investigations.
Company-wide allowlist built on backups that allows you to prevent false detections. This feature eliminates time-consuming manual listing of trusted corporate applications, ensures greater productivity, and improves the detection rate by using improved heuristics.
Besides basic Amazon S3 operations like GET, PUT, COPY, DELETE, the Bamboozle Object Storage implementation of the Amazon S3 protocol supports the following features:
Multipart upload
Access control lists (ACLs)
Versioning
Signed URLs
Object locking
Geo-replication
Server access logging
Object storage classes
Cross-region replication (CRR)
Bucket policies
Object expiration
Cross-origin resource sharing (CORS)
The following authentication schemes are supported by the Bamboozle Object Storage implementation of the Amazon S3 protocol:
The following authentication methods are supported by the Bamboozle Object Storage implementation of the Amazon S3 protocol:
The following authentication method is not supported:
The following Amazon S3 REST request headers are currently supported by the Bamboozle Object Storage implementation of the Amazon S3 protocol:
Authorization
Content-Length
Content-Type
Content-MD5
Date
Host
x-amz-content-sha256
x-amz-date
x-amz-security-token
x-amz-object-lock-retain-until-date
x-amz-object-lock-mode
x-amz-object-lock-legal-hold
x-amz-bypass-governance-retention
x-amz-bucket-object-lock-enabled
x-amz-geo-endpoint
x-amz-geo-access-key
x-amz-geo-access-secret
The following Amazon S3 REST response headers are currently supported by the Bamboozle Object Storage implementation of the Amazon S3 protocol:
Content-Length
Content-Type
Connection
Date
ETag
x-amz-delete-marker
x-amz-request-id
x-amz-version-id
x-amz-object-lock-retain-until-date
x-amz-object-lock-mode
x-amz-object-lock-legal-hold
x-amz-geo-endpoint
x-amz-geo-access-key
x-amz-geo-access-secret
The following Amazon S3 REST response headers are not used:
Server
x-amz-id-2
The following Amazon S3 REST error response headers are currently supported by the Bamboozle Object Storage implementation of the Amazon S3 protocol:
Code
Error
Message
The following Amazon S3 REST error response headers are not supported:
RequestId (not used)
Resource
The Flow Object Storage implementation of the Amazon S3 object lifecycle only supports object expiration by prefix. Deleting objects by tag is not available. The rule definition for object expiration is similar to that for bucket policies.
The following S3 object expiration actions are currently supported:
Expiration. Deletes objects by age or by date. In case of versioning, inserts a delete marker, which becomes the latest version of an object. Delete markers are not removed.
NonCurrentVersionExpiration. Deletes an object version after it has become non-current for the specified number of days.
AbortIncompleteMultipartUpload. Aborts a multipart upload that has not completed during the specified number of days.
ExpiredObjectDeleteMarker. Deletes a delete marker as soon as there are no other versions of an object.
Once you register in our portal an activation link is sent to the email provided in the system. Please follow the steps to activate your account.
Activate account button. Click the button and set the password for your account. Ensure that your password is at least nine characters long. For more information about the password, refer to Password requirements.
If your administrator has enabled two-factor authentication, you will be prompted to set it up for your account. For more information about it, refer to Two-factor authentication.
The password for a user account must be at least 9 characters long. Passwords are also checked for complexity, and fall into one of the following categories:
Weak
Medium
Strong
You cannot save a weak password, even though it might contain 9 characters or more. Passwords that repeat the user name, the login, the user email, or the name of the tenant to which a user account belongs are always considered weak. Most common passwords are also considered weak.
To strengthen a password, add more characters to it. Using different types of characters, such as digits, uppercase and lowercase letters, and special characters, is not mandatory but it results in stronger passwords that are also shorter.
In the Cyber Protect console, you can manage workloads and plans, change the protection settings, configure reports, or check the backup storage.
The Cyber Protection console provides access to additional services or features, such as File Sync & Share or Antivirus and Antimalware protection, Patch management, Device control, and Vulnerability assessment. The type and number of these services and features vary according to your Cyber Protection license.
To check the dashboard with the most important information about your protection, go to Monitoring > Overview.
Depending on your access permissions, you can manage the protection for one or multiple customer tenants or units in a tenant. To switch the hierarchy level, use the drop-down list in the navigation menu. Only the levels to which you have access are shown. To go to the management portal, click Manage.
The Devices section is available in simple and table view. To switch between them, click the corresponding icon in the top right corner.
The simple view shows only a few workloads.
Two-factor authentication provides extra protection from unauthorized access to your account. When two-factor authentication is set up, you are required to enter your password (the first factor) and a one-time code (the second factor) to log in to the service console. The one-time code is generated by a special application that must be installed on your mobile phone or another device that belongs to you. Even if someone finds out your login and password, they still will not be able to login without access to your second-factor device.
The one-time code to configure two-factor authentication for your account is generated based on the device's current time and the secret provided by the Cyber Protection service as the QR code or alphanumeric code. During the first login, you need to enter this secret to the authentication application.
To set up two-factor authentication for your account
You can and must configure two-factor authentication for your account when two-factor authentication has been enabled by an administrator for your organization. If two-factor authentication has been enabled while you are logged in to the Cyber Protection service console, you will have to configure it when your current session expires.
Two-factor authentication is enabled for your organization.
You are logged out of the Cyber Protection service console.
Choose a second-factor device.
Most commonly it is a mobile phone, but you can also use a tablet, laptop, or desktop.
Ensure that the device time settings are correct and reflect the actual current time, and that the device locks itself after a period of inactivity.
Install the authentication application on the device. The recommended applications are Google Authenticator or Microsoft Authenticator.
Go to the Cyber Protection service console sign in page and set your password.
The service console shows the QR code and the alphanumeric code.
Save the QR code and the alphanumeric code in any convenient way (such as, print out the screen, write down the code, or save the screenshot in cloud storage). If you lose the second-factor device, you will be able to reset the two-factor authentication by using these codes.
Open the authentication application, and then do one of the following:
Scan the QR code
Manually enter the alphanumeric code to the application
The authentication application generates a one-time code. A new code will be generated every 30 seconds.
Return to the service console login page and enter the generated code.
A one-time code is valid for 30 seconds. If you wait longer than 30 seconds, use the next generated code.
When logging in the next time, you can select the checkbox Trust this browser.... If you do this, the one-time code will not be required when you log in by using this browser on this machine.
If you have a trusted browser, you will be able to log in by using this browser. Nevertheless, when you have a new device, repeat steps 1-3 and 6-7 of the above procedure by using the new device and the saved QR code or alphanumeric code.
If you have not saved the code, ask the administrator or service provider to reset the two-factor authentication for your account, and then repeat steps 1-3 and 6-7 of the above procedure by using the new device.
When logging in, click the Reset two-factor authentication settings link, confirm the operation by entering the one-time code, and then repeat the above procedure by using the new device.
After you activate your account, you can access the Cyber Protection service by logging in to the Cyber Protection console or via the management portal.
To log in to the Cyber Protection console
Go to the Cyber Protection service login page.
Type your login, and then click Next.
Type your password, and then click Next.
[If you use more than one Cyber Protect Cloud service] Click Cyber Protection.
Users who only have access the Cyber Protection service, log in directly to the Cyber Protection console.
The timeout period for the Cyber Protection console is 24 hours for active sessions and 1 hour for idle sessions.
You can change the language of the web interface by clicking the account icon in the upper-right corner.
To access the Cyber Protection console via the management portal
In the management portal, go to Monitoring > Usage.
Under Cyber Protect, select Protection, and then click Manage service.
Alternatively, under Clients, select a customer, and then click Manage service.
As a result, you are redirected to the Cyber Protection console.
To reset your password
Go to the Cyber Protection service login page.
Type your login, and then click Next.
Click Forgot password?
Confirm that you want further instructions by clicking Send.
Follow the instructions in the email that you have received.
Set up your new password.
The Cyber Protect features are supported on the following operating systems:
Windows: Windows 7 Service Pack 1 and later, Windows Server 2008 R2 Service Pack 1 and later.
Windows Defender Antivirus management is supported on Windows 8.1 and later.
Linux: CentOS 6.10, 7.8+, CloudLinux 6.10, 7.8+, Ubuntu 16.04.7+, where plus refers to minor versions of these distributions.
Other Linux distributions and versions might be supported, but have not been tested.
macOS: 10.13.x and later (only Antivirus and Antimalware protection, and Device control are supported). Device control functionality is supported on macOS 10.15 and later or macOS 11.2.3 and later.
Agent for Data Loss Prevention might be installed on unsupported macOS systems because it is an integral part of Agent for Mac. In this case, the Cyber Protect console will display that Agent for Data Loss Prevention is installed on the computer, but the device control functionality will not work. Device control functionality will only work on macOS systems that are supported by Agent for Data Loss Prevention.
The Cyber Protect features are only supported for machines on which a protection agent is installed. For virtual machines protected in agentless mode, for example, by Agent for Hyper-V, Agent for VMware, Agent for Virtuozzo Hybrid Infrastructure, Agent for Scale Computing, or Agent for oVirt only backup is supported.
Backup operations require about 1 GB of RAM per 1 TB of backup size. The memory consumption may vary, depending on the amount and type of data being processed by the agents.
On x64 systems, operations with bootable media and disk recovery with restart require at least 2 GB of memory.
Selecting an agent depends on what you are going to back up. The table below summarizes the information, to help you decide.
In Windows, Agent for Exchange, Agent for SQL, Agent for Active Directory, and Agent for Oracle require that Agent for Windows is also installed. Thus, if you install, for example, Agent for SQL, you also will be able to back up the entire machine where the agent is installed.
It is recommended to install Agent for Windows when you install also Agent for VMware (Windows) and Agent for Hyper-V.
In Linux, Agent for Oracle and Agent for Virtuozzo require that Agent for Linux (64-bit) is also installed. These three agents share one installer.
*During the installation, Agent for Exchange checks for enough free space on the machine where it will run. Free space equal to 15 percent of the biggest Exchange database is temporarily needed during a granular recovery.
**If your ESXi uses a SAN attached storage, install the agent on a machine connected to the same SAN. The agent will back up the virtual machines directly from the storage rather than via the ESXi host and LAN. For detailed instructions, refer to "Agent for VMware - LAN-free backup".
***For Virtuozzo 7, only ploop containers are supported. Virtual machines are not supported.
****A virtual machine is considered virtual if it is backed up by an external agent. If an agent is installed in the guest system, the backup and recovery operations are the same as with a physical machine. Nevertheless, if Cyber Protection can identify a virtual machine by using the CPUID instruction, a virtual machine service quota is assigned to it. If you use direct passthrough or another option that masks the CPU manufacturer ID, only service quotas for physical machines can be assigned.
If Cyber Protection is not the only service you have access to, you can switch between the services by using the icon in the upper-right corner. Administrators can also use this icon for switching to the management portal.
Default protection plans
Remote Workers
Yes
No
No
Office Workers (third-party antivirus)
Yes
No
No
Office Workers (Cyber Protect antivirus)
Yes
No
No
Cyber Protect Essentials (only for Cyber Protect Essentials edition)
Yes
No
No
Forensic backup
Collecting memory dump
Yes
No
No
Snapshot of running processes
Yes
No
No
Notarization of local image forensic backup
Yes
No
No
Notarization of cloud image forensic backup
Yes
No
No
Continuous data protection (CDP)
CDP for files and folders
Yes
No
No
CDP for changed files via application tracking
Yes
No
No
Autodiscovery and remote installation
Network-based discovery
Yes
No
No
Active Directory-based discovery
Yes
No
No
Template-based discovery (importing machines from a file)
Yes
No
No
Manual adding of devices
Yes
No
No
Active Protection
Process Injects detection
Yes
No
No
Automatic recovery of affected files from the local cache
Yes
Yes
Yes
Self-defense for backup files
Yes
No
No
Self-defense for Bamboozle software
Yes
No
Yes
Trusted/blocked process management
Yes
No
Yes
Processes/folders exclusions
Yes
Yes
Yes
Ransomware detection based on a process behavior (AI-based)
Yes
Yes
Yes
Cryptomining process detection based on process behavior
Yes
No
No
External drives protection (HDD, flash drives, SD cards)
Yes
No
Yes
Network folder protection
Yes
No
Yes
Server-side protection
Yes
No
No
Zoom, Cisco Webex, Citrix Workspace, and Microsoft Teams protection
Yes
No
No
Antivirus and Antimalware protection
Fully-integrated Active Protection functionality
Yes
No
No
Real-time antimalware protection
Yes
Yes, when Advanced antimalware is enabled
Yes, when Advanced antimalware is enabled
Advanced real-time antimalware protection with local signature-based detection
Yes
Yes
Yes
Static analysis for portable executable files
Yes
No
Yes
On-demand antimalware scanning
Yes
Yes
Yes
Network folder protection
Yes
Yes
No
Server-side protection
Yes
No
No
Scan of archive files
Yes
No
Yes
Scan of removable drives
Yes
No
Yes
Scan of only new and changed files
Yes
No
Yes
File/folder exclusions
Yes
No
Yes
Processes exclusions
Yes
No
Yes
Behavioral analysis engine
Yes
No
Yes
Exploit prevention
Yes
No
No
Quarantine
Yes
Yes
Yes
Quarantine auto clean-up
Yes
No
Yes
URL filtering (http/https)
Yes
No
No
Corporate-wide whitelist
Yes
No
Yes
Microsoft Defender Antivirus management
Yes
No
No
Microsoft Security Essentials management
Yes
No
No
Registering and managing Antivirus and Antimalware protection via Windows Security Center
Yes
No
No
Vulnerability assessment
Vulnerability assessment of operating system and its native applications
Yes
Yes
Yes
Vulnerability assessment for 3rd-party applications
Yes
No
Yes
Patch management
Patch auto-approval
Yes
No
No
Patch auto-installation
Yes
No
No
Patch testing
Yes
No
No
Manual patch installation
Yes
No
No
Patch scheduling
Yes
No
No
Fail-safe patching: backup of machine before installing patches as part of protection plan
Yes
No
No
Cancelation of a machine reboot if a backup is running
Yes
No
No
Data protection map
Adjustable definition of important files
Yes
No
No
Scanning machines to find unprotected files
Yes
No
No
Unprotected locations overview
Yes
No
No
Ability to start the protection action from the Data protection map widget (Protect all files action)
Yes
No
No
Disk health
AI-based HDD and SSD health control
Yes
No
No
Smart protection plans based on Acronis Cyber Protection Operations
Center (CPOC) alerts
Threat feed
Yes
No
No
Threat feed
Yes
No
No
Backup scanning
Antimalware scan of image backups as part of backup plan
Yes
No
No
Scanning of image backups for malware in cloud
Yes
No
No
Malware scan of encrypted backups
Yes
No
No
Safe recovery
Antimalware scanning with Antivirus and Antimalware protection during the recovery process
Yes
No
No
Safe recovery for encrypted backups
Yes
No
No
Remote desktop connection
Connection via NEAR
Yes
Yes
Yes
Connection via RDP
Yes
No
No
Connection via Screen sharing
No
No
Yes
Connection via web client
Yes
No
No
Connection via Quick Assist
Yes
Yes
Yes
Remote assistance
Yes
Yes
Yes
File transfer
Yes
Yes
Yes
Screenshot transmission
Yes
Yes
Yes
#CyberFit Score
#CyberFit Score status
Yes
No
No
#CyberFit Score standalone tool
Yes
No
No
#CyberFit Score recommendations
Yes
No
No
Data loss prevention
Device control
Yes
No
Yes
Management options
Web-based centralized and remote management console
Yes
Yes
Yes
Cyber Protect Monitor
Cyber Protect Monitor app
Yes
No
Yes
Protection status for Zoom
Yes
No
No
Protection status for Cisco Webex
Yes
No
No
Protection status for Citrix Workspace
Yes
No
No
Protection status for Microsoft Teams
Yes
No
No
Software inventory
Software inventory scanning
Yes
No
Yes
Software inventory monitoring
Yes
No
Yes
Hardware inventory
Hardware inventory scanning
Yes
No
Yes
Hardware inventory monitoring
Yes
No
Yes
Agent for Windows
1.2 GB
Agent for Linux
2 GB
Agent for Mac
1 GB
Agent for SQL and Agent for Windows
1.2 GB
Agent for Exchange and Agent for Windows
1.3 GB
Agent for Data Loss Prevention
500 MB
Agent for Microsoft 365
500 MB
Agent for Active Directory and Agent for Windows
2 GB
Agent for VMware and Agent for Windows
1.5 GB
Agent for Hyper-V and Agent for Windows
1.5 GB
Agent for Virtuozzo and Agent for Linux
1 GB
Agent for Virtuozzo Hybrid Infrastructure
700 MB
Agent for Oracle and Agent for Windows
2.2 GB
Agent for Oracle and Agent for Linux
2 GB
Agent for MySQL/MariaDB and Agent for Linux
2 GB
Physical machines
Physical machines running Windows
Agent for Windows
On the machine that will be backed up.
Physical machines running Linux
Agent for Linux
Physical machines running macOS
Agent for Mac
Applications
SQL databases
Agent for SQL
On the machine running Microsoft SQL Server.
MySQL databases
Agent for MySQL/MariaDB
On the machine running MySQL Server.
MariaDB databases
Agent for MySQL/MariaDB
On the machine running MariaDB Server.
Exchange databases
Agent for Exchange
On the machine running the Mailbox role of Microsoft Exchange Server.*
Microsoft 365 mailboxes
Agent for Microsoft 365
On a Windows machine that is connected to the Internet.
Depending on the desired functionality, you may or may not need to install Agent for Microsoft 365. For more information, refer to "Protecting Microsoft 365 data".
Microsoft 365 OneDrive files and SharePoint Online sites
—
This data can be backed up only by an agent that is installed in the cloud. For more information, refer to "Protecting Microsoft 365 data".
Google Workspace Gmail mailboxes, Google Drive files, and Shared drive files
—
This data can be backed up only by an agent that is installed in the cloud. For more information, refer to "Protecting Google Workspace".
Machines running Active Directory Domain Services
Agent for Active Directory
On the domain controller.
Machines running Oracle Database
Agent for Oracle
On the machine running Oracle Database.
Virtual machines
VMware ESXi virtual machines
Agent for VMware (Windows)
On a Windows machine that has network access to vCenter Server and to the virtual machine storage.**
Agent for VMware (Virtual Appliance)
On the ESXi host.
Hyper-V virtual machines
Agent for Hyper-V
On the Hyper-V host.
Scale Computing HC3 virtual machines
Agent for Scale Computing HC3 (Virtual Appliance)
On the Scale Computing HC3 host.
Red Hat Virtualization virtual machines (managed by oVirt)
Agent for oVirt (Virtual Appliance)
On the Red Hat Virtualization host.
Virtuozzo virtual machines and containers***
Agent for Virtuozzo
On the Virtuozzo host.
Virtuozzo Hybrid Infrastructure virtual machines
Agent for Virtuozzo Hybrid Infrastructure
On the Virtuozzo Hybrid Infrastructure host.
Virtual machines hosted on Amazon EC2
The same as for physical machines****
On the machine that will be backed up.
Virtual machines hosted on Windows Azure
Citrix XenServer virtual machines
Red Hat Virtualization (RHV/RHEV)
Kernel-based Virtual Machines (KVM)
Oracle virtual machines
Nutanix AHV virtual machines
Mobile devices
Mobile devices running Android
Mobile app for Android
On the mobile device that will be backed up.
Mobile devices running iOS
Mobile app for iOS
Before you install an agent, you must download its installation file from the service console.
To download an agent while adding a workload to protect
In the Cyber Protection console, navigate to Devices > All devices.
In the upper right, click Add device.
In the Add devices panel, from the Release channel drop-down menu, select an agent version.
Previous release - download the agent version from the previous release.
Current - download the latest available agent version.
Select the agent that corresponds to the operating system of the workload that you are adding.
The Save As dialog opens.
[Only for Macs with Apple silicon (such as Apple M1) processors] Click Cancel. In the Add Mac panel that opens, click the Download ARM installer link.
Select a location to save the agent installation file and click Save.
To download an agent for later use
In the upper right corner of the Cyber Protection console, click the User icon.
Click Downloads.
In the Downloads dialog, from the Release channel drop-down menu, select an agent version.
Previous release - download the agent version from the previous release.
Current - download the latest available agent version.
Scroll the list of available installers to locate the agent installer that you need and click the download icon at the end of its row.
The Save As dialog opens.
Select a location to save the agent installation file and click Save.
Prerequisites
Download the agent that you need on the machine that you plan to protect. See Downloading protection agents.
To install Agent for Linux, you need at least 2 GB of free disk space.
To install Agent for Linux
Ensure that the machine is connected to the Internet.
As the root user, navigate to directory with the installation file, make the file executable, and then run it.
If a proxy server is enabled in your network, when running the installation file, specify the server host name/IP address and port in the following format: --http-proxy-host=
ADDRESS --http-proxy-port=
PORT --http-proxy-login=
LOGIN --http-proxy-password=
PASSWORD.
If you want to change the default method of registering the machine in the Cyber Protection service, run the installation file with one of the following parameters:
--register-with-credentials
– to ask for a user name and password during the installation
--token=STRING
– to use a registration token
--skip-registration
– to skip the registration
Select the check boxes for the agents that you want to install. The following agents are available:
Agent for Linux
Agent for Virtuozzo
Agent for Oracle
Agent for MySQL/MariaDB
Agent for Virtuozzo, Agent for Oracle, and Agent for MySQL/MariaDB require that Agent for Linux (64-bit) is also installed.
If you kept the default registration method in step 2, proceed to the next step. Otherwise, enter the user name and password for the Cyber Protection service, or wait until the machine will be registered by using the token.
Do one of the following:
If you log in under a company administrator account, register workloads for your company:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account under which you want to register the workload.
Click Check code, and then click Confirm registration.
If you log in under a partner administrator account, register workloads for your customers:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account of your customer under which you want to register the workload.
Click Check code, and then click Confirm registration.
Click Show registration info. The setup program shows the registration link and the registration code. If you cannot complete the workload registration on the current machine, copy the registration link and code, and then follow the registration steps on a different machine. In this case, you will need to enter the registration code in the registration form. The registration code is valid for one hour.
Alternatively, you can access the registration form by clicking All devices > Add, scrolling down to Registration via code, and then clicking Register.
Do not quit the setup program until you confirm the registration. To initiate the registration again, you will have to restart the setup program and repeat the installation procedure.
As a result, the workload will be assigned to the account that was used to log in to the service console.
Register the workload manually by using the command line. For more information on how to do this, refer to Registering workloads manually.
[If the agent is registered under an account whose tenant is in the Enhanced security mode] Set the encryption password.
If the UEFI Secure Boot is enabled on the machine, you are informed that you need to restart the system after the installation. Be sure to remember what password (the one of the root user or "acronis") should be used.
The installation generates a new key that is used for signing the kernel modules. You must enroll this new key to the Machine Owner Key (MOK) list by restarting the machine. Without enrolling the new key, your agent will not be operational. If you enable the UEFI Secure Boot after the agent is installed, you need to reinstall the agent.
After the installation completes, do one of the following:
Click Restart, if you were prompted to restart the system in the previous step.
During the system restart, opt for MOK (Machine Owner Key) management, choose Enroll MOK, and then enroll the key by using the password recommended in the previous step.
Otherwise, click Exit.
Troubleshooting information is provided in the file: /usr/lib/Acronis/BackupAndRecovery/HOWTO.INSTALL
Download the agent that you need on the workload that you plan to protect. See Downloading protection agents.
Ensure that the machine is connected to the Internet.
Log on as an administrator and start the installer.
[Optional] Click Customize installation settings and make the appropriate changes if you want:
To change the components to install (for example, to disable the installation of Cyber Protection Monitor or the Command-Line Tool, or to install the Agent for Antimalware protection and URL filtering).
On Windows machines, the antimalware protection and URL filtering features require the installation of Agent for Antimalware protection and URL filtering. It will be installed automatically for protected workloads if the Antivirus & Antimalware protection or the URL filtering module is enabled in their protection plans.
To change the method of registering the workload in the Cyber Protection service. You can switch from Use service console (default) to Use credentials or Use registration token.
To change the installation path.
To change the user account under which the agent service will run. For details, refer to Changing the logon account on Windows machines.
To verify or change the proxy server host name/IP address, port, and credentials. If a proxy server is enabled in Windows, it is detected and used automatically.
Click Install.
[Only when installing Agent for VMware] Specify the address and access credentials for the vCenter Server or stand-alone ESXi host whose virtual machines the agent will back up, and then click Done. We recommend using an account that has the Administrator role assigned. Otherwise, provide an account with the necessary privileges on the vCenter Server or ESXi.
[Only when installing on a domain controller] Specify the user account under which the agent service will run, and then click Done. For security reasons, the setup program does not automatically create new accounts on a domain controller.
The user account that you specify must be granted the Log on as a service right.
This account must have already been used on the domain controller, in order for its profile folder to be created on that machine.
For more information about installing the agent on a read-only domain controller, refer to this knowledge base article.
If you kept the default registration method Use service console in step 3, wait until the registration screen appears, and then proceed to the next step. Otherwise, no more actions are required.
Do one of the following:
If you log in under a company administrator account, register workloads for your company:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account under which you want to register the workload.
Click Check code, and then click Confirm registration.
If you log in under a partner administrator account, register workloads for your customers:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account of your customer under which you want to register the workload.
Click Check code, and then click Confirm registration.
Click Show registration info. The setup program shows the registration link and the registration code. If you cannot complete the workload registration on the current machine, copy the registration link and code, and then follow the registration steps on a different machine. In this case, you will need to enter the registration code in the registration form. The registration code is valid for one hour.
Alternatively, you can access the registration form by clicking All devices > Add, scrolling down to Registration via code, and then clicking Register.
Do not quit the setup program until you confirm the registration. To initiate the registration again, you will have to restart the setup program and repeat the installation procedure.
As a result, the workload will be assigned to the account that was used to log in to the service console.
Register the workload manually by using the command line. For more information on how to do this, refer to Registering workloads manually.
[If the agent is registered under an account whose tenant is in the Enhanced security mode] Set the encryption password.
Choose an agent, depending on what you are going to back up. For more information on the possible choices, refer to Which agent do I need?
Ensure that there is enough free space on your hard drive to install an agent. For detailed information about the required space, refer to System requirements for agents.
Download the setup program. To find the download links, click All devices > Add.
The Add devices page provides web installers for each agent that is installed in Windows. A web installer is a small executable file that downloads the main setup program from the Internet and saves it as a temporary file. This file is deleted immediately after the installation.
If you want to store the setup programs locally, download a package containing all agents for installation in Windows by using the link at the bottom of the Add devices page. Both 32-bit and 64-bit packages are available. These packages enable you to customize the list of components to install. These packages also enable unattended installation, for example, via Group Policy. This advanced scenario is described in Deploying agents through Group Policy.
To download the setup program for Agent for Microsoft 365, click the account icon in the top-right corner, and then click Downloads > Agent for Microsoft 365.
Installation in Linux and macOS is performed from ordinary setup programs.
All setup programs require an Internet connection to register the machine in the Cyber Protection service. If there is no Internet connection, the installation will fail.
Cyber Protect features require Microsoft Visual C++ 2017 Redistributable. Please ensure that it is already installed on your machine or install it before installing the agent. After the installation of Microsoft Visual C++, a restart may be required. You can find the Microsoft Visual C++ Redistributable package here https://support.microsoft.com/help/2999226/update-for-universal-c-runtime-in-windows.
Verify that your firewalls and other components of your network security system (such as a proxy sever) allow outbound connections through the following TCP ports.
Ports 443 and 8443
These ports are used for accessing the service console, registering the agents, downloading the certificates, user authorization, and downloading files from the cloud storage.
Ports in the range 7770 – 7800
The agents use these ports to communicate with the management server.
Ports 44445 and 55556
The agents use these ports for data transfer during backup and recovery.
If a proxy server is enabled in your network, refer to Proxy server settings to understand whether you need to configure these settings on each machine that runs a protection agent.
The minimum Internet connection speed required for managing an agent from the cloud is 1 Mbit/s (not to be confused with the data transfer rate acceptable for backing up to the cloud). Consider this if you use a low-bandwidth connection technology such as ADSL.
Port 443
Agent for VMware (both Windows and Virtual Appliance) connects to this port on the ESXi host/vCenter server to perform VM management operations, such as create, update, and delete VMs on vSphere during backup, recovery, and VM replication operations.
Port 902
Agent for VMware (both Windows and Virtual Appliance) connects to this port on the ESXi host to establish NFC connections to read/write data on VM disks during backup, recovery, and VM replication operations.
Port 3333
If the Agent for VMware (Virtual Appliance) is running on the ESXi host/cluster that is the target for VM replication, VM replication traffic does not go directly to the ESXi host on port 902. Instead, the traffic goes from the source Agent for VMware to TCP port 3333 on the Agent for VMware (Virtual Appliance) located on the target ESXi host/cluster.
The source Agent for VMware that reads data from the original VM disks can be anywhere else and can be of any type: Virtual Appliance or Windows.
The service that is responsible for accepting VM replication data on the target Agent for VMware (Virtual Appliance) is called “Replica disk server.” This service is responsible for the WAN optimization techniques, such as traffic compression and deduplication during VM replication, including replica seeding (see Seeding an initial replica). When no Agent for VMware (Virtual Appliance) is running on the target ESXi host, this service is not available, and therefore the replica seeding scenario is not supported.
The Downloader component is responsible for delivering updates to a computer and distributing them to other Downloader instances. It can run in agent mode which turns its computer into Downloader agent. The Downloader agent downloads updates from the internet and serves as the source of updates distribution to other computers. The Downloader requires the following ports to operate.
Port 6888
Used by the BitTorrent protocol for torrent peer-to-peer updates.
Port 6771
Used as the local peer discovery port. Also takes part in peer-to-peer updates.
Port 18018
Used for communication between updaters working in different modes: Updater and UpdaterAgent.
Port 18019
Local port, used for communication between the Updater and the protection agent.
On the machine where you plan to install the protection agent, verify that the following local ports are not in use by other processes.
127.0.0.1:9999
127.0.0.1:43234
127.0.0.1:9850
The Active Protection service is listening at TCP port 6110. Verify that it is not in use by another process.
Some of the ports required by the protection agent might be in use by other applications in your environment. To avoid conflicts, you can change the default ports used by the protection agent by modifying the following files.
In Linux: /opt/Acronis/etc/aakore.yaml
In Windows: \ProgramData\Acronis\Agent\etc\aakore.yaml
The protection agents can transfer data through an HTTP/HTTPS proxy server. The server must work through an HTTP tunnel without scanning or interfering with the HTTP traffic. Man-in-the-middle proxies are not supported.
Because the agent registers itself in the cloud during the installation, the proxy server settings must be provided during the installation or in advance.
If a proxy server is configured in Windows (Control panel > Internet Options > Connections), the setup program reads the proxy server settings from the registry and uses them automatically. Also, you can enter the proxy settings during the installation, or specify them in advance by using the procedure described below. To change the proxy settings after the installation, use the same procedure.
To specify the proxy settings in Windows
Create a new text document and open it in a text editor, such as Notepad.
Copy and paste the following lines into the file:
Replace proxy.company.com with your proxy server host name/IP address, and 000001bb with the hexadecimal value of the port number. For example, 000001bb is port 443.
If your proxy server requires authentication, replace proxy_login and proxy_password with the proxy server credentials. Otherwise, delete these lines from the file.
Save the document as proxy.reg.
Run the file as an administrator.
Confirm that you want to edit the Windows registry.
If the protection agent is not installed yet, you can install it now.
Open file %programdata%\Acronis\Agent\etc\aakore.yaml in a text editor.
Locate the env section or create it and add the following lines:
Replace proxy_login and proxy_password with the proxy server credentials, and proxy_address:port with the address and port number of the proxy server.
In the Start menu, click Run, type: cmd, and click OK.
Restart the aakore service by using the following commands:
Restart the agent by using the following commands:
Run the installation file with the parameters --http-proxy-host=
ADDRESS --http-proxy-port=
PORT --http-proxy-login=
LOGIN--http-proxy-password=
PASSWORD. To change the proxy settings after the installation, use the procedure described below.
To change the proxy settings in Linux
Open the file /etc/Acronis/Global.config in a text editor.
Do one of the following:
If the proxy settings were specified during the agent installation, find the following section:
Otherwise, copy the above lines and paste them into the file between the <registry name="Global">...</registry>
tags.
Replace ADDRESS with the new proxy server host name/IP address, and PORT with the decimal value of the port number.
If your proxy server requires authentication, replace LOGIN and PASSWORD with the proxy server credentials. Otherwise, delete these lines from the file.
Save the file.
Open file /opt/acronis/etc/aakore.yaml in a text editor.
Locate the env section or create it and add the following lines:
Replace proxy_login and proxy_password with the proxy server credentials, and proxy_address:port with the address and port number of the proxy server.
Restart the aakore service by using the following command:
Restart the agent by executing the following command in any directory:
You can enter the proxy settings during the installation, or specify them in advance by using the procedure described below. To change the proxy settings after the installation, use the same procedure.
To specify the proxy settings in macOS
Create the file /Library/Application Support/Acronis/Registry/Global.config and open it in a text editor, such as Text Edit.
Copy and paste the following lines into the file
Replace proxy.company.com with your proxy server host name/IP address, and 443 with the decimal value of the port number.
If your proxy server requires authentication, replace proxy_login and proxy_password with the proxy server credentials. Otherwise, delete these lines from the file.
Save the file.
If the protection agent is not installed yet, you can install it now.
Open file /Library/Application Support/Acronis/Agent/etc/aakore.yaml in a text editor.
Locate the env section or create it and add the following lines:
Replace proxy_login and proxy_password with the proxy server credentials, and proxy_address:port with the address and port number of the proxy server.
Go to Applications > Utilities > Terminal
Restart the aakore service by using the following commands:
Restart the agent by using the following commands:
When working under bootable media, you may need to access the cloud storage via a proxy server. To specify the proxy server settings, click Tools > Proxy server, and then specify the proxy server host name/IP address, port, and credentials.
To add the necessary modules to the Linux kernel, the setup program needs the following Linux packages:
The package with kernel headers or sources. The package version must match the kernel version.
The GNU Compiler Collection (GCC) compiler system. The GCC version must be the one with which the kernel was compiled.
The Make tool.
The Perl interpreter.
The libelf-dev
, libelf-devel
, or elfutils-libelf-devel
libraries for building kernels starting with 4.15 and configured with CONFIG_UNWINDER_ORC=y. For some distributions, such as Fedora 28, they need to be installed separately from kernel headers.
The names of these packages vary depending on your Linux distribution.
In Red Hat Enterprise Linux, CentOS, and Fedora, the packages normally will be installed by the setup program. In other distributions, you need to install the packages if they are not installed or do not have the required versions.
To check whether the packages are already installed, perform these steps:
Run the following command to find out the kernel version and the required GCC version:
This command returns lines similar to the following: Linux version 2.6.35.6
and gcc version 4.5.1
Run the following command to check whether the Make tool and the GCC compiler are installed:
For gcc, ensure that the version returned by the command is the same as in the gcc version
in step 1. For make, just ensure that the command runs.
Check whether the appropriate version of the packages for building kernel modules is installed:
In Red Hat Enterprise Linux, CentOS, and Fedora, run the following command:
In Ubuntu, run the following commands:
In either case, ensure that the package versions are the same as in Linux version
in step 1.
Run the following command to check whether the Perl interpreter is installed:
If you see the information about the Perl version, the interpreter is installed.
In Red Hat Enterprise Linux, CentOS, and Fedora, run the following command to check whether elfutils-libelf-devel
is installed:
If you see the information about the library version, the library is installed.
The following table lists how to install the required packages in various Linux distributions.
Red Hat Enterprise Linux
kernel-devel gcc make elfutils-libelf-devel
The setup program will download and install the packages automatically by using your Red Hat subscription.
perl
Run the following command:
CentOS
Fedora
kernel-devel gcc make elfutils-libelf-devel
The setup program will download and install the packages automatically.
perl
Run the following command:
Ubuntu
Debian
linux-headers linux-image gcc make perl
Run the following commands:
SUSE Linux
OpenSUSE
kernel-source gcc make perl
The packages will be downloaded from the distribution's repository and installed.
For other Linux distributions, please refer to the distribution's documentation regarding the exact names of the required packages and the ways to install them.
You may need to install the packages manually if:
The machine does not have an active Red Hat subscription or Internet connection.
The setup program cannot find the kernel-devel or gcc version corresponding to the kernel version. If the available kernel-devel is more recent than your kernel, you need to either update the kernel or install the matching kernel-devel version manually.
You have the required packages on the local network and do not want to spend time for automatic search and downloading.
Obtain the packages from your local network or a trusted third-party website, and install them as follows:
In Red Hat Enterprise Linux, CentOS, or Fedora, run the following command as the root user:
In Ubuntu, run the following command:
Follow these steps to install the required packages in Fedora 14 on a 32-bit machine:
Run the following command to determine the kernel version and the required GCC version:
The output of this command includes the following:
Obtain the kernel-devel and gcc packages that correspond to this kernel version:
Obtain the make package for Fedora 14:
Install the packages by running the following commands as the root user:
You can specify all these packages in a single rpm
command. Installing any of these packages may require installing additional packages to resolve dependencies.
In case your domain used for your Email Services is not registered through us please add the following to enable all features: MX Record: yourdomain.com MX PRIO: 10 mx1.mailchannels.net TTL:300 yourdomain.com MX PRIO: 10 mx2.mailchannels.net TTL:300 Please note: If you are using our SpamExperts Inbound Spam Gateway, please note that you have to change the MX records, once SpamExperts has been configured: yourdomain.com MX PRIO: 10 mx.spamexperts.com TTL: 300 yourdomain.com MX PRIO: 20 fallbackmx.spamexperts.eu TTL: 300 yourdomain.com MX PRIO: 30 lastmx.spamexperts.net TTL: 300 SPF Records: yourdomain.com TXT v=spf1 a mx include:relay.mailchannels.net ?all Please note: If you are using other Mail Services for your Domain please add them to your SPF record accordingly. Please contact us for customized DKIM and DMARC records.
On the Select components screen, define the account under which the services will run by specifying Logon account for the agent service. You can select one of the following:
Use Service User Accounts (default for the agent service)
Service User Accounts are Windows system accounts that are used to run services. The advantage of this setting is that the domain security policies do not affect these accounts' user rights. By default, the agent runs under the Local System account.
Create a new account
The account name will be Agent User for the agent.
Use the following account
If you install the agent on a domain controller, the system prompts you to specify existing accounts (or the same account) for the agent. For security reasons, the system does not automatically create new accounts on a domain controller.
The user account that you specify when the setup program runs on a domain controller must be granted the Log on as a service right. This account must have already been used on the domain controller, in order for its profile folder to be created on that machine.
For more information about installing the agent on a read-only domain controller, refer to this knowledge base article.
If you chose the Create a new account or Use the following account option, ensure that the domain security policies do not affect the related accounts' rights. If an account is deprived of the user rights assigned during the installation, the component may work incorrectly or not work.
A protection agent is run as a Managed Machine Service (MMS) on a Windows machine. The account under which the agent will run must have specific rights for the agent to work correctly. Thus, the MMS user should be assigned the following privileges:
Included in the Backup Operators and Administrators groups. On a Domain Controller, the user must be included in the group Domain Admins.
Granted the Full Control permission on the folder %PROGRAMDATA%\Acronis
(in Windows XP and Server 2003, %ALLUSERSPROFILE%\Application Data\Acronis
) and on its subfolders.
Granted the Full Control permission on certain registry keys in the following key: HKEY_LOCAL_MACHINE\SOFTWARE\Acronis
.
Assigned the following user rights:
Log on as a service
Adjust memory quotas for a process
Replace a process level token
Modify firmware environment values
Follow the instructions below to assign the user rights (this example uses the Log on as service user right, the steps are the same for other user rights):
Log on to the computer by using an account with administrative privileges.
Open Administrative Tools from Control Panel (or click Win+R, type control admintools, and press Enter) and open Local Security Policy.
Expand Local Policies and click on User Rights Assignment.
In the right pane, right-click Log on as a service and select Properties.
Click on the Add User or Group… button to add a new user.
In the Select Users, Computers, Service Accounts, or Groups window, find the user you wish to enter and click OK.
Click OK in the Log on as a service Properties to save the changes.
Ensure that the user which you have added to the Log on as service user right is not listed in the Deny log on as a service policy in Local Security Policy.
Note that it is not recommended to change logon accounts manually after the installation is completed.
Prerequisites
Download the agent that you need on the workload that you plan to protect. See Downloading protection agents.
To install Agent for Mac (x64 or ARM64)
Ensure that the machine is connected to the Internet.
Double-click the installation file (.dmg).
Wait while the operating system mounts the installation disk image.
Double-click Install.
If a proxy server is enabled in your network, click Protection Agent in the menu bar, click Proxy server settings, and then specify the proxy server host name/IP address, port, and credentials.
If prompted, provide administrator credentials.
Click Continue.
Wait until the registration screen appears.
Do one of the following:
If you log in under a company administrator account, register workloads for your company:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account under which you want to register the workload.
Click Check code, and then click Confirm registration.
If you log in under a partner administrator account, register workloads for your customers:
Click Register workload.
In the opened browser window, sign in to the service console and review the registration details.
In the Register for account list, select the user account of your customer under which you want to register the workload.
Click Check code, and then click Confirm registration.
Click Show registration info. The setup program shows the registration link and the registration code. If you cannot complete the workload registration on the current machine, copy the registration link and code, and then follow the registration steps on a different machine. In this case, you will need to enter the registration code in the registration form. The registration code is valid for one hour.
Alternatively, you can access the registration form by clicking All devices > Add, scrolling down to Registration via code, and then clicking Register.
Do not quit the setup program until you confirm the registration. To initiate the registration again, you will have to restart the setup program and repeat the installation procedure.
As a result, the workload will be assigned to the account that was used to log in to the service console.
Register the workload manually by using the command line. For more information on how to do this, refer to Registering workloads manually.
[If the agent is registered under an account whose tenant is in the Enhanced security mode] Set the encryption password.
If your macOS version is Mojave 10.14.x or later, grant full disk access to the protection agent to enable backup operations.
For instructions, see Grant the 'Full Disk Access' permission to the Cyber Protection agent (64657).
To use the remote desktop functionality, grant the required system permissions to the Connect Agent. For more information, see Granting the required system permissions to the Connect Agent.
For Windows workloads protected by agent version 15.0.26986 (released in May 2021) or later, the following components are installed dynamically – that is, only when required by a protection plan:
Agent for Antimalware protection and URL filtering – required for the operation of the antimalware protection and URL filtering features.
Agent for Data Loss Prevention – required for the operation of the device control features.
Acronis Cyber Protection Service - required for the operation of the antimalware protection.
By default, these components are not installed. The respective component is automatically installed if a workload becomes protected by a plan in which any of the following modules is enabled:
Antivirus & Antimalware protection
URL filtering
Device control
Similarly, if no protection plan requires antimalware protection, URL filtering, or device control features anymore, the respective component is automatically uninstalled.
Dynamic installation or uninstallation of components takes up to 10 minutes after you change the protection plan. However, if any of the following operations are running, dynamic installation or uninstallation will start after this operation finishes:
Backup
Recovery
Backup replication
Virtual machine replication
Testing a replica
Running a virtual machine from backup (including finalization)
Disaster recovery failover
Disaster recovery failback
Running a script (for Cyber Scripting functionality)
Patch installation
ESXi configuration backup
To enable all features from the remote desktop functionality on macOS workloads, in addition to the full disk access permission, you must grant the following permissions to the Connect Agent:
Screen Recording - enables screen recording of the macOS workload via NEAR. Until this permission is granted, all remote control connections will be denied.
Accessibility - enables remote connections in control mode via NEAR
Microphone - enables sound redirection from the remote macOS workload to the local workload via NEAR. To enable the sound redirection feature, a sound capture driver must be installed on the workload. For more information, see Remote sound redirection.
Automation - enables the empty Recycle bin action
After you start the agent on the macOS workload, it will check if the agent has these rights and will ask you to grant the permissions, if needed.
To grant the Screen Recording permission
In the Grant required system permissions for Cyber Protect Agent dialog, click Set up system permissions.
In the System permissions dialog, click Request Screen Recording permission.
Click Open System Preferences.
Select Connect Agent.
If the agent does not have the permission when you try to access the workload remotely, it will show the Screen Recording permission request dialog. Only the local user may answer the dialog.
To grant the Accessibility permission
In the Grant required system permissions for Cyber Protect Agent dialog, click Set up system permissions.
In the System permissions dialog, click Request Accessibility permission.
Click Open System Preferences.
Click the lock icon in the bottom-left corner of the window so that it changes to an unlocked one. The system will ask you for an administrator password to make changes.
Select Connect Agent.
To grant the Microphone permission
In the Grant required system permissions for the Connect Agent dialog, click Set up system permissions.
In the System permissions dialog, click Request Microphone permission.
Click OK.
You must also install a sound capture driver on the macOS workload to let the agent utilize the given permission and redirect the sound of the workload. For more information, see Remote sound redirection.
To grant the Automation permission
In the Grant required system permissions for the Connect Agent dialog, click Set up system permissions.
In the System permissions dialog, click Request Automation permission.
Please use following details to setup your Mail Account with Mail Clients like Outlook, Apple Mail and others with IMAP. Incoming Server bbzmail.me Port 993 SSL Encryption enabled Outgoing Server bbzmail.me Port 587 SSL Encryption enabled Outgoing Server needs authentication (Email, Password or "same as incoming")
When you Sign In, you enter your username and password and select the version you want to use. You can select to use the default client, or change the client version.
Contact your Company administrator for the login URL and credentials.
Figure 1. Zimbra 9 login page The Web Client has two versions — Modern and Classic. A Default option also appears in the version drop-down. After login, you can choose either Modern or Classic to be the default client.
Type the URL in a browser’s address bar.
Enter your username in the Username field.
Enter the password in the Password field.
Choose Modern from the Version drop-down to experience the all new Zimbra 9 email.
Check the box Stay signed in to avoid entering your password each time you launch Zimbra 9.
Click Sign In to login.
Microsoft Outlook is the de facto email client in the Microsoft space which helps millions of users connect all their email accounts, calendars, and files in one convenient spot.
First, we make sure that the Microsoft Outlook application is installed.
When we first open Outlook, it will prompt us to set up an account. If it does not, go to File > Info > Add Account.
Select Yes for the question: Do you want to set up Outlook to connect to an email account?
Click on Next
Select Manual setup or additional server types. Click Next.
Choose POP or IMAP, and then choose Next.
Enter all the required information found here with your account details.
Once done, on More Settings, the internet email dialogue box will appear.
Under the Outgoing Server tab, check “My outgoing server (SMTP) requires authentication”.
If not already selected, we select Use same settings as my incoming mail server.
Under the Advanced tab:
Click Next.
Then click Finish.
Finally, you can try to login into the account and send a test email.
You are set to start sending and receiving emails on the Outlook application.
IMAP, CalDav, and CardDav are an open set of rules for synchronizing your emails, contacts, calendars, and tasks with mobile or desktop devices. Collaboration Suite creates mobile profiles which you can download, configure, and sync your mobile devices. Android OS natively (without the help of external apps) supports IMAP for managing email; however, CalDAV and CardDAV require installation of apps like OpenSync. Mac and iOS have provisions for working with CalDAV and cardDAV; hence, you do not need any Mac or iOS app to work with them. This section explains how to export profiles. To import these profiles to your mobile devices, you may want to look at below help articles:
Export Profiles
There are five profiles available to download and sync with devices that support this. Email, Calendar, and Tasks, Contacts This profile syncs Email, Calendar, Tasks, and Contacts on mobile devices with Zimbra. Calendar and Tasks, Contacts This profile syncs only Calendar, Tasks, and Contacts on mobile devices, with Zimbra; it does not sync emails. Calendar and Tasks This profile syncs only Calendar and Tasks on mobile devices, with Zimbra; it does not sync emails and contacts. Contacts This profile syncs only contacts on mobile devices, with Zimbra; it does not sync emails, calendars, and tasks. Email This profile syncs only emails on mobile devices, with Zimbra; it does not sync contacts, calendars, and tasks.
Click Accounts in the left pane and choose an account from the right pane.
Scroll down to Mobile or Desktop configuration segment.
Choose one of the profiles from the drop-down and click Download.
Import profiles to iOS
IMAP https://support.apple.com/en-in/HT201320 CalDAV https://support.apple.com/en-in/guide/iphone/iph3d1110d4/ios CardDAV https://support.apple.com/en-in/guide/iphone/iph14a87326/ios
Import profiles to Android
Since Android — without external apps — supports IMAP only, you may need to check the instructions specific to the app you use for CardDAV and CalDAV.
Select → Settings.
This pane also displays the search result.
This pane displays emails from your Inbox by default. Event invitations appear with . This icon helps set an invitation apart from an email. Clicking a folder in the Left Sidebar lists its contents in this pane.
This section familiarizes you with Bamboozle's Business email interface.
Figure 2. Email interface
This page is the first thing you see when you log in to check your emails. It has
A left sidebar.
An email pane.
A reading pane located to the right or below the email pane. The reading pane can be disabled from Settings.
You can drag to change the width of each pane.
Zimbra supports keyboard shortcuts; to see what shortcuts are defined, type Ctrl+Q. The available keyboard shortcuts are context-sensitive. Ctrl+Q displays different shortcuts depending on whether you have selected mail, calendar, or contacts.
Shift and Ctrl help you select contiguous or non-contiguous emails, respectively.
Keyboard Shortcuts During Input
While providing input, e.g. "Add Event" dialog:
Tab moves to next element
Shift+Tab moves to previous element
Command+C or Ctrl+C to Copy
Command+X or Ctrl+X to Cut
Command+V or Ctrl+V to Paste
Commmand+Z or Ctrl+Z to Undo
Commmand+Shift+Z or Ctrl+Shift+Z to Redo
Mac users should consider enabling full keyboard access See
These buttons become functional after you select an email and view its contents in the reading pane.
Click to reply to the person who sent this email. Click to reply to everyone whose email address appears in To or Cc fields.
Any attachment in the original email is not included in Reply or Reply All functions.
Click to forward this email to others. It is especially helpful in sending a received attachment to others.
archives your emails and saves space. Archived emails do not appear in Inbox or any of the folders, but you can search for them using Email Search box.
removes emails from the current folder and moves them to a folder chosen from the drop-down.
deletes emails. The deleted emails appear in the Trash folder.
marks emails as spam and moves them to the Junk folder.
reveals further actions to take on emails like marking an email as read or unread, or mark an email with a for it to stand out, and blocking a contact from sending you emails.
The left pane of the email window contains the following folders.
Whenever someone sends you an email, it comes straight to your Inbox. Click this folder to view your incoming emails. You can also right-click this folder to create subfolders.
Mails that you have written and saved — or which Zimbra saved while you were composing them — but not yet sent appear under drafts folder.
When you send an email to someone, it appears in your sent folder. You can right-click this folder to create subfolders.
Zimbra moves all the unwanted or spam emails here to keep them out of your Inbox.
All deleted emails are moved to this folder until you Empty the Trash, permanently delete, or move to another folder to keep.
Sometimes, you may want a folder for storing specific emails. All such folders are listed here.
If you create a search that you want to use again, you can save it. The saved searches are listed here.
It also lists your tags that other emails may carry. Clicking a tag lists all emails in the email pane, carrying that tag. You can also create a custom tag.
The Zimbra Connector for Outlook (ZCO) provides real time, two-way synchronization of email messages, folders, tags, address books, tasks, and calendaring between Outlook and your Zimbra account.
ZCO stores a copy of your account data on your computer in a database called a ZDB. This allows you to work with your data even when you are not connected to the Zimbra server.
This guide covers installation, configuration, synchronization and other features of ZCO.
ZCO is supported on the following Microsoft Operating Systems:
Windows 10
Windows 8.1
All operating systems must have the latest updates from Microsoft.
ZCO is supported on the following versions of Microsoft Outlook:
Outlook 2019: 32-bit and 64-bit editions of Microsoft Office, including Click to run.
Outlook 2016: 32-bit and 64-bit editions of Microsoft Office, including Office365.
Outlook 2013: 32-bit and 64-bit editions of Microsoft Office. and Click to run versions.
Outlook 2013: 32-bit and 64-bit editions of Microsoft Office.
Microsoft has stopped supporting Outlook 2010 as of Oct 2020. Though ZCO should still work with Outlook 2010 32-bit and 64-bit editions, Synacor will support these versions on a Best Effort basis.
All installations of Microsoft Outlook and Microsoft Office must have the latest updates from Microsoft.
If Outlook is upgraded to a different version, ZCO must be uninstalled and reinstalled. This is particularly important following an upgrade to OL2013, as ZCO needs to be installed to a different location on the client computer.
Note: Click to run versions of Outlook 2010 are not supported.
This chapter provides information about how to set up ZCO to access your Zimbra email account via Outlook. There are three stages:
Install ZCO using the ZCO MSI (installer) file.
Create a ZCO Outlook Profile: See below for more information on profiles.
Start Outlook against the above profile. At this time, ZCO will do an InitialSync to pull your account data to the ZDB. The time this takes varies with the amount of content in your account, the size of the Global Address List, the number of other users also synchronizing, and network conditions. If you must interrupt a sync in progress, it will later resume where it left off.
You must have administrative privileges on your computer to install ZCO. If you do not, you can obtain them temporarily from your system administrator.
Before installing ZCO, make sure you know the following information
The Zimbra server host name
Whether the server requires a secure connection
Your Zimbra email address
Your Zimbra account password
When you start Outlook for the first time against a new profile, you should ensure that your computer is connected to the server using a reliable (preferably wired) connection so that initialization can take place quickly.
If you are running anti-virus software, it might slow down InitialSync, so, if possible, consider turning it off for the duration of the InitialSync
To install ZCO, you must download the ZCO MSI installation file to your computer. The MSI can normally be obtained by browsing to:
Alternatively, your system administrator will be able to provide it to you.
The installer walks you through the process of installing ZCO.
If Outlook is open, close it.
Double-click the MSI installation file on your computer to execute the installer.
Click Next.
Read the end-user license agreement and click I accept the terms in the License Agreement.
Click Next.
To begin the installation, click Next.
When finished installing, the Installation Complete dialog displays. Click Close.
Microsoft Outlook uses what is known as an Outlook (or sometimes "MAPI" or "mail") profile to connect to your email account. The profile tells ZCO which email account is to be used, how to connect to the server as well as other configuration settings.
You can configure multiple profiles, each for a different email account. For example, you might have a profile for your work-related email account and another for your personal email account. You can view profiles that are configured on your machine by using the Mail option in the Windows Control Panel.
While ZCO is installed, if there are no existing Zimbra profiles the ZCO installer automatically creates an empty ZCO profile (usually called Zimbra) for you.
To make use of this, follow the steps below.
Open Outlook.
Choose the profile called Zimbra. Outlook displays the Zimbra Server Configuration Settings dialog.
Enter the Server Name.
Unless otherwise instructed by your administrator, leave Use Secure Checkbox selected.
Enter your Zimbra email address.
Enter your Password.
(Optional) You can also go to the Connection Settings, Download Settings and Data Files tabs for more options. See the Advanced Profile Settings section below for more information on these.
Click OK to start Outlook. Outlook begins fetching your account data from the server and storing it in your ZDB. To check its progress, open the Zimbra Ribbon and click Show Zimbra Progress.
Note that these are typical steps only. Your administrator may have configured the server and/or the installer in a way that requires fewer steps. In that case, they will provide details separately
You can create additional ZCO profiles as follows:
Control Panel > Mail > Show Profiles, make sure the Prompt for a profile… option is selected, and then click Add.
Specify the name of the new profile.
Select Manually Configure server settings or additional server types and click Next.
Click Other and choose Zimbra Collaboration Server and click Next.
Complete the profile as specified in the Creating a ZCO Profile section above.
Your administrator will tell you if you need to change any of the following settings.
Connection Settings: ZCO uses Windows Internet Explorer (IE) proxy settings by default. If you want to manually configure proxy settings, you can enter an HTTP proxy and port number or select to use no proxy.
Download Settings: This setting determines how messages are downloaded. To save storage space on your computer, you can configure ZCO to download only the email message header instead of the complete message. The default is to download the complete message, including attachments.
Data Files: These are the roaming profile settings for your account. Setting up a roaming profile lets you access your Outlook mail from more than one computer. You store your Outlook profile information and settings on a remote machine.
If your system administrator has installed a newer version of ZCO on the server, and if you already have a version of ZCO installed on your system, the next time you start Outlook you will be asked if you want to upgrade ZCO.
You can choose to upgrade, skip the version, or never upgrade. If you select Upgrade, the latest version downloads to your computer, Outlook restarts automatically and the upgrade begins.
You must have administrative privileges on your computer to upgrade ZCO. If you do not, you can obtain them temporarily from your system administrator.
In some circumstances, for example before upgrading an existing Outlook installation to Outlook 2013 or later, you will need to uninstall ZCO.
To do this, select the Programs and Features option from the Windows Control Panel and then double click on the Zimbra Connector entry in the list of installed programs.
Uninstalling ZCO does not affect any existing Outlook profiles.
You must have administrative privileges on your computer to uninstall ZCO. If you do not, you can obtain them temporarily from your system administrator.
The first time you open Outlook after ZCO is installed and configured, your Outlook mailbox automatically does an Initial Synchronization with the server.
Initial synchronization can take a few minutes or longer, depending on the size of the mailbox, the network speed and other factors discussed in the previous section. On slow networks, the initial synchronization of large mailboxes can take several hours.
It is advantageous to install ZCO while connected to a fast and reliable company network. It is also strongly advised that Antivirus software is disabled during the initial sync, otherwise the Antivirus software can prolong the initialization by virus checking messages as they are placed in the ZDB.
The progress of your synchronization is displayed in the Zimbra Send/Receive Progress dialog.
In general, you can use Outlook during the synchronization because ZCO synchronizes in the background, but for the initial synchronization it is recommended that you wait for synchronization to complete.
During Synchronization, new mail received during the synchronization is delivered immediately.
If the synchronization does not start automatically, you can manually start the synchronization by pressing F9 or clicking Send/Receive All Folders on the Send/Receive Ribbon or pressing the F9 key.
For best performance, you should not interrupt the initial synchronization while it is in progress, for example by restarting Outlook, or disconnecting from the network. If you do, it will resume from where it left off.
ZCO synchronizes all of your folders including email in your Inbox, email you have filed to other folders, Sent Items, Drafts and Trash. It also synchronizes your Calendar, Contacts, Tasks and Notes folders.
In addition, it synchronizes any email signatures you have created, and the contents of the Safe Senders and Blocked Senders tabs of Outlook’s Junk Email Options dialog, together with selected preferences e.g. your Read receipt preferences.
After your first synchronization, you can access your Zimbra account using Outlook.
Your Zimbra mail folders display in the Navigation pane. You can view your calendar, contacts, and tasks by clicking the application bar below your mail folders, located at the lower left of the pane.
The most recent email received displays in your Inbox in the Content pane. The Content pane also displays the details of appointments, contacts, and tasks, depending on what application bar is active.
Your upcoming appointments and tasks display in the To-Do Bar on the right side of the view.
Changes you make using either Outlook or the Zimbra Web Client are automatically synchronized to each other within approximately one minute.
The exception to this rule is that changes made by owners of folders that they have shared to you (see Sharing Folders later in this guide) are synchronized to Outlook according to Outlook’s "Send/Receive Groups" dialog box (by default every 30 minutes). You can force a manual synchronization at any time by clicking Send/ Receive or pressing F9.
To obtain full support for Contact Groups for profiles that were created with older versions of ZCO, it is necessary to perform a full GAL reset on your ZCO client to ensure contact groups and their members are synced correctly with ZCS.
If users don’t access their ZCO Profile for long durations (e.g. more than 3 months), then the profile becomes stale. In such a scenario, when user launches Outlook, then a pop-up message "Your mailbox is too far out of date to be synchronized with the [ZIMBRA] server. Do you want to download fresh mailbox data the next time you start Outlook?" is displayed with YES/NO buttons.
If user clicks “YES” button, it will delete stale profile data files (zdb, .db etc) and on next Outlook launch ZCO will fetch all fresh data from the server. (Just like configuring the new profile)
If users clicks "NO" button, then same error message will be shown on next ZCO profile launch.
The Zimbra Advanced Settings dialog allows the user to configure settings specific to certain features in ZCO (e.g. purge, HAB, partial sync etc.), if any settings on the page are changed, then Outlook restart is required. ZCO will pop up the "Restart" dialog to do this.
This chapter describes the advanced features of ZCO.
A single Mail Profile can combine Zimbra, IMAP, Exchange and POP accounts but note that you cannot add more than one Zimbra account to an individual profile.
To add a new account, go to:
Start → Settings → Control Panel → Mail → Show Profiles → Add…
and follow the prompts to add a new email account.
Over time, the ZDB can become fragmented - taking more space than it needs, and affecting performance - particularly after the deletion of a large number of items.
It can, therefore, be beneficial to compact your ZDB periodically. Compacting every few months should be sufficient in most cases.
For large mailboxes, this operation can take significant time - an hour or even longer - during which you will not be able to use Outlook, so you should do this at a time when you do not need to use Outlook.
In Outlook, select File > Account Settings.
In the Account Settings dialog box, click the Email tab.
Select the Zimbra profile for which you want to compact the ZDB and click Change.
In the Zimbra Server Configuration Settings dialog, select the Data Files tab.
Click Compact files. A progress window opens and then closes after the ZDB compaction completes.
Click OK.
Zimbra administrators can now enable the automatic compaction of databases. If the administrator has disabled the progress dialog, the compaction still proceeds in the background, and you may see the Outlook splash screen for a bit longer than usual.
When Outlook starts up, it connects to the server to verify your login credentials. This process is known as Authentication.
ZCO supports four types of authentication:
Username and Password
Single Sign-on
Two-Factor Authentication
Certificate Authentication
Zimbra administrators configure the authentication type that you use.
Username and Password
The most common form of authentication wherein you enter your username and password to complete the verification process. Login requires no other information.
Single Sign-on
In Single Sign-on, ZCO uses your Windows Login credentials. If this is available in your organization, you will see a checkbox on the first Zimbra property page:
Connect using my Windows login credentials
Two-Factor Authentication
If your Zimbra server account has been set up to use Two-Factor Authentication, then you will be asked to provide a time-sensitive passcode during sign-in.
The passcode needs to be generated using a third-party app (e.g., Authy, Google Authenticator, Microsoft Authenticator, etc.), which Zimbra administrators configure for your account.
When entering the passcode, you will be given the option to Remember this device. If you select this option, you will not need to provide a code again for this account on your current machine for 30 days by default.
Certificate Authentication
If your Zimbra server account is set up to use certificate authentication, then you need an appropriate certificate for your Zimbra account configured on your PC. You will then be prompted to select this certificate whenever you sign in to your Zimbra server account with Outlook.
Outlook Notes synchronize with the server where they appear within Briefcase folders. There, they can be viewed, but not edited with the Zimbra Web Client. Each Outlook Notes folder appears as a Briefcase folder.
Briefcase folders created with the Zimbra Web Client do not appear in Outlook unless they contain Notes.
A Zimbra Persona allows you to create a separate email identity to manage different email accounts. E.g., you can create a persona for your work email and another for your non-business emails.
By using a persona, you can specify a different From address and a Reply To address. All outgoing email displays the email address of the persona that you are using. You choose the persona by clicking the From field in Outlook’s Compose Email window.
You can view, add, edit, and delete your Zimbra Personas from Outlook.
If you previously created personas using the Zimbra Web Client, the personas will sync with Outlook.
Adding a Persona
Click the Zimbra tab → Personas
Click Add.
Enter the name for the new persona and click OK.
(Optional) In the Personas Settings area, you can choose what appears in the From and Reply-to fields of email messages.
Uncheck the box Set the "Reply-to" field of email messages to: to set the same persona settings for new emails and replies.
To have a different Reply-to information, check the box and enter a different From name and email address.
Click OK to save your changes.
Synchronizing Personas
When composing or replying to an email, you may need to sync your personas if you do not see them under Accounts (Outlook 2007 and older) or under From (Outlook 2010 and newer).
Click the Zimbra tab → Personas
Click Add.
Confirm your account is in the Personas list. If your persona is not listed, you need to add a persona.
Click OK. This action syncs personas and displays the Account menu in the New Message dialog.
Deleting a Persona
Click the Zimbra tab → Personas
Click Add.
Select the persona you want to delete.
Click Delete to delete the selected persona.
Click OK.
To recover a deleted persona before changes are applied, click Cancel.
You cannot delete the default Persona.
You cannot recover personas once you have deleted them and saved the changes.
In Outlook, you can assign categories to email messages, contacts, tasks, and appointments. These categories are synchronized with your account and appear in Zimbra with colored labels known as tags.
You can use categories to organize and find particular items. One item can belong to multiple categories.
To browse your account by category, go to your Zimbra mail folder in the Outlook Navigation pane
Select Search Folders → Categorized Mail. The mail appears grouped by category in the Content pane.
Rules allow you to automatically filter or manage incoming or existing email in your account.
A rule consists of one or more conditions that an email must satisfy, and one or more actions that will be applied when it does. For example, you can select from the following actions:
Automatically move an incoming email into a specific folder
Delete a message
Forward a message
Assign an email to a category
Flag a message
Mark a message as read
There are two kinds of rules:
Zimbra Server Rules
Outlook Local Rules
Zimbra Server Rules are executed by the server even when your Outlook is not running. For this reason, server rules are generally the preferred way to automate email management, and ZCO disables Outlook rules by default.
To configure Server Rules, use Tools → Zimbra Server Rules.
Creating a New Email Rule
Click the Zimbra tab → Zimbra Server Rules.
In the Rules dialog box, click New. A rules wizard dialog appears.
In the Select condition(s) section, select the conditions that the message must match. As you select the conditions, they display in Edit the Rule Description section.
If the condition you selected requires a value, such as with specific words in the body, you must enter the values or parameters for the condition:
Click the condition line in the Edit the Rule Description section.
In the dialog that opens, enter, add, or select the value(s) or parameter(s) for the condition and click OK.
Click Next.
In the Select actions section select an action to take. Selected action appears in the Edit the Rule Description section.
If the action you selected requires a value, you must enter the values or parameters for the action:
Click the action line in the Edit the Rule Description section.
In the dialog that opens, enter, add, or select the value(s) or parameter(s) for the action and click OK.
Click Next.
In the Select exception(s) section, select the exceptions that the message must match. As you select the exceptions, they display in Edit the Rule Description section.
If the exception you selected requires a value, you must enter the values or parameters for the exception:
Click the exception line in the Edit the Rule Description section.
In the dialog that opens, enter, add, or select the value(s) or parameter(s) for the condition and click OK.
Click Next.
Enter a name for your new rule in the Specify a name for this rule field.
Select whether to apply the rule to messages that meet Any condition or All conditions.
(Optional) Select Do not process additional filter rules if applicable.
Review your rule description.
To make changes, click Back.
If your rule description is correct, click Finish.
Your new rule appears in the list of rules.
Editing an Email Rule
Click the Zimbra tab → Zimbra Server Rules.
Select the rule you want to edit.
Click Edit.
Select the condition, action, exception, or other detail you want to edit.
Click Next.
Click Finish when you are finished editing the rule.
Click Apply to exit the Rules Wizard and save your changes.
Deleting an Email Rule
Click the Zimbra tab → Zimbra Server Rules.
Select the rule you want to delete.
Click Delete.
Click Apply to exit the Rules Wizard and save your changes.
Running an Email Rule
You can run rules at your convenience or on already-received emails.
Click the Zimbra tab → Zimbra Server Rules.
Select the rule to run.
ZCO runs the highlighted rule regardless of whether you have checked the checkbox.
Click Run Now on the right.
Choose the folder on which to run the rule.
Click OK to run the rule.
While the server runs your selected rule on a folder, a progress dialog shows you how many emails have been processed and affected. You can stop the rule from running by clicking Cancel in the dialog.
When all the emails in the folder have been processed, you will be shown a summary of the run. Click OK to acknowledge and close the dialog.
The filter runs on the Zimbra server, so the client must be online, and changes for affected messages need to synchronize to the Outlook client before they are visible.
You can share your email, address book, calendar, tasks, and notes folders with others either in your organization, external guests, or the public.
Creating Internal, External, and Public Shares
When you share your folder, you identify whether to share your folder internally, externally, or to create a public share.
Internal share: Zimbra users or groups listed in the Global Address List (GAL) can view your folder. You select the types of privileges to grant to internal users.
External share: External users can see your folder using their email address and a password that you assign. External users cannot make any changes to the information they view.
Public shares: Anyone can see your folder using its URL. Viewers cannot make changes to the information they view.
Assigning Roles and Access Privileges
Roles are preset combinations of access privileges. The access privileges are defined as follows:
Read: View items in the folder.
Edit: Change the contents of the folder.
Create: Add items to the folder.
Delete: Delete items from the folder.
Act on Workflow: Respond to requests.
Administer Folder: Modify the permissions of the folder.
The following are the roles that a user can allow when sharing:
Administrator
Read, Edit, Create, Delete, Act on workflow, Administer folder. The grantee has the same access to the folder as the owner.
Delegate
Read, Edit, Create, Delete, Act on workflow
Reviewer
Read. This role is the default.
All external and public shares are assigned the role of Reviewer, and it cannot be changed.
Share Multiple Folders Using Parent Permissions
By default, the grantees and access privileges assigned to a folder only apply to that folder and not to any folders stored inside the folder (child folders). The Inherit permissions from parent option in the Sharing tab allows you to apply the same grantees and access privileges as the parent folder. This option enables you to assign grantees and access privileges to multiple folders without setting up individual shares for each one.
Sharing a Folder with Another Zimbra User
Right-click the folder you want to share and select Properties.
Click the Sharing tab.
Click Add.
Select Internal and click OK.
In the Search field, start typing a name to show the access list. Make sure you select the Address Book from which you want to search.
Select the user to whom you wish to assign delegate access.
Click OK. The name displays in the Properties dialog.
Note: You can only add one person at a time. To share with more than one person, repeat these steps.
From the Permission Level menu, select the role that defines the access privileges:
Administrator
Can create, read, edit, and delete items; can also administer a folder and act on workflow items.
Delegate
Can create, read, edit, and delete items and act on workflow items.
Reviewer
Has read-only privileges. But if you want to have the same permission level as the parent folder, check Inherit permissions from parent.
Click Apply.
Click OK.
The person receives a notification email with the sharing information.
Share a Folder with an External User
Right-click the folder to share and select Properties.
Click the Sharing tab.
On the Sharing tab, click Add.
Select External.
In the * Email Address* field, type the email address of the external user.
In the Password field, type a password for the person to use for accessing this shared folder.
Click OK. The Sharing tab lists the external user’s email address. The permission level is Reviewer and cannot be changed.
Click Apply. To add other users to the Sharing list, repeat these steps.
The person receives a notification email with the sharing information.
Create a Public Share
Creating a public share allows access to external users without a password.
Right-click the folder to share and select Properties.
Go to the Sharing tab.
On the Sharing tab, click Add.
Select Public.
Click OK. An option Public appears in the Sharing tab. The permission level is Reviewer and cannot be changed.
Click OK.
To access this share, users must enter the folder’s URL in a Web browser. The URL is your mail server’s address, followed by /home/:
For example, if your mail server is https://mail.example.com/, the username is Joe, and the folder you are sharing is Tasks, the sharing URL is
Changing or Revoking Access
You can change the role that you assigned and delete access.
Right-click the folder you have shared and choose Properties.
Click the Sharing tab to see who has the permission to access the folder.
Select the name and change the permission levels. To cancel the access, select the name and click Remove.
Click OK.
The next time a grantee syncs with the Zimbra server, the shared folder updates with new information. If you deleted access, the folder no longer appears when the grantee syncs. If you have deleted an external or public share, the grantee cannot access the folder.
Accepting or Declining a Share
When a new sharing invitation is received, Accept Share and Decline Share buttons appear on the main (Home) tab of the Outlook Window’s ribbon. These buttons also appear on the Zimbra tab and the main tab of an open message window.
If you click Accept Share or Decline Share, you must confirm your action.
If you choose Accept the Share:
The shared folder is opened in Outlook.
A corresponding link is created in Zimbra Collaboration (so that the same shared folder is also available in a second Outlook profile and the Zimbra Web Client.
The share message is deleted.
If you choose Decline the Share, the share message is deleted after confirmation.
Share messages present in the Outlook profile — before a ZCO upgrade — will not display the Accept Share or Decline Share buttons.
If the shared storage is already open in Outlook, you receive a notification, and ZCO deletes the shared message.
Copies of outgoing share messages (typically in Sent Items) do not display the Accept Share or Decline Share buttons.
Opening a Shared Folder
If someone has shared their folder with you, follow the below steps to access it.
On the Outlook menu bar, go to Zimbra Ribbon → Open Other User’s Mailbox. The address book dialog opens with the Global Address List displayed.
Navigate to the name of the person who has granted you access. You can also enter their email address.
Click OK. The shared folder now appears at the bottom of your folders list.
To see all folders in the mailbox that are shared, view the Folder List in the Navigation pane.
Viewing Share Status
To view the status of a share, go to:
Zimbra Ribbon → Share Status
Choosing this displays a dialog box that lists all mailboxes whose folders you can access. Entries are added to this list whenever you use Open Other User’s Mailbox. New listings since you last accessed Outlook appear in red.
To the left of the entry is a checkbox. You can uncheck this to stop sharing all folders from that mailbox. You can later recheck it to begin sharing.
Recover Deleted Items allows you to recover deleted items. This feature, when enabled by a system administrator, is useful to recover files you have deleted.
You can recover only emails and contacts.
Recovering a deleted item
Select Zimbra Ribbon → Recover.
Select Messages or Contacts.
Click OK.
Select item(s) you would like to recover.
Click OK.
Recovered items appear in the Trash folder, from where you can move it to the desired folder.
If you want others to send an email on your behalf, then you need to add them to your list of Delegates. Once you have added a user, you can use the Delegates function to share folders, such as Calendar and Tasks from your email account. Sharing permissions and roles were described above.
Select Delegates from the Zimbra ribbon.
Click Add to select your delegates.
Click Permissions… to grant permissions to the selected user.
By default, a new delegate has unrestricted access to the Calendar and Tasks folders.
Click OK.
You can enable multiple delegates to send an email on your behalf. These delegates cannot access your account unless you grant them folder permissions.
If you forward a meeting invitation to other users, they also receive a notification for the initial meeting request.
You can send an automatic response to people when you are out of the office. You can also have different responses for people who are not in your organization.
Click the Zimbra tab → Out of Office Assistant.
Select I am currently Out of the Office.
In the text box, type the message to be sent, such as “I am on vacation from June 1 to June 6 and will not be checking for messages.”
Set the start and end dates and times for using this message.
Under External Senders there are four options in the drop-down.
Send same reply message
The message drafted above is the same that is sent to people outside your organization.
Send different reply to everyone outside my organization
Choose this option and draft a separate message that you would like to send to people who are not in your organization.
Send different reply to everyone outside my organization unless in address book
People who are neither in your organization nor save in your address book receive a different reply than people in your organization.
Don’t send reply to external senders
Choose this option if you do not want the external senders to receive an out of office response.
Click OK. The Out of office message starts on the date and time you specified. External senders may not receive a response as per your choice above.
You can store email messages on the Zimbra server up to the quota configured for your mailbox. Email messages, attachments to messages, address books, calendars, tasks, and the items in your Trash folder contribute to your used quota. When you reach your quota, you may not receive new emails.
You can check your Zimbra Mailbox Quota from Outlook:
Tools > Mailbox Quota
Delete email messages and old calendar appointments from your account. Empty your trash after you delete items to update your storage space.
Download email attachments and save them on your computer locally. You can then remove the attachment from an email to free up space on the server.
Archive messages in Outlook.
The Outlook AutoArchive function is disabled for Zimbra profiles and folders. This feature should not be enabled. Auto-archiving removes files from the server, including items shared with others. This removal can cause data loss or problems with recurring appointments, shared objects, and historical calendar data.
Outlook’s global AutoArchive function remains enabled for Outlook features that are not Zimbra specific.
After you delete items, use the Refresh feature to check for the most recent quota.
When you are working offline:
Only the items that are in the ZDB that are on your computer are available.
If you configured the settings to download headers only, only the messages that you have downloaded are available.
New mail is not synchronized to your computer until you go online and connect to the Zimbra server.
Email that you create while working offline is saved to your Outbox and is automatically sent when you connect to the Zimbra server.
To view the history of ZCO sync activity, go to Zimbra Ribbon > Show Zimbra Progress.
The standard Outlook progress dialog does not apply to ZCO.
To hide the progress dialog when there is no ZCO sync activity, click the push-pin in the bottom right corner.
The Global Address List (GAL) contains contact details of people in your organization. By default, a copy of this list is stored in your ZDB so that you can access these details when you are offline.
You can control how often your local GAL is updated. Go to Zimbra Ribbon → Sync Global Address List.
Options include:
Automatic
Your GAL is updated whenever your mailbox is synchronized.
Manual
Your GAL is updated when you do manual sync (e.g., by pressing F9)
Disabled: Updating is disabled
Update Global Address List: Forces an immediate GAL update
Reset Global Address List: Rebuilds your GAL from scratch. Your administrator may request that you rebuild the GAL following specific changes to the server’s GAL.
Resetting your GAL can take an hour or more depending on the size of your organization. You can, however, continue to use Outlook while the reset is in progress.
The Hierarchical Address Book (HAB) allows users to look for recipients using an organizational hierarchy. Zimbra HAB configuration needs to be done at the server-side. Please refer to the https://wiki.zimbra.com/wiki/HAB_configuration for information about HAB setup.
Once HAB is enabled at the server, ZCO will fetch the HAB details and users can view the HAB details using the following ways.
Using HAB search in Outlook Address Book
Using HAB browser from Zimbra ribbon.
Let’s take a brief look at these two options mentioned above:
Using HAB search in Outlook Address Book
ZCO will fetch the data from server at Outlook launch and user will see the Synchronizing HAB task in Zimbra Send/Receive Progress dialog.
Once the Synchronizing HAB task completed then the user can see the hierarchy of the user is shown in Department column in Address Book.
User can enable/disable the HAB Search functionality using option Enable HAB Search in Address Book from Advance Settings dialog.
Using HAB browser from Zimbra tab
ZCO users will see the organization hierarchy by clicking the HAB Browser button in Zimbra ribbon.
All the users of selected department are fetched from the server and populated in the view.
Using Filter button user can search for the specific username if It does not appear up-front.
HAB Browser functionality will not be available if Outlook is set to Work Offline.
An Organizational Chart represents the Global Address Book as an organization chart. The logged-in user can search for any user and get the Hierarchy from that point.
ZCO now supports the organizational browser if the organization chart is configured on the server using zimbra-zimlet-org-chart
.
Following are the steps to access the Org Chart:
On the Outlook menu bar, go to Zimbra Ribbon → Org Browser.
Click on the Org Browser button to open the dialog.
By default, 3 levels of organization hierarchy are displayed for a logged-in user. As the manager of the logged-in user and his reporters, there will be 3 scenarios as below.
HAB Only (Department Wise): This is displayed when the HAB feature is enabled on the server.
Organization Only (Personnel): This is displayed when the org chart is enabled on the server.
HAB with Hierarchy of Organizations (Department + Personnel): This is displayed when both features are enabled on the server.
ZCO now supports Delivery Receipt notifications.
Following are the steps to enable the delivery receipt notification:
In compose window, click on Options.
Select the Request a Delivery Receipt option.
The user will receive a notification mail on successful mail delivery.
One of the problems faced by users of Zimbra Connector for Outlook (ZCO) has been the fact that all data from the server is synchronised on the client machine where Outlook is installed. This means that the client machine needs disk space and resources to manage this data. The Partial/Customised Sync feature helps address this problem, by removing data older than the number of days configured by the use.
This feature, when enabled, will move Mails, Tasks & Calendar items that are older than the days provided by the user to a folder called Zimbra Trash, which is a subfolder of Trash. The user can then regularly do an Empty Trash to permanently remove these older items. The moving of these items in ZCO has no effect on the corresponding items on the Zimbra Server. If the user wants to also delete those items on the Zimbra Server then they can use the Web Interface provided with Zimbra.
Please bear in mind that once these items are purged they will no longer be available to the user later for any activity until user creates new profile and synchronizes all data from server. So it is recommended that the user choses the number of days judiciously – typically at least a month’s worth of data.
In case the Outlook user employs archiving feature of Outlook by moving data into PST files regularly, then we recommend this Partial/Customised Sync feature need not be used. Please see next section how to disable it.
ZCO allows the user to configure the number of days to keep separately for calendar and other items. The number of days for which user wants to keep the Mails, Tasks & Calendar items in outlook can be configured in Advanced Settings.
The value for Purge calendar items older than can be set either by directly entering the required value or by using spin button provided on the right side of the text box. This value will control the calendar items that will be retained in outlook, moving the rest of the items to Zimbra Trash folder.
Any value greater than 0(ZERO) will activate the feature.
Value 0(ZERO) will disable the feature and will keep all the calendar items in outlook since the profile was created.
The value for Purge mail items older than can be set either by directly entering the required value or by using the spin button provided on the right side of the text box. This value will control the mail items that will be retained in outlook, moving the rest of the items to Zimbra Trash folder.
Any value greater than 0(ZERO) will activate the feature.
Value 0(ZERO) will disable the feature and will keep all the mail items in outlook since the profile was created.
The value for Purge task items older than can be set either by directly entering the required value or by using the spin button provided on the right side of the text box. This value will control the task items that will be retained in outlook, moving the rest of the items to Zimbra Trash folder.
Any value greater than 0(ZERO) will activate the feature.
Value 0(ZERO) will disable the feature and will keep all the task items in outlook since the profile was created.
Purging will not move the items from folder Drafts, Sent, Trash, Deleted Items, Junk & Notes folder.
Task items will be purged based on Due Date without considering the task status while purging.
Purging of items, will take place in two different ways:
Once when outlook starts/restarts
When user starts purging by clicking Start Purge button provided on Zimbra Ribbon in Syncing section
Purging can be a very disk intensive activity based on the amount of data to be purged. In case the user finds that it takes up too many resources, we recommend that purge can be employed when the client machine is not being used (for example at nights).
Purging of items, can be paused by clicking Pause Purge button provided on Zimbra Ribbon in Syncing section.
When both the text boxes, Purge calendar items older than & Purge mail & task items older than have been set to zero, the Partial/Customized Sync feature will be disabled. Accordingly, the button to manually start purge will be disabled automatically.
To see the number of items purged since last outlook start/restart, use have to hover the mouse on Start Purge or Pause Purge button on Zimbra Ribbon and it will display a tool tip with the total items purged since last outlook start/restart.
Purge will be done for Primary profile only.
Users can now choose between the Zimbra Free Busy and Internet-Free Busy Provider.
Following are the steps:
Run the Outlook as an administrator. ( Right-click on Outlook and select Run as administrator)
Go to Zimbra → Advanced Settings → Free-Busy Provider.
Users can choose between the Internet FB and Zimbra FB.
Internet FB is an existing FB provider which is selected by default and based on Free-Busy URL. Where the user can see free/busy status for users. However, there are some limitations, such as the user can only see it for the duration that has been configured.
Zimbra FB is a custom Free Busy Provider that retrieves free-busy information via SOAP calls and overcomes issues with Internet FB.
While booking Meeting/Appointment, Outlook users can find available rooms using the Room Finder feature. Room Finder option is available in Zimbra ribbon when the user composes a new appointment/meeting.
Following are the steps to use the feature:
Open Meeting/Appointment window.
Select the start time and end time.
Click on the Room Finder button.
Specify search criteria. for eg. input Minimum Capacity as 10
The result will show all rooms having Minimum Capacity greater than or equal to 10.
Select the desired room from the result list. Click on the select button. Selected rooms get added for the current Meeting/Appointment.
The user can also add multiple rooms by selecting the Allow Multiple Locations check box.
Select Ok to add the selected room(s) in the Location field in Outlook.
When ZCO encounters a problem synchronizing an item, it notifies you by creating a message called a Failure Message. You can control whether ZCO should place these messages in the Inbox or the Sync Issues folder.
Go to Zimbra Ribbon > Error Reports
To access support features, go to Zimbra Ribbon > Support group
Items in the above groups are used only for troubleshooting. Your administrator can explain how to use these should you encounter problems with ZCO.
Report a ZCO issue to the system administrator
A system administrator must enable this feature. You can use it to report any ZCO issue that you experience to the system administrator.
Click the Report Issue menu option to bring up ZCO Issue Detail dialog. Enter the following details to help investigate and solve your problem.
Issue title
a summary of the problem (Max 220 chars)
Issue Description
details about how the problem arose and any contributing conditions (Max 2048 chars)
Completing these fields enables the Submit button on the dialog.
Clicking the Submit button will report the ZCO Issue to your system administrator, and share a copy of the operational logs from your PC.
Clicking on the Cancel button will exit the Report Issue operation, after getting your confirmation.
You can monitor the status of the reporting operation in the Zimbra Send/Receive Progress dialog under the Create and Upload Log Archive task. It usually takes a few minutes to complete, but could take more depending on the size of the log files and communication speeds.
The Report Issue operation creates and uploads a compressed file to ZCOLogs
folder in your briefcase. System administrators can access this folder to identify the issue. Changing the permissions to ZCOLogs
folder may restrict a system admin’s accessibility to this folder.
ZCO supports a feature called Auto upgrade. When Outlook starts, ZCO contacts the server to check if there is a newer version of ZCO available. You get the options below when there is an upgrade available.
Upgrade
Downloads the newer version of ZCO, exits Outlook, and installs the latest version.
Skip this version
Suppresses auto-upgrade until the next version becomes available.
Never Upgrade
Disables Auto upgrade
In addition to auto-upgrade, you can manually check for a newer version at any time from Zimbra Ribbon → Check for Updates.
Check for Updates also detects ZCO versions that you skipped using Skip This Version above.
If you are using Outlook 2016, please see this article
From 8.8.15-Patch-18 and 9.0.0-Patch-11 onwards, ZCO supports Partial/Customized Sync feature which helps Users in better disk space and resource management. Refer to section for more details.
Zimbra Desktop is a desktop email client that gives you online and offline access to your Zimbra email. More than just another choice in the email client landscape, Zimbra Desktop blurs the line bet
Zimbra Desktop uses the same technology as Zimbra's Web Application, has intuitive navigation, supports customizations, and is secure.
Zimbra Desktop app is supported on Windows 10 or newer versions and Mac 10.13 or newer versions.
Setting up Zimbra Desktop app
Setting up the Zimbra Desktop app is easy. When the Desktop app is opened for the first time, users will have to provide the Zimbra Server URL for the Desktop App to connect to the Zimbra server.
Users need to perform this step only once when accessing the Zimbra Desktop app for the first time.
Open the Zimbra Desktop app. Specify the organization’s Zimbra Server URL in the text box. For Bamboozle Business email the link is https://bbzmail.me
Click Continue.
Enter your username in the Email field.
Enter your password in the Password field.
Click Sign in to login.
Upon successful authentication, user will be logged into his Inbox.
Zimbra intends to provide a consistent user experience across all types of devices and hence the desktop application has been designed to support almost all the functionality available in the Zimbra Web App.
In the following documentation:
The term Online is used to refer to a scenario when the Zimbra Desktop app is connected to the Internet.
The term Offline is used to refer to a scenario when the Zimbra Desktop app is not connected to the Internet.
When Zimbra Desktop app is online
All Zimbra Web App functionalities are available when a user is online.
When Zimbra Desktop app is offline
Most of the core mail related functionalities are available to the user even when the desktop application is offline.
The following features are available when the desktop application is offline:
View emails.
View and download attachments.
Reply, Reply All, Forward an email.
Compose a new mail.
Send a new mail.
Mark email as read.
Star / Unstar an email.
Mark email as spam.
Archive an email.
Delete an email.
Move an email.
Create sub-folders under Local Folders.
Message View.
All formatting options in Mail Composer.
Search limited to keywords: from, to, cc, subject, in, has, date.
Limited access to events in Calendar vertical.
Limited access to contacts in Contacts vertical.
While users can perform all of these actions while offline, they will get executed only when the user goes online. For example, a user may send a mail while offline, however the mail will leave the user’s Outbox only when the user goes online.
The following features are not available when the desktop application is offline:
Following options in the Folder Context Menu (i.e. on folder right-click).
Import.
Share.
Create subfolder.
Export.
Empty folder.
Following options in the Trash Folder Context Menu (i.e. on folder right-click).
Mark emails as read.
Empty Trash.
Export.
Recover discarded mail.
Following options in the Mail Context Menu (i.e. on email right-click)
Tag.
Block.
Print.
New Event.
New Filter.
Mark as Spam.
Show Original.
Add Sender to Contacts.
Schedule Send.
Create, Edit, Delete tag.
Access to all contacts.
Access to all calendar items.
Accept, Tentative, Decline, Propose New Time options on a meeting invite.
Conversation View.
Mail Preview Pane settings.
Advanced Search.
Contact Chooser from To field in Composer.
Video, Chat and Cloud Storage verticals.
When logging in for the first time, the user will see the login screen. The user needs to provide valid credentials to log into his account. Upon successful login, mails will be downloaded to the user’s local storage. Users will always have access to these downloaded mails. When the user is online, the user will have access to the data on his mail server as well as the locally stored data. However, when the user is offline, the user will only have access to locally stored data. Users may choose to log out or get logged out due to session expiry. Even when logged out, the user may access the locally stored data by clicking on Cancel on the login screen.
By default, 30 days’s mailbox data will be available to the user for Offline access. If the user wants to download older data, he can navigate to the Local Storage setting and download it by specifying the date.
Click Offline.
Select the date in the date picker for the previous data to be downloaded.
Click Apply.
The data download process will get started.
The Zimbra Desktop app is also designed to handle network error conditions. For e.g. if the message download to local storage is in progress and the network is interrupted, then the message download process will go in a paused state. The Zimbra Desktop app will resume the download process once the network connection is restored.
Once the user’s mailbox data is downloaded successfully, each message is stored in a .eml file.
The data is downloaded at the following location on user’s desktop:
Windows : C:\Users\[USER-NAME]\AppData\Roaming\@zimbra\storage\[account-email-address]\
.
Mac : /Users/[USER-NAME]/Library/Application Support/@zimbra/storage/[account-email-address]/
.
Users will have limited storage available on their mailbox. Users may free up space on their mailbox by moving some of their emails to their local storage. The emails moved to local storage will be accessible to users via the Zimbra Desktop app.
To move the emails to local storage, follow the instructions below:
In Mail tab, create a folder under Local Folders.
Select the mails you want to move to the local storage.
Move those mails to the folder that was created under Local Folders.
Alternatively, user can utilize the Auto-Archive feature to automatically move mails from mailbox to local storage on a regular basis. Refer to Auto-Archive section to know more.
Zimbra Desktop app downloads user’s mailbox data to user’s desktop’s local storage. Hence, it is very important to keep the local data secured.
Zimbra recommends using disk encryption to secure this mailbox information on user’s desktop. Using such disk encryption helps protect user’s mailbox data from data theft, by rendering data stored on hard drives unreadable when an unauthorized user tries to gain access.
Zimbra suggests using operating system recommended disk encryption. Refer the following articles for more information:
Encrypting data on Mac OS - https://support.apple.com/en-in/guide/mac-help/mh11785/mac
Encrypting data on Windows - https://support.microsoft.com/en-us/windows/turn-on-device-encryption-0c453637-bc88-5f74-5105-741561aae838
Zimbra Desktop app supports S/MIME functionality. Users can send Signed or Signed and Encrypted emails to other users. The administrator will have to enable this feature and provide the user’s private certificate and recipient’s public certificate.
S/MIME feature is not available on Mobile App.
User can read or send signed and encrypted messages only when the S/MIME feature is enabled. By default the S/MIME feature is disabled for all users.
The S/MIME feature available on the Zimbra Desktop app is client-side S/MIME, and the S/MIME feature available on the Modern/Classic Web app is server-side S/MIME. To avoid confusion for end-users, we recommend not to use both of these features together.
The Encrypted email refers to an email that has been encrypted with a digital certificate.
Encrypting an email helps to protect sensitive data and preserve confidentiality and privacy. This helps in making sure that only the intended recipient can read the email. If the email is intercepted and opened by an unintended user, that user won’t be able to decrypt and view the email.
For sending encrypted emails, users will need their Private certificate and the recipients Public certificate.
For reading encrypted emails, users will only need their Private certificates.
The Signed email refers to an email that has been signed with a digital certificate.
Signing an email helps to:
Ensure data integrity i.e. the email was not altered from its original form.
Email authenticity i.e. the email came from an authentic sender.
Non-repudiation i.e. the signer cannot deny the authenticity of the email.
This helps in knowing that the received email message comes indeed from the declared sender (a warning appears if someone else intercepted and modified the message before it arrived).
For sending signed emails, users will need their Private certificate.
For reading signed emails, users will need the recipient’s Public certificate.
In this guide we assume that the users have got the certificate from standard service providers (e.g. Comodo, DigiCert, Go Daddy, etc) whose root CA certificates are already present in browsers.
For easy understanding of the steps, we will refer to following examples throughout the section:
Sender’s private certificate - sender-pvt.p12
Recipient’s public certificate - recipient-pub.crt
Importing sender’s private certificate
Zimbra Desktop app refers to the system location for validating the user’s private certificates. Depending upon the format of the certificate, the file extension may vary. Some of the standard certificate extensions are pfx, .p12, .p7B, .sst.
Importing on Windows
There are 2 options to import the certificate on Windows.
Option #1 - Using Internet Options window.
Press Windows+R to open Run box.
Type inetcpl.cpl to open the Internet options window.
Go to Content → Certificates → Personal.
Click on Import.
Follow the instructions and provide your private certificate sender-pvt.p12 and its password when prompted.
You should see a The import was successful message once the import is completed successfully.
Option #2 - Using certificate manager window.
Press Windows+R to open Run box.
Type certmgr.msc to open certificates management window.
On the left hand side, right-click on Personal and go to All Tasks → Import to open the certificate import wizard.
Follow the instructions and provide your private certificate sender-pvt.p12 and its password when prompted.
You should see a The import was successful message once the import is completed successfully.
Importing on Mac
Importing Private certificate:
Double-click on private certificate sender-pvt.p12.
Grant access to the system keychain.
Follow the instructions and provide the certificate password when prompted.
The certificate is added to system keychain
Set the trust level of the certificate:
Double-click on the added certificate sender-pvt.p12 in the system folder.
Select the 'Always trust' option in the trust field.
Grant Zimbra Desktop app the access to the certificate key:
Expand the added certificate in the system folder.
Double-click the certificate key.
Go to Access control tab.
Add Zimbra Desktop app in the list of apps which have access to the key
Save changes
Importing recipient’s public certificate
Click [Contacts] tab.
Right-click the contact and select Edit Details.
In the Security Certificate section, click on Add a certificate.
From the file explorer, select the recipient-pub.crt and click Open.
Click [Save].
Compose a new message.
Add a recipient in the To field.
At the right-hand top corner choose an option from the dropdown. By default Do not sign or encrypt is selected.
Do not sign or encrypt: Mail is neither signed nor encrypted. This is equivalent of disabling the S/MIME feature.
Sign: Send signed message to the recipient.
Sign and Encrypt: Send signed and encrypted messages to the recipient.
Click [Send].
You can change the sign and encryption preferences from Settings.
Select the preference of your choice.
Click [Save].
The selected option will be applicable when users compose a new message.
PST Import feature allows users to import their emails from an existing PST file into the Zimbra Desktop app. Currently, it only supports importing mail data. If the .pst file has any Contacts or Calendar data, that will not be imported.
Click Accounts in the left pane and choose an account from the right pane.
In Import from Outlook (.pst file) section, click on Choose .pst file
Choose the .pst file in the file explorer and click Select.
Click Import to start the PST import.
Depending upon the file size, the import process may take time. Users will be notified once the import is complete.
The mail data is imported under Local Folders. A folder will be created by the name of the imported PST file. For e.g. if the imported .pst file name was importmail.pst
, then a folder importmail.pst will be created under Local Folders. Users may rename the folder after the PST import is completed successfully.
The folder hierarchy in the PST file will be preserved in the imported folder.
PST Import feature is not available on Zimbra Desktop app on Mac.
Sometimes importing PST files may fail due to low disk space availability. If the PST import fails, user may start the PST import process again. However, if the folder has been created then those will have to be manually deleted before starting the PST Import again.
Zimbra Desktop app provides an Auto-Archive feature which helps user move old emails from the mail server storage to the Desktop App’s Local Storage. The archived emails are not accessible through Web App but will be accessible Zimbra Desktop app.
Archiving regularly helps free space on your mail servers.
For example, if you have a 5GB quota available which gets exhausted, then you can archive your mails to free up this quota.
Suppose you archive mails amounting to 1GB, then these 1GB of mails will move from your mail server to your local storage.
These 1GB mails would be accessible using your Zimbra Desktop, but not using your webmail.
You will be able to access these 1GB mails even when you do not have internet connectivity, as these mails will be stored in your local storage.
Archiving checks for the email across all the folders/subfolders. If the primary folder and its subfolder emails matches the archiving criteria, those will be moved under Local Folders and the folder hierarchy will be maintained.
Auto-archive feature is disabled by default.
Following are the steps to enable it:
In General → Storage, select the Enable checkbox.
By default mails older than 30 days will be archived.
To change the days, update Auto-archive emails older than textbox field.
Click Save.
To start the archiving of messages, Zimbra Desktop app needs to be restarted.
Any changes to Auto-Archive settings will be reflected only after restarting the Zimbra Desktop app.
Zimlets are not available when the Zimbra Desktop app is Offline.
Following Zimlets are available in Zimbra Desktop app when it is Online.
Jitsi: Zimlet to add a Jitsi video conferencing link to an event.
Video Call preferences: Allows the user to define video call providers to use in the Calendar.
Slack: The Slack zimlet helps to connect user’s Slack account to Zimbra for quickly initiating conversations using Slack.
Date Zimlet: Detects dates in emails or other content and displays list of the day’s event on hover.
Additional Signatures: Allows user to make extra signatures to use with any accounts.
Restore Contacts: Restore contacts from previous backup. Restore from backup option is added in Contacts → Sort Dropdown
Calendar Subscription: Adds Subscribe option in Calendar → Others to subscribe to external calendar feeds.
Following Zimlets are not available in Zimbra Desktop app when it is Online. However these zimlets can be accessed via Zimbra Modern Web App.
Dropbox
Google Drive
OneDrive
Zoom
Upcoming features planned for the future releases of Zimbra Desktop App are:
Offline support for Calendar
Offline support for Contacts
Backup and Restore
Enhanced Search
Offline support for documents in user’s Briefcase
And many more….
User might very rarely encounter a white-screen followed by Zimbra Desktop app becoming unresponsive. Even if user encounters such a situation, no data is lost. As a workaround, user may try the following workarounds:
Click on Edit→Reload
Restart the Zimbra Desktop app
If the app becomes unresponsive without showing the white-screen, users may to switch to Message View instead of the 'Conversation View'
Customers who are on Kepler-Patch-24 or Joule-Patch-31, would have users face issues during logging into the Desktop App. They can wait for the next patch Kepler-Patch-25 or Joule-Patch-32 for this issue to get resolved or use a workaround.
Workaround - Admin needs to set the zimbra_same_site_cookie
variable to null. Commands to be used on CLI:
In Offline mode, only partial (cached) Contacts and Calendar data is available to the users.
When user is Offline and enters any text to search, the Invalid Search, please try again error is displayed. When Offline, only the following keyword based search is supported - from, to, cc, subject, in, has, date. Other search parameters provided in the following list will be implemented as a part of product roadmap - http://docs.zimbra.com/desktop7/help/en_US/Search/query_language_description.htm.
When a user sends a Signed/Encrypted email containing inline images added through the Insert Images option in the toolbar, the images are not displayed to the recipient.
Users will not able to set the Zimbra Desktop app on Windows Operating System as the default mailto App.
Share and Meeting action buttons don’t appear on the emails when they are moved to a Local Folder.
When users move a message which has a signature containing an image, from Inbox to a local folder, the image is lost.
When the user replying to a Signed message which contains an inline image and changes the S/MIME setting to Do not sign and encrypt, an error is encountered and the mail is not sent.
On Mac OS, when sending a Signed or Signed and Encrypted message, the email address of the sender is not displayed along with the message type. Only the message type like Signed or Signed and Encrypted gets displayed.
Errors are encountered when a user who does not have a valid certificate tries to Reply/Reply-All/Forward/ a Signed or Signed/Encrypted message.
If a user creates contact with multiple email addresses and tries to upload the certificate which has only 1 matching email address in the contact, an error is encountered and the certificate upload fails. The workaround is to create a contact with a single email address matching the certificate.
Invalid Zimbra Server
error when I specify the Zimbra Server URL while trying to log into the Zimbra Desktop App for the first time ?The Zimbra Desktop app is designed to do validations when users provide a Zimbra Server URL in the textbox. Before the user proceeds to the login page, it checks if the URL provided is of the valid Zimbra Server.
Users can check:
If the Zimbra Server URL is accessible from the system by specifying the URL in Web Browser.
Check if the Zimbra Server URL is correct.
Users may not be able to view emails offline because emails have not been downloaded to their local storage.
Users can check:
Yes, click Cancel on the login screen to access the emails from the local storage.
There are some functionalities that are not available when the users are Offline. Refer to Offline Functionality section for more details to see which functionalities are available and which are not available when users are Offline.
When you install the Zimbra Desktop app and login into your account for the first time, the app will start downloading the last 30 days of mails to your local storage immediately. The time taken for this download to complete may vary depending upon the amount of data that you have available in the last 30 days, your internet connection speed, and the server availability.
No, the mails downloaded to local storage will not be removed from the mail server. They coexist on mail servers as well as local storage. The mails will only be removed from the mail server if the user has enabled the Auto-Archive feature.
Yes, the mails in your local storage also be available on your web mail. Since the mails co-exist on mail server as well as local storage, they will be available on your web mail as well. However, if the Auto-Archive feature is enabled, then the web-view and Desktop-view of your mailbox will differ.
Once the Auto-archive feature is enabled, Zimbra Desktop App will have to be restarted to start the auto-archiving of the mails. Depending upon the data to be archived, the process may take some time. The mails matching the auto-archive criteria will be moved from Inbox to Local Folders. If mails from multiple folders or subfolders are archived, then the folder hierarchy will be also maintained under Local Folders.
There are multiple reasons why it might appear that auto-archiving is not working.
If offline-sync is already completed, please try re-starting the app.
When a user logs in for the first time in the Zimbra Desktop app, by default last 30 days' mail data will be downloaded to their local storage. Users can go to → Settings → Offline and choose a date to download older emails to the local storage.
→ Settings.
→ Language.
→ Help.
Select → Settings.
Go to → Settings → S/MIME and Encryption
Go to → Settings
Auto-Archive will only archive emails present in your local storage. Refer to for more information on downloading the emails to local storage.
Go to → Settings
User Feedback: Adds an option in to provide product feedback to Zimbra.
Date under → Settings → Offline: If the emails that user is looking for are from a date earlier than the date provided in the Date picker in Offline Settings, then the user will have to select the appropriate date to be able to view those emails offline.
Data download aborted due to errors: There is a possibility that the user initiated data download was not completed successfully. Users can go to → Settings → Offline and check for error messages, and re-initiate the download.
When the app is downloading emails to your local storage, you can see a Downloading label in the → Settings → Offline tab.
No, you will not see the mails downloaded to your local storage separately in your mailbox. Mails stored locally and mails not stored locally appear together in your mail folders. The user experience is designed to be seamless for the end user. So, for example, if my Inbox has mails which are up to 1 year older, and I have set my → Settings → Offline → Download data back to configuration for last 30 days, then even after mails have synced to local storage, the user will see all the mails dating past 1 year in the Inbox. If the user loses internet connectivity and goes offline, then Inbox will display mails which are in his local storage i.e. only the mails dated 30 days ago.
Auto-archive feature is disabled by default, please check if you have enabled the feature from → Settings → General → Auto-archiving → Enable.
Whenever you start your Zimbra Desktop App, it starts downloading the latest mails to your local storage as per the date provided in the → Settings → Offline → Download data back to setting. This process is called the offline-sync process. If auto-archive feature is enabled, the auto-archive process will start only after the offline-sync process gets completed, i.e. all mails as per the offline criterion have been downloaded to the local storage. Please wait for the offline-sync process to complete and check again.
Auto-archive will only run on locally stored emails. Please check if the date provided under → Settings → Offline → Download data back to is older than the days provided under → Settings → General → Auto-archiving → Archive mails older than. For example, if today’s date is 1st January 2021, and
if → Settings → Offline → Download data back to = 1st January 2020
then, → Settings → General → Auto-archiving → Archive mails older than should have value less than 365 for auto-archive to work.