orasw_meta_internal

Meta role used to store internal variables from ansible-oracle.

Do not use any of the variables in your inventory!

This will create issues and problems in ansible-oracle and is not supported.

Table of contents

Requirements

  • Minimum Ansible version: 2.16.0

Default Variables

_db_password_cdb

The variable is internal used only.

Do not set it in inventory!

Default value

_db_password_cdb: _internal_used_

_db_password_pdb

The variable is internal used only.

Do not set it in inventory!

Default value

_db_password_pdb: _internal_used_

_db_service_name

The variable is internal used only.

Do not set it in inventory!

Default value

_db_service_name: _internal_used_

_db_service_pdb

The variable is internal used only.

Do not set it in inventory!

Get the service_name for a PDB.

Requires opdb as loop_var.

Default value

_db_service_pdb: _internal_used_

_db_unique_name_for_pdb

The variable is internal used only.

Do not set it in inventory!

get db_unique_name from CDB for current pdb Requires opdb as loop_var.

Default value

_db_unique_name_for_pdb: _internal_used_

_grid_env

The variable is used for shell, command tasks to set environment Variables.

Do not set it in inventory!

Default value

_grid_env:
  ORACLE_HOME: '{{ oracle_home_gi }}'
  LD_LIBRARY_PATH: '{{ oracle_home_gi }}/lib'

_listener_port_cdb

The variable is internal used only.

Do not set it in inventory!

Default value

_listener_port_cdb: _internal_used_

_listener_port_pdb

The variable is internal used only.

Do not set it in inventory!

Default value

_listener_port_pdb: _internal_used_

_odb_loop_helper

The variable is internal used only.

Do not set it in inventory!

Default value

_odb_loop_helper: _internal_used_

_odb_standby_archivelog_deletion_policy

The variable is internal used only.

Do not set it in inventory!

RMAN CONFIGURE ARCHIVELOG DELETION POLICY TO <value> of the current member: archivelog_deletion_policy of the member or of the configuration (mandatory, checked by orasw_meta).

Default value

_odb_standby_archivelog_deletion_policy: _internal_used_

_odb_standby_config

The variable is internal used only.

Do not set it in inventory!

Entry of db_standby_config referenced by standby_config of the current database (_odb_loop_helper). Empty dictionary for a database without standby_config.

Default value

_odb_standby_config: _internal_used_

_odb_standby_create_method

The variable is internal used only.

Do not set it in inventory!

Method for the creation of the standby database of the current member: create_method of the member, of the configuration or rman_duplicate_active.

Default value

_odb_standby_create_method: _internal_used_

_odb_standby_member

The variable is internal used only.

Do not set it in inventory!

Member of _odb_standby_config for the current database and host: member with inventory_hostname in hosts, db_unique_name decides when more than 1 member matches. Empty dictionary when no or more than 1 member matches (checked by the asserts in orasw_meta).

Default value

_odb_standby_member: _internal_used_

_odb_standby_others

The variable is internal used only.

Do not set it in inventory!

All other members of _odb_standby_config (without _odb_standby_member).

Default value

_odb_standby_others: _internal_used_

_opdb_home

Default value

_opdb_home: "{{ (oracle_databases | selectattr('oracle_db_name', 'equalto', _opdb_loop_helper['cdb']))[0]['home'] }}"

_opdb_loop_helper

The variable is internal used only.

Do not set it in inventory!

Default value

_opdb_loop_helper: _internal_used_

_oracle_all_editions_options

Defines linkable options available for all editions of oracle database (e.g. Unified auditing, DirectNFS) Dictionary key (dnfs, uniaud, etc.), suffixed by _on/_off, must match the make target in {{ oracle_home_db }}/rdbms/lib/ins_rdbms.mk match_file: File relative to {{ oracle_home_db }} where to grep for current state of the option enabled_matches: Pattern that matches in match_file if option currently is enabled

_oracle_db_instance_name

The variable is internal used only.

Do not set it in inventory!

Default value

_oracle_db_instance_name: _internal_used_

_oracle_db_unique_name

The variable is internal used only.

Do not set it in inventory!

Default value

_oracle_db_unique_name: _internal_used_

_oracle_ee_opiton_dict

This is an internal variable in ansible-oracle.

IMPORTANT

Do not set this variable in inventory, set_fact …!

Default value

_oracle_ee_opiton_dict:
  11.2.0.4: '{{ oracle_ee_options_112 }}'
  12.1.0.1: '{{ oracle_ee_options_121 }}'
  12.1.0.2: '{{ oracle_ee_options_121 }}'
  12.2.0.1: '{{ oracle_ee_options_122 }}'
  18.3.0.0: '{{ oracle_ee_options_183 }}'
  19.3.0.0: '{{ oracle_ee_options_193 }}'
  21.3.0.0: '{{ oracle_ee_options_213 }}'
  26.1.0.0: '{{ oracle_ee_options_261 }}'

_oracle_ee_options_link

This is an internal variable in ansible-oracle.

Maps the chopt option names from oracle_ee_options_* to the make target in $ORACLE_HOME/rdbms/lib/ins_rdbms.mk (suffixed by _on/_off) and to the object in libknlopt.a, which is present when the option is enabled. All options are linked by one make call with a single ioracle at the end.

IMPORTANT

Do not set this variable in inventory, set_fact …!

Default value

_oracle_ee_options_link:
  oaa:
    make_target: dm
    match_file: rdbms/lib/libknlopt.a
    enabled_matches: \bdmwdm\.
  olap:
    make_target: olap
    match_file: rdbms/lib/libknlopt.a
    enabled_matches: \bxsyeolap\.
  partitioning:
    make_target: part
    match_file: rdbms/lib/libknlopt.a
    enabled_matches: \bkkpoban\.
  rat:
    make_target: rat
    match_file: rdbms/lib/libknlopt.a
    enabled_matches: \bkecwr\.

_oracle_ee_options_valid

This is an internal variable in ansible-oracle.

Options from _oracle_ee_options_link, which are valid for a release. Same as the options in $ORACLE_HOME/bin/chopt.ini. 26ai has no oaa and olap anymore.

IMPORTANT

Do not set this variable in inventory, set_fact …!

Default value

_oracle_ee_options_valid:
  19.3.0.0: [oaa, olap, partitioning, rat]
  21.3.0.0: [oaa, olap, partitioning, rat]
  26.1.0.0: [partitioning, rat]

_oracle_env

The variable is used for shell, command tasks to set environment Variables.

Do not set it in inventory!

Default value

_oracle_env:
  ORACLE_HOME: '{{ _oracle_home_db }}'
  LD_LIBRARY_PATH: '{{ _oracle_home_db }}/lib'

_oracle_env_pdb

Default value

_oracle_env_pdb:
  ORACLE_HOME: '{{ _oracle_home_db_pdb }}'
  LD_LIBRARY_PATH: '{{ _oracle_home_db_pdb }}/lib'

_oracle_home_db

This is an internal variable in ansible-oracle.

Do not set it in inventory!

Default value

_oracle_home_db: _internal_used_

_oracle_home_db_pdb

Default value

_oracle_home_db_pdb: "{{ db_homes_config[_opdb_home]['oracle_home'] }}"

_orasw_meta_standby_sid

The variable is internal used only.

Do not set it in inventory!

ORACLE_SID of the current database (_odb_loop_helper).

Default value

_orasw_meta_standby_sid: _internal_used_

cluster_master

Default value

cluster_master: '{{ ansible_play_batch[0] }}'

db_mode

Default value

db_mode: sysdba

db_password

Default value

db_password: >-
  {% if dbpasswords is defined
      and dbpasswords[item.oracle_db_name] is defined
      and dbpasswords[item.oracle_db_name][db_user] is defined -%}
    {{- dbpasswords[item.oracle_db_name][db_user] }}
  {%- else %}{{ default_dbpass }}
  {%- endif %}

db_service_name

Deprecated: since v4.0.0

Default value

db_service_name: '{% if item is defined -%} {%- if item.oracle_db_unique_name is defined -%}{{ item.oracle_db_unique_name }}{%- elif item.oracle_db_instance_name is defined -%}{{ item.oracle_db_instance_name }}{%- else -%}{{ item.oracle_db_name }}{%- endif -%}{%- endif %}'

db_user

Default value

db_user: sys

db_version

This is an internal variable in ansible-oracle.

IMPORTANT

Do not set this variable in inventory, set_fact …!

Deprecated: since v4.0.0

Default value

db_version: _unset_

grid_env

The variable is used for shell, command tasks to set environment Variables.

Do not set it in inventory!

Deprecated: since v4.0.0

Default value

grid_env:
  ORACLE_HOME: '{{ oracle_home_gi }}'
  LD_LIBRARY_PATH: '{{ oracle_home_gi }}/lib'

listener_home

Deprecated: since v4.0.0

Default value

listener_home: "{%- if lsnrinst is defined -%}{%- if db_homes_config[lsnrinst.home]['oracle_home'] is defined -%}{{ db_homes_config[lsnrinst.home]['oracle_home'] }}{%- else -%}{{ oracle_base }}/{{ db_homes_config[lsnrinst.home]['version'] }}/{{ db_homes_config[lsnrinst.home]['home'] }}{%- endif -%}{%- endif -%}"

listener_port_template

Deprecated: since v4.0.0

Default value

listener_port_template: '{% if item.listener_port is defined %}{{ item.listener_port }}{% else %}{{ listener_port }}{% endif %}'

listener_protocols

Deprecated: since v4.0.0

Default value

listener_protocols: TCP

ocm_response_file

Default value

ocm_response_file: '{{ oracle_patch_stage }}/{{ db_version }}/ocm.rsp'

oracle_all_editions_options

Default value

oracle_all_editions_options:
  26.1.0.0: &261_all_editions_options
    dnfs:
      match_file: rdbms/lib/odm/libnfsodm??.so
      enabled_matches: .*
    uniaud:
      match_file: rdbms/lib/libknlopt.a
      enabled_matches: \bkzaiang\.
  21.3.0.0:
    <<: *261_all_editions_options
  19.3.0.0:
    <<: *261_all_editions_options
  18.3.0.0:
    <<: *261_all_editions_options
  12.2.0.1:
    <<: *261_all_editions_options
  12.1.0.2:
    <<: *261_all_editions_options
  12.1.0.1:
    <<: *261_all_editions_options
  11.2.0.4: &1124_all_editions_options
    dnfs:
      match_file: rdbms/lib/odm/libnfsodm??.so
      enabled_matches: .*
  11.2.0.3:
    <<: *1124_all_editions_options

oracle_env

The variable is used for shell, command tasks to set environment Variables.

Do not set it in inventory!

Deprecated: since v4.0.0

Default value

oracle_env:
  ORACLE_HOME: '{{ oracle_home_db }}'
  LD_LIBRARY_PATH: '{{ oracle_home_db }}/lib'

oracle_env_lsnrctl

The variable is used for shell, command tasks to set environment Variables.

Do not set it in inventory!

Deprecated: since v4.0.0

Default value

oracle_env_lsnrctl:
  ORACLE_BASE: '{{ oracle_base }}'
  ORACLE_HOME: '{{ listener_home }}'
  LD_LIBRARY_PATH: '{{ listener_home }}/lib'
  PATH: '{{ listener_home }}/bin:$PATH:/usr/local/bin:/bin:/sbin:/usr/bin:/usr/sbin'

oracle_home_db

This is an internal variable in ansible-oracle.

The variable is deprecated and removed in a future version.

IMPORTANT

Do not set this variable in inventory, set_fact …!

Deprecated: since v4.0.0

Default value

oracle_home_db: _unset_

oracle_home_gi

Custom setting for CRS_HOME.

The default value depends on _oraswgi_meta_configure_cluster and oracle_home_gi_cl or oracle_home_gi_so.

Default value

oracle_home_gi: '{% if oracle_install_version_gi is defined -%}{%- if _oraswgi_meta_configure_cluster -%}{{ oracle_home_gi_cl }}{%- else -%}{{ oracle_home_gi_so }}{%- endif -%}{%- endif %}'

oracle_patch_install

Default value

oracle_patch_install: '{% if not oracle_sw_copy | bool and not oracle_sw_unpack | bool %}{{ oracle_patch_stage_remote }}{% else %}{{ oracle_patch_stage }}{% endif %}'

oracle_patch_stage

Default value

oracle_patch_stage: '{{ oracle_stage }}/patches'

oracle_patch_stage_remote

Default value

oracle_patch_stage_remote: '{{ oracle_stage_remote }}/patches'

oracle_stage_install

This is an internal variable. Do not set it in Inventory.

Default value

oracle_stage_install: '{% if not oracle_sw_copy | bool and not oracle_sw_unpack | bool %}{{ oracle_stage_remote }}{% else %}{{ oracle_stage }}{% endif %}'

oracle_sw_copy

Default value

oracle_sw_copy: '{{ not (install_from_nfs | bool) }}'

oracle_sw_extract_path

Default value

oracle_sw_extract_path: "{%- if '18' in db_version -%}{{ oracle_home_db }}{%- else -%}{{ oracle_stage }}/{{ item[0].version }}{%- endif -%}"

oracle_sw_unpack

Default value

oracle_sw_unpack: '{{ not (install_from_nfs | bool) }}'

Dependencies

None.

License

license (MIT)

Author

[Thorsten Bruhns]

Last modified November 12, 2026: oraswdb_install: link database options with one relink of oracle (99395007)