Configuring and Using Oracle Auto Service Request (Oracle ASR)

Configure and use Oracle ASR to automatically generate a service request for specific hardware faults.

About Configuring Oracle ASR

Configure Oracle Auto Service Request (Oracle ASR) to automatically generate service requests for specific hardware faults.

Oracle ASR is a secure support feature that can improve system availability through expedited diagnostics and priority service request handling. You can configure Oracle ASR on Oracle Database Appliance to use Oracle ASR Manager configured on another server in the same network as your appliance.

Oracle Database Appliance supports Oracle ASR configuration. You can use the odacli configure-asr command to configure Oracle ASR.

Oracle ASR Manager is not installed on one Oracle Database Appliance. For example, if Oracle ASR manager is not installed on oda1, but Oracle ASR Manager is installed on another Oracle Database Appliance, oda2, then the assets that belong to oda2 assets are registered with Oracle ASR Manager installed on oda1. To register Oracle Database Appliance assets with Oracle ASR Manager, you must first update the repository with Oracle ASR Manager configuration files. After that, configure Oracle ASR to register the assets with Oracle ASR Manager.

External ASR is an ASR manager configured and managed outside Oracle Database Appliance tooling. External describes the management boundary, not the ASR Manager’s physical location: it may run on bare metal, on a system outside Oracle Database Appliance, or inside an application KVM. The configuration remains the same across these deployment options. The odacli configure-asr command is supported for registering and activating Oracle Database Appliance assets with external ASR manager.

You can configure Oracle ASR as part of deploying the appliance, or you can use the Browser User Interface (BUI) or command-line interface to configure or edit an Oracle ASR after deployment.

Starting with Oracle Database Appliance release 19.21, when you configure Oracle ASR, you specify HTTPS settings and not the SNMP settings. Following are the requirements to configure Oracle ASR:

Registering with Oracle ASR Manager

Use ODACLI commands or the Browser User Interface to register Oracle Database Appliance with an Oracle Auto Service Request (Oracle ASR) Manager.

You can register with Oracle ASR Manager at any time.

Before configuring, verify that the Oracle Database Appliance hardware is associated with a Support Identifier (SI) in My Oracle Support.

Configuring Oracle ASR Using the BUI

Ensure that the zip file of Oracle ASR configured is imported to the repository using the odacli update-repository command, and then run the following steps:

  1. Open a browser and enter the following URL to access BUI:

    https://ip-address:7093/mgmt/index.html

  2. Login as oda-admin.

  3. Click the Appliance tab.

  4. Click the Oracle ASR menu.

  5. Click Create.

Configuring Oracle ASR Using ODACLI Commands

Understand how you can configure Oracle Database Appliance with Oracle Auto Service Request (Oracle ASR) Manager.

Prerequisites: 1. Ensure that the ASR manager is installed with version 23.2.0 or above. Run the /opt/asrmanager/bin/asr show_version command to view the Oracle ASR version:

<pre class="copy"><code>/opt/asrmanager/bin/asr show_version  ASR Manager version: 23.2.0  Rules definitions version: 23.2.0.0  Auto Update Statistics ========================== Last Run Time: 2024-02-08 12:19:27.777 Last Run Status: Oracle Automated Service Manager not yet registered. Next Run Time: 2024-02-09 12:19:27.777  Skipping ASR connectivity tests as ASR Auto Update isn&#39;t enabled  Auto Update Status ========================== Auto Update functionality is disabled. Please refer to the My Oracle Support Doc Id: 1503107.1 for instructions on Auto Update of ASR Manager software.  ASR Manager Services  -------------------- ASR Notification Trap is enabled. Remote Request feature is enabled.</code></pre>
  1. Ensure that Oracle ASR is enabled to run with HTTPS by running the following commands:

    /opt/asrmanager/bin/asr https_config
    /opt/asrmanager/bin/asr https_enable

    Ensure that the required setting is present by running the /opt/asrmanager/bin/asr show_http_receiver command as follows:

    /opt/asrmanager/bin/asr show_http_receiver
        HTTP Receiver configuration:
    
        HTTP Receiver Status: Enabled
        Host Name: xx.xxx.x.xxx
        SFB forward: true
        HTTP Port: 16161
        HTTPS/SSL Port: 16162
        HTTPS/SSL: Enabled
        Jetty HTTP Compliance: Medium - RFC2616
        Enable Jetty Older Ciphers: true

    The output of the command must display HTTPS/SSL as Enabled.

    Note that when you run the /opt/asrmanager/bin/asr https_config command, and the “What is your first and last name?” question is prompted for the certificate, you must enter the ASR manager IP address and keep the rest of the answers default.

Configuring Oracle ASR Using ODACLI Commands

Run these steps on the appliance where Oracle ASR Manager is configured:

  1. Create a directory called asr under /tmp.

    mkdir /tmp/asr
  2. Go to the directory created in step 1.

    cd /tmp/asr
  3. Generate the public key with the name asrHTTPSCertificate.crt under the directory created in step 1 for Oracle ASR Manager, using its keystore present at /var/opt/asrmanager/configuration/asrmKeyStore.jks. The following command creates a certificate /tmp/asr/asrHTTPSCertificate.crt for the keystore:

    jdkbinpath/keytool -exportcert -alias alias set for the keystore -keystore /var/opt/asrmanager/configuration/asrmKeyStore.jks -file /tmp/asr/asrHTTPSCertificate.crt -rfc
    Enter keystore password: Enter the certificate password provided in "asr https_config" command
  4. Create a new JSON file with the name asrdetails.json with the following details under /tmp/asr and set the values for the following:

    • asrManagerIp: The IP address of the host where Oracle ASR Manager runs.

    • userName: The email ID with which Oracle ASR Manager is registered.

    • httpsPortNumber: The HTTPS port number set for Oracle ASR Manager in the asr https_config command.

    • httpsCertAlias: The certificate ALIAS set when prompted by the asr https_config command.

    Example of /tmp/asr/asrdetails.json:

    {
      "asrManagerIp" : "xx.xxx.x.xxx",
      "userName" : "test",
      "httpsPortNumber" : 16162,
      "httpsCertAlias" : "oda-asr-client2024-01-31t10:15:52"
    }
  5. Generate a zip file with the files created in step 3 and step 4 asrHTTPSCertificate.crt and asrdetails.json from the asr directory present under /tmp directory.

    cd /tmp
    zip ASRConfiguration.zip asr/asrHTTPSCertificate.crt asr/asrdetails.json
  6. Copy the zip file created in step 5 to the Oracle Database Appliance machine whose assets must be registered with Oracle ASR.

    scp /tmp/ASRConfiguration.zip user@machine name/IP:destination path for the zip

After copying the Oracle ASR Manager configuration zip file to Oracle Database Appliance, run the following steps on the Oracle Database Appliance:

  1. Run the odacli update-repository command to unzip the zip file created on Oracle ASR machine and copied to the appliance.

    $odacli update-repository -f <zip file path>
    
    odacli describe-job -i c659b6ee-9f02-4cb4-aba4-4ed8de883e3a
    
    Job details
    
    ----------------------------------------------------------------
                         ID:  c659b6ee-9f02-4cb4-aba4-4ed8de883e3a
                Description:  Repository Update
                     Status:  Success
                    Created:  September 30, 2026 3:44:28 PM CST
                    Message:  /opt/oracle/dcs/bin/ASRConfiguration.zip
    
    Task Name                                Start Time                               End Time                                 Status
    
    ---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
    Unzip bundle                             September 30, 2026 3:44:28 PM CST         September 30, 2026 3:44:28 PM CST         Success
  2. Configure Oracle ASR Manager.

    $odacli configure-asr
    
    Enter ASR user's password: <SSO password>
    Retype ASR user's password:
    
    odacli describe-job -i 1099eac8-2879-4341-b391-d56237696395
    
    Job details
    
    ----------------------------------------------------------------
                         ID:  1099eac8-2879-4341-b391-d56237696395
                Description:  Configure ASR
                     Status:  Success
                    Created:  September 30, 2026 3:46:50 PM CST
                    Message:
    
    Task Name                                Start Time                               End Time                                 Status
    
    ---------------------------------------- ---------------------------------------- ---------------------------------------- ----------------
    Setting up SSH equivalence               September 30, 2026 3:46:52 PM CST         September 30, 2026 3:46:54 PM CST         Success
    Creating ASR configuration folders       September 30, 2026 3:46:54 PM CST         September 30, 2026 3:46:54 PM CST         Success
    Setup ASR XML templates                  September 30, 2026 3:46:54 PM CST         September 30, 2026 3:46:54 PM CST         Success
    Importing ASR certificate into DCS       September 30, 2026 3:46:54 PM CST         September 30, 2026 3:46:56 PM CST         Success
    truststore
    Registering Asset: ODA Host              September 30, 2026 3:46:56 PM CST         September 30, 2026 3:46:57 PM CST         Success
    ASR assets activation                    September 30, 2026 3:46:57 PM CST         September 30, 2026 3:46:58 PM CST         Success
    Configure ILOM                           September 30, 2026 3:46:58 PM CST         September 30, 2026 3:47:07 PM CST         Success

Configuring ASR Using Browser User Interface (BUI)

After copying Oracle ASR Manager configuration zip file to Oracle Database Appliance, follow these steps: 1. Open a browser and enter the following URL to access BUI:

<pre class="copy"><code>https://ip-address:7093/mgmt/index.html</code></pre>
  1. Login as oda-admin.

  2. Click the Appliance tab.

  3. Specify the Zip File Location.

  4. Click Update Repository.

  5. After the repository is updated with the zip file, click Next.

  6. Specify and confirm the ASR Password.

  7. Click Configure ASR.

  8. After the job completes successfully, verify the Oracle ASR configuration on the ASR Information page.

Testing Oracle ASR

Use the odacli test-asr command to confirm that your Oracle ASR configuration is working.

When you run the command, a test alert is sent to Oracle ASR manager from both Oracle ILOM and the host registered with Oracle ASR. The registered email ID receives an email about the test alert for the registered Oracle ILOM and host.

Attempting to test the configuration outside of the odacli test-asr command might not provide the expected test result.

  1. Log in as root user.

  2. Run the odacli test-asr command.

    # odacli test-asr
    
    Job details
    
    ----------------------------------------------------------------
                         ID: 51522c07-1b32-4874-9bc7-bbee5885f1e5
                Description: Test ASR
                     Status: Success
                    Created: October 20, 2023 1:02:49 PM UTC
                    Message:
    
    Task Name Start Time                     End Time                        Status
    
    --------- ------------------------------- ------------------------------- --------
    Test ASR October 20, 2023 1:02:50 PM UTC October 20, 2023 1:02:50 PM UTC Success

Managing an Oracle ASR Configuration

Use the command-line to review an existing configuration, make changes to a configuration, or delete a configuration.

All log files for Oracle ASR are located in the/var/opt/asrmanager/log/ directory.

  1. To display Oracle Auto Service Request (Oracle ASR) configuration details, use the odacli describe-asr command.

    # odacli describe-asr
    
    ASR details
    
    ----------------------------------------------------------------
                         ID: e0e31043-c312-4371-8301-e62642ef8a4a
                       Name: ASR
            ASR Manager IP : 10.32.202.13
       ASR Manager username: scott.tiger@example.com
          HTTPS port number: 16164
                      State: CONFIGURED
                    Created: September 3, 2026 4:02:38 AM UTC
                    Updated: September 3, 2026 4:03:32 AM UTC
  2. (Optional) To remove the Oracle ASR configuration from the system, use the odacli delete-asrcommand.

    # odacli delete-asr
    {
    "jobId" : "5d70bd17-ec4a-48da-8196-1364105db99d",
    "status" : "Running",
    "message" : null,
    "reports" : [ ],
    "createTimestamp" : 1469409622451,
    "description" : "Delete ASR",
    "updatedTime" : 1469409622458
    }

If the odacli delete-asr command fails due to some modification at the ASR manager side, use the --force,-f option in odacli delete-asr command. The force option will cleanup ASR configuration from DCS metadata and allow user to re-configure ASR using the updated ASR Manager zip file.

Related Topics

Additional Resources for Oracle ASR

Refer to these sections for more information about Oracle ASR.