Merge pull request #278873 from Phil-Jensen/azacsnap_10

Doc update for AzAcSnap 10 Release

Author: Stacyrch140

articles/azure-netapp-files/TOC.yml

@@ -172,16 +172,48 @@
     - name: Azure Application Consistent Snapshot (AzAcSnap) tool
       items: 
       - name: What is AzAcSnap?
-        href: azacsnap-introduction.md
-      - name: Release Notes for AzAcSnap
-        href: azacsnap-release-notes.md
+        items:
+        - name: Introduction to AzAcSnap
+          href: azacsnap-introduction.md
+        - name: Release Notes for AzAcSnap
+          href: azacsnap-release-notes.md
       - name: Get started with AzAcSnap
-        href: azacsnap-get-started.md
-      - name: Install AzAcSnap
-        href: azacsnap-installation.md
+        items:
+        - name: Overall workflow
+          href: azacsnap-get-started.md
+        - name: Install AzAcSnap
+          href: azacsnap-installation.md
+        - name: Configure Database
+          items:
+          - name: All databases
+            href: azacsnap-configure-database.md
+          - name: SAP HANA
+            href: azacsnap-configure-database.md?tabs=sap-hana
+          - name: Oracle Database
+            href: azacsnap-configure-database.md?tabs=oracle
+          - name: IBM Db2
+            href: azacsnap-configure-database.md?tabs=db2
+          - name: Microsoft SQL Server (PREVIEW)
+            href: azacsnap-preview.md?tabs=mssql#microsoft-sql-server
+        - name: Configure Storage
+          items:
+          - name: All storage
+            href: azacsnap-configure-storage.md
+          - name: Azure NetApp Files
+            href: azacsnap-configure-storage.md?tabs=azure-netapp-files
+          - name: Azure Large Instance
+            href: azacsnap-configure-storage.md?tabs=azure-large-instance
+          - name: Azure Managed Disk (PREVIEW)
+            href: azacsnap-preview.md?tabs=mssql#azure-managed-disks
+        - name: Configure AzAcSnap
+          href: azacsnap-cmd-ref-configure.md
+        - name: Test configuration of AzAcSnap
+          href: azacsnap-cmd-ref-test.md
+        - name: Backup your database with AzAcSnap
+          href: azacsnap-cmd-ref-backup.md
       - name: Disaster recovery using AzAcSnap
         href: azacsnap-disaster-recovery.md
-      - name: Tips and tricks for using AzAcSnap
+      - name: Tips for using AzAcSnap
         href: azacsnap-tips.md
       - name: Troubleshoot AzAcSnap
         href: azacsnap-troubleshoot.md

articles/azure-netapp-files/azacsnap-cmd-ref-backup.md

@@ -5,7 +5,7 @@ services: azure-netapp-files
 author: Phil-Jensen
 ms.service: azure-netapp-files
 ms.topic: reference
-ms.date: 07/29/2022
+ms.date: 05/15/2024
 ms.author: phjensen
 ---
 
@@ -15,9 +15,9 @@ This article provides a guide for running the backup command of the Azure Applic
 
 ## Introduction
 
-A storage snapshot based backup is run using the `azacsnap -c backup` command.  This command performs the orchestration of a database consistent storage snapshot on the DATA volumes, and a storage snapshot (without any database consistency setup) on the OTHER volumes.  
+A storage snapshot based backup is run using the `azacsnap -c backup` command. This command performs the orchestration of a database consistent storage snapshot on the DATA volumes, and a storage snapshot (without any database consistency setup) on the OTHER volumes. 
 
-For DATA volumes `azacsnap` will prepare the database for a storage snapshot, then it will take the storage snapshot for all configured volumes, finally it will advise the database the snapshot is complete.  It will also manage any database entries which record snapshot backup activity (e.g. SAP HANA backup catalog).
+For DATA volumes `azacsnap` prepares the database for a storage snapshot, then it takes a storage snapshot for all configured volumes, finally it tells the database the snapshot is complete. It also manages any database entries which record snapshot backup activity (for example, SAP HANA backup catalog).
 
 ## Command options
 
@@ -27,36 +27,36 @@ The `-c backup` command takes the following arguments:
   - `data` snapshots the volumes within the `dataVolume` stanza of the configuration file.
     1. **data** Volume Snapshot process
        1. put the database into *backup-mode*.
-       1. take snapshots of the Volume(s) listed in the configuration file's `"dataVolume"` stanza.
+       1. take snapshots of the Volumes listed in the configuration file's `"dataVolume"` stanza.
        1. take the database out of *backup-mode*.
        1. perform snapshot management.
   - `other` snapshots the volumes within the `otherVolume` stanza of the configuration file.
     1. **other** Volume Snapshot process
-       1. take snapshots of the Volume(s) listed in the configuration file's `"otherVolume"` stanza.
+       1. take snapshots of the Volumes listed in the configuration file's `"otherVolume"` stanza.
        1. perform snapshot management.
-  - `all` snapshots all the volumes in the `dataVolume` stanza and then all the volumes in the `otherVolume` stanza of the configuration file.  The 
+  - `all` snapshots all the volumes in the `dataVolume` stanza and then all the volumes in the `otherVolume` stanza of the configuration file. The 
     processing is handled in the order outlined as follows:
     1. **all** Volumes Snapshot process
        1. **data** Volume Snapshot (same as the normal `--volume data` option)
           1. put the database into *backup-mode*.
-          1. take snapshots of the Volume(s) listed in the configuration file's `"dataVolume"` stanza.
+          1. take snapshots of the Volumes listed in the configuration file's `"dataVolume"` stanza.
           1. take the database out of *backup-mode*.
           1. perform snapshot management.
        1. **other** Volume Snapshot (same as the normal `--volume other` option)
-          1. take snapshots of the Volume(s) listed in the configuration file's `"otherVolume"` stanza.
+          1. take snapshots of the Volumes listed in the configuration file's `"otherVolume"` stanza.
           1. perform snapshot management.
 
   > [!NOTE]
   > By creating a separate config file with the boot volume as the otherVolume, it's possible for `boot` snapshots to be taken on an entirely different schedule (for example, daily).
 
-- `--prefix=` the customer snapshot prefix for the snapshot name. This parameter has two purposes. Firstly purpose is to provide a unique name for grouping of snapshots. Secondly to determine the `--retention` number of storage snapshots that are kept for the specified `--prefix`.
+- `--prefix=` the customer snapshot prefix for the snapshot name. This parameter has two purposes. Firstly provide a unique name for grouping of snapshots. Secondly to determine the `--retention` number of storage snapshots that are kept for the specified `--prefix`.
 
     > [!IMPORTANT]
     > Only alpha numeric ("A-Z,a-z,0-9"), underscore ("_") and dash ("-") characters are allowed.
 
-- `--retention` the number of snapshots of the defined `--prefix` to be kept. Any additional snapshots are removed after a new snapshot is taken for this `--prefix`.
+- `--retention` the number of snapshots of the defined `--prefix` to be kept. Any extra snapshots are removed after a new snapshot is taken for this `--prefix`.
 
-- `--trim` available for SAP HANA v2 and later, this option maintains the backup catalog and on disk catalog and log backups. The number of entries to keep in the backup catalog is determined by the `--retention` option above, and deletes older entries for the defined prefix (`--prefix`) from the backup catalog, and the related physical logs backup. It also deletes any log backup entries that are older than the oldest non-log backup entry. This operations helps to prevent the log backups from using up all available disk space.
+- `--trim` available for SAP HANA v2 and later, this option maintains the backup catalog and on disk catalog and log backups. The number of entries to keep in the backup catalog is determined by the `--retention` option above, and deletes older entries for the defined prefix (`--prefix`) from the backup catalog, and the related physical logs backup. It also deletes any log backup entries that are older than the oldest non-log backup entry. This `--trim` operation helps to prevent the log backups from using up all available disk space.
 
   > [!NOTE]
   > The following example command will keep 9 storage snapshots and ensure the backup catalog is continuously trimmed to match the 9 storage snapshots being retained.
@@ -68,7 +68,7 @@ The `-c backup` command takes the following arguments:
 - `[--ssl=]` an optional parameter that defines the encryption method used to communicate
     with SAP HANA, either `openssl` or `commoncrypto`. If defined, then the `azacsnap -c backup`
     command expects to find two files in the same directory, these files must be named after
-    the corresponding SID. Refer to [Using SSL for communication with SAP HANA](azacsnap-installation.md#using-ssl-for-communication-with-sap-hana). The following example takes a `hana` type snapshot with a prefix of `hana_TEST` and will keep `9` of them communicating with SAP HANA using SSL (`openssl`).
+    the corresponding SID. Refer to [Using SSL for communication with SAP HANA](azacsnap-configure-database.md#using-ssl-for-communication-with-sap-hana). The following example takes a `hana` type snapshot with a prefix of `hana_TEST` and keeps `9` of them communicating with SAP HANA using SSL (`openssl`).
 
     ```bash
     azacsnap -c backup --volume data --prefix hana_TEST --retention 9 --trim --ssl=openssl
@@ -79,13 +79,13 @@ The `-c backup` command takes the following arguments:
 ## Snapshot backups are fast
 
 The duration of a snapshot backup is independent of the volume size, with a 10-TB volume being snapped
-within the same approximate time as a 10-GB volume.  
+within the same approximate time as a 10-GB volume.
 
 The primary factors impacting overall execution time are the number of volumes to be snapshot and any
 changes in the `--retention` parameter (where a reduction can increase the execution time as excess
 snapshots are removed).
 
-In the example configuration above (for **Azure Large Instance**), snapshots for the
+In the example configuration provided for **Azure Large Instance**, snapshots for the
 two volumes took less than 5 seconds to complete. For **Azure NetApp Files**, snapshots for the two volumes
 would take about 60 seconds.
 
@@ -100,15 +100,15 @@ needs to remove the extra snapshots.
 azacsnap -c backup --volume data --prefix hana_TEST --retention 9 --trim
 ```
 
-The command does not output to the console, but does write to a log file, a result file,
+The command doesn't output to the console, but does write to a log file, a result file,
 and `/var/log/messages`.
 
-In this example the *log file* name is `azacsnap-backup-azacsnap.log` (see [Log files](#log-files))
+In this example, the *log file* name is `azacsnap-backup-azacsnap.log` (see [Log files](#log-files)).
 
-When running the `-c backup` with the `--volume data` option a result file is also generated as a file to allow
-for quickly checking the result of a backup.  The *result* file has the same base name as the log file, with `.result` as its suffix.
+When running the command `-c backup` with the `--volume data` option, a result file is also generated as a file to allow
+for quickly checking the result of a backup. The *result* file has the same base name as the log file, with `.result` as its suffix.
 
-In this example the *result file* name is `azacsnap-backup-azacsnap.result` and contains the following output:
+In this example, the *result file* name is `azacsnap-backup-azacsnap.result` and contains the following output:
 
 ```bash
 cat logs/azacsnap-backup-azacsnap.result
@@ -144,10 +144,10 @@ Jul  2 06:02:06 server01 azacsnap[114280]: Database # 1 (H80) : completed ok
 azacsnap -c backup --volume other --prefix logs_TEST --retention 9
 ```
 
-The command does not output to the console, but does write to a log file only.  It does _not_ write
+The command doesn't output to the console, but does write to a log file only. It does _not_ write
 to a result file or `/var/log/messages`.
 
-In this example the *log file* name is `azacsnap-backup-azacsnap.log` (see [Log files](#log-files)).
+In this example, the *log file* name is `azacsnap-backup-azacsnap.log` (see [Log files](#log-files)).
 
 ## Example with `other` parameter (to backup host OS)
 
@@ -163,14 +163,14 @@ azacsnap -c backup --volume other --prefix boot_TEST --retention 9 --configfile
 > For Azure Large Instance, the configuration file volume parameter for the boot volume might not be visible at the host operating system level.
 > This value can be provided by Microsoft Operations.
 
-The command does not output to the console, but does write to a log file only.  It does _not_ write
+The command doesn't output to the console, but does write to a log file only. It does _not_ write
 to a result file or `/var/log/messages`.
 
-In this example the *log file* name is `azacsnap-backup-bootVol.log` (see [Log files](#log-files)).
+In this example, the *log file* name is `azacsnap-backup-bootVol.log` (see [Log files](#log-files)).
 
 ## Log files
 
-The log file name is constructed from the following "(command name)-(the `-c` option)-(the config filename)".  For example, if running the command `azacsnap -c backup --configfile h80.json --retention 5 --prefix one-off` then the log file will be called `azacsnap-backup-h80.log`.  Or if using the `-c test` option with the same configuration file (e.g. `azacsnap -c test --configfile h80.json`) then the log file will be called `azacsnap-test-h80.log`.
+The log file name is constructed from the following "(command name)-(the `-c` option)-(the config filename)". For example, if running the command `azacsnap -c backup --configfile h80.json --retention 5 --prefix one-off` then the log file is called `azacsnap-backup-h80.log`. Or if using the `-c test` option with the same configuration file (e.g. `azacsnap -c test --configfile h80.json`) then the log file is called `azacsnap-test-h80.log`.
 
 > [!NOTE]
 > Log files can be automatically maintained using [this guide](azacsnap-tips.md#manage-azacsnap-log-files).

articles/azure-netapp-files/azacsnap-cmd-ref-test.md

@@ -5,7 +5,7 @@ services: azure-netapp-files
 author: Phil-Jensen
 ms.service: azure-netapp-files
 ms.topic: reference
-ms.date: 08/04/2021
+ms.date: 05/15/2024
 ms.author: phjensen
 ---
 
@@ -39,7 +39,7 @@ For SSL, this command can take the following optional argument:
 - `--ssl=` forces an encrypted connection with the database and defines the encryption
     method used to communicate with SAP HANA, either `openssl` or `commoncrypto`. If defined,
     then this command expects to find two files in the same directory, these files must be
-    named after the corresponding SID. Refer to [Using SSL for communication with SAP HANA](azacsnap-installation.md#using-ssl-for-communication-with-sap-hana).
+    named after the corresponding SID. Refer to [Using SSL for communication with SAP HANA](azacsnap-configure-database.md#using-ssl-for-communication-with-sap-hana).
 
 ### Output of the `azacsnap -c test --test hana` command