Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to Oracle Site Guard

• 1.1 What is Oracle Site Guard
• 1.2 Benefits of Oracle Site Guard
• 1.3 What's New in this Guide
  • 1.3.1 What’s New in Release 13.2.2.0.0
  • 1.3.2 What’s New in Release 13.2.0.1.0
  • 1.3.3 What's New in Release 13.1.1.0.0
  • 1.3.4 What's New in Release 12.1.0.7.0

2 Understanding Oracle Site Guard Concepts

• 2.1 Oracle Site Guard Terminology
• 2.2 Representation of a Site in Enterprise Manager Cloud Control Console
• 2.3 Oracle Site Guard Features
  • 2.3.1 Extensibility
    • 2.3.1.1 Types of Scripts for Extensibility
    • 2.3.1.2 Sequence of Script Execution
    • 2.3.1.3 Configuring Script Paths
  • 2.3.2 Prechecks and Health Checks
    • 2.3.2.1 Prechecks
    • 2.3.2.2 Health Checks
    • 2.3.2.3 Customizing Prechecks and Health Checks
    • 2.3.2.4 Lag Checks
  • 2.3.3 Storage Integration
    • 2.3.3.1 Oracle Sun ZFS
    • 2.3.3.2 NetApp MetroCluster
    • 2.3.3.3 Integrating Other Storage Types
    • 2.3.3.4 Mount and Unmount Scripts
  • 2.3.4 Standby Site Validation
  • 2.3.5 Creating Execution Groups
  • 2.3.6 Monitoring Executions and Managing Errors
    • 2.3.6.1 Customizing Operations
    • 2.3.6.2 Monitoring Executions
    • 2.3.6.3 Operation Error Modes
    • 2.3.6.4 Retrying Failed Operations
    • 2.3.6.5 Suspending and Resuming Operations
  • 2.3.7 Credential Management
    • 2.3.7.1 Oracle Enterprise Manager Credential Management Framework
    • 2.3.7.2 Oracle Site Guard Credential Configuration
  • 2.3.8 Role-Based Access Control
  • 2.3.9 Software Library Integration
  • 2.3.10 Custom Credentials for Script Execution
  • 2.3.11 Passing Credentials as Script Parameters
• 2.4 Oracle Site Guard Workflows
  • 2.4.1 Switchover Workflow
  • 2.4.2 Failover Workflow
  • 2.4.3 Start Workflow
  • 2.4.4 Stop Workflow
  • 2.4.5 Open for Validation Workflow
  • 2.4.6 Revert to Standby Workflow

3 Installing and Preparing Oracle Site Guard

• 3.1 Installing Oracle Site Guard
• 3.2 Preparing Oracle Site Guard for Operation
  • 3.2.1 Discovering Targets on the Primary and the Standby Sites
  • 3.2.2 Creating Oracle Site Guard Administrator Users
    • 3.2.2.1 Creating an Oracle Site Guard Administrator User with Enterprise Manager Cloud Control Console
    • 3.2.2.2 Creating an Oracle Site Guard Administrator User with Enterprise Manager Command-Line Interface
  • 3.2.3 Creating Primary and Standby Sites
    • 3.2.3.1 Creating a Generic System with Enterprise Manager Cloud Control Console
    • 3.2.3.2 Creating a Generic System with Enterprise Manager Command-Line Interface
  • 3.2.4 Creating Credentials
    • 3.2.4.1 Creating Named Credentials
    • 3.2.4.2 Creating Preferred Credentials
  • 3.2.5 Granting Credential Privileges to Oracle Site Guard Administrator Users
    • 3.2.5.1 Granting Credential Privileges with Enterprise Manager Cloud Control Console
  • 3.2.6 Configuring Software Library Storage Location
    • 3.2.6.1 Configuring Software Library Storage Location with Enterprise Manager Cloud Control Console
    • 3.2.6.2 Configuring Software Library Storage Location with Enterprise Manager Command-Line Interface
  • 3.2.7 Verifying Database and Data Guard Configurations

4 Configuring Oracle Site Guard

• 4.1 Overview
• 4.2 Configuring Sites
  • 4.2.1 Configuring Sites with Enterprise Manager Cloud Control Console
  • 4.2.2 Configuring Sites with EMCLI Commands
• 4.3 Updating Site Configuration
  • 4.3.1 Updating Site Configuration with Enterprise Manager Cloud Control Console
  • 4.3.2 Updating Site Configuration with EMCLI Commands
• 4.4 Deleting Site Configuration
  • 4.4.1 Deleting Site Configuration with Enterprise Manager Cloud Control Console
  • 4.4.2 Deleting Site Configuration with EMCLI Commands
• 4.5 Creating Credential Associations
  • 4.5.1 Creating Named or Preferred Credential Associations
    • 4.5.1.1 Creating Named or Preferred Credential Associations with Enterprise Manager Cloud Control Console
    • 4.5.1.2 Creating Named or Preferred Credential Associations with EMCLI Commands
• 4.6 Configuring Scripts
  • 4.6.1 Configuring Custom Precheck Scripts, Pre Scripts, Post Scripts, Global Pre Scripts, and Global Post Scripts
    • 4.6.1.1 Configuring Custom Precheck Scripts, Pre Scripts, Post Scripts, Global Pre Scripts, and Global Post Scripts with Enterprise Manager Cloud Control Console
    • 4.6.1.2 Configuring Custom Precheck Scripts, Pre Scripts, Post Scripts, Global Pre Scripts, and Global Post Scripts with EMCLI Commands
  • 4.6.2 Configuring Mount and Unmount Scripts
    • 4.6.2.1 mount_umount.sh
      • 4.6.2.1.1 Configuring Mount or Unmount Scripts with Enterprise Manager Cloud Control Console
      • 4.6.2.1.2 Configuring Mount or Unmount Scripts with EMCLI Commands
  • 4.6.3 Configuring Storage Scripts
    • 4.6.3.1 zfs_storage_role_reversal.sh
    • 4.6.3.2 Configuring Storage Scripts with Enterprise Manager Cloud Control Console
    • 4.6.3.3 Configuring Storage Scripts with EMCLI Commands
  • 4.6.4 Configuring Credentials as Parameters for Scripts
    • 4.6.4.1 Adding Credential Parameters to a Script
    • 4.6.4.2 Deleting Credential Parameters with a Script
    • 4.6.4.3 Getting Credential Parameters for a Script
  • 4.6.5 Cloning a Script with Existing Scripts
• 4.7 Configuring Auxiliary Hosts
  • 4.7.1 Adding an Auxiliary Host with EMCLI Commands
  • 4.7.2 Deleting an Auxiliary Host with EMCLI Commands
  • 4.7.3 Listing Auxiliary Targets with EMCLI Commands
• 4.8 Configuring Database Lag Checks with EMCLI Commands
  • 4.8.1 Configuring Database Lag Checks with EMCLI Commands
  • 4.8.2 Updating Threshold Value for Database Lag with EMCLI Commands
  • 4.8.3 Deleting Threshold Value for Database Lag with EMCLI Commands
  • 4.8.4 Listing Database Lag Thresholds with EMCLI Commands

5 Performing Oracle Site Guard Operations

• 5.1 Overview
• 5.2 Managing Operation Plans
  • 5.2.1 Creating Operation Plans
    • 5.2.1.1 Creating an Operation Plan with Enterprise Manager Cloud Control Console
    • 5.2.1.2 Creating an Operation Plan with EMCLI Commands
  • 5.2.2 Creating New Operation Plans with Existing Plans
  • 5.2.3 Editing and Updating Operation Plans
    • 5.2.3.1 Editing and Updating Operation Plans with Enterprise Manager Cloud Control Console
    • 5.2.3.2 Editing and Updating Operation Plans with EMCLI Commands
    • 5.2.3.3 Adding and Deleting Operation Plan Tags with EMCLI Commands
  • 5.2.4 Deleting an Operation Plan
    • 5.2.4.1 Deleting an Operation Plan with Enterprise Manager Cloud Control Console
    • 5.2.4.2 Deleting an Operation Plan with EMCLI Commands
• 5.3 Running Prechecks
  • 5.3.1 Running Precheck Utility with Enterprise Manager Cloud Control Console
  • 5.3.2 Running Precheck Utility with EMCLI Commands
• 5.4 Scheduling and Stopping Health Checks
  • 5.4.1 Scheduling a Health Check with Enterprise Manager Cloud Control Console
  • 5.4.2 Scheduling a Health Check with EMCLI Commands
  • 5.4.3 Stopping a Health Check with Enterprise Manager Cloud Control Console
  • 5.4.4 Stopping a Health Check with EMCLI Commands
  • 5.4.5 Getting a Health Check Report with EMCLI Commands
• 5.5 Executing Oracle Site Guard Operation Plans
  • 5.5.1 Executing Oracle Site Guard Operation Plan with Enterprise Manager Cloud Control Console
  • 5.5.2 Executing Oracle Site Guard Operation Plan with EMCLI Command
• 5.6 Monitoring Oracle Site Guard Operations
  • 5.6.1 Monitoring an Operation Plan with Enterprise Manager Cloud Control Console
    • 5.6.1.1 Viewing an Operation Activity
    • 5.6.1.2 Suspending, Resuming, or Stopping an Operation
  • 5.6.2 Monitoring an Operation Plan with EMCLI Commands
• 5.7 Managing Execution Errors
• 5.8 Manually Reversing Site Roles
  • 5.8.1 Manually Reversing Site Roles with Enterprise Manager Cloud Control Console
  • 5.8.2 Manually Reversing Site Roles with EMCLI Commands

6 Troubleshooting Oracle Site Guard

• 6.1 Configuration Issues
  • 6.1.1 Create Site Guard Configuration Fails
• 6.2 Operation Plan Issues
  • 6.2.1 Targets Not Discovered in Operation Plan Workflow
  • 6.2.2 Oracle WebLogic Server Managed Server Target Not Identified
  • 6.2.3 Manual Intervention Needed for Hung Operation Step
  • 6.2.4 OPMN Managed System Components Not Discovered In Operation-Plan Workflow
  • 6.2.5 Oracle RAC Database Not Discovered in Operation Plan
  • 6.2.6 Operation Step Failure When Target is Accessed with Sudo Privileges
  • 6.2.7 Error While Creating Operation Plan Indicating Credential Association Not Configured
  • 6.2.8 Inability to Associate Credentials for Targets Added to a Site
  • 6.2.9 Error While Deleting Or Updating Operation Plans
  • 6.2.10 Error Indicating Inability to Create Scalar Value While Creating Operation Plan
  • 6.2.11 Error While Creating Operation Plan Indicating Missing Node Manager Credentials
  • 6.2.12 Error Indicating Inability to Stage SWLIB Artifacts Due To Insufficient Disk Space on Target Host
  • 6.2.13 Operation Plan Fails Because of Inability to Copy WLS Utility Script to Domain Directory
  • 6.2.14 Operation Plan Will Not Execute After a Major Product Upgrade
• 6.3 Switchover and Failover Operation Issues
  • 6.3.1 Oracle WebLogic Administration Server Not Starting After Switchover or Failover Operation
  • 6.3.2 Oracle WebLogic Administration Server not Restarting After Switchover or Failover Operation
  • 6.3.3 Host Not Available During Switchover or Failover Operation
  • 6.3.4 Switchover or Failover Operation Fails When Oracle RAC Database Not Available
• 6.4 Precheck and Healthcheck Issues
  • 6.4.1 Prechecks Failures
  • 6.4.2 Prechecks Hang When Oracle Management Agent Is Not Available
  • 6.4.3 Healthchecks Can Not Be Retried or Resumed
• 6.5 Oracle WebLogic Server Issues
  • 6.5.1 Node Manager Fails to Restart
  • 6.5.2 Node Manage Start/Stop Fails Due to Missing Properties File
  • 6.5.3 Oracle WebLogic Server Managed Server Fails to Start
  • 6.5.4 Oracle Site Guard Does Not Include Oracle WebLogic Server Instances That Are Migrated to a Different Host
  • 6.5.5 Error While Creating Operation Plan
  • 6.5.6 Oracle Site Guard Fails To Access Node Manager
  • 6.5.7 Unable to Associate Distinct Credentials for Node Manager
  • 6.5.8 Oracle WebLogic Server Password Updates and Site Guard Credentials
  • 6.5.9 Oracle Enterprise Manager Cannot Manage Domain Components
• 6.6 Database Issues
  • 6.6.1 Prechecks for Database Switchover and Failover Operations Fail
  • 6.6.2 Databases Protected by Data Guard Included in the Incorrect Operation Plan Category
  • 6.6.3 Database Inaccessible When Opening a Site for Standby Validation
• 6.7 Storage Issues
  • 6.7.1 ZFS Storage Appliance Log in Failure
  • 6.7.2 Storage Role Reversal Operation Failure
  • 6.7.3 Storage Role Reversal Operation Failure
  • 6.7.4 ZFS Storage Role Reversal Fails During Operation Plan Execution
  • 6.7.5 Remote Replication Targets List Multiple Appliances With The Same Name
  • 6.7.6 ZFS Storage Role Reversal Failure
  • 6.7.7 ZFS Storage Create Clone Failure

7 Oracle Site Guard Command Line Interface

• 7.1 add_operation_plan_tags
• 7.2 add_siteguard_aux_hosts
• 7.3 add_siteguard_script_credential_params
• 7.4 add_siteguard_script_hosts
• 7.5 configure_siteguard_lag
• 7.6 create_operation_plan
• 7.7 create_siteguard_configuration
• 7.8 create_siteguard_credential_association
• 7.9 create_siteguard_script
• 7.10 delete_operation_plan
• 7.11 delete_operation_plan_tags
• 7.12 delete_siteguard_aux_host
• 7.13 delete_siteguard_configuration
• 7.14 delete_siteguard_credential_association
• 7.15 delete_siteguard_lag
• 7.16 delete_siteguard_script
• 7.17 delete_siteguard_script_credential_params
• 7.18 delete_siteguard_script_hosts
• 7.19 get_operation_plan_details
• 7.20 get_operation_plans
• 7.21 get_siteguard_aux_hosts
• 7.22 get_siteguard_configuration
• 7.23 get_siteguard_credential_association
• 7.24 get_siteguard_health_checks
• 7.25 get_siteguard_health_check_report
• 7.26 get_siteguard_lag
• 7.27 get_siteguard_script_credential_params
• 7.28 get_siteguard_script_hosts
• 7.29 get_siteguard_scripts
• 7.30 get_siteguard_supported_targets
• 7.31 run_prechecks
• 7.32 schedule_siteguard_health_checks
• 7.33 stop_siteguard_health_checks
• 7.34 submit_operation_plan
• 7.35 update_operation_plan
• 7.36 update_siteguard_configuration
• 7.37 update_siteguard_credential_association
• 7.38 update_siteguard_lag
• 7.39 update_siteguard_script

8 Upgrading or Downgrading Oracle Site Guard

• 8.1 Upgrading Oracle Site Guard
• 8.2 Downgrading Oracle Site Guard

A Passing Credentials as Parameters

• A.1 Passing Credentials as Parameters
• A.2 extract_credentials_sample_script.sh
• A.3 extract_credentials_sample_script.py
• A.4 extract_credentials_sample_script.pl

B Bundled Scripts

• B.1 Bundled Scripts
• B.2 Oracle Virtual Machine (OVM) DR Script — siteguard_ovm_control.py
• B.3 Oracle Virtual Machine CLI (OVMCLI) DR Script — siteguard_ovmcli_control.py
• B.4 WebLogic Server Control Script – wls_control_wrapper.pl
• B.5 Node Manager Control Script – nm_control_wrapper.pl
• B.6 Database Control Script - db_control_wrapper.pl
• B.7 ZFS Storage Script - zfs_storage_role_reversal.sh
• B.8 ZFS Analysis Script - zfs_analysis.sh
• B.9 ZFS Standby Site Replication Cleanup Script – sg_zfs_utility.sh