# Volumes

VPSA virtual Volumes are thinly provisioned utilizing an efficient and
sophisticated block-level mapping layer. The Volume’s virtual address
space is carved into virtual contiguous blocks (a.k.a. “Chunks”). When
you create a Volume it consumes zero Pool capacity. Pool capacity is
provisioned to volumes on demand. Only at the first write to each chunk
the physical space is allocated from the Pool capacity to the Volume,
and mapping update of the virtual-to-physical addresses.

The Volume’s virtual Capacity is not limited to the available Pool
capacity.

Snapshots are read-only representations of the Volume’s data at a
given point-in-time. They are thinly provisioned and share the same data
chunks with their Volume as much as possible until you actually modify the
chunk’s data. This triggers a Redirect On Write (ROW) operation where a
new chunk is provisioned and the modified data is written there.

Cloned Volumes are Volumes created by cloning another Volume’s data set
at a specified point-in-time Snapshot. Volumes and their Clones share
unmodified Pool Chunks. A COW is triggered whenever you modify a chunk
in the Volume or in the Clone.

Volumes can be Block Volumes (exposed via an iSCSI or Fibre Channel
protocols) or NAS Shares (exposed via NFS or SMB protocols).

The following protocols are supported in the VPSA Storage Array and VPSA Flash Array:

#### Supported volume protocols

| Volume Type    | Version          |
|----------------|------------------|
| Block          | iSCSI, iSER, FC  |
| NAS (SMB/CIFS) | 2.x, 3.x         |
| NAS (NFS)      | 3, 4.0, 4.1, 4.2 |

<a id="creating-and-deleting-a-volume"></a>

## Creating and Deleting a Volume

To Create a Volume go to the Volumes Page and press the Create
button. Select whether you wish to create a Block Volume or a NAS Share.

### Creating a Block Volume

Define the following Volume attributes in the Create Block Volume
dialog:

- **Name** – the Volume’s display name. This must be unique, and can be
  modified throughout the Volume’s lifetime.
- **Capacity** – Virtual Capacity of the Volume in GB. All Volumes are
  thinly provisioned. No actual capacity is allocated when the
  Volume is created, so the aggregated Virtual capacity of the volumes
  is not bounded by the Pool
  capacity. It is possible to over-provision a Pool, but you need to
  manage and monitor this it carefully, using a Pool Protection Mechanism
  (see [Managing Pool Capacity Alerts](pools.md#managing-pool-capacity-alerts) for more details).
- **Pool** – Select the Pool that is most appropriate for your Volume’s
  QoS requirements (based on available capacity, caching, RAID
  protection, drive types, etc.).
- **Encrypted** – Select this checkbox if you wish to encrypt the
  volume’s data on the drives. Please note that you must first define
  an encryption password via the Controllers Page. For more details
  about Volume encryption see [Managing Encrypted Volumes](#managing-encrypted-volumes).
- VPSA Flash Array **Compress** and **Dedupe** options:
  - **Compress** – Check the checkbox if you want the new volume
    to be compressed.
  - **Dedupe** – Check the checkbox if you want the new volume to
    be deduped.
- **Attach Default Snapshot Policies** – Refer to
  [Managing Snapshot Policies](snapshots-and-snapshot-policies.md#managing-snapshot-policies) for a detailed explanation
  regarding snapshot policies. You can apply
  and remove snapshot policies from a Volume at any time.
- **Performance Capping** - To limit the volume’s maximum input or output
  operations or throughput per second, enter values for:

  | Performance Capping Parameter   | Description                                                                  |
  |---------------------------------|------------------------------------------------------------------------------|
  | Read IOPS                       | The maximum number of read operations per second.                            |
  | Write IOPS                      | The maximum number of write operations per second.                           |
  | Read MBPS                       | The maximum throughput of data in Megabytes per second for read operations.  |
  | Write MBPS                      | The maximum throughput of data in Megabytes per second for write operations. |

<a id="creating-nas-share"></a>

### Creating a NAS share

Define the following Volume attributes in the Create Share dialog:

- **Name** – The share’s display name. It must be unique, and can be
  modified throughout the share’s lifetime
- **Capacity** – Virtual Capacity of the Volume in GB. All Volumes are
  thinly provisioned. No actual capacity is allocated when the
  Volume is created, so the aggregated Virtual capacity of the volumes
  is not bounded by the Pool
  capacity. It is possible to over-provision a Pool, but you need to
  manage and monitor this it carefully, using a Pool Protection Mechanism (see
  [Managing Pool Capacity Alerts](pools.md#managing-pool-capacity-alerts) for more details).
- **Export Name** – The name of the NFS/SMB mount point as seen by the
  Server. This must be unique. By default it is identical to the Share
  name.
- **Pool** – Select the Pool that is most appropriate for your Share’s
  QoS requirements (based on available capacity, caching, RAID
  protection etc.).
- **Attach Default snapshot Policy** – See [Managing Snapshot Policies](snapshots-and-snapshot-policies.md#managing-snapshot-policies)
  for a detailed explanation
  regarding snapshot policies. You can apply and remove snapshot
  policies from a Share at any time. If you select this checkbox you
  need to select one of the existing snapshot policies.
- **Filesystem Write Policy** - refer to different ways in which data is
  written to the underlying VPSA volume filesystem during filesystem operations.
  - **Asynchronous Writing (default)**
    When the filesystem is mounted with the “Asynchronous Writing” option,
    data modifications are not immediately synchronized with the volume file-system.
    Instead, the system buffers these changes in memory and may perform the
    actual write to the filesystem at a later time.
    This can lead to faster write performance as the system doesn’t need to
    wait for each individual write to complete before proceeding with other
    tasks.
  - **Synchronous Writing**
    When a filesystem is mounted with the “Synchronous Writing” option,
    all data modifications (writes) are immediately synchronized with the
    storage device. This means that before a write operation is considered
    complete, the data is physically written to the VPSA filesystem,
    ensuring that changes are safely stored on stable storage.
    This can ensure data integrity but can also lead to slower write performance,
    as the system waits for the filesystem to confirm the write operation
    before proceeding.
- **Encrypted** – Select this checkbox if you wish to encrypt the
  Share’s data on the drives. Please note that you must first define an
  encryption password via the Controllers Page. For more details about
  Volume encryption see [Managing Encrypted Volumes](#managing-encrypted-volumes).
- **atime Update** – Set this checkbox to indicate whether you want to
  enable updating the access time of files and directories on every
  access, including read-access. (default: enabled).
- **User Quotas** – Select On or Off, to enable/disable the User Quotas
  mechanism for this Volume. for more information about quotas see [Setting User/Group Quotas](nas-users-and-groups.md#setting-user-group-quotas).
- **Group Quotas** – Select On or Off to enable/disable the Group Quotas
  mechanism for this Volume.
- **Project Quotas** – Select On or Off to enable/disable the Project Quotas
  mechanism for this Volume. Project is defined as a set of folders (one or more)
  regardless of their User/group ownership.
  See [Setting Project Quotas](nas-users-and-groups.md#setting-project-quotas).
- **File Access Audit** - Select On or Off to enable or disable the File
  Access Audit mechanism for this volume.

**SMB Options**

- **SMB Only** – Set this checkbox if you know that this NAS share will
  only be attached to Servers via the SMB protocol. When this is the
  case the VPSA is able to do some locking optimization that enhances
  performance.
- **Allow Guest Access** – Set this checkbox if you want to enable
  connection and access to the NAS share by anonymous users without
  requiring a password.
- **Encryption Mode** – Select this to use SMB Encryption Secure protocol.
  Connected Windows hosts should support SMB encryption.
  See Microsoft MSDN for details:
  [https://learn.microsoft.com/en-us/archive/blogs/openspecification/encryption-in-smb-3-0-a-protocol-perspective](https://learn.microsoft.com/en-us/archive/blogs/openspecification/encryption-in-smb-3-0-a-protocol-perspective)

  Select “Off” to disable SMB Encryption, “Required” to enforce SMB Encryption
  (Windows host must enable encryption to connect) or “Desired” to let the client side
  decide if encryption is used or not.
- **Enhanced Windows ACLs** – Set this checkbox to enable the Enhanced
  Windows ACLs. These include support for Windows NT format ACLs,
  permission inheritance and additional extended attributes specific
  to Windows.
- **File Creation Mask** – Use this field to set the default bitmask
  used for file creation at the UNIX level.
- **Directory Creation Mask** – Use this field to set the default
  bitmask used for directory creation at the UNIX level.
- **Map Archive** – Set this checkbox to enable mapping of an archive
  bit. The DOS archive bit is used to flag a file that has been changed
  since it was last archived. Many programs do not work properly if the
  archive bit is not stored correctly for DOS and Windows files.
- **Browseable** – Select this checkbox for this share to be shown in
  the list of available shares in a network view and in the browse list.
- **Hidden Files** – Use this field to enter a list of files or
  directories that will not be visible, but will still be accessible.
  The DOS ‘hidden’ attribute is applied to any files or directories
  that match. Each entry in the list must be separated by a ‘/’, which
  allows spaces to be included in the entry. ‘\*’ and ‘?’ can be used
  to specify multiple files or directories as in DOS wild cards. Each
  entry must be a UNIX path, not a DOS path, and must not include the
  Unix directory separator ‘/’. Note that this list is case sensitive.
- **Hide Unreadable** – Set this checkbox to prevent clients from
  seeing the existence of files that cannot be read.
- **Hide Unwritable** – Set this checkbox to prevent clients from
  seeing the existence of files that cannot be written to.
- **Store DOS Attributes** – Set this checkbox to preserve DOS file attributes
  Specifically , Hidden, Archive, Read-Only and System in the when creating/copying
  files into an SMB share. Turn on for compatibility with file system created on early
  NTFS versions.
- **SMB Serial small IO workload optimized** – Select this checkbox if
  your workload is serial small IOs from a single client (non concurrent)

**NFS Options**

- **NFS Root Squash** – Select this checkbox to block external root
  access to this share. If this box is checked, the system maps
  requests from uid/gid 0 (root) to the anonymous uid/gid.
- **NFS All Squash**  – Select this checkbox to consolidate permission set for
  all users accessing this export (can be used to coordinate permissions between
  multiple server/applications or for setting up public file shares ). If this box is
  checked, the system maps all external user requests to the anonymous uid/gid.
- **NFS anonymous GID**  – explicitly sets a specific group id for the anonymous account.
  this option is useful when set in conjunction with NFS Root/All Squash.
- **NFS anonymous GID**  – explicitly sets a specific user id for the anonymous account.
  this option is useful when set in conjunction with NFS Root/All Squash.

**File Lifecycle Management**

- **Enable File Lifecycle Management Indexing** - The VPSA supports file
  lifecycle management and analytics.
  If the VPSA is configured for file lifecycle management and analytics,
  mark the checkbox to activate the file lifecycle management and
  analytics feature for this volume.

Click **Submit** to create a NAS Share with the supplied parameters.

### Deleting a Volume/Share

You can delete a Volume only if it is not attached to a server.

On the Volumes page select the Volume and press the Delete
button. After confirming that you want to delete, it will immediately move
the Volume to “Deleting” status. The
deletion process may take some time depending on the Volume size and
the number of Snapshots and Clones which share the data Chunks. The
VPSA then updates chunk mapping and references accordingly. When the
deletion process completes, the Volume will disappear from the Volumes
page, and an event-log message will be saved.

If the Volume has snapshots associated with it the VPSA will delete
them together with the Volume. You will be prompted to confirm the
deletion of the Snapshots as well.

Clones of the deleted Volume are **not** affected by the deletion of the
Volume.

<a id="filtering-volumes-list"></a>

## Filtering the List of Volumes

To filter the list of volumes displayed in the center pane, you can use one
or more of the predefined filters, or a predefined custom tag.

![volume-add-filter](media/volume-add-filter.png)

1. Expand the **Filter** control.
2. On the right, click the **Add Filter** dropdown to select a filter.
   The selected filter appears on the left.
3. Repeat the **Add Filter** actions to select additional filters.
4. Refining the filtering:
   * For most filters, select one of its dropdown options.
   * The **Name** filter accepts input of a case-sensitive string.
     If the input string matches part or all of a volume’s name,
     the volume is listed.
     Wildcards are not accepted.
   * The **Tag** filter requires input of a predefined custom **Tag Name**,
     and optionally, a **Tag Value** to further refine filtering for tags
     that have specific values for assigned volumes.
     Wildcards are not accepted.

     See the [Tags](#tags-tab)
     section for configuring predefined custom tags.
5. Click **Search** to apply the filter.
6. To remove a single filter, click the trash icon to the right of the filter.
   Click **Search** again to refresh the volumes list.
7. To remove all the filters, click **Clear**.

<a id="attaching-detaching-volumes-to-servers"></a>

## Attaching & detaching Volumes to Servers

Volumes can be attached to many Servers. Block Volumes are attached via
the iSCSI protocol. NAS Shares are attached via the NFS/SMB protocol.

**To attach a Volume**

Go to the Volumes page, select the Volume and press the
Servers > Attach to Server(s) button:

- Select the Server(s) that you’d like to provide with access to the Volume.
- For NAS Shares, select the access type: NFS or SMB.
- For Block Volumes over Fibre Channel, select FC
- Press Submit to confirm.

**Mounting an NFS Share on a Linux machine**

1. Install the NFS client:

   On Ubuntu Servers do:
   ```default
   apt-get install nfs-common
   ```

   On Redhat/CenOS Servers do:
   ```default
   yum install nfs-utils
   ```
2. Create a mount point:
   ```default
   $ mkdir /mnt/nfs_share
   ```
3. Run the following command as the superuser (or with sudo):
   ```default
   $mount –t nfs4 <NFS_Export_Path>/<mount point>
   ```

   You can find the NFS_Export_Path in
   the Volumes > Properties tab.
4. Follow the step in [Creating NAS Users](nas-users-and-groups.md#creating-nas-users) to setup basic NFS
   authentication.

**Mounting an SMB Share on a Windows Server**

1. On the Windows Server, go to **Computer > Map Network Drive**.
2. In the **Map Network Drive** dialog:
   1. **Drive**: Select a drive letter.
   2. **Folder**: Enter the SMB Export Path of the SMB share in the format
      `\\<VPSA_IP>\<volume_export_name>`.
      You can find the SMB Export Path parameter in the VPSA GUI
      **Volumes > Properties** tab.

<br/>

**Format a Volume**

Once the Volume is attached to the Server and identified by the Operating System as a drive,
use the specific OS tools to format the drive to the needs of the OS or file-system
used. Allocation units of 512B to 64KB are supported.

<br/>

**To detach a Volume**

When you detach a Volume from a Server, the Server will lose access to
the Volume’s data. The recommended practice is to unmount the Volume on
the Server side before detaching it on the VPSA.

To detach a Volume from a Server, go to the Volumes page, select a Volume
and click **Servers > Detach from Server(s)**. You will be requested to
select the Servers from which to detach this Volume.

Alternatively, you can view the attached Servers list in the Volume’s
South Panel, select the Server from which to detach the Volume,
and click **Detach Server(s)** in the top-left corner of the South Panel.

## Expanding a Volume

You can expand a Volume anytime, regardless of whether the Volume has Snapshots,
Clones or is being remotely mirrored.

To expand a Volume go to the Volumes page, select the Volume and click
**Expand**.
Enter the amount of additional virtual capacity with which you’d like to
expand the Volume, and press **Submit**.

<br/>

### Volume Automatic Expansion

To avoid out-of-space situations for File shares, the VPSA provides an
Automatic Expansion mechanism.

It allows the customer to define an automatic NAS volume expansion policy.

Automatic Expansion is controlled by 3 parameters:

- **Emergency Threshold** - Volume will be expanded once the free capacity of the NAS share
  is below the given threshold. Default: 10% of the volume provisioned capacity.
- **Expand By** - The additional provisioned capacity to be added. Default: 50GiB
- **Maximum Volume Capacity** - The maximum allowed volume provisioned capacity (up to MAX Pool capacity)
  Default: 0GiB (Unlimited)

By default all volumes are created with Automatic Expansion disabled.
To enable it, check the **Automatic Expansion** checkbox on the
**Create > Create NAS share** dialog, or enable it from the **Properties** tab’s **Capacity** column.

<a id="managing-smb-file-history"></a>

## Managing SMB File History

SMB File History is a mechanism that allows restoration of previous
versions of any given file or folder on a NAS volume, attached to
Windows. SMB File History is similar to the VPSA snapshots mechanism,
and driven by the same Snapshots Policies.

### To Apply a SMB File History Policy on a Volume

1. Go to the Volumes page, and select the NAS Volume.
2. Select **Data Services > Attach File History Policy**.
3. In the **Apply Snapshot Policy to Volume** dialog, select the
   Snapshot Policy to apply to the Volume and press **Submit**.

### To detach a SMB File History Policy from a Volume

1. Go to the Volumes page, and select the Volume and press the
   **Snapshot Policies** south tab to view the Volume’s applied Snapshot
   Policies.
2. Select the Snapshot Policy to delete, and press the **Detach Policy**
   button at the top left corner of the South Panel.

   You will be prompted to select whether or not to delete all of the
   Volume’s Snapshots associated with this Policy.

### To restore files from SMB File History

1. On a Windows Server, open Windows Explorer and navigate to the
   file/folder you want to restore.
2. Right-click on the file, and select **Restore previous versions**.
3. In the dialog that opens, go to the **Previous Versions** tab, select
   the version to restore, and click **Restore**.

<br/>

## Cloning a Volume

Cloning a Volume is the process of creating a Read/Write zero-capacity
replica of a Volume, with a data set identical to that of the Volume,
from a selected point-in-time (which can be the time the Clone is
created, or one of the existing Snapshots’ point-in-time).

The result of the Cloning operation is a new Volume. The two Volumes now
share all of the non-modified chunks. Only upon a first-write to a
chunk, a Copy-On-Write occurs which allocates a new chunk and breaks the
chunk sharing.

You can create an unlimited number of Clones of a given Volume, either
from the same data set (from the same Snapshot) or from different data
sets.

Clones are  completely independent from each other, from the source Volume and from
the Snapshot from which they were created. For example, you can delete
the original Volume and/or Snapshot and it will leave the Cloned Volume
unaffected. You can also modify Volume attributes of each Clone
independently.

You can only create Clones within the Pool where the original Volume
resides.

**To create a new Clone**

1. Go to the Volumes page, select the Volume to be cloned and press
   **Data Services > Clone**.
2. In the **Clone Volume** dialog:
   * **Clone Name** – Enter a name for the Cloned Volume.
   * **Clone from** – Select the point-in-time Snapshot whose data set
     you wish to replicate.

     **If you wish to clone the current data set of the Volume,
     don’t select any Snapshot.**
3. Press **Submit**.

Alternative method: **Clone from Snapshot**

1. On the Volumes page, select the Volume to be cloned.
2. Press the **Snapshots** tab in the South Panel, and select the
   desired point-in-time Snapshot.
3. Press **Clone** at the top left corner of the South Panel.
4. In the **Clone from Snapshot** dialog, enter a name for the new cloned
   Volume.

The newly created Clone will appear as a regular Volume in the Volume
list.

The NFS/SMB Export name of a cloned Volume will be identical to the Cloned Volume
display name.
|

<a id="online-volume-migration"></a>

## Online Volume Migration

Volumes created in a VPSA pool can be easily migrated to a different pool in
the same VPSA. All entities bounded to the volume (snapshot policies, servers
attachments etc.) will be migrated as well. Existing snapshots migration is
configurable by the user.

The online migration process is completely seamless to the end user and will
not cause any service disruption to the hosts connected to the volume.

A common use case for using the Online Volume Migration feature is migrating
performance demanding volume to a more performant storage pool(e.g. SATA pool to
an SSD pool) on-the-fly.

Online Volume Migration can be initiated from the VPSA GUI or via VPSA
REST API. For the REST API usage and examples please refer to the
Volumes section of the
[VPSA REST API Guide](http://vpsa-api.zadarastorage.com/#volumes).

### Migrating a Volume

In the left pane menu, navigate to the Volumes section under
the Resources section.

1. Select the Volume that will be migrated to another VPSA Pool.
2. From the upper options menu select **Data Services > Migrate**.
3. In the **Migrate Volume** dialog:
   - **Destination pool** – Select the destination Pool to migrate to, from the
     list of available pools. Make sure to select a Pool with sufficient free
     capacity.
   - **Migrate Existing Snapshots** – Check the checkbox if the migration of the
     volume should include the existing snapshots of the volume.
     If **Migrate Existing Snapshots** is checked, all snapshots will be
     migrated to the destination Pool.
   - VPSA Flash Array options:
     - **Compress** – Check the checkbox if you want the new volume to be compressed.
     - **Dedupe** – Check the checkbox if you want the new volume to be deduped.
   - Press **Submit** to start the migration.
   - In the **Create Migration** confirmation dialog, review the details
     and confirm the Online Volume Migration operation.

### Monitoring the migration

Once started, the online migration task can be monitored from the VPSA GUI.

1. In the left pane menu navigate to the Volumes section under Resources.
2. Select the Volume that is currently being migrated.
3. On the south panel, the new **Migration Status** tab is available.
   The **Migration Status** tab will provide real-time migration
   information while the migration is still running.
4. The user has complete control on the migration task as it can be Paused or
   Aborted in the **Migration Status** tab.
5. Upon completion, the **Migration Status** tab will be removed from
   the Volume south panel. A log entry will be added in the **Logs** tab
   as an indication of a successful migration.

<br/>

<a id="managing-data-reduction-volumes"></a>

## Managing Data Reduction

Scope: VPSA Flash Array

The ability to apply the Compress and Dedupe options on a Volume is dependent
on the Data Reduction feature being enabled at the VPSA level in the
Provisioning portal.
See [Enabling or Disabling Data Reduction Bundle](first-steps.md#enabling-or-disabling-data-reduction-bundle).

* Data Reduction on a VPSA can be enabled or disabled at any time.
* Compress and Dedupe can be enabled or disabled on a Volume at any time,
  on a VPSA that has Data Reduction enabled.
  Subsequent block write operations on the Volume follow the latest
  Compress and Dedupe Enabled/Disabled settings.
* To apply the Compress and Deduplication feature to existing data within the
  Volume, the Volume should undergo a live migration to a new Storage Pool.
  The new Volume on the destination Storage Pool should be created with
  the Compress and Dedupe features enabled, so that inline Data Reduction
  is applied as the live migration occurs.
  See [Online Volume Migration](#online-volume-migration).

<a id="managing-encrypted-volumes"></a>

## Managing Encrypted Volumes

Encrypting data at rest is a highly recommended security measure to protect
sensitive information from unauthorized access. This provides an extra layer
of security, even if the data drive is stolen or compromised.
It is especially important for organizations that handle sensitive information
such as personal data, financial information, and confidential business information.

Encryption management of Data-at-Rest (data on the Disk Drives) is applied
by the VPSA on a per-Volume basis. Encrypted and unencrypted Volumes
can coexist in the same VPSA Pool.

Volume encryption has a negligible impact (if any) on volume performance.
It’s important to note that the benefits of encryption far outweigh any
potential performance impact, as it ensures the protection of sensitive data.

A VPSA generates a random 256-bit unique Volume Encryption Key per
encrypted Volume and uses the Advanced Encryption Standard (AES) to
encrypt and decrypt the Volume data.

The Volume Encryption Keys are stored on disk as ciphertext, using AES
with a 256-bit Master Encryption Key, which is generated from
a user-supplied **Master Encryption Password.**

The User owns the Master Encryption Password. It is *never* stored on
any persistent media. Instead, only its SHA3 hash-sum is saved on disk
for password validation.

During VPSA operation, the Master Encryption Password itself is held in
kernel memory of the VPSA. Core-dumping any user-mode process within the
VPSA will not reveal the Master Encryption Key.

This method ensures that encrypted Data-at-Rest cannot be accessed
without explicitly knowing the user-supplied Master Encryption Password,
thus providing you full protection if you opt for Data-at-Rest Volume
encryption.

Supported volume encryption options:

- [Encryption using an Encryption Password](#encryption-using-an-encryption-password)
- [Encryption using AWS KMS Store](#encryption-using-aws-kms-store)
- [Encryption using KMIP supporting KMS](#encryption-using-kmip-supporting-kms)

<a id="encryption-using-an-encryption-password"></a>

### Encryption using an Encryption Password

To create a Master Encryption Password:

1. Go to the Settings page.
2. In the **Security** tab, in the **Encryption** section press **Edit**.
3. Read the instructions and warning.
4. Enter your Password and **Save**.

Once the Master Encryption Password is set, you can change or reset it at any time.
Master Encryption Password does not affect the encrypted data.

**Store your Master Encryption Password in a secure place.**

To create an encrypted volume, follow the steps in the
[Creating and Deleting a Volume](#creating-and-deleting-a-volume)
section.

Encrypted volumes will present the Encrypted property in the VPSA Volumes
view and in the Volume’s properties.

<a id="encryption-using-aws-kms-store"></a>

### Encryption using AWS KMS Store

Amazon’s AWS Key Management Service (KMS) centrally manages keys and
policies across integrated services and applications from a single point.
AWS KMS generates a data key, encrypts it under the KMS key, and sends both
the plaintext data key and the encrypted data key to Amazon S3. Amazon S3
encrypts the data using the data key and removes the plaintext key from
memory as soon as possible after use.

Zadara VPSA supports use of AWS KMS for VPSA volume encryption.

Configuring AWS KMS encryption for a volume involves configurations on both
the AWS Management Console and the VPSA admin GUI.

#### AWS KMS Configuration

- Create a new customer managed key:
  - Symmetric (default)
  - Encrypt & Decrypt (default)
  - Single region key (default)
- The user allowed to use the key should have access to the KMS Service along
  with the following action:
  * “kms:Encrypt”
  * “kms:Decrypt”
  * “kms:ReEncrypt\*”
  * “kms:GenerateDataKey\*”
  * “kms:DescribeKey”

#### VPSA Configuration

After setting up AWS KMS keys in the AWS Management Console,
in the VPSA GUI, under **System**, open the **Settings** page, and
configure the following parameters.

1. Click the **Security** tab.
2. Click **Edit** on the right of **Encryption**.
3. Click **Encryption using KMIP supporting KMS**.
4. Select **Encryption using AWS KMS Store**.
5. **Region**: Select the region  of your AWS KMS Store.
6. **KMS Key ID**: Enter the UUID of your AWS Key ID.
7. **AWS Access Key**: Enter your AWS access key ID.
8. **AWS Secret Key**: Enter your AWS secret access key.
9. Read the KMS disclaimer. To acknowledge your acceptance of
   responsibility to maintain KMS access, mark the checkbox.
10. Click **Save**.

Once the system is set to encrypt volumes using the AWS KMS Service, the status
for Encryption will be set to “Activated, AWS KMS”.

Encrypted volumes will present the Encrypted property in the VPSA Volumes
view and in the Volume’s properties.

To create an encrypted volume, follow the steps in the
[Creating and Deleting a Volume](#creating-and-deleting-a-volume)
section.

#### Disable AWS KMS Encryption

If volume encryption with AWS KMS is no longer required, click **Edit**
and select **Remove AWS KMS Encryption**. The system will only allow the
removal of the encryption setting if the VPSA does not have any encrypted volumes.

#### Encryption Key recovery

Similar to the other Encryption modes (KMIP or Encryption Password) during
VPSA operation, the Master Encryption Password itself is held in kernel
memory of the VPSA. Since is not stored persistently in the VPSA, the user
will be prompted to validate their AWS KMS configuration in case of a failure.

In such case:

1. The VPSA Administrator will be notified
2. Volumes will not be accessible
3. User action is required from the VPSA Settings view

In case of AWS KMS, the VPSA administrator will be required to enter the
following information:

- AWS Region
- AWS Access Key
- AWS Secret Key

The same KMS key can be used by multiple IAM users, therefor in case of a rotation
of the user’s credentials or in case the original credentials are no long
valid (access key & secret) a new pair can be used to restore VPSA to KMS
integration given it is allowed to use the original KMS key.

<a id="encryption-using-kmip-supporting-kms"></a>

### Encryption using KMIP supporting KMS

The Key Management Interoperability Protocol (KMIP) enables the secure
creation and storage of keys and other security objects on a key management
server (KMS).

Zadara VPSA supports Fortanix Data Security Manager
(DMS) for VPSA Storage Array volume encryption.

Configuring Fortanix DSM for a volume involves configurations on both
the Fortanix DSM UI and the VPSA admin GUI:

- [Fortanix DSM configuration](#fortanix-dsm-configuration)
- [VPSA KMIP configuration](#vpsa-kmip-configuration)

<a id="fortanix-dsm-configuration"></a>

#### Fortanix DSM configuration

1. In the **Groups** panel, create a new group with a meaningful name and
   click **Save**.
2. In the **Apps** panel, create a new app with the following parameters:
   1. **Name**: A meaningful name for the app.
   2. **Interface**: Select **KMIP**.
   3. **Authentication**: Select **API key** or **Certificate**.
      If you are uncertain, choose **API key**.
   4. Assign the group that you created in the previous step.
   5. Click **Save**.
3. In the **Security objects** panel, create a new object with the
   following parameters:
   1. **Name**: A meaningful name for the security object.
   2. **Group**: Select the group you created earlier.
   3. Select **GENERATE** as the key creation method.
   4. **Key type**: Select **AES** as the key type.
   5. **Key size**: Select **256** for the AES key size.
   6. **Key operations permitted**: Configure **both**:
      - ENCRYPT
      - DECRYPT
   7. Accept the default settings for the rest of the configuration.
   8. Click **GENERATE** at the bottom of the form.

<a id="vpsa-kmip-configuration"></a>

#### VPSA KMIP configuration

In the VPSA GUI, under **System**, open the **Settings** page, and
configure the following parameters.

1. Click the **Security** tab.
2. Click **Edit** on the right of **Encryption**.
3. Click **Encryption using KMIP supporting KMS**.
4. **KMS Type**: Select **Fortanix DSM**.
5. **KMS Host**: Select the region where the SmartKey KMS is registered.
   Supported regions:
   - North America
   - European Union
   - United Kingdom
   - Asia Pacific
   - Australia
6. **Connect Via**: Select the interface used by the VPSA to connect to the
   KMS. Currently the VPSA frontend and public IP are supported.
7. **KMS Key ID**: Enter the ID for the KMS key used for the VPSA volume
   keys encryption.
   For Fortanix DSM, this is the UUID of the key object.
8. **KMS Username**: Enter the username used by the VPSA for KMS
   authentication.
   It can be retrieved from the Fortanix DSM app by clicking on
   **View credentials** > **Username/Password**.
9. **KMS Password**: Enter the password used by the VPSA for KMS
   authentication.
   It can be retrieved from the Fortanix DSM app by clicking on
   **View credentials** > **Username/Password**.
10. **Use Proxy**: If you need a proxy server:
    1. Mark **Use Proxy**.
    2. Enter the proxy **Host** and **Port**.
    3. If the proxy requires authentication credentials:
       1. Mark **Use Authentication**.
       2. Enter the proxy’s **User** and **Password**.
11. **Login with credentials + certificate**:
    VPSA KMS integration supports an enhanced security login mode using
    login credentials together with a certificate.
    To use the enhanced security login, mark
    **Login with credentials + certificate**.
    1. **Keyfile Content**: Copy your keyfile content, and paste it here.
    2. **Certfile Content**: Copy your certfile content, and paste it here.
12. Read the KMS disclaimer. To acknowledge your acceptance of
    responsibility to maintain KMS access, mark the checkbox.
13. Click **Save**.

To create an encrypted volume, follow the steps in the
[Creating and Deleting a Volume](#creating-and-deleting-a-volume)
section.

Encrypted volumes are displayed with the ![image67](media/image67.png) icon.

#### KMS and VPSA Key rotation

1. In the Fortanix DSM UI, go to your SmartKey account and rotate the
   key. After key rotation, copy the new KMS key’s UUID.
2. In the VPSA GUI, under **System**, open the **Settings** page.
3. Click the **Security** tab.
4. Click **Edit** on the right of **Encryption**.
5. Paste the new KMS key’s UUID into **KMS Key ID**.
6. Click **Save**.

<br/>

<a id="audit-log-management"></a>

## Audit Log Management

The VPSA supports audit logging of specific file system events.

### Configuring file access auditing

The auditing policy must first be configured globally in the
[Security](settings.md#security) tab on the **Settings** page, before it can be applied to
volumes.

File access auditing can be enabled when creating a new volume
(see **Creating a NAS Share** under [Creating and Deleting a Volume](#creating-and-deleting-a-volume))
and also on existing volumes.

### Enabling file access auditing

To **Enable** file access auditing on an existing volume:

1. In the center pane, click on the volume to mark it.
2. Click the **Audit Log** dropdown and click **Enable**.

### Downloading the volume audit log

To **Download** the audit log:

1. In the center pane, click on the volume to mark it.
2. Click the **Audit Log** dropdown and click **Download Audit Log**.
3. In the **Download Audit Log** dialog box that displays, enter the date
   and time range to download.

#### Volume’s audit log output

The audit log is exported to a field-delimited file, containing rows with
11 columns.
In some cases, a 12th column is included, which contains extended
parameters of the logged command.

|   Column | Parameter                            |
|----------|--------------------------------------|
|        1 | Timestamp                            |
|        2 | VC name                              |
|        3 | Share name                           |
|        4 | Protocol                             |
|        5 | Client host IP address               |
|        6 | Client hostname (if available)       |
|        7 | User ID or username                  |
|        8 | Group ID or groupname                |
|        9 | Command                              |
|       10 | Return status                        |
|       11 | Command-specific parameters          |
|       12 | Extended command-specific parameters |

The following table lists and describes possible logged commands:

<!-- comment - define strikethrough to use on deprecated commands in the table -->

| Category                                                                                                                        | Command description             | SMB command                         | NFS-3 command   | NFS-4 command   |
|---------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-------------------------------------|-----------------|-----------------|
| CONNECT                                                                                                                         | User connects to the share      | connect                             |                 |                 |
| CONNECT                                                                                                                         | User disconnects from the share | disconnect                          |                 |                 |
| CREATE                                                                                                                          | Create new regular file         | create(file)                        | create(file)    | create(file)    |
|                                                                                                                                 | Create new directory            | mkdirat                             | mkdir           | mkdir           |
| Create new symbolic link                                                                                                        | symlinkat                       | symlink                             | symlink         |                 |
| Create new hard link                                                                                                            | linkat                          | link                                | link            |                 |
| Create new special file                                                                                                         |                                 | mknod(blk)                          | mknod(blk)      |                 |
|                                                                                                                                 | mknod(chr)                      | mknod(chr)                          |                 |                 |
|                                                                                                                                 | mknod(socket)                   | mknod(socket)                       |                 |                 |
| OPEN FILE                                                                                                                       | Open existing file              | open(file)                          |                 | open(file)      |
| RENAME                                                                                                                          | Rename file or directory        | renameat                            | rename          | rename          |
| REMOVE                                                                                                                          | Delete file                     | unlinkat                            | unlink          | remove          |
| Delete directory                                                                                                                | unlinkat                        | rmdir                               | remove          |                 |
| ATTRIBUTES                                                                                                                      | Change permissions              | fchmod<br/><br/>fset_dos_attributes | setattr         | setattr         |
|                                                                                                                                 |                                 |                                     |                 |                 |
| <strike> *chmod* </strike> (deprecated since v22.06)<br/><br/><strike> *set_dos_attributes* </strike> (deprecated since v22.06) |                                 |                                     |                 |                 |
|                                                                                                                                 |                                 |                                     |                 |                 |
| Change owner                                                                                                                    | fchown<br/><br/>lchown          | setattr                             | setattr         |                 |
|                                                                                                                                 |                                 |                                     |                 |                 |
| Change ACLs                                                                                                                     | fset_nt_acl                     |                                     |                 |                 |

The following snippet depicts several lines of an audit log.

```console
Timestamp                 |VC name          |Share|Protocol|IP address |host |User ID or name  |Group ID or name      |Command|St|Command parameters

2024-09-11 08:21:43.435816|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|connect|ok|smb1
2024-09-11 08:21:57.133796|vsa-000001ab-vc-0| smb2|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|connect|ok|smb2
2024-09-11 08:22:56.135063|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|mkdirat|ok|/export/smb1/Test
2024-09-11 08:22:56.138699|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_dos_attributes|ok|/export/smb1/Test
2024-09-11 08:22:56.141804|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_nt_acl|ok|/export/smb1/Test|<extended parameters>
2024-09-11 08:22:56.150438|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|mkdirat|ok|/export/smb1/Test/proc0
2024-09-11 08:22:56.151271|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_dos_attributes|ok|/export/smb1/Test/proc0
2024-09-11 08:22:56.154084|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_nt_acl|ok|/export/smb1/Test/proc0|<extended parameters>
2024-09-11 08:22:56.277061|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|mkdirat|ok|/export/smb1/Test/proc1
2024-09-11 08:22:56.277842|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_dos_attributes|ok|/export/smb1/Test/proc1
2024-09-11 08:22:56.281236|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_nt_acl|ok|/export/smb1/Test/proc1|<extended parameters>
2024-09-11 08:22:56.296915|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|create(file)|ok|/export/smb1/Test/proc0/data_0.din|w
2024-09-11 08:22:56.298040|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_dos_attributes|ok|/export/smb1/Test/proc0/data_0.din
2024-09-11 08:22:56.300355|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_nt_acl|ok|/export/smb1/Test/proc0/data_0.din|<extended parameters>
2024-09-11 08:22:56.305856|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|create(file)|ok|/export/smb1/Test/proc1/data_0.din|w
2024-09-11 08:22:56.306814|vsa-000001ab-vc-0| smb1|SMB3_11|<IP address>|vm123|ZSTORAGE2\user123|ZSTORAGE2\domain users|fset_dos_attributes|ok|/export/smb1/Test/proc1/data_0.din
```

### Disabling file access auditing

To **Disable** the audit log for a volume:

1. In the center pane, click on the volume to mark it.
2. Click the **Audit Log** dropdown and click **Disable**.
   A confirmation dialog box opens.

<a id="volume-file-lifecycle-management"></a>

## Volume File Lifecycle Management

The VPSA supports file lifecycle management and analytics. When file
lifecycle management is enabled for a VPSA, the following options are
available for configuring each volume:

![volumes-file-lifecycle](media/volumes-file-lifecycle.png)

- **Indexing Enable** - Selecting this option activates file lifecycle
  management and analytics on the selected volume.
- **Indexing Pause** - Suspend analytics collection for the selected volume.
  This option is available for volumes that are enabled for file lifecycle
  and analytics.
- **Indexing Resume** - Resume analytics collection for the selected volume.
  This option is available for volumes that are enabled for file lifecycle
  and analytics, and their indexing is paused.
- **Indexing Disable** - Selecting this option deactivates file lifecycle
  management and analytics on the selected volume.

<a id="viewing-volume-properties"></a>

## Viewing Volume Properties

**Filtering Volumes**

In a VPSA with many volumes it might be difficult to locate a specific volume in the
Volumes page. [Filtering the List of Volumes](#filtering-volumes-list) can be useful.

The Volumes page displays the list of Volumes (Block and NAS) in the
VPSA. Select a Volume to see its detailed information in the following
South Panel tabs:

### Properties

Each Volume includes the following properties:

| **Property**                                                                                                | **Description**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|                                                                                                             | **General**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ID                                                                                                          | An internally assigned unique ID.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Name                                                                                                        | User assigned name. Can be modified anytime.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Comment                                                                                                     | User free text comment. Can be used for labels, reminders or any other purpose                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Status<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>            | - Creating - Initializing Volume’s metadata.<br/><br/><br/><br/><br/>- Deleting - In process of deleting the Volume and updating data chunks references.<br/><br/><br/><br/><br/>- Partial/Failed - The Volume is inaccessible due to lower construct failure (on Pool or RAID Group level).<br/><br/><br/><br/><br/>- Available - The Volume is healthy but is not attached to any Server.<br/><br/><br/><br/><br/>- In-use - The Volume is healthy and is attached to one or more Servers.<br/><br/>                                                                                                                                                                                                                                                                                                                                           |
| Data Type<br/><br/><br/><br/><br/><br/>                                                                     | - “Block” for Block Volume.<br/><br/><br/><br/><br/>- “File-system” for NAS Shares.<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Pool                                                                                                        | The Pool name where this Volume is provisioned.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Server(s)                                                                                                   | Server Name attached to the Volume. Multiple(X) will be displayed when X servers are attached.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| NFS Export Path                                                                                             | (NAS Shares Only) The NFS Share export path to be used when mounting it. All defined paths are listed here. Additional path can be defined.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| SMB Export Path                                                                                             | (NAS Shares Only) The SMB Share export path(s) to be used when connecting to it from a Windows Server. All defines paths listed.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| Access Type<br/><br/><br/><br/><br/><br/>                                                                   | (NAS Shares Only) Access protocols which are used by the Servers which are attached to a NAS Share:<br/><br/><br/><br/><br/>NFS, SMB, or Multiple.<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| atime Update                                                                                                | (NAS Shares Only) Yes/No – Indicates whether to update access time of NAS Share files and directories on every access, including read-access.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| SMB Only                                                                                                    | (NAS Shares Only) Yes/No – enable/disable locking optimizations                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| SMB Guest Access                                                                                            | (SMB Only) Yes/No – Allow/Block anonymous user access                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| SMB Encryption Mode                                                                                         | (SMB Only) Off/Desired/Required - Sets SMB encrypt secured protocol behaviour                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Enhanced Windows ACLs                                                                                       | (SMB Only) Yes/No                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Directory Creation Mask                                                                                     | (NAS Shares Only) Default directory umask value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| File Creation Mask                                                                                          | (NAS Shares Only) Default file umask value                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| Map archive                                                                                                 | (NAS Shares Only) Yes/No - Maps the windows archive bit to the unix execute bit.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| SMB Browsable                                                                                               | (SMB Only) Yes/No - seen in the list of available shares                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| SMB Hidden Files                                                                                            | (SMB Only) This is a list of files or directories that are not visible but are accessible (delimited by /)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| SMB Hide Unreadable                                                                                         | (SMB Only) Yes/No - Prevents clients from seeing the existence of files that cannot be read.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| SMB Hide Unwritable                                                                                         | (SMB Only) Yes/No - Prevents clients from seeing the existence of files that cannot be written.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| SMB Hide Dot Files                                                                                          | (SMB Only) Yes/No - Prevents clients from seeing the existence of “.\*” files.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| SMB serial small IO workload Optimized                                                                      | (SMB Only) Yes/No                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| SMB Store DOS Attributes                                                                                    | (SMB Only) Yes/No - Preserve DOS attributes (hidden, archive, read-only, system)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| User Quotas                                                                                                 | (NAS Shares Only) On/Off - user quotas on volume.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Group Quotas                                                                                                | (NAS Shares Only) On/Off - group quotas on volume.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Project Quotas                                                                                              | (NAS Shares Only) On/Off - Project quotas on volume.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| NFS Root Squash<br/><br/><br/><br/><br/><br/>                                                               | (NFS Only) Yes/No - map requests from uid/gid 0 (root) to the anonymous uid/gid.<br/><br/><br/><br/><br/>*Note: Set to “Yes” to block external root access to the volume.*<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| NFS All Squash<br/><br/><br/><br/>                                                                          | (NFS Only) Yes/No - map requests from and uid/gid to the anonymous uid/gid.<br/><br/><br/>*Note: Useful for inter server/application correlation or Public File shares*<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| NFS anonymous GID                                                                                           | (NFS Only) explicitly sets a specific group id for the anonymous account                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| NFS anonymous UID                                                                                           | (NFS Only) explicitly sets a specific user id for anonymous account                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| File Lifecycle Index Management<br/><br/><br/><br/><br/><br/>                                               | Indicates the state of indexing for analytics data collection. Possible values:<br/><br/><br/>**Enabled/Disabled** for analytics data collection.<br/><br/><br/>**Paused** when analytics data collection is enabled, but pending resume.<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| File Lifecycle Index Management Full Scan State<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> | When File Lifecycle Index Management is enabled, the VPSA performs a single full scan of NAS share files.<br/><br/><br/>Subsequent detected filesystem changes are updated in the indexing. Possible statuses of the volume’s full scan:<br/><br/><br/>**In Progress**: indicates the full scan progress as a percentage.<br/><br/><br/>**Finished**: inicates that the full scan is complete.<br/><br/><br/>**Paused**: indicates that File Lifecycle Index Management is paused.<br/><br/><br/>**Disabled**: indicates that File Lifecycle Index Management is disabled.<br/><br/>                                                                                                                                                                                                                                                             |
| Extended Metering<br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/>           | Yes/No – Enabling extended metering.<br/><br/><br/><br/><br/>When “Extended Metering” is disabled, the VPSA records the volume’s performance statistics of reads and writes operations.<br/><br/><br/><br/><br/>When “Extended Metering” is enabled, the VPSA also records performance statistics of other file operations, including create, delete, etc.<br/><br/><br/><br/><br/>*Note: “Extended Metering” enabled puts extra load on the VPSA, and the metering DB might grow rapidly.*<br/><br/><br/>*It is recommended to use it for only limited period of time, for planning or troubleshooting purposes.*<br/><br/>                                                                                                                                                                                                                     |
| WWID                                                                                                        | (Block Only) SCSI unique World-wide ID. Use this value on Linux Servers to identify the Volume device when multipathing is configured.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Compress VPSA Flash Array<br/><br/><br/><br/><br/><br/><br/><br/>                                           | Indicates the state of data compression. Possible values:<br/><br/><br/>**Enabled/Disabled**<br/><br/><br/>Compression can be enabled or disabled at any time. See [Enabling or Disabling Data Reduction Bundle](first-steps.md#enabling-or-disabling-data-reduction-bundle).<br/><br/><br/>Subsequent block write operations on the volume follow the latest **Enabled/Disabled** setting.<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| Dedupe VPSA Flash Array<br/><br/><br/><br/><br/><br/><br/><br/>                                             | Indicates the state of data deduplication. Possible values:<br/><br/><br/>**Enabled/Disabled**<br/><br/><br/>Deduplication can be enabled or disabled at any time. See [Enabling or Disabling Data Reduction Bundle](first-steps.md#enabling-or-disabling-data-reduction-bundle).<br/><br/><br/>Subsequent block write operations on the volume follow the latest **Enabled/Disabled** setting.<br/><br/>                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Encrypted                                                                                                   | Yes/No                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Encryption Size Key                                                                                         | The number of bits in a key used by the encryption algorithm.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| Created                                                                                                     | Date & time when the Volume was created.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| Modified                                                                                                    | Date & time when the Volume was last modified.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                                                                                             | **Capacity**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| Virtual Capacity                                                                                            | Capacity of the Volume as seen by the attached Servers.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Available Capacity                                                                                          | (NAS Shares Only) Free capacity of the NAS Share.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Mapped Capacity                                                                                             | The used capacity (allocated from the Pool) of the Volume excluding its Snapshots and Clones. The VPSA Volumes are thinly provisioned and uses 256KB/1MB/2MB/4MB chunks (depending on the Pool type) to allocate capacity form the Pool as needed.<br/>It’s important to note that the actual data written by the host may be smaller than the mapped capacity. For example:<br/><br/>- A host writes 0.5 MB, skips 0.5 MB, writes another 0.5 MB, and continues this pattern until the end of the volume.<br/>- In this case, the mapped capacity will equal the full provisioned capacity of the volume, since every chunk has been allocated.<br/>- However, the actual data written is only half of that amount.<br/><br/>In other words, once a chunk is mapped, it remains allocated, regardless of how much of it is actually written to. |
| Data Copies Capacity                                                                                        | The used capacity (allocated from the Pool) of the Volume’s Snapshots and Clones.<br/><br/>*Note: the total capacity allocated for a Volume and all its Clones and Snapshots is the sum of Mapped Capacity + Data Copies Capacity*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Read IOPS                                                                                                   | The maximum number of read operations per second.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Write IOPS                                                                                                  | The maximum number of write operations per second.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| Read MBPS                                                                                                   | The maximum throughput of data in Megabytes per second for read operations.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| Write MBPS                                                                                                  | The maximum throughput of data in Megabytes per second for write operations.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |

### Snapshots

Lists the point-in-time Snapshots of this Volume. If you retain many
Snapshots per Volume, you may want to use the Snapshot Filtering tool to
find a specific Snapshot. For more details see
[Filtering Snapshots](snapshots-and-snapshot-policies.md#filtering-snapshots).

The following Properties are provided per Snapshot:

| **Attribute**   | **Description**                    |
|-----------------|------------------------------------|
| ID              | Snapshot ID                        |
| Name            | Display Name.                      |
| TimeStamp       | Snapshot creation time stamp       |
| Status          | Normal\\Pending Deletion\\Deletion |

### Object Storage Snapshots

Lists the point-in-time Snapshots of this Volume which are stored in an Object
Storage (e.g S3). These Snapshots are created by the Backup to Object
Storage feature, as defined in [Backup to Object Storage](backup-to-object-storage.md#backup-to-object-storage)

The following Properties are provided per Object Storage Snapshot:

| **Attribute**   | **Description**                    |
|-----------------|------------------------------------|
| ID              | Snapshot ID                        |
| Name            | Display Name.                      |
| Region          | Object storage region              |
| Bucket          | Object storage bucket              |
| TimeStamp       | Snapshot creation time stamp       |
| Status          | Normal\\Pending Deletion\\Deletion |

### SMB File History (SMB Only)

Lists the point-in-time Snapshots of this Volume which are kept for SMB
File History recovery purposes. These Snapshots are created by the SMB
File History mechanism. For details see
[Managing SMB File History](#managing-smb-file-history).

The following Properties are provided per File History Snapshot:

| **Attribute**   | **Description**                     |
|-----------------|-------------------------------------|
| ID              | Snapshot ID                         |
| Name            | Display Name.                       |
| TimeStamp       | Snapshot creation time stamp        |
| Status          | Normal\\Pending Deletion\\Deletion  |
| Pool            | Pool where the file history is kept |

### Snapshot Policies

The Snapshot Policies tab lists the policies that are attached
to the selected Volume. The following Properties are provided per
Snapshot Policy:

| **Attribute**       | **Description**                                                                                                                                       |
|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| Name                | Display Name.                                                                                                                                         |
| Status              | Active or Paused.                                                                                                                                     |
| Type                | The VPSA application controlling the Policy:<br/><br/>- Snapshot Manager<br/>- Remote Mirroring<br/>- Backup to Object Storage<br/>- SMB File History |
| Create Policy       | Frequency of Snapshot creation.                                                                                                                       |
| Delete Policy       | Number of Snapshots to retain.                                                                                                                        |
| Dest. Delete Policy | Number of Snapshots to retain on Remote Mirror destination Volume.                                                                                    |

For more details on Snapshot Policies management,
see [Managing Snapshots and Snapshot Policies](snapshots-and-snapshot-policies.md#managing-snapshots-and-policies).

### Servers

The Servers tab lists the Servers to which the Volume is attached. For
Block Volumes the LUN Number associated with each Server is displayed.
It also indicates if the server accesses the volume via iSCSI or FC.

### Containers

Lists the Docker Containers that are able to access the selected Volume,
along with their statuses. For details about attaching Volumes to
Containers see [Containers](containers.md#managing-container-services).

### Metering

The Metering Charts provide live metering of the IO workload associated
with the selected Volume.

The charts display the usage data as it was captured in the past 20
“intervals”. An interval length can be set to one of the following: 1
Second, 10 Seconds, 1 Minute, 10 Minutes, or 1 Hour. The Auto button lets you
see continuously-updating live metering info (refreshed every 3 seconds).

The following charts are displayed:

| **Chart**         | **Description**                                                                                                   |
|-------------------|-------------------------------------------------------------------------------------------------------------------|
| IOPs              | The number of read and write SCSI commands issued to the selected Volume from all attached Servers.               |
| Bandwidth (MB\\s) | Total throughput (in MB) of read and write SCSI command issued to the selected Volume from all attached Servers.  |
| IO Time (ms)      | Average response time of all read and write SCSI command issued to the selected Volume from all attached Servers. |

### Logs

Displays all event logs associated with this Volume.

### Performance Alerts

Displays Performance Alerts for the selected Volume.

- **Read IOPS Limit** – Creates an alert when, during the past minute,
  the average read IOPS for the selected Volume exceeds a
  user-specified threshold.
- **Read Throughput Limit** - Creates an alert when, during the past
  minute, the average read MB/s for the selected Volume exceeds a
  user-specified threshold.
- **Read Latency Limit** – Creates an alert when, during the past minute,
  the average read latency for the selected
  Volume exceeds a user-specified threshold.
- **Write IOPS Limit** – Creates an alert when, during the past minute,
  the average write IOPS for the selected Volume exceeds a
  user-specified threshold.
- **Write Throughput Limit** - Creates an alert when, during the past
  minute, the average write MB/s for the selected Volume exceeds a
  user-specified threshold.
- **Write Latency Limit** – Creates an alert when, during the past
  minute, the average write latency for the selected Volume exceeds a
  user-specified threshold.

### Capacity Alerts

Displays capacity Alerts for the selected NAS Volume
The Capacity Alerts tab lists the configurable attributes of the NAS Volume capacity
Protection Mechanism, similar to the pool capacity alerts. See
[Managing Pool Capacity Alerts](pools.md#managing-pool-capacity-alerts) for more details.

- **Alert Threshold** - Creates an alert when it is estimated that the
  Volume will be at full capacity in X Minutes.
  - Default Value: 360 minutes
- **Alert Interval** - Calculates the estimated time until the Volume
  is full based on the capacity usage in the previous X minutes.
  - Default Value: 60 minutes
- **Emergency Threshold** - Creates an alert when the volume is running out of
  free space and reaching the given threshold.”
  - Default Value: 1 GB

<br/>

### File Lifecycle

The File Lifecycle tab provides a shortcut button to navigate directly to
the file lifecycle analytics page for the selected volume.

<a id="tags-tab"></a>

### Tags

Predefined custom tags can be configured in the **Tags** tab.
An example use case for tags is
[Filtering the List of Volumes](#filtering-volumes-list)
in the center pane.

A tag is identified by its **Tag Name** and has a **Tag Value** associated
with it. A tag can be defined only once for a volume. However, the same
**Tag Name** can be defined with a different **Tag Value** for other
volumes.

- **Create**: To create a new tag for a volume, in the volume’s **Tags**
  tab click **Create**, and enter the **Tag Name** and **Tag Value**.
  The tag is added to the list of tags in the **Tags** tab.
- **Edit**: To change the **Tag Value** of an existing tag, click on that
  tab in the tags list to mark it, and then click **Edit**.
  The **Edit Tag** dialog box opens, allowing overwriting of the
  **Tag Value**.
- **Delete**: To delete a tag, click on that tag row in the tags list to
  mark it, and then click **Delete**. A confirmation dialog box opens.
- **Refresh**: Displays the updated tags list.
