Skip to content

Commit 8fcbc80

Browse files
Merge pull request #308475 from Phil-Jensen/main
Revise troubleshooting steps for AzAcSnap tool
2 parents 8b35b55 + 65369fe commit 8fcbc80

1 file changed

Lines changed: 94 additions & 76 deletions

File tree

articles/azure-netapp-files/azacsnap-troubleshoot.md

Lines changed: 94 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,66 @@ services: azure-netapp-files
55
author: Phil-Jensen
66
ms.service: azure-netapp-files
77
ms.topic: troubleshooting
8-
ms.date: 10/30/2025
8+
ms.date: 11/18/2025
99
ms.author: phjensen
1010
ms.custom: kr2b-contr-experiment
1111
# Customer intent: "As a system administrator using Azure Application Consistent Snapshot tool, I want to troubleshoot command execution issues, so that I can ensure successful operations and maintain reliable backups of my applications."
1212
---
1313

1414
# Troubleshoot the Azure Application Consistent Snapshot (AzAcSnap) tool
1515

16-
This article describes how to troubleshoot issues when using the Azure Application Consistent Snapshot (AzAcSnap) tool for Azure NetApp Files and Azure Large Instance.
16+
This article describes how to troubleshoot issues when using the Azure Application Consistent Snapshot ([AzAcSnap](https://aka.ms/azacsnap)) tool.
1717

1818
You might encounter several common issues when running AzAcSnap commands. Follow the instructions to troubleshoot the issues.
1919

2020
> [!IMPORTANT]
2121
> To ensure accurate troubleshooting and support, issues should be reproduced using the latest AzAcSnap release. Update to the most recent version before reporting any problems.
2222
> If you still have issues, go to the Azure portal and select Support + troubleshooting and search for guidance on issues with AzAcSnap, this allows you to open a Service Request for Microsoft Support.
2323
24+
## Check log files, result files, and syslog
25+
26+
Some of the best sources of information for investigating AzAcSnap issues are the log files, result files, and the system log.
27+
28+
### Log files
29+
30+
The AzAcSnap log files are stored in the directory configured by the `logPath` parameter in the AzAcSnap configuration file. The default configuration filename is *azacsnap.json*, and the default value for `logPath` is *./logs*, which means the log files are written into the *./logs* directory relative to where the `azacsnap` command runs. If you make the `logPath` an absolute location, such as */home/azacsnap/logs*, `azacsnap` always outputs the logs into */home/azacsnap/logs*, regardless of where you run the `azacsnap` command.
31+
32+
The log filename is based on the application name, `azacsnap`, the command run with `-c`, such as `backup`, `test`, or `details`, and the default configuration filename, such as *azacsnap.json*. With the `-c backup` command, a default log filename would be *azacsnap-backup-azacsnap.log*, written into the directory configured by `logPath`.
33+
34+
This naming convention allows for multiple configuration files, one per database, to help locate the associated log files. If the configuration filename is *SID.json*, then the log filename when using the `azacsnap -c backup --configfile SID.json` option is *azacsnap-backup-SID.log*.
35+
36+
### Result files and syslog
37+
38+
For the `-c backup` command, AzAcSnap writes to a *\*.result* file. The purpose of the *\*.result* file is to provide high-level confirmation of success/failure. If the *\*.result* file is empty, then assume failure. Any output written to the *\*.result* file is also output to the system log (for example, `/var/log/messages`) by using the `logger` command. The *\*.result* filename has the same base name as the log file to allow for matching the result file with the configuration file and the backup log file. The *\*.result* file goes into the same location as the other log files and is a simple one line output file.
39+
40+
- Example for successful completion:
41+
42+
- Output to *\*.result* file:
43+
44+
```output
45+
Database # 1 (PR1) : completed ok
46+
```
47+
48+
- Output to `/var/log/messages`:
49+
50+
```output
51+
Dec 17 09:01:13 azacsnap-rhel azacsnap: Database # 1 (PR1) : completed ok
52+
```
53+
54+
- Example output where a failure occurred and AzAcSnap captured the failure:
55+
56+
- Output to *\*.result* file:
57+
58+
```output
59+
Database # 1 (PR1) : failed
60+
```
61+
62+
- Output to `/var/log/messages`:
63+
64+
```output
65+
Dec 19 09:00:30 azacsnap-rhel azacsnap: Database # 1 (PR1) : failed
66+
```
67+
2468
## AzAcSnap command won't run
2569
2670
In some cases AzAcSnap won't start due to the user's environment.
@@ -89,50 +133,6 @@ Make a `TMPDIR` for the `azacsnap` user:
89133
> [!IMPORTANT]
90134
> Changing the user's `TMPDIR` would need to be made permanent by changing the user's profile (for example, `$HOME/.bashrc` or `$HOME/.bash_profile`). Making this change means a manual clean up of the `TMPDIR` would be needed on system reboot. This `TMPDIR` clean up is typically automatic for `/tmp`.
91135
92-
## Check log files, result files, and syslog
93-
94-
Some of the best sources of information for investigating AzAcSnap issues are the log files, result files, and the system log.
95-
96-
### Log files
97-
98-
The AzAcSnap log files are stored in the directory configured by the `logPath` parameter in the AzAcSnap configuration file. The default configuration filename is *azacsnap.json*, and the default value for `logPath` is *./logs*, which means the log files are written into the *./logs* directory relative to where the `azacsnap` command runs. If you make the `logPath` an absolute location, such as */home/azacsnap/logs*, `azacsnap` always outputs the logs into */home/azacsnap/logs*, regardless of where you run the `azacsnap` command.
99-
100-
The log filename is based on the application name, `azacsnap`, the command run with `-c`, such as `backup`, `test`, or `details`, and the default configuration filename, such as *azacsnap.json*. With the `-c backup` command, a default log filename would be *azacsnap-backup-azacsnap.log*, written into the directory configured by `logPath`.
101-
102-
This naming convention allows for multiple configuration files, one per database, to help locate the associated log files. If the configuration filename is *SID.json*, then the log filename when using the `azacsnap -c backup --configfile SID.json` option is *azacsnap-backup-SID.log*.
103-
104-
### Result files and syslog
105-
106-
For the `-c backup` command, AzAcSnap writes to a *\*.result* file. The purpose of the *\*.result* file is to provide high-level confirmation of success/failure. If the *\*.result* file is empty, then assume failure. Any output written to the *\*.result* file is also output to the system log (for example, `/var/log/messages`) by using the `logger` command. The *\*.result* filename has the same base name as the log file to allow for matching the result file with the configuration file and the backup log file. The *\*.result* file goes into the same location as the other log files and is a simple one line output file.
107-
108-
1. Example for successful completion:
109-
110-
1. Output to *\*.result* file:
111-
112-
```output
113-
Database # 1 (PR1) : completed ok
114-
```
115-
116-
1. Output to `/var/log/messages`:
117-
118-
```output
119-
Dec 17 09:01:13 azacsnap-rhel azacsnap: Database # 1 (PR1) : completed ok
120-
```
121-
122-
1. Example output where a failure occurred and AzAcSnap captured the failure:
123-
124-
1. Output to *\*.result* file:
125-
126-
```output
127-
Database # 1 (PR1) : failed
128-
```
129-
130-
1. Output to `/var/log/messages`:
131-
132-
```output
133-
Dec 19 09:00:30 azacsnap-rhel azacsnap: Database # 1 (PR1) : failed
134-
```
135-
136136
## Troubleshoot failed 'test storage' command
137137

138138
The command `azacsnap -c test --test storage` might not complete successfully.
@@ -182,48 +182,31 @@ You can test the AzAcSnap configuration by using Cloud Shell through the Azure p
182182
> [!NOTE]
183183
> The test command can take about 90 seconds to complete.
184184
185-
### Failed test on Azure Large Instance
185+
### Failed test with Azure NetApp Files
186186

187-
The following error example is from running `azacsnap` on Azure Large Instance:
187+
The following error example is from running a storage test with `azacsnap` with Azure NetApp Files:
188188

189189
```bash
190190
azacsnap -c test --test storage
191191
```
192192

193-
```output
194-
The authenticity of host '172.18.18.11 (172.18.18.11)' can't be established.
195-
ECDSA key fingerprint is SHA256:QxamHRn3ZKbJAKnEimQpVVCknDSO9uB4c9Qd8komDec.
196-
Are you sure you want to continue connecting (yes/no)?
197-
```
198-
199-
To troubleshoot this error, don't respond `yes`. Make sure that your storage IP address is correct. You can confirm the storage IP address with the Microsoft operations team.
193+
#### 'Does not have authorization'
200194

201-
The error usually appears when the Azure Large Instance storage user doesn't have access to the underlying storage. To determine whether the storage user has access to storage, run the `ssh` command to validate communication with the storage platform.
195+
Example output from the log file:
202196

203-
```bash
204-
ssh <StorageBackupname>@<Storage IP address> "volume show -fields volume"
197+
```output
198+
The client '00001111-aaaa-2222-bbbb-3333cccc4444' with object id 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' does not have authorization to perform action 'Microsoft.NetApp/netAppAccounts/read' over scope ...
205199
```
206200

207-
The following example shows the expected output:
201+
This error can be caused by having both a System Assigned Managed Identity and User Assigned Identity in use on the Virtual Machine for authentication.
208202

209-
```bash
210-
ssh [email protected] "volume show -fields volume"
211-
```
203+
To resolve this issue use one of the following solutions:
212204

213-
```output
214-
vserver volume
215-
--------------------------------- ------------------------------
216-
osa33-hana-c01v250-client25-nprod hana_data_h80_mnt00001_t020_vol
217-
osa33-hana-c01v250-client25-nprod hana_data_h80_mnt00002_t020_vol
218-
```
205+
- Disable or Delete the System Assigned Managed Identity.
206+
- Configure AzAcSnap to use the [Service Principal method](azacsnap-configure-storage.md?tabs=azure-netapp-files#generate-a-service-principal-file) for authentication.
219207

220-
### Failed test with Azure NetApp Files
221-
222-
The following error example is from running `azacsnap` with Azure NetApp Files:
223208

224-
```bash
225-
azacsnap --configfile azacsnap.json.NOT-WORKING -c test --test storage
226-
```
209+
#### 'Could not create StorageANF object'
227210

228211
```output
229212
BEGIN : Test process started for 'storage'
@@ -250,6 +233,41 @@ To troubleshoot this error:
250233
> [!TIP]
251234
> For more information on generating a new Service Principal, see the section [Enable communication with Storage](azacsnap-configure-storage.md?tabs=azure-netapp-files#enable-communication-with-storage) in the [Install Azure Application Consistent Snapshot tool](azacsnap-installation.md) guide.
252235
236+
### Failed test on Azure Large Instance
237+
238+
The following error example is from running `azacsnap` on Azure Large Instance:
239+
240+
```bash
241+
azacsnap -c test --test storage
242+
```
243+
244+
```output
245+
The authenticity of host '172.18.18.11 (172.18.18.11)' can't be established.
246+
ECDSA key fingerprint is SHA256:AA11BB22CC33DD44EE55FF66AA77BB88CC99DD00.
247+
Are you sure you want to continue connecting (yes/no)?
248+
```
249+
250+
To troubleshoot this error, don't respond `yes`. Make sure that your storage IP address is correct. You can confirm the storage IP address with the Microsoft operations team.
251+
252+
The error usually appears when the Azure Large Instance storage user doesn't have access to the underlying storage. To determine whether the storage user has access to storage, run the `ssh` command to validate communication with the storage platform.
253+
254+
```bash
255+
ssh <StorageBackupname>@<Storage IP address> "volume show -fields volume"
256+
```
257+
258+
The following example shows the expected output:
259+
260+
```bash
261+
ssh [email protected] "volume show -fields volume"
262+
```
263+
264+
```output
265+
vserver volume
266+
--------------------------------- ------------------------------
267+
osa33-hana-c01v250-client25-nprod hana_data_h80_mnt00001_t020_vol
268+
osa33-hana-c01v250-client25-nprod hana_data_h80_mnt00002_t020_vol
269+
```
270+
253271
## Troubleshoot failed 'test hana' command
254272

255273
The command `azacsnap -c test --test hana` might not complete successfully.
@@ -294,7 +312,7 @@ hdbsql -n 172.18.18.50 -i 00 -U AZACSNAP "select version from sys.m_database"
294312

295313
For more information on setup of the `hdbuserstore`, see [Get started with AzAcSnap](azacsnap-get-started.md).
296314

297-
### Failed test
315+
### Failed test with SAP HANA
298316

299317
When validating communication with SAP HANA by running a test with `azacsnap -c test --test hana`, you might get the following error:
300318

@@ -330,7 +348,7 @@ To troubleshoot this error:
330348
sql port : saphana1:30013
331349
```
332350

333-
### Insufficient privilege error
351+
### Insufficient privilege error with SAP HANA
334352

335353
If running `azacsnap` presents an error such as `* 258: insufficient privilege`, check that the user has the appropriate AZACSNAP database user privileges set up per the [installation guide](azacsnap-configure-database.md#enable-communication-with-the-database). Verify the user's privileges with the following command:
336354

0 commit comments

Comments
 (0)