Edit

Share via

Quickstart: Run the preregistration script for SAP ASE (Sybase) database backup in Azure Cloud Shell

  • Article

This quickstart describes how to run the preregistration script to prepare an SAP Adaptive Server Enterprise (ASE) (Sybase) database configuration for backup on Azure VMs using Azure Cloud Shell.

The preregistration script for SAP ASE database backup using Azure Backup ensures the system is properly configured, which includes authentication configuration, network connectivity validation, and necessary packages installation. It also supports private endpoints and prepares the database for seamless backup operations.

Learn about the supported configurations and scenarios for SAP ASE database backup on Azure VMs.

Prerequisites

Before you run the preregistration script, ensure that the following prerequisites are met:

Preregistration script workflow

The preregistration script is a Python script that you run on the VM where the SAP ASE database is installed. The script performs the following tasks:

  • Creates the necessary group where the plugin users are added.
  • Installs and updates required packages such as waagent, Python, curl, unzip, Libicu, and PythonXML.
  • Verifies the status of waagent, checks wireserver and IMDS connectivity, and tests TCP connectivity to Microsoft Entra ID.
  • Confirms if the geographic region is supported.
  • Checks for available free space for logs, in the waagent directory, and /opt directory.
  • Validates if the Adaptive Server Enterprise (ASE) version is supported.
  • Logs in the SAP instance using the provided username and password, enabling dump history, which is necessary for backup and restore operations.
  • Ensures that the OS version is supported.
  • Installs and updates required Python modules such as requests and cryptography.
  • Creates the workload configuration file.
  • Sets up the required directories under /opt for backup operations.
  • Encrypts the password and securely stores it in the virtual machine.

Run the preregistration script

After you download the ASE preregistration script file, copy it to the virtual machine (VM).

To execute the preregistration script for SAP ASE database backup, run the following bash commands:

Note

Replace <script name> in the following commands with the name of the script file you downloaded and copied to the VM.

  1. Convert the script to the Unix format.

     dos2unix <script name>

  2. Change the permission of the script file.

    Note

    Before you run the following command, replace /path/to/script/file with the actual path of the script file in the VM.

     sudo chmod -R 777 /path/to/script/file

  3. Run the script.

    Note

    Before running the following command, provide the required values for the placeholders.

     sudo ./<script name> -aw SAPAse --sid <sid> --sid-user <sid-user> --db-port <db-port> --db-user <db-user> --db-host <private-ip-of-vm> --enable-striping <enable-striping>

    List of parameters:

    • <sid>: Name of the required ASE server (required)
    • <sid-user>: OS Username under which ASE System runs (for example, syb<sid>) (required)
    • <db-port>: The Port Number of the ASE Database server (for example, 4901) (required)
    • <db-user>: The ASE Database Username for Open Database Connectivity (ODBC) connection (for example, sapsa) (required)
    • <db-host>: Private IP address of the VM (required)
    • <enable-striping>: Enable striping (choices: [true, false], required)
    • <stripes-count>: Stripes count (default: '4')
    • <compression-level>: Compression level (default: '101')

    Note

    To find the <private-ip-of-vm>, open the VM in the Azure portal and check the private IP under the Networking section.

  4. View details of the parameters.

     sudo ./<script name> -aw SAPAse --help

    After running the script, you're prompted to provide the database password. Provide the password and press ENTER to proceed.

Next steps