Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs-3588 Update VMware-Snapshots Article
This commit updates the VMware-Snapshots.md how-to article content, creates the new VMware-SnapshotsScreen.md article. Fixes style issues. Local build test links working.
- Loading branch information
1 parent
c4b2cb3
commit 5fbc2ba
Showing
2 changed files
with
32 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,33 @@ | ||
--- | ||
title: "VMware-Snapshots" | ||
title: "Creating VMware-Snapshots" | ||
weight: 30 | ||
aliases: /core/storage/vmware-snapshots/ | ||
--- | ||
|
||
**Storage** > **VMware-Snapshots** coordinates ZFS snapshots when using TrueNAS as a VMware datastore. | ||
When a ZFS snapshot is created, TrueNAS automatically snapshots any running VMware virtual machines before taking a scheduled or manual ZFS snapshot of the dataset or zvol backing that VMware datastore. | ||
|
||
Virtual machines **must be powered on** for TrueNAS snapshots to be copied to VMware. | ||
To copy TrueNAS snapshots to VMWare, virtual machines must be powered-on. | ||
The temporary VMware snapshots are then deleted on the VMware side but still exist in the ZFS snapshot and are available as stable restore points. | ||
These coordinated snapshots go in the **Storage > Snapshots** list. | ||
These coordinated snapshots go on the **Storage > Snapshots** list. | ||
|
||
{{< hint info >}} | ||
You need a paid-edition for VMware ESXi to use VMware-Snapshots. If you try to use them with ESXi free then you see the following error message: **Error: Can’t create snapshot, current license or ESXi version prohibits execution of the requested operation.**. Indeed ESXi free has locked (read-only) API that prevents using TrueNAS VMware-Snapshots. The cheapest ESXi edition that is compatible with TrueNAS VMware-Snapshots is *VMware vSphere Essentials Kit*. | ||
You need a paid-edition for VMware ESXi to use VMware-Snapshots. | ||
If you try to use them with ESXi free edition you see the following error message: **Error: Can't create snapshot, current license or ESXi version prohibits execution of the requested operation.** | ||
ESXi free has a locked (read-only) API that prevents using TrueNAS VMware-Snapshots. | ||
The cheapest ESXi edition that is compatible with TrueNAS VMware-Snapshots is **VMware vSphere Essentials Kit**. | ||
{{< /hint >}} | ||
|
||
## Create a VMware Snapshot | ||
|
||
Go to **Storage > VMware Snapshots** and click *ADD*. | ||
Go to **Storage > VMware Snapshots** and click **ADD**. | ||
|
||
![StorageVMwareSnapshotsAdd](/images/CORE/12.0/StorageVMwareSnapshotsAdd.png "Creating a VMware Snapshot") | ||
|
||
| Setting | Value | Description | | ||
|---------|-------|-------------| | ||
| Hostname | string | Enter the IP address or hostname of the VMware host. When clustering, use the IP address or hostname of the vCenter server for the cluster. | | ||
| Username | string | Enter a user account name created on the VMware host. The account must have permission to snapshot virtual machines. | | ||
| Password | string | Enter the password associated with the *Username*. | | ||
| ZFS Filesystem | browse button | Select a filesystem to snapshot. | | ||
| Datastore | drop-down menu | After entering the *Hostname*, *Username*, and *Password*, click *FETCH DATASTORES* to populate the menu. Select the datastore to synchronize. | | ||
After entering the **Hostname**, **Username**, and **Password**, click **FETCH DATASTORES** to populate the menu and then select the datastore to synchronize. | ||
|
||
TrueNAS connects to the VMware host after clicking *FETCH DATASTORES*. | ||
The *ZFS Filesystem* and *Datastore* drop-down menus populate from the VMware host response. | ||
The **ZFS Filesystem** and **Datastore** drop-down menus populate from the VMware host response. | ||
Choosing a datastore also selects any previously mapped dataset. | ||
|
||
See [VMware Screen]({{< relref "/CORE/UIReference/Storage/VMware-SnapshotsScreen.md" >}}) |
20 changes: 20 additions & 0 deletions
20
content/CORE/UIReference/Storage/VMware-SnapshotsScreen.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: "VMware-Snapshots Screen" | ||
weight: 30 | ||
--- | ||
|
||
Use **Storage** > **VMware-Snapshots** to add a VMWare snapshot that coordinates ZFS snapshots when using TrueNAS as a VMware datastore. | ||
|
||
![StorageVMwareSnapshotsAdd](/images/CORE/12.0/StorageVMwareSnapshotsAdd.png "Creating a VMware Snapshot") | ||
|
||
| Setting | Description | | ||
|---------|-------------| | ||
| **Hostname** | Enter the IP address or host name of the VMware host. When clustering, use the IP address or host name of the vCenter server for the cluster. | | ||
| **Username** |Enter a user account name created on the VMware host. The account must have permission to snapshot virtual machines. | | ||
| **Password** | Enter the password associated with the value in **Username**. | | ||
| **ZFS Filesystem** | Select a file system to snapshot from the dropdown list. Values populate from the VMWare host response. | | ||
| **Datastore** | Select an option from the dropdown list after entering the **Hostname**, **Username**, and **Password**, click **FETCH DATASTORES** to populate the menu. Select the datastore to synchronize. Selecting a datastore also select any previously mapped datasets. | | ||
|
||
Use **FETCH DATASTORES** to have TrueNAS connect to the VMware host. | ||
|
||
For more informtion see [VMWare Shanpshots]({{< relref "/CORE/CORETutorials/Storage/VMware-Snapshots.md" >}}) |