Automating Oracle RMAN backup configuration on Linux with Ansible

Having valid backup of the databases is one of the most important tasks for every DBAs. Having proper RMAN backup scripts on place and covering all aspects to protect your databases can be lifesaving in the event that a crisis hits.

However, when you’re a DBA covering multiple environments with multiple databases running across them, applying your RMAN configuration and backup scripts on place can be quite frustrating and time consuming. When multiple environments are managed by multiple DBAs the biggest problem often found is consistency. Every DBA has his/her own practice and scripts for implementing or defining these tasks. It can be quite challenging when you’re jumping from server to server, trying to identify what went wrong with the backups and you have no choice but to decipher the logic behind the RMAN script that you didn’t author. Having different practices in place for sensitive tasks increases the risk of potential disaster. And (much like Murphy’s law) you will inevitably lose an environment due to problems with the backup script that is works fine everywhere else other than the critical DB that has failed.

With this said, imagine you have a template for RMAN backup scripts that has been proven to work without any issues. You have a method to generate, deploy and schedule these scripts on any server you like within seconds. I think that sounds awesome.

That is why I took initiative to work on automating this task; so we can be efficient and avoid these time consuming tasks while also keeping consistency at the highest level across the entire environment that we manage.

Here is where Ansible comes into play. I used Ansible to automate Oracle RMAN backup configuration on Linux by covering the following two aspects:

• Standardization and,
• Efficiency

For those of you not familiar with it, Ansible is an open source agent-less automation tool that does everything through standard SSH. More on Ansible can be found here .

How do I do it?

First, let’s ask ourselves what input parameters would be needed to generate proper RMAN scripts and schedule it in cron.

My main choice was the following:

• ORACLE_SID: we must enter ORACLE_SID so ansible would know for which database we are setting backup for and adjust the environment variables accordingly (for RAC this needs to be instance SID)
• Backup type: we can insert backup type whether is DISK or tape backup (SBT) so ansible would know how to adjust the RMAN parameters (channel type, PARMS … etc.) – default is DISK
• Parallelism: we can enter parallelism degree so ansible would know how to adjust the RMAN number of channels – default is 1
• Retention policy type: we can enter retention policy type whether is redundancy or recovery window so ansible would know how to adjust the retention policy – default is redundancy
  • redundancy: If you chose redundancy for retention policy you can enter value for redundancy > 0 – default is 1
  • recovery window: If you chose recovery window for retention policy you can enter value for recovery window > 0 – default is 7
• Backup location: If you chose DISK for backup type then you can enter backup location (mount volume) where backups would reside – default location is /home/oracle/rman_bkp
• Archive logs retention: we can enter a value of how many days we would like to keep the archive logs available after being backed up – default is 2 days
• Script logs/traces retention: we can enter a value of how many days we would like to keep the scripts execution logs/traces available – default is 2 days
• Email address for notification when backup fails – this is optional and if you add e-mail address the RMAN backup script will contain module to notify when failed – however this module functionality depends on whether you have set up the outgoing mails to work properly on the server so you can send notification mails from that server (mailx command needs to work properly as well)
• Email address for notification when backup succeeds – this is optional and if you add e-mail address the RMAN backup script will contain module to notify when succeeds – however this module functionality depends on whether you have set up the outgoing mails to work properly on the server so you can send notification mails from that server (mailx command needs to work properly as well)
• L0 schedule: we can enter a value for a cron schedule for the L0 backup (in cron format: ex. 0 1 * * 0) – Default is every Sunday ad 1 AM
• L1 schedule: we can enter a value for a cron schedule for the L1 backup (in cron format: ex. 0 1 * * 1-6) – Default is every day except Sunday ad 1 AM
• Arch schedule: we can enter a value for a cron schedule for the archive logs backup (in cron format: ex. 0 * * * *) – Default is every hour

I also have two other variables in the background with default values that I considered unnecessary to prompt for user input but are necessary for generating the RMAN backup scripts and cron schedules:

• nls_date_format: DD-MON-YYYY HH24:MI:SS – I use this to have proper output format on the timings when rman task is executed
• backup_scr_home: /scripts/bkp/rman – I use this to have standardized script directory location across the servers – The final location of the backup scripts after ansible generates the environment variables would be /home/oracle/scripts/bkp/rman

The full list of the defaults is this:

---
oracle_sid: ""            #ORACLE_SID so ansible would know for which database we are setting backup for and adjust the environment variables accordingly (for RAC this needs to be instance SID)
backup_type: "DISK"       #Allowed values DISK or SBT
sbt_params: ""            #SBT tape params in format ENV=(xxx,xxx) so ansible would know how to adjust the RMAN parameters
parallelism: 1            #integer > 0 ; parallelism degree so ansible would know how to adjust the RMAN number of channels
retention_policy_type: 1  #1 - redundancy | 2 - recovery window
redundancy: 1             #integer > 0
recovery_window: 7        #integer > 0
backup_dest: /home/oracle/rman_bkp  #backup location (mount volume) where backups would reside
arch_log_ret: 2           #value of how many days we would like to keep the archive logs available after being backed up - float > 0
logs_ret: 30              #value of how many days we would like to keep the scripts execution logs/traces available - integer > 0
notify_mail_succ: ""      #e-mail address on which to notify when backup failed
notify_mail_fail: ""      #e-mail address on which to notify when backup succeeded
nls_date_format: DD-MON-YYYY HH24:MI:SS
backup_scr_home: /scripts/bkp/rman   #adjust this to have desired output format on the timings when rman task is executed
sched_L0: "0 1 * * 0"     #value for a cron schedule for the L0 backup (in cron format: ex. 0 1 * * 0)
sched_L1: "0 1 * * 1-6"   #value for a cron schedule for the L1 backup (in cron format: ex. 0 1 * * 1-6)
sched_arch: "0 * * * *"   #value for a cron schedule for the archove logs backup (in cron format: ex. 0 * * * *)

Of course, all these default values can be adjusted through –extra-vars inline parameter when calling the playbook run so they all can be changed.

Now that we have defined which input parameters are required, we can start building the playbook.

For my test cases, I am using a control Linux box with hostname: control where I have Ansible configured and a database Linux box with hostname: oracledb where I have an Oracle database running with ORACLE_SID=UPGR . I will use this as reference while explaining the code for this project.

Let’s begin.

I start my playbook (rmanbackup.yml) with the vars_prompt module from Ansible to prompt the required variables in combination with the pre_tasks module where I initiate validation of the input. The code for this portion of the playbook is as follows:

---
- hosts: oracledb
  become: true
  become_user: oracle
  vars_prompt:
    - name: "oracle_sid"
      prompt: "Please enter the ORACLE_SID"
      private: no
    - name: "backup_type"
      prompt: "Please enter the backup type: DISK or SBT - default is DISK (DISK | SBT)"
      default: "DISK"
      private: no
    - name: "sbt_params"
      prompt: "Please enter the media manager parameters for sbt backup (format ENV=(xxx,xxx)) - if you chose DISK backup skip this by hitting enter"
      private: no
    - name: "parallelism"
      prompt: "Please enter the parallelism value (number of channels) - default is 1"
      default: 1
      private: no
    - name: "retention_policy_type"
      prompt: "Please enter the retention policy type - default is redundancy (1 - redundancy | 2 - recovery window)"
      default: 1
      private: no
    - name: "redundancy"
      prompt: "Please enter the redundancy (defualt is 1) - if you chose recovery window type skip this by hitting enter"
      default: 1
      private: no
    - name: "recovery_window"
      prompt: "Please enter the recovery window in days (defualt is 7) - if you chose redundancy type skip this by hitting enter"
      default: 7
      private: no
    - name: "backup_dest"
      prompt: "Please enter the backup location where backup files will reside on disk (defualt is /home/oracle/rman_bkp) - if you chose SBT backup skip this by hitting enter"
      default: "/home/oracle/rman_bkp"
      private: no
    - name: "arch_log_ret"
      prompt: "Please enter a value in days for cleaning up archive logs that have already been backed up older then X days (defult is 2 days)"
      default: 2
      private: no
    - name: "logs_ret"
      prompt: "Please enter a value in days for cleaning up scripts execution logs/traces older then X days (defult is 30 days)"
      default: 30
      private: no
    - name: "notify_mail_succ"
      prompt: "Please enter an e-mail address for notification when scripts execution is SUCCESSFULL [optional]"
      private: no
    - name: "notify_mail_fail"
      prompt: "Please enter an e-mail address for notification when scripts execution FAILED [optional]"
      private: no
    - name: "sched_L0"
      prompt: "Please enter a value for a cron schedule for the L0 backup (in cron format: ex. 0 1 * * 0) - Default is every Sunday ad 1 AM"
      default: "0 1 * * 0"
      private: no
    - name: "sched_L1"
      prompt: "Please enter a value for a cron schedule for the L1 backup (in cron format: ex. 0 1 * * 1-6) - Default is every day except Sunday ad 1 AM"
      default: "0 1 * * 1-6"
      private: no
    - name: "sched_arch"
      prompt: "Please enter a value for a cron schedule for the archove logs backup (in cron format: ex. 0 * * * *) - Default is every hour"
      default: "0 * * * *"
      private: no
  pre_tasks:
    - assert:
        that: oracle_sid !=""
        msg: "ORACLE_SID is not defined! Please define ORACLE_SID!"
      tags: ['sid']
    - assert:
        that: backup_type|lower == "disk" or backup_type|lower == "sbt"
        msg: "Backup type is not properly defined! Please choose between DISK or SBT!"
    - assert:
        that: "'ENV=(' in sbt_params"
        msg: "sbt_params are not properly defined! Please verify input!"
      when: backup_type|lower == "sbt"
    - assert:
        that: parallelism|int > 0
        msg: "Parallelism value is not properly defined! Please insert number > 0"
    - assert:
        that: retention_policy_type == "1" or retention_policy_type == "2"
        msg: "Retention policy type is not properly defined! Please choose between option 1 or 2!"
    - assert:
        that: redundancy|int > 0
        msg: "Redundancy value is not properly defined! Please insert number > 0"
      when: retention_policy_type == "1"
    - assert:
        that: recovery_window|int > 0
        msg: "Recovery window value is not properly defined! Please insert number > 0"
      when: retention_policy_type == "2"
    - assert:
        that: arch_log_ret|float > 0
        msg: "Archive log retention value is not properly defined! Please insert number > 0"
    - assert:
        that: logs_ret|int > 0
        msg: "Scripts logs/traces retention value is not properly defined! Please insert number > 0"
    - assert:
        that: notify_mail_succ | match("^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$") or notify_mail_succ ==""
        msg: "Not a valid e-mail address for SUCCESS notification! Please insert correct e-mail address!"
      tags: ['mailSvalidate']
    - assert:
        that: notify_mail_fail | match("^[_a-z0-9-]+(\.[_a-z0-9-]+)*@[a-z0-9-]+(\.[a-z0-9-]+)*(\.[a-z]{2,4})$") or notify_mail_fail ==""
        msg: "Not a valid e-mail address for FAILURE notification! Please insert correct e-mail address!"
      tags: ['mailFvalidate']
    - name: Get L0 cron
      command: echo "*" ""
      register: cron_l0_validate
    - debug: var=cron_l0_validate.stdout
    - assert:
        that: cron_l0_validate.stdout | match("^\\s*($|#|\\w+\\s*=|(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?(?:,(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?)*)\\s+(\\?|\\*|(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?(?:,(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?)*)\\s+(\\?|\\*|(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?(?:,(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?)*|\\?|\\*|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?(?:,(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?)*)\\s+(\\?|\\*|(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?(?:,(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?)*|\\?|\\*|(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?(?:,(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?)*)(|\\s)+(\\?|\\*|(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?(?:,(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?)*))$")
        msg: "Not a valid value for L0 cron schedule. Please insert correct value in cron format - (ex. 0 1 * * 0) !"
      tags: ['cronl0validate']
    - name: Get L1 cron
      command: echo "*" ""
      register: cron_l1_validate
    - debug: var=cron_l1_validate.stdout
    - assert:
        that: cron_l1_validate.stdout | match("^\\s*($|#|\\w+\\s*=|(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?(?:,(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?)*)\\s+(\\?|\\*|(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?(?:,(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?)*)\\s+(\\?|\\*|(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?(?:,(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?)*|\\?|\\*|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?(?:,(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?)*)\\s+(\\?|\\*|(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?(?:,(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?)*|\\?|\\*|(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?(?:,(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?)*)(|\\s)+(\\?|\\*|(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?(?:,(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?)*))$")
        msg: "Not a valid value for L1 cron schedule. Please insert correct value in cron format - (ex. 0 1 * * 1-6) !"
      tags: ['cronl1validate']
    - name: Get arch cron
      command: echo "*" ""
      register: cron_arch_validate
    - debug: var=cron_arch_validate.stdout
    - assert:
        that: cron_arch_validate.stdout | match("^\\s*($|#|\\w+\\s*=|(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?(?:,(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?)*)\\s+(\\?|\\*|(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?(?:,(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?)*)\\s+(\\?|\\*|(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?(?:,(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?)*|\\?|\\*|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?(?:,(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?)*)\\s+(\\?|\\*|(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?(?:,(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?)*|\\?|\\*|(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?(?:,(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?)*)(|\\s)+(\\?|\\*|(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?(?:,(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?)*))$")
        msg: "Not a valid value for archive logs backup cron schedule. Please insert correct value in cron format - (ex. 0 * * * *) !"
      tags: ['cronarchvalidate']

In the code noted above, most of the required input is pretty straight forward and easy to validate. However, I got stuck a bit at the cron schedule input. For that reason I needed a rather complex regular expression so I could match all possible valid cron scheduler entries. Otherwise, the user input may have caused the playbook to fail if it wasn’t validated properly when we reached the task at the end which schedules the scripts in cron. Since it wasn’t the focus of this project, I didn’t want to waste a lot of energy figuring that out so I used a regular expression that I found with a little research via Google:

"^\\s*($|#|\\w+\\s*=|(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?(?:,(?:[0-5]?\\d)(?:(?:-|\/|\\,)(?:[0-5]?\\d))?)*)\\s+(\\?|\\*|(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?(?:,(?:[01]?\\d|2[0-3])(?:(?:-|\/|\\,)(?:[01]?\\d|2[0-3]))?)*)\\s+(\\?|\\*|(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?(?:,(?:0?[1-9]|[12]\\d|3[01])(?:(?:-|\/|\\,)(?:0?[1-9]|[12]\\d|3[01]))?)*)\\s+(\\?|\\*|(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?(?:,(?:[1-9]|1[012])(?:(?:-|\/|\\,)(?:[1-9]|1[012]))?(?:L|W)?)*|\\?|\\*|(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?(?:,(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC)(?:(?:-)(?:JAN|FEB|MAR|APR|MAY|JUN|JUL|AUG|SEP|OCT|NOV|DEC))?)*)\\s+(\\?|\\*|(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?(?:,(?:[0-6])(?:(?:-|\/|\\,|#)(?:[0-6]))?(?:L)?)*|\\?|\\*|(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?(?:,(?:MON|TUE|WED|THU|FRI|SAT|SUN)(?:(?:-)(?:MON|TUE|WED|THU|FRI|SAT|SUN))?)*)(|\\s)+(\\?|\\*|(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?(?:,(?:|\\d{4})(?:(?:-|\/|\\,)(?:|\\d{4}))?)*))$"

- name: Check if ORACLE_SID exists
  shell: cat /etc/oratab | grep  | grep ^[^#] | cut -d ':' -f1
  register: oracle_sid_check
  tags: ['sid']
- name: Exit if ORACLE_SID does not exist
  fail:
    msg: "The database  does not exist. Please enter valid ORACLE_SID!"
  when: oracle_sid_check.stdout != oracle_sid
  tags: ['sid']

- name: Get user OS home directory
  command: echo ~
  register: user_home
  tags: [ 'userhome' ]

- name: Check if backup_scr_home directory exist
  stat: path=0
  register: bkp_scr_dst
  tags: [ 'scrhome' ]
- name: Create the backup_scr_home directory if it does not exist
  file: path=0 state=directory
  when: not bkp_scr_dst.stat.exists
  tags: [ 'scrhomecreate' ]

- name: Check if backup_dest location exist
  stat: path=
  register: bkp_dst_loc
  tags: [ 'bkpdestloc' ]
- name: Exit if backup_dest location does not exist
  fail:
    msg: "The backup destination directory does not exist. Please enter valid location!"
  when: not bkp_dst_loc.stat.exists
  tags: [ 'bkpdestloccreate' ]
- name: Check if backup_dest directory exist
  stat: path=null/null/bkp/rman
  register: bkp_dst
  tags: [ 'bkpdestdir' ]
- name: Create the backup_dest directory if it does not exist
  file: path=null/null/bkp/rman state=directory
  when: not bkp_dst.stat.exists
  tags: [ 'bkpdestdircreate' ]

- name: Check if log directory exist
  stat: path=0/logs
  register: logs_dir
  tags: [ 'logdir' ]
- name: Create the log directory if it does not exist
  file: path=0/logs state=directory
  when: not logs_dir.stat.exists
  tags: [ 'logdircreate' ]

RMAN scripts location:      <oracle OS home>/scripts/bkp/rman/
RMAN scripts logs location: <oracle OS home>/scripts/bkp/rman/logs
RMAN backup location:       <backup volume provided by user>/<oracle_sid provided by user>/bkp/rman/

PATH=/usr/kerberos/sbin:/usr/kerberos/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/root/bin
ORACLE_SID=
ORAENV_ASK=NO
. oraenv
unset ORAENV_ASK
######
export NLS_DATE_FORMAT=""
#####
BACKUP_DEST=null/${ORACLE_SID}/bkp/rman
BACKUP_HOME=0
BACKUP_LOGFILE=${BACKUP_HOME}/logs/rmanbackup_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
BACKUP_ARC_LOGFILE=${BACKUP_HOME}/logs/rmanbackup_${ORACLE_SID}_arc_`date +%Y%m%d%H%M%S`.log
BACKUP_ERRORLOG=${BACKUP_HOME}/logs/RmanBakUpError_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
RMAN_SET_ENV_LOG=${BACKUP_HOME}/logs/rmansetenv_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
#####
ORACLE_INITFILE=$ORACLE_HOME/dbs/init${ORACLE_SID}.ora
ORACLE_PWDFILE=$ORACLE_HOME/dbs/orapw${ORACLE_SID}

- name: Oracle ENV template
  template:
    src: oracle_env.j2
    dest: "0/null_rman.env"
    mode: 0755
  tags: [ 'oraenv' ]

<oracle OS home>/scripts/bkp/rman/<oracle_sid provided by user>_rman.env

-rwxr-xr-x. 1 oracle dba  796 Jul 26 09:05 /home/oracle/scripts/bkp/rman/UPGR_rman.env

PATH=/usr/kerberos/sbin:/usr/kerberos/bin:/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin:/root/bin
ORACLE_SID=UPGR
ORAENV_ASK=NO
. oraenv
unset ORAENV_ASK
######
export NLS_DATE_FORMAT="DD-MON-YYYY HH24:MI:SS"
#####
BACKUP_DEST=/home/oracle/rman_bkp/${ORACLE_SID}/bkp/rman
BACKUP_HOME=/home/oracle/scripts/bkp/rman
BACKUP_LOGFILE=${BACKUP_HOME}/logs/rmanbackup_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
BACKUP_ARC_LOGFILE=${BACKUP_HOME}/logs/rmanbackup_${ORACLE_SID}_arc_`date +%Y%m%d%H%M%S`.log
BACKUP_ERRORLOG=${BACKUP_HOME}/logs/RmanBakUpError_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
RMAN_SET_ENV_LOG=${BACKUP_HOME}/logs/rmansetenv_${ORACLE_SID}_`date +%Y%m%d%H%M%S`.log
#####
ORACLE_INITFILE=$ORACLE_HOME/dbs/init${ORACLE_SID}.ora
ORACLE_PWDFILE=$ORACLE_HOME/dbs/orapw${ORACLE_SID}

DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID>"}
set -a
source /home/oracle/scripts/bkp/rman/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# Setup RMAN config parameters
#------------------------------------
rman  << EOF set echo on connect target; show all; CONFIGURE CONTROLFILE AUTOBACKUP ON;  CONFIGURE CHANNEL DEVICE TYPE sbt PARMS ''; CONFIGURE DEFAULT DEVICE TYPE TO sbt; CONFIGURE DEVICE TYPE sbt PARALLELISM  BACKUP TYPE TO COMPRESSED BACKUPSET;   CONFIGURE RETENTION POLICY TO RECOVERY WINDOW OF  DAYS;  EOF ) > ${RMAN_SET_ENV_LOG} 2>&1
exit

 <oracle OS home>/scripts/bkp/rman/<oracle_sid provided by user>_rman_set_env.sh

- name: RMAN ENV template
  template:
    src: rman_env.j2
    dest: "0/null_rman_set_env.sh"
    mode: 0755
  tags: [ 'rmanenv' ]
- name: Run the rman set env script
  shell: "0/null_rman_set_env.sh null"
  tags: ['setrmanenv']

-rwxr-xr-x. 1 oracle dba  868 Jul 26 08:27 /home/oracle/scripts/bkp/rman/UPGR_rman_set_env.sh

DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID>"}
set -a
source /home/oracle/scripts/bkp/rman/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# Setup RMAN config parameters
#------------------------------------
rman  << EOF set echo on connect target; show all; CONFIGURE CONTROLFILE AUTOBACKUP ON; CONFIGURE DEFAULT DEVICE TYPE TO DISK; CONFIGURE CONTROLFILE AUTOBACKUP FORMAT FOR DEVICE TYPE DISK TO '/home/oracle/rman_bkp/UPGR/bkp/rman/%d_%F.ctl'; CONFIGURE DEVICE TYPE DISK PARALLELISM 1 BACKUP TYPE TO COMPRESSED BACKUPSET; CONFIGURE CHANNEL DEVICE TYPE DISK FORMAT '/home/oracle/rman_bkp/UPGR/bkp/rman/UPGR_%d_%I_%T_%U' MAXOPENFILES 1; CONFIGURE SNAPSHOT CONTROLFILE NAME TO '/home/oracle/rman_bkp/UPGR/bkp/rman/snapcf_UPGR.f'; CONFIGURE RETENTION POLICY TO REDUNDANCY 1; EOF ) > ${RMAN_SET_ENV_LOG} 2>&1
exit

rman_db_bkp_tmpl.j2
--------------------------------------------
################################################################################
# Common RMAN Backup
################################################################################
DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID> <LEVEL>"}
LVL=${2:?"---> USAGE: $DN/$BN <ORACLE_SID> <LEVEL>"}
set -a
source 0/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# BackUp of Database using RMAN
#------------------------------------
rman  << EOF
set echo on
connect target;
show all;
sql 'ALTER SYSTEM ARCHIVE LOG CURRENT';

backup as compressed backupset archivelog all not backed up 1 times tag 'ARCHIVE';
sql 'ALTER SYSTEM ARCHIVE LOG CURRENT';
backup as compressed backupset incremental level ${LVL} database tag 'LEVEL${LVL}' filesperset 1;
sql 'ALTER SYSTEM ARCHIVE LOG CURRENT';
sql "alter database backup controlfile to trace as ''${BACKUP_DEST}/${ORACLE_SID}_ctl.trc'' reuse";
backup as compressed backupset archivelog all not backed up 1 times tag 'ARCHIVE';
backup spfile;
backup current controlfile;
crosscheck archivelog all;
crosscheck backup of database;
crosscheck backup of archivelog all;
delete noprompt expired archivelog all;
delete noprompt obsolete;
delete noprompt archivelog until time 'sysdate - ' backed up 1 times to sbt;

EOF
if [ $? != 0 ]
then

    echo "\n RMAN backup of DB $ORACLE_SID is Failed .... : \n"
    echo " Check BkUp Completed or not .....\n "
    mailx -s "FAILED: ${ORACLE_SID} - LEVEL ${LVL} RMAN backup of ${ORACLE_SID}" "" < ${BACKUP_LOGFILE}
    exit 1

fi
#--------------------------------
# Backup of initora and password file
#---------------------------------
cp -v $ORACLE_INITFILE $BACKUP_DEST/.
cp -v $ORACLE_PWDFILE  $BACKUP_DEST/.
echo " \n BackUp of DB ${ORACLE_SID} Ended at :`date` \n"
sleep 3

mailx -s "SUCCESS: ${ORACLE_SID} - LEVEL ${LVL} RMAN Backup of ${ORACLE_SID}." "" < ${BACKUP_LOGFILE}  sleep 3 [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime + -type f -exec ls -lt {} \; [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime + -type f -exec rm {} \; ) > ${BACKUP_LOGFILE} 2>&1
exit
rman_arc_bkp_tmpl.j2
--------------------------------------------
################################################################################
# Common RMAN Archive Logs Backup
################################################################################
DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID> "}
set -a
source 0/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# BackUp of archive logs using RMAN
#------------------------------------
rman  << EOF
set echo on
connect target;
show all;
sql 'ALTER SYSTEM ARCHIVE LOG CURRENT';

backup as compressed backupset archivelog all not backed up 1 times;
sql "alter database backup controlfile to trace as ''${BACKUP_DEST}/${ORACLE_SID}_ctl.trc'' reuse";
backup spfile;
backup current controlfile;
crosscheck archivelog all;
crosscheck backup of archivelog all;
delete noprompt expired archivelog all;
delete noprompt archivelog until time 'sysdate - ' backed up 1 times to sbt;

EOF
if [ $? != 0 ]
then

    echo "\n RMAN backup of archive logs for $ORACLE_SID is Failed .... : \n"
    echo " Check BkUp Completed or not .....\n "
    mailx -s "FAILED: ${ORACLE_SID}- archivelog backup of ${ORACLE_SID}" "" < ${BACKUP_ARC_LOGFILE}
    exit 1

fi
#--------------------------------
# Backup of initora and password file
#---------------------------------
cp -v $ORACLE_INITFILE $BACKUP_DEST/.
cp -v $ORACLE_PWDFILE  $BACKUP_DEST/.
echo " \n BackUp of archive log ${ORACLE_SID} Ended at :`date` \n"
sleep 3

mailx -s "SUCCESS: ${ORACLE_SID}- Archive logs RMAN Backup of ${ORACLE_SID}." "" < ${BACKUP_ARC_LOGFILE}  sleep 3 [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime + -type f -exec ls -lt {} \; [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime + -type f -exec rm {} \; ) > ${BACKUP_ARC_LOGFILE} 2>&1
exit

- name: RMAN DB bkp template
  template:
    src: rman_db_bkp_tmpl.j2
    dest: "0/rman_db_backup.sh"
    mode: 0755
  tags: [ 'dbbkptmpl' ]
- name: RMAN Archive logs bkp template
  template:
    src: rman_arc_bkp_tmpl.j2
    dest: "0/rman_arc_backup.sh"
    mode: 0755
  tags: [ 'archbkptmpl' ]

<oracle OS home>/scripts/bkp/rman/rman_db_backup.sh
<oracle OS home>/scripts/bkp/rman/rman_arc_backup.sh

-rwxr-xr-x. 1 oracle dba 2205 Jul 28 12:18 /home/oracle/scripts/bkp/rman/rman_db_backup.sh
-rwxr-xr-x. 1 oracle dba 1781 Jul 28 12:18 /home/oracle/scripts/bkp/rman/rman_arc_backup.sh

rman_db_backup.sh
------------------------------------------------------------
################################################################################
# Common RMAN Backup
################################################################################
DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID> <LEVEL>"}
LVL=${2:?"---> USAGE: $DN/$BN <ORACLE_SID> <LEVEL>"}
set -a
source /home/oracle/scripts/bkp/rman/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# BackUp of Database using RMAN
#------------------------------------
rman  << EOF set echo on connect target; show all; sql 'ALTER SYSTEM ARCHIVE LOG CURRENT'; backup as compressed backupset archivelog all not backed up 1 times tag 'ARCHIVE' format '${BACKUP_DEST}/rman_al_%d_%I_%h_%e_%T_%U'; sql 'ALTER SYSTEM ARCHIVE LOG CURRENT'; backup as compressed backupset incremental level ${LVL} database tag 'LEVEL${LVL}' format '${BACKUP_DEST}/rman_l${LVL}_%U' filesperset 1; sql 'ALTER SYSTEM ARCHIVE LOG CURRENT'; sql "alter database backup controlfile to trace as ''${BACKUP_DEST}/${ORACLE_SID}_ctl.trc'' reuse"; backup as compressed backupset archivelog all not backed up 1 times tag 'ARCHIVE' format '${BACKUP_DEST}/rman_al_%d_%I_%h_%e_%T_%U'; backup spfile format '${BACKUP_DEST}/spfile_%d_%I_%T_%U'; backup current controlfile format '${BACKUP_DEST}/ctl_%d_%I_%T_%U'; crosscheck archivelog all; crosscheck backup of database; crosscheck backup of archivelog all; delete noprompt expired archivelog all; delete noprompt obsolete; delete noprompt archivelog until time 'sysdate - 2' backed up 1 times to disk; EOF if [ $? != 0 ] then echo "\n RMAN backup of DB $ORACLE_SID is Failed .... : \n" echo " Check BkUp Completed or not .....\n " exit 1 fi #-------------------------------- # Backup of initora and password file #--------------------------------- cp -v $ORACLE_INITFILE $BACKUP_DEST/. cp -v $ORACLE_PWDFILE $BACKUP_DEST/. echo " \n BackUp of DB ${ORACLE_SID} Ended at :`date` \n" sleep 3 sleep 3 [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime +30 -type f -exec ls -lt {} \; [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime +30 -type f -exec rm {} \; ) > ${BACKUP_LOGFILE} 2>&1
exit
rman_arc_backup.sh
------------------------------------------------------------
################################################################################
# Common RMAN Archive Logs Backup
################################################################################
DN=`dirname $0`
BN=`basename $0`
SID=${1:?"---> USAGE: $DN/$BN <ORACLE_SID> "}
set -a
source /home/oracle/scripts/bkp/rman/${SID}_rman.env
set +a
(
/bin/env
#------------------------------------
# BackUp of archive logs using RMAN
#------------------------------------
rman  << EOF set echo on connect target; show all; sql 'ALTER SYSTEM ARCHIVE LOG CURRENT'; backup as compressed backupset archivelog all not backed up 1 times tag 'ARCHIVE' format '${BACKUP_DEST}/rman_al_%d_%I_%h_%e_%T_%U'; sql "alter database backup controlfile to trace as ''${BACKUP_DEST}/${ORACLE_SID}_ctl.trc'' reuse"; backup spfile format '${BACKUP_DEST}/spfile_%d_%I_%T_%U'; backup current controlfile format '${BACKUP_DEST}/ctl_%d_%I_%T_%U'; crosscheck archivelog all; crosscheck backup of archivelog all; delete noprompt expired archivelog all; delete noprompt archivelog until time 'sysdate - 2' backed up 1 times to disk; EOF if [ $? != 0 ] then echo "\n RMAN backup of archive logs for $ORACLE_SID is Failed .... : \n" echo " Check BkUp Completed or not .....\n " exit 1 fi #-------------------------------- # Backup of initora and password file #--------------------------------- cp -v $ORACLE_INITFILE $BACKUP_DEST/. cp -v $ORACLE_PWDFILE $BACKUP_DEST/. echo " \n BackUp of archive log ${ORACLE_SID} Ended at :`date` \n" sleep 3 sleep 3 [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime +30 -type f -exec ls -lt {} \; [[ ! -z "$BACKUP_HOME/logs" ]] && find $BACKUP_HOME/logs -maxdepth 1 -name "*.log" -mtime +30 -type f -exec rm {} \; ) > ${BACKUP_ARC_LOGFILE} 2>&1
exit
6.    And now we have reached to the end. We have all the required scripts ready on place so all we have to do next is schedule them to run from cron. For that purpose, I use the ansible cron module the following way:
- name: Schedule RMAN L0 backup from oracle cron
  cron:
    name: "Schedule RMAN L0"
    user: "oracle"
    minute: ""
    hour: ""
    day: ""
    month: ""
    weekday: ""
    job: "0/rman_db_backup.sh null 0 > /tmp/rman_db_backup_L0.out 2>&1"
  tags: [ 'cronsch','L0' ]
- name: Schedule RMAN L1 backup from oracle cron
  cron:
    name: "Schedule RMAN L1"
    user: "oracle"
    minute: ""
    hour: ""
    day: ""
    month: ""
    weekday: ""
    job: "0/rman_db_backup.sh null 1 > /tmp/rman_db_backup_L1.out 2>&1"
  tags: [ 'cronsch','L1' ]
- name: Schedule RMAN archive log backup from oracle cron
  cron:
    name: "Schedule RMAN arch"
    user: "oracle"
    minute: ""
    hour: ""
    day: ""
    month: ""
    weekday: ""
    job: "0/rman_arc_backup.sh null > /tmp/rman_arc_backup.out 2>&1"
  tags: [ 'cronsch','archive' ]

  roles:
    - rmanbackup

ansible-playbook rmanbackup.yml

#Ansible: Schedule RMAN L0
0 1 * * 0 /home/oracle/scripts/bkp/rman/rman_db_backup.sh <oracle_sid you provided> 0 > /tmp/rman_db_backup_L0.out 2>&1
#Ansible: Schedule RMAN L1
0 1 * * 1-6 /home/oracle/scripts/bkp/rman/rman_db_backup.sh <oracle_sid you provided> 1 > /tmp/rman_db_backup_L1.out 2>&1
#Ansible: Schedule RMAN arch
0 * * * * /home/oracle/scripts/bkp/rman/rman_arc_backup.sh <oracle_sid you provided> > /tmp/rman_arc_backup.out 2>&1

Ex. ansible-playbook rmanbackup.yml --skip-tags "cronl0validate,cronl1validate,cronarchvalidate" --extra-vars "sched_arch='0 */2 * * *'"

#Ansible: Schedule RMAN L0
0 1 * * 0 /home/oracle/scripts/bkp/rman/rman_db_backup.sh <oracle_sid you provided> 0 > /tmp/rman_db_backup_L0.out 2>&1
#Ansible: Schedule RMAN L1
0 1 * * 1-6 /home/oracle/scripts/bkp/rman/rman_db_backup.sh <oracle_sid you provided> 1 > /tmp/rman_db_backup_L1.out 2>&1
#Ansible: Schedule RMAN arch
0 */2 * * * /home/oracle/scripts/bkp/rman/rman_arc_backup.sh <oracle_sid you provided> > /tmp/rman_arc_backup.out 2>&1

Ex. ansible-playbook rmanbackup.yml --skip-tags "L1"

#Ansible: Schedule RMAN L0
0 1 * * 0 /home/oracle/scripts/bkp/rman/rman_db_backup.sh <oracle_sid you provided> 0 > /tmp/rman_db_backup_L0.out 2>&1
#Ansible: Schedule RMAN arch
0 */2 * * * /home/oracle/scripts/bkp/rman/rman_arc_backup.sh <oracle_sid you provided> > /tmp/rman_arc_backup.out 2>&1

Ex. ansible-playbook rmanbackup.yml --skip-tags "sid,cronsch,setrmanenv"