orasw_meta

Important

The description for variables is work in progress.!

Meta role used by other roles to share variable defaults.

This role has a dependency to orahost_meta.

There are a lot of variables who are used by orasw_meta

Table of contents

Requirements

  • Minimum Ansible version: 2.16.0

Default Variables

_www_download_bin

The variable will be removed soon. The download will be changed to get_url to simplify the code.

Default value

_www_download_bin: curl

apply_patches_db

Apply Patches from db_homes_config for installed ORACLE_HOME?

This is a global switch to enable/disable DB-Patching for all ORACLE_HOMEs.

Default value

apply_patches_db: true

assert_db_homes_config

Switch for enable/disable assert on db_homes_config.

The assert allows only the versions 19.3.0.0 and 26.1.0.0. false disables all checks of db_homes_config, not only the check of the version.

Please change the state only when really needed!

Default value

assert_db_homes_config: true

autostartup_service

Enable autostart of database during system startup.

This switch is only used, when Single Instance without Grid Infrastructure / Restart is installed.

The solution is selected with autostartup_service_mode.

Default true since 5.0.0 (4.x: false).

Default value

autostartup_service: true

autostartup_service_adopt_interval

Interval of oracle-adopt.timer (autostartup_service_mode: units), which attaches databases and listeners started outside of systemd to their unit. An inactive unit of a database, which was started outside of systemd, is started.

Default value

autostartup_service_adopt_interval: 2min

autostartup_service_dependency

Units which are required by the autostart and started before the databases and listeners (Requires= and After=), e.g. a service which mounts the file systems of the databases. Several units are separated by a blank.

Used by both values of autostartup_service_mode. With units, the units network-online.target, remote-fs.target and local-fs.target are always used in After=.

Default value

autostartup_service_dependency: network.target

autostartup_service_mode

Solution for the autostart of databases and listeners with autostartup_service: true.

  • units (default since 5.0.0): one systemd unit per database (oracle-db@<ORACLE_SID>.service) and listener (oracle-listener@<LISTENER_NAME>.service) from oracle_databases and listener_installed, grouped by oracle-databases.target and oracle-listeners.target. Created by oradb_manage_db. Databases and listeners started outside of systemd are attached to their unit by the timer oracle-adopt.timer, so they are stopped cleanly during a shutdown of the server.
  • legacy: the solution before 5.0.0 with one service oracle-rdbms.service for all databases in /etc/oratab. Created by oraswdb_install.

Switching the mode removes the units of the other solution without stopping the databases. See the Breaking Changes guide for the migration.

Default value

autostartup_service_mode: units

autostartup_service_restart

Restart a database after a crash (autostartup_service_mode: units).

The unit oracle-db@<ORACLE_SID>.service monitors PMON of the database. When PMON is gone and the last entry in the alert log is not Instance shutdown complete (or Instance shutdown (abort) complete), the database crashed. With true, systemd restarts the unit after autostartup_service_restart_sec (max. 10 starts of the unit within 1 hour), with false the unit fails.

A shutdown outside of systemd (e.g. shutdown immediate or shutdown abort in sqlplus) is not restarted.

Can be set per database with autostartup_service_restart in oracle_databases. A change is used without a restart of the database.

Default value

autostartup_service_restart: true

Example usage

oracle_databases:
  - oracle_db_name: DB1
    autostartup_service_restart: false

autostartup_service_restart_sec

RestartSec of the database units after a crash (autostartup_service_restart: true), for all databases.

Default value

autostartup_service_restart_sec: 2min

autostartup_service_shutdown_mode

Shutdown mode of the databases (autostartup_service_mode: units): immediate, transactional, normal or abort.

Default value

autostartup_service_shutdown_mode: immediate

autostartup_service_start_timeout

TimeoutStartSec of the database units (autostartup_service_mode: units).

The start of a database with crash recovery can take a long time.

Default value

autostartup_service_start_timeout: 15min

autostartup_service_stop_timeout

TimeoutStopSec of the database units (autostartup_service_mode: units).

systemd does not kill a database after the timeout (KillMode=process).

Default value

autostartup_service_stop_timeout: 15min

db_homes_config

This is a central variable for ORACLE_HOME configuration.

Defines the known ORACLE_HOMEs with a lot of additional informations but not the installation itself.

See db_homes_installed for a list of installed ORACLE_HOMEs.

The dictionary holds data for:

Attribute Description
imagename Set an optional name for a golden Image to install from. The archiv is read from same directory as the normal installation medias from Oracle.
filesource imagename can be replaced/overridden by filesource to provide an absolute path/url to the golden image (when not available in the normal installation place)
edition allowed values: SE, SE2, EE. default value:
opatch_minversion Is needed for patching. Automatically installs a new version of OPatch, when existing version is older then opatch_minversion
oracle_home
oracle_home_name Mandatory variable, when readonly_home: true. Oracle allows only characters, numbers and ‘_’ as value in oracle_home_name. Do not use ‘-’ as a value!
opatchauto Bundle patches to be installed/removed using opatchauto
opatch One-off patches to be installed/removed using opatch
readonly_home Should ansible-oracle install this ORACLE_HOME as readonly home? Do NOT change this attribute for an installed ORACLE_HOME. default value: false
version The base version for the ORACLE_HOME. Use the version from the official 1st release of Oracle.

See examples for allowed values.

Example usage

db_homes_config:
  21300_base: # 21c without patching - you should never use this in production!
    home: db1_base
    version: 21.3.0.0
    edition: EE
  19300_base: # 19c without patching - you should never use this in production!
    home: db1_base
    version: 19.3.0.0
    edition: EE
  1931_se2:
    oracle_home: /u01/app/oracle/product/19.0.0/dbhome_1
    version: 19.3.0.0
    edition: SE2
    opatch_minversion: "12.2.0.1.51"
    opatchauto:
      - patchid: 39062956
        patchversion: 19.31.0.0.260421
        state: present
        path: 39062956/39062956/39036936
        subpatches:
          - 39034528 # Database
          - 39039430 # OCW
          - 39055473 # ACFS
          - 39107855 # Tomcat
          - 39107825 # DBWLM
        apply_options:
          - "-deleteInactivePatches"
    opatch:
      - patchid: 39473469
        state: present
        path: 39473469/39473469/39473469
        apply_options:
          - "-force_conflict"

db_homes_installed

Example usage

db_homes_installed:
  - home: 19300-base
    apply_patches: true
    state: present

db_standby_config

Defines the standby configurations (Data Guard, Dbvisit).

Not set by default. Must be identical on all members of a configuration. A database is assigned with standby_config in oracle_databases.

The inventory structure is described in doc/guides/standby_databases.adoc.

Type dataguard: the standby databases and the broker configuration are created by the role oradb_standby.

IMPORTANT! Only the asserts are implemented for type dbvisit at the moment.

Example usage

db_standby_config:
  - name: DG1
    type: dataguard
    dg:
      protection_mode: MaxPerformance
      archivelog_deletion_policy: APPLIED ON ALL STANDBY
    members:
      - hosts: [dbhost1]
        db_unique_name: DB1_SITE1
        initial_role: primary
        dg:
          connect_identifier: DB1_SITE1
          log_xpt_mode: ASYNC
      - hosts: [dbhost2]
        db_unique_name: DB1_SITE2
        initial_role: physical_standby
        dg:
          connect_identifier: DB1_SITE2
          log_xpt_mode: ASYNC

dbenvdir

Define the directory for db environment configurations.

Used during installation of ocenv.sh.

Default value

dbenvdir: '{{ oracle_user_home }}/dbenv'

dbpasswords

Define the passwords for DB-Users in nonCDB, CDB and PDBs.

Default value

dbpasswords: {}

Example usage


nonCDB with db_name: orcl

dbpasswords:
  <db_name>:
    <db_user>: <db_password>

dbpasswords:
  orcl:
    SYS: Oracle_456
    SYSTEM: Oracle_456
    DBSNMP: Oracle_456

CDB with `db_name: orcl` and `PDB: orclpdb`

dbpasswords:
  <CDB db_name>:
    <CDB db_user>: <db_password>
    <PDB name>:
      <PDB db_user>: <db_password>

dbpasswords:
  orcl:
    SYS: Oracle_456
    SYSTEM: Oracle_456
    DBSNMP: Oracle_456
    ORCLPDB:
      PDBADMIN: Oracle_789

default_dbpass

Set the default password for all DB-Users not defined in dbpasswords.

Default value

default_dbpass: >-
  {% if item is defined and item.oracle_db_passwd is defined %}{{ item.oracle_db_passwd -}}
  {%- elif dbh is defined and dbh.oracle_db_passwd is defined %}{{ dbh.oracle_db_passwd -}}
  {%- endif %}

Example usage

default_dbpass: topeS3cr§t

deploy_ocenv

Install the ocenv.sh environment script.

Source is from: https://github.com/opitzconsulting/oracle-scripts

Default value

deploy_ocenv: true

disable_ee_options

Global switch to define if Oracle options should be changed in binary for Enterprise-Edition.

Default value

disable_ee_options: 'true'

Example usage

disable_ee_options: true # change options in binary
disable_ee_options: false # do not change options in binary

get_url_ssl_client_cert

PEM formatted certificate chain file to be used for SSL client authentication with ansible.builtin.get_url

Type: path

Example usage

/etc/pki/ca-trust/source/anchors/client-certchain.pem

get_url_ssl_client_key

PEM formatted file that contains your private key to be used for SSL client authentication with ansible.builtin.get_url

Type: path

Example usage

/etc/pki/tls/private/client-cert.pem

grid_base

ORACLE_BASE for Grid Infrastructure/Restart

Important!

ORACLE_BASE for Grid-Infrastructure must be different the ORACLE_BASE for RDBMS.

ORACLE_BASE for Oracle Rstart is same as RDBMS.

Default value

grid_base: >-
  {% if oracle_install_option_gi == 'CRS_CONFIG' -%}
  /u01/app/grid/base{% else %}{{ oracle_base }}{% endif %}

hostgroup

Defines the hostgroup with nodes for a Grid-Infrastructure Cluster.

The variable needs a refactoring.

Default value

hostgroup: '{{ group_names[0] }}'

http_proxy

Define the http proxy for downloads

Default value

http_proxy: ''

https_proxy

Define the https proxy for downloads

Default value

https_proxy: ''

install_from_nfs

Mount NFS-Server for installation media?

nfs_server_sw and nfs_server_sw_path are needed, when install_from_nfs: true

Default value

install_from_nfs: false

is_sw_source_local

Default value

is_sw_source_local: true

listener_port

The global default port for listener when no dedicated port is configured in listener itself.

Default value

listener_port: 1521

nfs_server_sw

Defines the NFS-Server used to mount the installation media from.

Example usage

nfs_server_sw: nfs-server.example.com

nfs_server_sw_path

Path to installation medias on NFS-Ser.

Important

ansible-oracle expects a fixed structure for installation media and patches!

Example usage

nfs_server_sw_path: /orasw

no_proxy

Define no_proxy list für downlads.

Default value

no_proxy: ''

ocenv_bashrc_init

Add ocenv.sh to bashrc of oracle user?

deploy_ocenv: true is needed for the installation.

Default value

ocenv_bashrc_init: true

ocenv_bashrc_init_section

Define the conntents to add to .bashr when ocenv_bashrc_init: true.

Default value

ocenv_bashrc_init_section: |
  echo "execute ocenv to source Oracle Environment"
  alias ocenv='. "{{ dbenvdir }}/ocenv"'

opatch_conflict_check

When calling oracle_opatch for DB or GI, decide if analyze stage of opatch/opatchauto should be executed. Will be overridden by opatch_db_conflict_check and opatch_gi_conflict_check.

Type: boolean

Default value

opatch_conflict_check: true

oracle_all_editions_options_state

Intended state of edition independent database options, as defined in {{ oracle_all_editions_options }}

Default value

oracle_all_editions_options_state:
  - {option: dnfs, enabled: false}
  - {option: uniaud, enabled: false}

oracle_asm_disk_string

Default value

oracle_asm_disk_string: ORCL:*

oracle_base

ORACLE_BASE for Oracle RDBMS

Default value

oracle_base: /u01/app/oracle

oracle_databases

Defines the list of databases on a host.

There are diffent sub list to define Profiles, Services, Tablespaces, Users …

Attributes (selection)

Attribute Default Description
home key in db_homes_config (mandatory)
oracle_db_name DB_NAME (mandatory)
state present or absent (mandatory)
is_container true create a Container Database. Only true is allowed for 26ai. Set is_container: false for a non-CDB with 19c.
omf true Oracle Managed Files (dbca -useOMF). omf: true needs db_create_file_dest and db_recovery_file_dest in init_parameters. OMF is strongly recommended. omf: false is only allowed with storage_type: FS, needs an own DBCA template without OMF (dbca_templatename) and is not tested.
storage_type FS FS or ASM. ASM requires omf: true.

Container Databases (is_container: true, default) need max_pdbs in init_parameters (assert) with the number of PDBs allowed by the license: max. 3 for SE2, max. 1024 for EE. IMPORTANT! EE allows more than 3 PDBs only with a license for the Multitenant Option.

Databases of an EE home need control_management_pack_access in init_parameters (assert) with NONE, DIAGNOSTIC or DIAGNOSTIC+TUNING. It is optional for SE2 and must be NONE if defined. IMPORTANT! DIAGNOSTIC needs a license for the Diagnostics Pack, DIAGNOSTIC+TUNING for the Diagnostics and Tuning Pack.

Every database needs processes in init_parameters (assert in orahost_meta, used for kernel.sem). Every database needs sga_target and pga_aggregate_target in init_parameters (assert). oracle_db_mem_totalmb is not supported anymore. With Hugepages (configure_hugepages: true, default) memory_target and memory_max_target are not allowed in init_parameters (assert), Automatic Memory Management prevents the usage of Hugepages.

datafile_dest and recoveryfile_dest are removed from oracle_databases (assert fails), they are replaced by db_create_file_dest and db_recovery_file_dest in init_parameters.

File destinations in dbca:

omf storage_type datafile destination recovery area destination
true (default) FS or ASM db_create_file_dest in init_parameters db_recovery_file_dest in init_parameters
false FS oracle_dbf_dir_fs oracle_reco_dir_fs
false ASM not allowed (assert fails)

The values in init_parameters are also used for standby databases (RMAN duplicate) and oradb_rman.

IMPORTANT! OMF is strongly recommended in ansible-oracle. Databases without OMF are not tested. Use an own DBCA template without OMF (dbca_templatename) for omf: false.

Sub-Sections

statspack

Attribute Description
purgedays Purgedays for snapshots
snaplevel snaplevel used in job
state create (present) or remove (absent) statspack from nonCDB, CDB or PDB

tablespaces

Defines the Tablespace to add, drop or modify to the database.

Known limitations:

Multiple files with dedicated file names are not supported.

Use OMF instead, which is the default during creation of Tablespaces.

Attribute Description
name
size
autoextend
next
maxsize
content
state
bigfile
numfiles mutually exclusive with datafile
datafile mutually exclusive with numfiles
See examples for allowed values.

init_parameters

Initialization parameters, managed by oradb_manage_parameters (also in oracle_pdbs).

Attribute Description
name name of the parameter
value value of the parameter
scope both (default), spfile or memory
state present, absent or reset
sid instance name for the SID clause, default * (all instances). Case-sensitive, e.g. for local_listener per RAC instance. The instance does not need to run, then only the spfile is changed.
dbca false: not used during creation with dbca (only oracle_databases). Default true, false for entries with sid other than *. dbca: true with sid other than * is not allowed (dbca has no SID clause).

Single Instance databases (also with Oracle Restart) need local_listener in init_parameters, e.g. {name: local_listener, value: '//localhost:1521', scope: both, state: present}. The alias from DBCA in tnsnames.ora is missing after a switch of the ORACLE_HOME.

Example usage


# IMPORTANT! This following example shows the general structure of oracle_databases.
# Do not use it as a real example.

oracle_databases:
  - home: 19300-base
    oracle_db_name: orcl
    state: present
    statspack:
      purgedays: 14
      snaplevel: 5
      state: present
    tablespaces:
      - {name: system, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
    init_parameters:
      - {name: audit_trail, value: 'NONE', scope: spfile, state: present}
      # RAC: one entry per instance
      - {name: local_listener, value: 'rac1-vip:1521', scope: both, state: present, sid: orcl1}
      - {name: local_listener, value: 'rac2-vip:1521', scope: both, state: present, sid: orcl2}
    profiles:
      - name: DEFAULT
    users:
      - schema: dbsnmp

oracle_databases:
  - home: 19300-base
    oracle_db_name: orcl
    oracle_db_type: SI
    storage_type: FS
    oracle_database_type: MULTIPURPOSE
    redolog_size: 100M
    redolog_groups: 3
    archivelog: false
    flashback: false
    force_logging: false
    listener_name: LISTENER
    state: present
    statspack:
      purgedays: 14
      snaplevel: 5
      state: present
    tablespaces:
      - {name: system, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
      - {name: sysaux, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
      - {name: undotbs1, size: 10M, autoextend: true, next: 50M, maxsize: 8G, content: permanent, state: present, bigfile: false}
      - {name: users, size: 10M, autoextend: true, next: 50M, maxsize: 2G, content: permanent, state: present, bigfile: false}
      - {name: temp, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
    init_parameters:
      - {name: audit_trail, value: 'NONE', scope: spfile, state: present}
      - {name: control_management_pack_access, value: 'NONE', scope: both, state: present}
      - {name: control_file_record_keep_time, value: '30', scope: both, state: present}
      - {name: db_files, value: '200', scope: spfile, state: present}
      - {name: deferred_segment_creation, value: 'false', scope: both, state: present}
      - {name: filesystemio_options, value: 'setall', scope: spfile, state: present}
      - {name: job_queue_processes, value: '10', scope: both, state: present}
      # Disable forcing hugepages on really small systems
      #  - {name: use_large_pages ,value: 'ONLY', scope: spfile, state: present}
      - {name: log_archive_dest_1, value: 'location=USE_DB_RECOVERY_FILE_DEST', scope: both, state: present}
      - {name: log_buffer, value: '64M', scope: spfile, state: present}
      - {name: pga_aggregate_target, value: '200M', scope: both, state: present, dbca: false}
      - {name: sga_target, value: '1800M', scope: spfile, state: present, dbca: false}
      - {name: recyclebin, value: 'off', scope: spfile, state: present}
      - {name: streams_pool_size, value: '152M', scope: spfile, state: present}
      - {name: "_cursor_obsolete_threshold", value: '1024', scope: spfile, state: present}
      - {name: max_pdbs, value: '3', scope: both, state: present}
      - {name: clonedb, value: 'true', scope: spfile, state: present, dbca: false}
      - {name: db_create_file_dest, value: '/u02/oradata', scope: both, state: present}
      - {name: db_create_online_log_dest_1, value: '/u02/oradata', scope: both, state: present}
      - {name: db_recovery_file_dest_size, value: '10G', scope: both, state: present, dbca: false}
      - {name: db_recovery_file_dest, value: '/u02/fra', scope: both, state: present}
    profiles:
      - name: DEFAULT
        state: present
        attributes:
          - {name: password_life_time, value: unlimited}
    users:
      - schema: dbsnmp
        state: unlocked
        update_password: always

oracle_dbf_dir_fs

Datafile destination in DBCA for databases with omf: false (only storage_type: FS).

Databases with omf: true (default) use db_create_file_dest from init_parameters.

Default value

oracle_dbf_dir_fs: /u02/oradata/

oracle_ee_options_112

Define the enabled/disabled options for 11.2 binaries.

Default value

oracle_ee_options_112:
  - {option: dm, state: false}
  - {option: dv, state: false}
  - {option: lbac, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_121

Define the enabled/disabled options for 12.1 binaries.

Default value

oracle_ee_options_121:
  - {option: dm, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_122

Define the enabled/disabled options for 12.2 binaries.

Default value

oracle_ee_options_122:
  - {option: oaa, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_183

Define the enabled/disabled options for 18c binaries.

Default value

oracle_ee_options_183:
  - {option: oaa, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_193

Define the enabled/disabled options for 19c binaries.

Default value

oracle_ee_options_193:
  - {option: oaa, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_213

Define the enabled/disabled options for 21c binaries.

Default value

oracle_ee_options_213:
  - {option: oaa, state: false}
  - {option: olap, state: false}
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_ee_options_261

Define the enabled/disabled options for 26ai binaries.

Default value

oracle_ee_options_261:
  - {option: partitioning, state: false}
  - {option: rat, state: false}

oracle_home_gi_cl

Custom setting for CRS_HOME when Grid-Infrastructure is installed.

The variable is used as a default for oracle_home_gi.

Do not forget `` for Cluster installations.

Default value

oracle_home_gi_cl: /u01/app/{{ oracle_install_version_gi }}/grid

oracle_home_gi_so

Custom setting for CRS_HOME when Oracle Restart is installed.

The variable is used as a default for the internal variable oracle_home_gi.

Default value

oracle_home_gi_so: '{{ oracle_base }}/{{ oracle_install_version_gi }}/grid'

oracle_hostname

Grid-Infrastructure nodename.

Used as hostname for all oradb_manage_-connections and as hostname in RDBMS installation.

Default value

oracle_hostname: '{{ ansible_fqdn }}'

oracle_install_option_gi

Define the installation type for Grid Infrastructure or Oracle Restart.

Value Description
"" Install Single Instance (Default)
CRS_CONFIG Install Grid-Infrastructure
HA_CONFIG Install Oracle Restart

Default value

oracle_install_option_gi: ''

Example usage


oracle_install_option_gi: ''

oracle_install_option_gi: CRS_CONFIG

oracle_install_option_gi: HA_CONFIG

oracle_install_version_gi

Define the version (base release) for Grid-Infrastructure or Oracle Restart.

Important

Do not forget to set oracle_install_option_gi.

Set the version in every inventory with Grid Infrastructure or Oracle Restart. It must match the installation media (oracle_sw_image_gi, oracle_install_image_gi). The default is 26ai (26.1.0.0) as of 5.0.0 (19c before).

Default value

oracle_install_version_gi: 26.1.0.0

Example usage


oracle_install_version_gi: 26.1.0.0

oracle_install_version_gi: 19.3.0.0

oracle_opatch_patch

Mapping from OPatch ZIP-archive to Oracle Release.

The variable is configured for all supported Oracle Release by default.

Default value

oracle_opatch_patch:
  - filename: p6880880_230000_Linux-x86-64.zip
    version: 26.1.0.0
  - filename: p6880880_210000_Linux-x86-64.zip
    version: 21.3.0.0
  - filename: p6880880_190000_Linux-x86-64.zip
    version: 19.3.0.0
  - filename: p6880880_180000_Linux-x86-64.zip
    version: 18.3.0.0
  - filename: p6880880_122010_Linux-x86-64.zip
    version: 12.2.0.1
  - filename: p6880880_122010_Linux-x86-64.zip
    version: 12.1.0.2
  - filename: p6880880_121010_Linux-x86-64.zip
    version: 12.1.0.1
  - filename: p6880880_112000_Linux-x86-64.zip
    version: 11.2.0.4
  - filename: p6880880_112000_Linux-x86-64.zip
    version: 11.2.0.3

oracle_pdbs

Define the list of PDBs in CDB.

Important!

For each listelement in oracle_pdbs an element in oracle_databases with cdb = oracle_db_name must exists..

Otherwise the assert for oracle_pdbs will fail!

Example usage

oracle_pdbs:
  - home: 19300-base
    listener_port: 1521
    cdb: orcl
    pdb_name: ORCLPDB
    state: present
    statspack:
      purgedays: 14
      snaplevel: 7
      state: present
    tablespaces:
      - {name: system, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
      - {name: sysaux, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
      - {name: undotbs1, size: 10M, autoextend: true, next: 50M, maxsize: 8G, content: permanent, state: present, bigfile: false}
      - {name: users, size: 10M, autoextend: true, next: 50M, maxsize: 2G, content: permanent, state: present, bigfile: false}
      - {name: temp, size: 10M, autoextend: true, next: 50M, maxsize: 4G, content: permanent, state: present, bigfile: false}
    users:
      # quotas: list of tablespace/size, size in bytes with optional K, M, G, T or unlimited.
      # With quotas, the default_tablespace gets no automatic quota unlimited.
      # quotas_mode: append (default) keeps other quotas, enforce removes them.
      # size 0 removes the quota on a tablespace.
      - schema: app
        state: present
        default_tablespace: users
        quotas_mode: enforce
        quotas:
          - tablespace: users
            size: unlimited
          - tablespace: sysaux
            size: 100M

oracle_profile_template

Define which template is used to create .profile scripts.

Important

This variable is only used when deploy_ocenv: false. The default is true.

Default value

oracle_profile_template: dotprofile-home.j2

oracle_reco_dir_fs

Recovery area destination in DBCA for databases with omf: false (only storage_type: FS).

Databases with omf: true (default) use db_recovery_file_dest from init_parameters.

Default value

oracle_reco_dir_fs: /u02/fra/

oracle_stage_remote

Default value

oracle_stage_remote: '{{ oracle_stage }}'

oracle_sw_patches

Defines the list of known Patches in ansible-oracle.

Patch files are expected to be found by their filename under oracle_sw_source_local, or oracle_sw_source_www respectively, unless a filesource dict element provides a full path / complete URL to the patch file.

Usage of this variable:

If a complete software repository with patches is used with a nfs-mount, this variable is not needed.

Default value

oracle_sw_patches: []

Example usage

oracle_sw_patches:
  - filename: p28183653_122010_Linux-x86-64.zip
    filesource: /mnt/patches/p28183653_122010_Linux-x86-64.zip
    patchid: 28183653
    version: 12.2.0.1
    patchversion: 12.2.0.1.180717
    description: GI-RU-July-2018
    creates: 28183653/28163133/files/suptools/orachk.zip
  - filename: p27468969_122010_Linux-x86-64.zip
    filesource: https://downloadserver/patches?id=27468969
    patchid: 27468969
    version: 12.2.0.1
    patchversion: 12.2.0.1.180417
    description: GI-RU-April-2018
    creates: 27468969/27674384/README.txt
  - filename: p28140658_12201180417DBAPR2018RU_Linux-x86-64.zip
    patchid: 28140658
    version: 12.2.0.1
    patchversion: 12201180417DBAPR2018RU
    description: 'PARALLEL QUERY Patch for Bug# 28140658 for Linux-x86-64 Platforms'
    creates: online/files/hpatch/bug28140658.pch

oracle_sw_source_local

Define the directory when `` is set.

The archives are directly read from this directory.

Default value

oracle_sw_source_local: /tmp

oracle_sw_source_www

Define the URL for downloading installation medias and patches from a central server during software installation and patching.

Default value

oracle_sw_source_www: http://www/orasw

orasw_meta_assert_db_standby_config

Switch for enable/disable assert on db_standby_config and standby_config in oracle_databases.

Please change the state only when really needed!

Default value

orasw_meta_assert_db_standby_config: true

orasw_meta_assert_oracle_databases

Switch for enable/disable assert on oracle_databases.

Please change the state only when really needed!

Default value

orasw_meta_assert_oracle_databases: true

orasw_meta_cluster_hostgroup

Ansible Inventory hostgroup for RAC-Cluster.

Default value

orasw_meta_cluster_hostgroup: ''

orasw_meta_forced_lang

Certain modules (e.g. oracle_db and oracle_opatch) rely on English language outputs. This causes trouble if system has different locale settings. That’s why we force the language in script environments.

Default value

orasw_meta_forced_lang: en_US.UTF-8

proxy_env

This is an internal variable for downloading patches. Usually no need to change it.

Default value

proxy_env:
  http_proxy: '{{ http_proxy }}'
  https_proxy: '{{ https_proxy }}'
  no_proxy: '{{ no_proxy }}'

set_oracle_all_editions_options_state

Switch to globally enable/disable linking of edition independent database options

Default value

set_oracle_all_editions_options_state: true

shell_aliases

Define shell Aliases for oracle user.

Default value

shell_aliases:
  - asmcmd='. oraenv ;rlwrap asmcmd -p'
  - sqlsyso='. oraenv ;rlwrap sqlplus "/ as sysdba"'
  - dgmgrl='rlwrap dgmgrl'
  - rman='rlwrap rman'
  - sid='export ORACLE_SID=$(ps -ef | grep "ora_pmon_$ORACLE_DBNAME" |grep -v grep | sed 's/^.*pmon_//g')'
  - sqlp='rlwrap sqlplus'
  - sqlsys='rlwrap sqlplus "/ as sysdba"'
  - dbh='cd $ORACLE_HOME'
  - dbb='cd $ORACLE_BASE'
  - talert='tail -500f $ORACLE_BASE/diag/rdbms/$ORA_DB_UNQ_NAME/$ORACLE_SID/trace/alert_$ORACLE_SID.log'
  - lalert='less $ORACLE_BASE/diag/rdbms/$ORA_DB_UNQ_NAME/$ORACLE_SID/trace/alert_$ORACLE_SID.log'
  - lsnrstart='lsnrctl start $LSNRNAME'
  - lsnrstop='lsnrctl stop $LSNRNAME'
  - lsnrstatus='lsnrctl status $LSNRNAME'
  - lsnrservice='lsnrctl services $LSNRNAME'

shell_ps1

Configure shell prompt for OS-User oracle

Default value

shell_ps1: "'[$LOGNAME'@'$ORACLE_SID `basename $PWD`]$'"

ulimit_systemd_mapping

Mapping of oracle_seclimits to the limits of the systemd units for the autostart.

Default value

ulimit_systemd_mapping:
  hard nproc: {name: LimitNPROC}
  hard nofile: {name: LimitNOFILE}
  hard stack: {name: LimitSTACK, sysctlfactor: 1024}
  hard memlock: {name: LimitMEMLOCK, sysctlfactor: 1024}

use_proxy

Enable Proxy for Download

Default value

use_proxy: false

Discovered Tags

always

assert_ansible
 Assert version of Ansible Core

assert_ansible_oracle
 Assert inventory variables from ansible-oracle

nfsmountdb

nfsumountdb

Open Tasks

  • (bug): add assert for install_from_nfs, nfs_server_sw, nfs_server_sw_path
  • (bug): why do we need oracle_stage_remote?
  • (bug): is_sw_source_local really needed with default or as dependency from other vars?
  • (bug): Open Issue with changed behavior for _oraswgi_meta_configure_cluster
  • (bug): Variable hosgroup needs a refactoring
  • (bug): Check if shell_ps1 is used for oracle and grid
  • (bug): Check when shell_aliases is used in ansible-oracle and change description
  • (bug): check if assert for deploy_ocenv + ocenv_bashrc_init is existing
  • (information): variable description is missing
  • (information): variable description is missing
  • (information): db_homes_installed not used for a long time…
  • (information): variable description is missing
  • (information): variable description is missing
  • (todo): Remove variable _www_download_bin

Dependencies

  • orahost_meta
  • orasw_meta_internal

License

license (MIT)

Author

[Thorsten Bruhns]

Last modified November 13, 2026: orasw_meta: oracle_install_version_gi 26ai by default, OPatch for 26ai (72f6b5db)