> ## Documentation Index
> Fetch the complete documentation index at: https://docs.macstadium.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Private Cloud Network Attached Storage

> Create and manage a NAS virtual machine in MacStadium Private Cloud to share storage across VMs and machines on your private network.

Network Attached Storage (NAS) devices are specialized servers that handle only data storage and file-sharing requests. They provide fast, secure, and reliable storage services to private networks.

NAS is managed through the same interface as other virtual servers in the network, so it can move from one physical host to another. NAS functionality can be added by downloading and implementing an instance of the standard NAS VM Recipe.

The NAS service is a dedicated virtual machine that presents itself as a service providing users the ability to create and manage file based storage without the need for using physical or virtual appliances. Each NAS service is complete with its own dashboard and is completely managed from the user interface.

## About NAS

NAS lets you take storage in Private Cloud and expose it to other machines, then share that storage between machines. It is a virtual NAS with redundancy. NAS storage can be exposed to other machines over the network.

NAS allows for virtual machines to share storage with assets inside or outside of the Private Cloud, then use a file share to move files back and forth between machines.

NAS is used to expand storage and to share files between Macs, and you can configure this yourself.

## Create the NAS Service

The NAS service is a dedicated virtual machine that presents itself as a service providing users the ability to create and manage file based storage without the need for using physical or virtual appliances. Each NAS service includes its own dashboard and is fully managed from the user interface. Using the integrated NAS service takes advantage of the VergeIO snapshot engine and deduplication algorithm to get the most of usable storage space.

1. From the Cloud Dashboard, select **NAS** from the left menu.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779757211.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=65a01591aab67687e6a275daa6b8e7ba" alt="Private Cloud left sidebar with NAS option highlighted" width="1364" height="731" data-path="images/attachments/43920779757211.png" />

NAS

2. The **NAS Dashboard** opens.

For a new user, when this dashboard is opened for the first time, there are no NAS services or volumes. A NAS Service is the virtual machine in Private Cloud that runs the virtual NAS.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792310939.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=4495da061d3ffc5d85622ab73d4d9649" alt="Private Cloud NAS Dashboard with no services and New NAS Service button" width="1333" height="633" data-path="images/attachments/43920792310939.png" />

NEW NAS Services

3. Click **New NAS Service** to open a recipe that is used to create the new NAS service.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792311323.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=8cd1af51bc349ca627687c536d137793" alt="Private Cloud New NAS Service recipe form with VM Recipe Instance fields" width="1252" height="649" data-path="images/attachments/43920792311323.png" />

VM Recipe Instance

This recipe only deploys NAS appliances for Private Cloud.

4. Complete the following information:

* Enter a  ****Name**** for the new NAS Service.

* The default setting for  ****Cores**** is 4.

* The default setting for  ****RAM**** is 4 GB

8 GB of RAM is required for antivirus to be enabled. If fewer than 8 GB of RAM are used, then a warning message appears. The message can be disabled, or the RAM can be set to 8 GB. The antivirus only protects the computers connected to the NAS, which is done by scanning the files on the volume. Some users may decide to keep the Antivirus and some users may decide to use less RAM. The system-defined-default  ****Cluster**** is automatically selected.

* Select the  ****Network**** on which the NAS should run. Options include Internal and External networks.

* Select  ****IP Address Type**** for the NAS Service.

  * Select **Static**

Consult the IP Plan in your MacStadium Portal account to determine an IP Address that does not conflict with existing machines.

* Define a  ****Hostname**** for the NAS Service VM.

* **OPTIONAL** : Enter a  ****domain.**** (If the Domain field is left blank, the system defaults the domain to **workgroup**.)

* ****Timezone**** defaults to the default time zone.

* The **default** ****NTP Servers**** setting is recommended. This defines the Network Time Protocol (NTP) servers list, which is used for keeping the NAS service time synchronized.

* **OPTIONAL** : Enter the address of a  ****Remote Syslog server.****

* **OPTIONAL** : Enter a  ****Remote Syslog Template.****

4. Click **Submit** , and the NAS appears in the **NAS Service list**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792315163.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=b37fd6c279cf5eb466b7fd62c14aeae9" alt="Private Cloud NAS Service list showing the newly created NAS service" width="1252" height="772" data-path="images/attachments/43920792315163.png" />Newly Created NAS Service

5. To disable the **Antivirus** checkbox, deselect the checkmark and the **Antivirus Settings** box opens.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779762331.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=2487831fdf52026167110d37a6298843" alt="Private Cloud NAS Service settings with Antivirus checkbox" width="495" height="166" data-path="images/attachments/43920779762331.png" />

Antivirus Checkbox

6. Uncheck the box and click **Submit**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792320027.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=4009540638dc3c9d15075cf1d098b8c2" alt="Private Cloud Antivirus Settings dialog with Submit button" width="1245" height="771" data-path="images/attachments/43920792320027.png" />

Antivirus Setting

7. Double-click the **Service** to bring up the Dashboard for the Service.

8. Select **Power On** to start the NAS.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792320667.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=b5e418ad209a679397cfbd9742a174db" alt="Private Cloud NAS Service dashboard with Power On button" width="1246" height="771" data-path="images/attachments/43920792320667.png" />

Power On

9. Click the **Yes** to confirm power on.

To utilize the NAS service, at least one **Volume** needs to be implemented. A NAS service consists of one or more Volumes. Each Volume is a separate directory structure with its own settings for security, snapshots, storage tier, max size, antivirus, and sharing.

10. The next step is to create a NAS User.

### Create a NAS User

1. From the Main Dashboard, select **NAS**.

2. Select **NAS Services** → **Select a Service**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792322203.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=ccc4effa323e3f72ff17b6460644cb1c" alt="Private Cloud NAS Services list with a service to select" width="1452" height="772" data-path="images/attachments/43920792322203.png" />

Select a Service

3. Double-click a Service.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792323483.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=27bd1d05aacb844d4f5ff43c8f8633da" alt="Private Cloud NAS Service detail showing NAS User option" width="1452" height="930" data-path="images/attachments/43920792323483.png" />

NAS User

4. Select **NAS User**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779767195.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=dce95b3e18f8160e9fd47ed013a914b6" alt="Private Cloud NAS Service Users tab" width="1452" height="930" data-path="images/attachments/43920779767195.png" />

NAS User

5. Select **New** to add a new NAS User. (This page is also used to edit or delete a user.)

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792324635.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=b5f83f06b0fba004891b8b54aededf51" alt="Private Cloud New NAS User form with username and password fields" width="1265" height="835" data-path="images/attachments/43920792324635.png" />

NAS User

This is per service. For every virtual NAS appliance, there must be a set of users assigned to it.

* Required: **Username**

* Required: **Password**

* Optional: **Display Name**

* Optional: **Description**

* Optional: **Home Share**

* Optional: **Home Drive Letter**

6. Click **Submit**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779768731.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=d0bde7438af71255cf02bd5b8c117c7c" alt="Private Cloud NAS Users list showing the newly created user" width="1265" height="835" data-path="images/attachments/43920779768731.png" />

New User

7. The next step is to create a Volume.

## Volumes

A NAS service consists of one or more Volumes. Each Volume is a separate directory structure with its own settings for security, snapshots, storage tier, max size, antivirus, and sharing. Multiple volumes can be set up on the NAS, and the size of the volume determines the space available to deploy files on the NAS.

Volume-level snapshots allow for customizing snapshot schedule and retention rules per individual NAS volume and provide the option for a quiesced snapshot. (Non-quiesced NAS volumes can be imported from Cloud snapshots to be used for restore.)

Quiesced volume snapshots freeze file system during the snapshot process. The Quiesce option can be selected when taking a manual volume snapshot and can be enabled within the snapshot profile for automated snapshots.

### About Volumes

There are two types of Volumes:

* **Local Volumes** are file systems stored within Private Cloud and consume storage in the vSAN. Each local volume can have different sharing, syncing, tiering, and permission settings.

* **Remote Volumes** are external file systems that are mounted to the VergeIO system and presented as if local.

### Creating Local Volumes

1. From the Main Dashboard, select **NAS**.

2. Select **Volumes** from the left menu.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792325659.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=75c3d4e2561e599afd6b95195c52fa9a" alt="Private Cloud left menu with Volumes option highlighted" width="1202" height="664" data-path="images/attachments/43920792325659.png" />

Volumes

When the NAS is first created, one volume (for log files) is automatically created.

2. Select **New** from the left menu.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779771291.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=1338051e0bbcc93404235c63b3cc7ad2" alt="Private Cloud Volumes page with New button in left menu" width="1207" height="570" data-path="images/attachments/43920779771291.png" />

New

3. Select the appropriate  ****NAS Service**** from the dropdown list.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779777947.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=93c8fe0331d6083e3c180acdf827b5ad" alt="Private Cloud New Volume form with NAS Service dropdown" width="572" height="1123" data-path="images/attachments/43920779777947.png" />

NAS Service

* Enter a  ****Name**** for the volume (required).

Spaces are not permitted.

* Enter a  ****Description**** for the volume (optional).

* In the  ****Filesystem Type**** dropdown list, select **Local Volume (EXT4)**.

* The  ****Encrypt Volume**** option can be selected to encrypt the entire volume (AES-XTS).

**Encryption Considerations**

* **Encryption selection is only available during creation** ; a volume cannot be changed from encrypted to unencrypted or vice-versa after creation.
* **Minor to moderate performance implications** are involved with enabling volume encryption.
* The **original encryption key** (defined when creating the volume) is needed for the lifetime of the volume; this encryption key must be **entered each time the volume is brought online** (for example, after disabling/enabling a volume or after its NAS service is rebooted).
* **Without the encryption key, it is not possible to bring the volume back online.**

4. Click **Submit.**

5. The next step is to create a Share (NFS or CIFS).

## Shares: NFS and CIFS

Network File System (NFS) and Common Internet File System (CIFS) are both file access protocols that allow client systems to access files on remote devices.

### About NFS and CIFS

* NFS uses a lightweight protocol with less overhead, which results in faster file access and transfer speeds.

* CIFS has more protocol overhead due to its support for various Windows-specific features. This can impact performance, especially in high-latency networks.

MacStadium recommends using CIFS.

### Creating a CIFS Share on an Existing Volume

CIFS (Common Internet File System) is a network protocol that allows clients to communicate with servers and access file sharing and print services as if they were stored locally. CIFS offers robust security features, which make them suitable for secure environments. They are important in Private Cloud because they allow access to a NAS volume over CIFS/SMB.

1. Navigate to the **NAS Dashboard**.

2. Click **New CIFS Shares**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792328475.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=f192a23e6e787195354810659ae77044" alt="Private Cloud NAS Dashboard with New CIFS Shares button" width="1617" height="738" data-path="images/attachments/43920792328475.png" />

New CIFS Shares

3. In the **CIFS Shares** screen enter the necessary information.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792328987.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=2d49697b049b78ee04b094ec965e1421" alt="Private Cloud CIFS Shares form with Name, Share Path, and permissions fields" width="1511" height="1091" data-path="images/attachments/43920792328987.png" />

CIFS Shares

* Required: Enter a **Name** for the CIFS share.

* Optional: **Share Path** can be entered to define a specific path within the Volume; **otherwise** , this field **can be left blank** to share the entire Volume.

* Optional: A **Description** can be entered for the Share to record additional information about the Share.

* Optional: A **Comment** can be entered for the Share.

* Optional: A **Valid Users** list can be specified. This defines the users that are allowed to connect to the Share.

* Optional: A **Valid Groups** list can be specified. Users of the specified groups are allowed connection to the Share.

* Optional: **Allowed Hosts** field is to define one or more hosts that are permitted to access the Share. Hostname, IP address, domain name, netgroup, and subnet are all valid entries.

* Optional: **Denied Hosts** field is to define one or more hosts that are NOT permitted access to the Share. **Hostname, IP address, domain name, netgroup, and subnet are all valid entries.**

* Optional: **Read-Only** option can be selected to deny any write operations via this Share.

* **Browseable** option can be selected to make the Share visible in lists of available shares. **This option is disabled by default**.

Optional: **Users / Admin Groups** allow is to grant administrative privileges to the Share. This means that all file operations will be done as the super-user (root). Use this option carefully, as those in the list can do anything on the Share, regardless of individual file permissions.

* Optional: **User / Force Group** options can be specified to define a user or group used for all file operations performed via this Share.

* Optional: **Configuration Options** (advanced samba share options) can be specified to handle special-case scenarios.

3. Click **Submit**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792329499.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=57b38ec83474c3062c192babc45b9787" alt="Private Cloud NAS CIFS Shares list showing the newly created share" width="1607" height="586" data-path="images/attachments/43920792329499.png" />

Newly Created CIFS Share

### Creating a NFS File Share on an Existing Volume

1. From the Main Dashboard, select **NAS**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792330011.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=2892f1d9cb0fb7953fcf381830c92323" alt="Private Cloud left sidebar with NAS option highlighted" width="1363" height="641" data-path="images/attachments/43920792330011.png" />

NAS

2. Select **Volumes**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779782299.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=51714c88890424a8b5de76b94f5de6e4" alt="Private Cloud NAS left menu with Volumes option highlighted" width="1363" height="641" data-path="images/attachments/43920779782299.png" />

Volumes

3. Select the **Volume**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792332443.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=5c106c73f1b7abb253a860762c5b9c5f" alt="Private Cloud Volumes list with a volume row highlighted" width="1484" height="641" data-path="images/attachments/43920792332443.png" />

View

4. Select **View**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792333083.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=241c115e4260cc0dc17feb0befa61a0a" alt="Private Cloud Volume detail page showing NFS Shares and other options" width="1428" height="1096" data-path="images/attachments/43920792333083.png" />

Volumes

5. Select **NFS Shares**.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920792333339.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=7e949b5b4734104fe3a24f9b93a238eb" alt="Private Cloud Volume NFS Shares tab" width="1428" height="1096" data-path="images/attachments/43920792333339.png" />

NFS Shares

6. Select **New** to create a new share.

<img src="https://mintcdn.com/macstadiuminc/dU1lCoT-Tf9PRIOx/images/attachments/43920779792539.png?fit=max&auto=format&n=dU1lCoT-Tf9PRIOx&q=85&s=81b8fc2ea959cae8c0ca1410e05793ba" alt="Private Cloud NFS Shares page with New button" width="1501" height="484" data-path="images/attachments/43920779792539.png" />

New

* Enter a Name for the share

* Enter a Share Path to define a specific path within the volume

* Enter a Description for the share

* Select Allow Everyone to allow all hosts, or specify one or more allowed hosts

* Select a Data Access option

* Select a User/Group Squashing option

7. Click **Submit**.

## Connecting to the Share

Now that the NAS Service, Volume, Users, and Share are created, end users can map to the shared drive from their Mac mini or other devices on the network.
