oradb_rman

Oracle RMAN Backup for ansible-oracle

Please use only oradb_rman_ variables from role oradb_rman.

All other role variables from oradb_rman are deprecated and will be removed in a future release.

Table of contents

Requirements

  • Minimum Ansible version: 2.16.0

Default Variables

oradb_rman_assert_control_file_record_keep_time

Assert control_file_record_keep_time in init_parameters of databases with rman_jobs (state: present, sid: '*').

With the retention policy RECOVERY WINDOW OF <n> DAYS the value must be >= <n>. Otherwise the controlfile reuses the records of backups, which are needed by RMAN without catalog.

Default value

oradb_rman_assert_control_file_record_keep_time: true

oradb_rman_autofs

Configure autofs for RMAN Backups?

Default value

oradb_rman_autofs: '{{ rmanautofs | default(false) }}'

oradb_rman_channel_disk_default

Defines the format for disk target in RMAN-Templates from role.

Used for CONFIGURE CHANNEL DEVICE TYPE DISK <value> => the value starts with format.

Default value

oradb_rman_channel_disk_default: >-
  {% set __channel_disk_default = "format '/u10/rmanbackup/%d/%d_%T_%U'" -%}
  {{ rman_channel_disk_default | default(__channel_disk_default) -}}

oradb_rman_controlfile_autobackup_disk_default

Defines the contolfile autobackup target directory for the RMAN-Templates from role.

Default value

oradb_rman_controlfile_autobackup_disk_default: >-
  {% set __autobackup_disk_default = "'/u10/rmanbackup/%d/%d_%F'" -%}
  {{ rman_controlfile_autobackup_disk_default | default(__autobackup_disk_default) -}}

oradb_rman_cron_mkjob

Add mk-job to all cronjobs in /etc/cron.d for RMAN backups.

This is only needed when RMAN backups are monitored by checkmk.

Default value

oradb_rman_cron_mkjob: '{{ rman_cron_mkjob | default(false) }}'

oradb_rman_cronfile

Name for file for crontab in /etc/cron.d

Default value

oradb_rman_cronfile: oracle_rman_ansible

oradb_rman_log_dir

Lgofiledirectory for rman_wrapper.sh.

Default value

oradb_rman_log_dir: "{{ rman_log_dir | default((odb.0 | default(odb)).rman_log_dir | default(oracle_base + '/rman/log')) }}"

oradb_rman_log_retention

Days to keep the logfiles of rman_backup.sh in oradb_rman_log_dir (RMAN_LOG_RETENTION).

rman_backup.sh writes one logfile per execution and removes the logfiles of the database and action, which are older than this number of days. 0 keeps all logfiles.

Default value

oradb_rman_log_retention: 30

oradb_rman_retention_policy_default

Defines the policy for the RMAN-Templates from role.

Default value

oradb_rman_retention_policy_default: "{{ rman_retention_policy_default | default('RECOVERY WINDOW OF 14 DAYS') }}"

oradb_rman_script_dir

Directory for *.rman-Files.

Default value

oradb_rman_script_dir: "{{ rman_script_dir | default((odb.0 | default(odb)).rman_script_dir | default(oracle_base + '/rman')) }}"

oradb_rman_tns_admin

TNS_ADMIN for rman_wrapper.sh. This is needed for RMAN-Catalogconnections.

Default value

oradb_rman_tns_admin: "{{ rman_tns_admin | default(oracle_base + '/rman/network/admin') }}"

oradb_rman_tnsnames_installed

Defines custom entries in tnsnames.ora in oradb_rman_tns_admin.

Format is same as tnsnames_installed.

Example usage

oradb_rman_tnsnames_installed:
  - home: db19-si-ee
    tnsname: orclpdb
    state: present

oradb_rman_wallet_loc

Directory for Oracle wallet.

Default value

oradb_rman_wallet_loc: "{{ rman_wallet_loc | default(oracle_base + '/rman/network/wallet') }}"

oradb_rman_wallet_password

Password for Orale wallet.

Default value

oradb_rman_wallet_password: "{{ rman_wallet_password | default('oracleWallet1') }}"

Discovered Tags

always

assert

assert_rman_tns_admin

autofs

notest

rmancfg

rmancopy

rmancron

rmanexecute

rmanregister

tns

wallet

wallet_contents

Dependencies

  • orasw_meta

License

license (MIT)

Author

[Thorsten Bruhns]

Last modified November 8, 2026: oradb_rman: format in oradb_rman_channel_disk_default (b5d9b6c9)