You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This article provides a guide on set up and usage of the new features in preview for **AzAcSnap**. This guide should be read along with the main
26
26
documentation for AzAcSnap at [aka.ms/azacsnap](./azacsnap-introduction.md).
27
27
28
-
The preview features provided with **AzAcSnap 6** are:
28
+
The preview features provided with **AzAcSnap 7** are:
29
+
30
+
- Azure NetApp Files Backup.
31
+
- IBM Db2 Database.
29
32
- Azure Managed Disk.
30
33
- Azure Key Vault support for storing Service Principal.
31
34
32
35
## Providing feedback
33
36
34
37
Feedback on AzAcSnap, including this preview, can be provided [online](https://aka.ms/azacsnap-feedback).
35
38
36
-
## Getting the AzAcSnap Preview snapshot tools
39
+
## Using AzAcSnap Preview features
40
+
41
+
AzAcSnap preview features are offered together with generally available features. Using the preview features requires the use of the `--preview` command line option to enable their usage. To setup and install AzAcSnap refer to [Get started with Azure Application Consistent Snapshot tool](azacsnap-get-started.md)
42
+
43
+
Return to this document for details on using the specific preview features.
44
+
45
+
## Azure NetApp Files Backup
46
+
47
+
> [!NOTE]
48
+
> Support for Azure NetApp Files Backup is a Preview feature.
When taking snapshots with AzAcSnap on multiple volumes all the snapshots have the same name by default. Due to the removal of the Volume name from the resource ID hierarchy when the snapshot is archived into Azure NetApp Files Backup it's necessary to ensure the Snapshot name is unique. AzAcSnap can do this automatically when it creates the Snapshot by appending the Volume name to the normal snapshot name. For example, for a system with two data volumes (`hanadata01`, `hanadata02`) when doing a `-c backup` with `--prefix daily` the complete snapshot names become `daily__F2AFDF98703__hanadata01` and `daily__F2AFDF98703__hanadata02`.
52
+
53
+
This can be enabled in AzAcSnap by setting `"anfBackup": "renameOnly"` in the configuration file, see the following snippet:
54
+
55
+
```output
56
+
"anfStorage": [
57
+
{
58
+
"anfBackup" : "renameOnly",
59
+
"dataVolume": [
60
+
```
61
+
62
+
This can also be done using the `azacsnap -c configure --configuration edit --configfile <configfilename>` and when asked to `Enter new value for 'ANF Backup (none, renameOnly)' (current = 'none'):` enter `renameOnly`.
63
+
64
+
## IBM Db2 Database
65
+
66
+
### Supported platforms and operating systems
67
+
68
+
> [!NOTE]
69
+
> Support for IBM Db2 is Preview feature.
70
+
> This section's content supplements [What is Azure Application Consistent Snapshot tool](azacsnap-introduction.md) page.
71
+
72
+
New database platforms and operating systems supported with this preview release.
73
+
74
+
-**Databases**
75
+
- IBM Db2 for LUW on Linux-only is in preview as of Db2 version 10.5 (refer to [IBM Db2 Azure Virtual Machines DBMS deployment for SAP workload](../virtual-machines/workloads/sap/dbms_guide_ibm.md) for details)
This section explains how to enable communication with the database. Ensure the database you're using is correctly selected from the tabs.
85
+
86
+
# [IBM Db2](#tab/db2)
87
+
88
+
The snapshot tools issue commands to the IBM Db2 database using the command line processor `db2` to enable and disable backup mode.
89
+
90
+
After putting the database in backup mode, `azacsnap` will query the IBM Db2 database to get a list of "protected paths", which are part of the database where backup-mode is active. This list is output into an external file, which is in the same location and basename as the log file, but with a ".\<DBName>-protected-paths" extension (output filename detailed in the AzAcSnap log file).
91
+
92
+
AzAcSnap uses the IBM Db2 command line processor `db2` to issue SQL commands, such as `SET WRITE SUSPEND` or `SET WRITE RESUME`. Therefore AzAcSnap should be installed in one of the following two ways:
93
+
94
+
1. Installed onto the database server, then complete the setup with "[Local connectivity](#local-connectivity)".
95
+
1. Installed onto a centralized backup system, then complete the setup with "[Remote connectivity](#remote-connectivity)".
96
+
97
+
#### Local connectivity
98
+
99
+
If AzAcSnap has been installed onto the database server, then be sure to add the `azacsnap` user to the correct Linux group and import the Db2 instance user's profile per the following example setup.
100
+
101
+
##### `azacsnap` user permissions
37
102
38
-
Refer to [Get started with Azure Application Consistent Snapshot tool](azacsnap-get-started.md)
103
+
The `azacsnap` user should belong to the same Db2 group as the database instance user. Here we are getting the group membership of the IBM Db2 installation's database instance user `db2tst`.
39
104
40
-
Return to this document for details on using the preview features.
From the output we can confirm the `db2tst` user has been added to the `db2iadm1` group, therefore add the `azacsnap` user to the group.
114
+
115
+
```bash
116
+
usermod -a -G db2iadm1 azacsnap
117
+
```
118
+
119
+
##### `azacsnap` user profile
120
+
121
+
The `azacsnap` user will need to be able to execute the `db2` command. By default the `db2` command will not be in the `azacsnap` user's $PATH, therefore add the following to the user's `.bashrc` file using your own IBM Db2 installation value for `INSTHOME`.
122
+
123
+
```output
124
+
# The following four lines have been added to allow this user to run the DB2 command line processor.
125
+
INSTHOME="/db2inst/db2tst"
126
+
if [ -f ${INSTHOME}/sqllib/db2profile ]; then
127
+
. ${INSTHOME}/sqllib/db2profile
128
+
fi
129
+
```
130
+
131
+
Test the user can run the `db2` command line processor.
132
+
133
+
```bash
134
+
su - azacsnap
135
+
db2
136
+
```
137
+
138
+
```output
139
+
(c) Copyright IBM Corporation 1993,2007
140
+
Command Line Processor for DB2 Client 11.5.7.0
141
+
142
+
You can issue database manager commands and SQL statements from the command
143
+
prompt. For example:
144
+
db2 => connect to sample
145
+
db2 => bind sample.bnd
146
+
147
+
For general help, type: ?.
148
+
For command help, type: ? command, where command can be
149
+
the first few keywords of a database manager command. For example:
150
+
? CATALOG DATABASE for help on the CATALOG DATABASE command
151
+
? CATALOG for help on all of the CATALOG commands.
152
+
153
+
To exit db2 interactive mode, type QUIT at the command prompt. Outside
154
+
interactive mode, all commands must be prefixed with 'db2'.
155
+
To list the current command option settings, type LIST COMMAND OPTIONS.
156
+
157
+
For more detailed help, refer to the Online Reference Manual.
158
+
```
159
+
160
+
```sql
161
+
db2 => quit
162
+
DB20000I The QUIT command completed successfully.
163
+
```
164
+
165
+
Now configure azacsnap to user localhost.
166
+
Once this is working correctly go on to configure (`azacsnap -c configure`) with the `serverAddress=localhost` and test (`azacsnap -c test --test db2`) azacsnap database connectivity.
167
+
168
+
169
+
#### Remote connectivity
170
+
171
+
If AzAcSnap has been installed following option 2, then be sure to allow SSH access to the Db2 database instance per the following example setup.
172
+
173
+
174
+
Log in to the AzAcSnap system as the `azacsnap` user and generate a public/private SSH key pair.
175
+
176
+
```bash
177
+
ssh-keygen
178
+
```
179
+
180
+
```output
181
+
Generating public/private rsa key pair.
182
+
Enter file in which to save the key (/home/azacsnap/.ssh/id_rsa):
183
+
Enter passphrase (empty for no passphrase):
184
+
Enter same passphrase again:
185
+
Your identification has been saved in /home/azacsnap/.ssh/id_rsa.
186
+
Your public key has been saved in /home/azacsnap/.ssh/id_rsa.pub.
Log in to the AzAcSnap system as the `azacsnap` user and test SSH access.
222
+
223
+
```bash
224
+
ssh <InstanceUser>@<ServerAddress>
225
+
```
226
+
227
+
```output
228
+
[InstanceUser@ServerName ~]$
229
+
```
230
+
231
+
Test the user can run the `db2` command line processor.
232
+
233
+
```bash
234
+
db2
235
+
```
236
+
237
+
```output
238
+
(c) Copyright IBM Corporation 1993,2007
239
+
Command Line Processor for DB2 Client 11.5.7.0
240
+
241
+
You can issue database manager commands and SQL statements from the command
242
+
prompt. For example:
243
+
db2 => connect to sample
244
+
db2 => bind sample.bnd
245
+
246
+
For general help, type: ?.
247
+
For command help, type: ? command, where command can be
248
+
the first few keywords of a database manager command. For example:
249
+
? CATALOG DATABASE for help on the CATALOG DATABASE command
250
+
? CATALOG for help on all of the CATALOG commands.
251
+
252
+
To exit db2 interactive mode, type QUIT at the command prompt. Outside
253
+
interactive mode, all commands must be prefixed with 'db2'.
254
+
To list the current command option settings, type LIST COMMAND OPTIONS.
255
+
256
+
For more detailed help, refer to the Online Reference Manual.
257
+
```
258
+
259
+
```sql
260
+
db2 => quit
261
+
DB20000I The QUIT command completed successfully.
262
+
```
263
+
264
+
```bash
265
+
[prj@db2-02 ~]$ exit
266
+
267
+
```output
268
+
logout
269
+
Connection to <serverAddress> closed.
270
+
```
271
+
272
+
Once this is working correctly go on to configure (`azacsnap -c configure`) with the Db2 server's external IP address and test (`azacsnap -c test --test db2`) azacsnap database connectivity.
273
+
274
+
Run the `azacsnap` test command
275
+
276
+
```bash
277
+
cd ~/bin
278
+
azacsnap -c test --test db2 --configfile Db2.json
279
+
```
280
+
281
+
```output
282
+
BEGIN : Test process started for 'db2'
283
+
BEGIN : Db2 DB tests
284
+
PASSED: Successful connectivity to Db2 DB version v11.5.7.0
285
+
END : Test process complete for 'db2'
286
+
```
287
+
288
+
---
289
+
290
+
### Configuring the database
291
+
292
+
This section explains how to configure the data base.
293
+
294
+
# [IBM Db2](#tab/db2)
295
+
296
+
No special database configuration is required for Db2 as we are using the Instance User's local operating system environment.
297
+
298
+
---
299
+
300
+
### Configuring AzAcSnap
301
+
302
+
This section explains how to configure AzAcSnap for the specified database.
The following sections provide detailed guidance on the various values required for the configuration file.
311
+
312
+
# [IBM Db2](#tab/db2)
313
+
314
+
#### Db2 Database values for configuration
315
+
316
+
When adding a Db2 database to the configuration, the following values are required:
317
+
318
+
- **Db2 Server's Address** = The database server hostname or IP address.
319
+
- If Db2 Server Address (serverAddress) matches '127.0.0.1' or 'localhost'then azacsnap will execute all `db2` commands locally (refer "Local connectivity"). Otherwise AzAcSnap will use the serverAddress as the host to connect to via SSH using the "Instance User" as the SSH login name, this can be validated with `ssh <instanceUser>@<serverAddress>` replacing instanceUser and serverAddress with the respective values (refer "Remote connectivity").
320
+
- **Instance User** = The database System Instance User.
321
+
- **SID** = The database System ID.
322
+
323
+
---
41
324
42
325
## Azure Managed Disk
43
326
@@ -540,4 +823,4 @@ The steps to follow to set up Azure Key Vault and store the Service Principal in
540
823
541
824
- [Get started](azacsnap-get-started.md)
542
825
- [Test AzAcSnap](azacsnap-cmd-ref-test.md)
543
-
- [Back up using AzAcSnap](azacsnap-cmd-ref-backup.md)
826
+
- [Back up using AzAcSnap](azacsnap-cmd-ref-backup.md)
0 commit comments