Merge pull request #250828 from ShawnJackson/four-azure-application-consistent-snapshot-articles

[AQ] edit pass: Four AzAcSnap articles

Author: ktoliver

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

@@ -1,6 +1,6 @@
 ---
-title: Configure Azure Application Consistent Snapshot tool for Azure NetApp Files | Microsoft Docs
-description: Provides a guide for running the configure command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. 
+title: Configure the Azure Application Consistent Snapshot tool for Azure NetApp Files
+description: Learn how to run the configure command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files. 
 services: azure-netapp-files
 documentationcenter: ''
 author: Phil-Jensen
@@ -16,28 +16,23 @@ ms.date: 08/21/2023
 ms.author: phjensen
 ---
 
-# Configure Azure Application Consistent Snapshot tool
+# Configure the Azure Application Consistent Snapshot tool
 
-This article provides a guide for running the configure command of the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files.
+This article shows you how to run the `azacsnap -c configure` command of the Azure Application Consistent Snapshot tool (AzAcSnap) that you can use with Azure NetApp Files.
 
-## Introduction
+## Commands for the configuration file
 
-The configuration file can be created or edited by using the `azacsnap -c configure` command.
+You can create or edit the configuration file for AzAcSnap by using the `azacsnap -c configure` command. The command has the following options:
 
-## Command options
+- `--configuration new` to create a new configuration file
 
-The `-c configure` command has the following options
+- `--configuration edit` to edit an existing configuration file
 
-- `--configuration new` to create a new configuration file.
+- `[--configfile <config filename>]` (optional parameter) to allow for custom configuration file names
 
-- `--configuration edit` to edit an existing configuration file.
+By default, the name of the configuration file is *azacsnap.json*. You can use a custom file name with the `--configfile=` parameter (for example, `--configfile=<customname>.json`).
 
-- `[--configfile <config filename>]` is an optional parameter allowing for custom configuration file names.
-
-## Configuration file for snapshot tools
-
-A configuration file can be created by running `azacsnap -c configure --configuration new`.  By default the configuration filename is `azacsnap.json`.  A custom file name can be used with the `--configfile=` parameter (for example, `--configfile=<customname>.json`)
-The following example is for Azure Large Instance configuration:
+The following example creates a configuration file for an Azure Large Instances configuration:
 
 ```bash
 azacsnap -c configure --configuration new
@@ -79,79 +74,77 @@ Enter the database type to add, 'hana', 'oracle', or 'exit' (for no database): e
 Editing configuration complete, writing output to 'azacsnap.json'
 ```
 
-## Details of required values
-
-The following sections provide detailed guidance on the various values required for the configuration file.
+## Required values for the configuration file
 
-Database section
+The following sections provide detailed guidance on required values for the database section of the configuration file.
 
 # [SAP HANA](#tab/sap-hana)
 
 When you add an *SAP HANA database* to the configuration, the following values are required:
 
-- **HANA Server's Address** = The SAP HANA server hostname or IP address.
-- **HANA SID** = The SAP HANA System ID.
-- **HANA Instance Number** = The SAP HANA Instance Number.
-- **HANA HDB User Store Key** = The SAP HANA user configured with permissions to run database backups.
-- **Do you need AzAcSnap to automatically disable/enable backint during snapshot** - defaults to NO, can be set to YES to allow AzAcSnap to disable/re-enable the backint interface (see notes on **Backint coexistence**).
-
-- Single node: IP and Hostname of the node
-- HSR with STONITH: IP and Hostname of the node
-- Scale-out (N+N, N+M): Current master node IP and host name
-- HSR without STONITH: IP and Hostname of the node
-- Multi SID on Single node: Hostname and IP of the node hosting those SIDs
+- `HANA Server's Address`: The SAP HANA server's host name or IP address.
+- `HANA SID`: The SAP HANA system ID (SID).
+- `HANA Instance Number`: The SAP HANA instance number.
+- `HANA HDB User Store Key`: The SAP HANA user configured with permissions to run database backups.
+- `Do you need AzAcSnap to automatically disable/enable backint during snapshot`: Defaults to `n` (no). You can set it to `y` (yes) to allow AzAcSnap to disable or re-enable the Backint interface. The [Backint coexistence](#backint-coexistence) section in this article explains this option in more detail.
+- `Single node`: Host name and IP address of the node.
+- `HSR with STONITH`: Host name and IP address of the node.
+- `Scale-out (N+N, N+M)`: Current host name and IP address of the master node.
+- `HSR without STONITH`: Host name and IP address of the node.
+- `Multi SID on Single node`: Host name and IP address of the node that hosts those SIDs.
 
 ### Backint coexistence
 
-[Azure Backup](../backup/index.yml) service provides an alternate backup tool for SAP HANA, where database and log backups are streamed into the 
-Azure Backup Service.  Some customers would like to combine the streaming backint-based backups with regular snapshot-based backups.  However, backint-based 
-backups block other methods of backup, such as using a files-based backup or a storage snapshot-based backup (for example, AzAcSnap).  Guidance is provided on the Azure Backup site on how to [Run SAP HANA native clients backup on a database with Azure Backup enabled](../backup/backup-azure-sap-hana-database.md#run-sap-hana-native-clients-backup-on-a-database-with-azure-backup). 
+The [Azure Backup](../backup/index.yml) service provides an alternate backup tool for SAP HANA. You can stream database and log backups into Azure Backup.
+
+Some customers want to combine the streaming Backint-based backups with regular snapshot-based backups. However, Backint-based backups block other backup methods, such as using a files-based backup or a storage snapshot-based backup (for example, AzAcSnap). For more information, see [Run SAP HANA native clients backup on a database with Azure Backup](../backup/backup-azure-sap-hana-database.md#run-sap-hana-native-clients-backup-on-a-database-with-azure-backup).
 
-The process described in the Azure Backup documentation has been implemented with AzAcSnap to automatically do the following steps:
+The process that the Azure Backup documentation describes has been implemented with AzAcSnap to automatically do the following steps:
 
-1. force a log backup flush to backint.
-1. wait for running backups to complete.
-1. disable the backint-based backup.
-1. put SAP HANA into a consistent state for backup.
-1. take a storage snapshot-based backup.
-1. release SAP HANA.
-1. re-enable the backint-based backup.
+1. Force a log backup flush to Backint.
+1. Wait for running backups to finish.
+1. Disable the Backint-based backup.
+1. Put SAP HANA into a consistent state for backup.
+1. Take a storage snapshot-based backup.
+1. Release SAP HANA.
+1. Re-enable the Backint-based backup.
 
-By default this option is disabled, but it can be enabled by running `azacsnap -c configure –configuration edit` and answering ‘y’ (yes) to the question 
-“Do you need AzAcSnap to automatically disable/enable backint during snapshot? (y/n) [n]”.  Editing the configuration as described sets the 
-autoDisableEnableBackint value to true in the JSON configuration file (for example, `azacsnap.json`).  It's also possible to change this value by editing 
-the configuration file directly.
+By default, this option is disabled. You can enable it by running `azacsnap -c configure –configuration edit` and answering `y` (yes) to the question `Do you need AzAcSnap to automatically disable/enable backint during snapshot? (y/n) [n]`.
+
+Editing the configuration as described sets the `autoDisableEnableBackint` value to `true` in the JSON configuration file (for example, *azacsnap.json*). It's also possible to change this value by editing the configuration file directly.
 
 # [Oracle](#tab/oracle)
 
-When you add an *Oracle database* to the configuration, the following values are required:
+When you add an Oracle database to the configuration, the following values are required:
 
-- **Oracle DB Server's Address** = The database server hostname or IP address.
-- **SID** = The database System ID.
-- **Oracle Connect String** = The Connect String used by `sqlplus` to connect to Oracle and enable/disable backup mode.
+- `Oracle DB Server's Address`: The database server's host name or IP address.
+- `SID`: The database system ID.
+- `Oracle Connect String`: The string that `sqlplus` uses to connect to Oracle and enable or disable backup mode.
 
 # [IBM Db2](#tab/db2)
 
-When adding a *Db2 database* to the configuration, the following values are required:
+When you add a Db2 database to the configuration, the following values are required:
+
+- `Db2 Server's Address`: The database server's host name or IP address.
 
-- **Db2 Server's Address** = The database server hostname or IP address.
-  - If Db2 Server Address (serverAddress) matches '127.0.0.1' or 'localhost' then azacsnap executes all `db2` commands locally (refer "Local connectivity").  Otherwise AzAcSnap uses the serverAddress as the host to connect to via SSH using the "Instance User" as the SSH login name.  Remote access via SSH can be validated with `ssh <instanceUser>@<serverAddress>` replacing instanceUser and serverAddress with the respective values (refer "Remote connectivity").
-- **Instance User** = The database System Instance User.
-- **SID** = The database System ID.
+  If `Db2 Server Address` (`serverAddress`) matches `127.0.0.1` or `localhost`, the snapshot tool runs all `db2` commands locally. Otherwise, the snapshot tool uses `serverAddress` as the host to connect to via Secure Shell (SSH), by using the `Instance User` value as the SSH login name.
+  
+  You can validate remote access via SSH by using `ssh <instanceUser>@<serverAddress>`. Replace `<instanceUser>` and `<serverAddress>` with the respective values.
+- `Instance User`: The instance user for the database system.
+- `SID`: The database system ID.
 
 > [!IMPORTANT]
-> Setting the Db2 Server Address (serverAddress) aligns directly with the method used to communicate with Db2, ensure this is set correctly as described.
+> Setting `Db2 Server Address` (`serverAddress`) aligns directly with the method that's used to communicate with Db2. Ensure that you set it correctly, as described.
 
 ---
 
-# [Azure Large Instance (Bare Metal)](#tab/azure-large-instance)
+# [Azure Large Instances (bare metal)](#tab/azure-large-instance)
 
-When you add *HLI Storage* to a database section, the following values are required:
+When you add Azure Large Instances storage to a database section, the following values are required:
 
-- **Storage User Name** = This value is the user name used to establish the SSH connection to the Storage.
-- **Storage IP Address** = The address of the Storage system.
-- **Storage Volume Name** = the volume name to snapshot.  This value can be determined multiple ways, perhaps the
-   simplest is to try the following shell command:
+- `Storage User Name`: The user name for establishing the SSH connection to the storage.
+- `Storage IP Address`: The IP address of the storage system.
+- `Storage Volume Name`: The volume name to snapshot. You can determine this value in multiple ways. A simple way is to use the following shell command:
 
     ```bash
     grep nfs /etc/fstab | cut -f2 -d"/" | sort | uniq
@@ -164,31 +157,29 @@ When you add *HLI Storage* to a database section, the following values are requi
     hana_shared_p40_soldub41_t020_vol
     ```
 
-# [Azure NetApp Files (with VM)](#tab/azure-netapp-files)
+# [Azure NetApp Files (with a virtual machine)](#tab/azure-netapp-files)
 
-When you add *ANF Storage* to a database section, the following values are required:
+When you add Azure NetApp Files storage to a database section, the following values are required:
 
-- **Service Principal Authentication filename** (JSON field: authFile)
-  - To use a System Managed Identity, leave empty with no value and press [Enter] to go to the next field.
-    - An example to set up an Azure System Managed Identity can be found on the [AzAcSnap Installation](azacsnap-installation.md).
-  - To use a Service Principal, use name of the authentication file (for example, `authfile.json`) generated in the Cloud Shell when configuring
-    communication with Azure NetApp Files storage.
-    - An example to set up a Service Principal can be found on the [AzAcSnap Installation](azacsnap-installation.md).
-- **Full ANF Storage Volume Resource ID** (JSON field: resourceId) = the full Resource ID of the Volume being snapshot.  This string can be retrieved from:
-    Azure portal –> ANF –> Volume –> Settings/Properties –> Resource ID
+- `Service Principal Authentication filename` (JSON field: `authFile`):
+  - To use a system-managed identity, leave this field empty with no value, and then select the Enter key to go to the next field.
+  
+    For an example to set up an Azure system-managed identity, see [Install the Azure Application Consistent Snapshot tool](azacsnap-installation.md).
+  - To use a service principal, use the name of the authentication file (for example, *authfile.json*) that's generated in Azure Cloud Shell when you're configuring communication with Azure NetApp Files storage.
+  
+    For an example to set up a service principal, see [Install the Azure Application Consistent Snapshot tool](azacsnap-installation.md).
+- `Full ANF Storage Volume Resource ID` (JSON field: `resourceId`): The full resource ID of the volume that's being snapshot. You can retrieve this string by going to the Azure portal and then selecting **Azure NetApp Files** > **Volume** > **Settings** or **Properties** > **Resource ID**.
 
 ---
 
-## Configuration file overview (`azacsnap.json`)
+## Example configuration file
 
-In the following example, the `azacsnap.json` is configured with the one SID.
+In the following example, *azacsnap.json* is configured with the one SID.
 
-The parameter values must be set to the customer's specific SAP HANA environment.
-For **Azure Large Instance** system, this information is provided by Microsoft Service Management during the onboarding/handover call, and
-is made available in an Excel file that is provided during handover. Open a service request if you
-need to be provided this information again.
+You must set the parameter values to your specific SAP HANA environment.
+For an Azure Large Instances system, Microsoft Service Management provides this information as an Excel file during the call for onboarding and handover. Open a service request if you need Microsoft Service Management to send the information again.
 
-The following output is an example configuration file only and is the content of the file as generated by the configuration example, update all the values accordingly.
+The following output is an example configuration file only. It's the content of the file that the configuration example generates. Update all the values accordingly.
 
 ```bash
 cat azacsnap.json
@@ -233,13 +224,10 @@ cat azacsnap.json
 ```
 
 > [!NOTE]
-> For a DR scenario where backups are to be run at the DR site, then the HANA Server Name configured in the DR configuration file
-> (for example, `DR.json`) at the DR site should be the same as the production server name.
-
-> [!NOTE]
-> For Azure Large Instance your storage IP address must be in the same subnet as your server pool. For example, in this case, our 
-> server pool subnet is 172. 18. 18 .0/24 and our assigned storage IP is 172.18.18.11.
+> For a disaster recovery (DR) scenario where you'll run backups at the DR site, the HANA server name that's configured in the DR configuration file (for example, `DR.json`) at the DR site should be the same as the production server name.
+>
+> For Azure Large Instances, your storage IP address must be in the same subnet as your server pool. For example, in this case, the server pool subnet is 172.18.18.0/24 and the assigned storage IP address is 172.18.18.11.
 
 ## Next steps
 
-- [Test Azure Application Consistent Snapshot tool](azacsnap-cmd-ref-test.md)
+- [Test the Azure Application Consistent Snapshot tool](azacsnap-cmd-ref-test.md)

articles/azure-netapp-files/azacsnap-get-started.md

@@ -166,7 +166,7 @@ The following guidance is provided to illustrate the usage of the snapshot tools
 
 - [What are the prerequisites for the storage snapshot](azacsnap-installation.md#prerequisites-for-installation)
   - [Enable communication with storage](azacsnap-installation.md#enable-communication-with-storage)
-  - [Enable communication with database](azacsnap-installation.md#enable-communication-with-database)
+  - [Enable communication with database](azacsnap-installation.md#enable-communication-with-the-database)
 - [How to take snapshots manually](azacsnap-tips.md#take-snapshots-manually)
 - [How to set up automatic snapshot backup](azacsnap-tips.md#setup-automatic-snapshot-backup)
 - [How to monitor the snapshots](azacsnap-tips.md#monitor-the-snapshots)