ibre5041.ansible_oracle_modules.oracle_db (3.2.0) — module

Install collection

Install with ansible-galaxy collection install ibre5041.ansible_oracle_modules:==3.2.0

Add to requirements.yml

  collections:
    - name: ibre5041.ansible_oracle_modules
      version: 3.2.0

Description

Create/delete a database using dbca

Stop/Start database

If a responsefile is available, it will be used. If initparams is defined, those will be attached to the createDatabase command

If no responsefile is created, the database will be created based on all other parameters

Requirements

• cx_Oracle

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create database
  oracle_db:
    oracle_home: '/oracle/u01/product/19.17.0.0'
    db_name: 'X01'
    db_unique_name: 'X01_A'
    sys_password: "{{ sys_password }}"
    #system_password:
    #dbsnmp_password:
    #template:
    db_options:
      JSERVER: True
      ORACLE_TEXT: False
      IMEDIA: False
      CWMLITE: False
      SPATIAL: False
      OMS: False
      APEX: False
      DV: False
    initparams:
      memory_target: 0
      memory_max_target: 0
      sga_target: 1500MB
      sga_max_size: 1500MB
    storage_type: ASM
    datafile_dest: +XDATA
    state: present
  become_user: oracle
  become: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Drop database
  oracle_db:
    oracle_home: '/oracle/u01/product/19.17.0.0'
    db_name: 'X01'
    sys_password: "{{ sys_password }}"
    state: absent

Inputs

    
amm:
    choices:
    - 'True'
    - 'False'
    default: false
    description: Should Automatic Memory Management be used (memory_target, memory_max_target)
    required: false

cdb:
    aliases:
    - container
    default: false
    description: Should the database be a container database
    required: false
    type: bool

omf:
    default: true
    description: Use OMF (Oracle manageded files)
    required: false
    type: bool

sid:
    aliases:
    - oracle_sid
    description:
    - Sid(System identifier) of newly created database
    - 'NOTE: Database can have SID, DB_NAME, DB_UNIQUE_NAME and Cluster resource name.
      DBCA is quite cryptic when generating these names'
    - When sid is omitted, db_name=TESTDB, db_unique_name=TESTDB_LA, ORACLE_SID becomes
      TESTDBLA1, Cluster resource name becomes testdb_la
    - db_unique_name has precedence over db_name when sid is not specified
    required: false

state:
    choices:
    - present
    - absent
    - stopped
    - started
    - restarted
    default: present
    description: The intended state of the database

db_name:
    aliases:
    - db
    - database_name
    - name
    description: The name of the database
    required: true

db_type:
    choices:
    - MULTIPURPOSE
    - OLTP
    - DATA_WAREHOUSING
    default: MULTIPURPOSE
    description: Default Type of database (MULTIPURPOSE, OLTP, DATA_WAREHOUSING)
    required: false

nodelist:
    default: On RAC cluster default value is a list of all nodes
    description: The list of nodes a RAC DB should be created on
    required: false

template:
    default: General_Purpose.dbc
    description: The template the database will be based off
    required: false

flashback:
    choices:
    - 'True'
    - 'False'
    default: false
    description: Enables flashback for the database
    required: false
    type: bool

listeners:
    default: None
    description: '...'
    required: false

archivelog:
    choices:
    - 'True'
    - 'False'
    default: false
    description: Puts the database is archivelog mode
    required: false
    type: bool

db_options:
    description:
    - 'JSERVER: true'
    - ORACLE_TEXT:false
    - 'IMEDIA: false'
    - 'CWMLITE: false'
    - 'SPATIAL: false'
    - 'OMS: false'
    - 'APEX: false'
    - 'DV: false'
    required: false
    type: dict

initparams:
    description:
    - List of key=value pairs
    - 'e.g. initparams: { "sga_target": "1GB", "sga_max_size": "1GB" }'
    required: false
    type: dict

oracle_home:
    aliases:
    - oh
    description:
    - The home where the database will be created
    - If not provided, environment variable ORACLE_HOME has to be set
    required: false

characterset:
    default: AL32UTF8
    description: The database characterset
    required: false

responsefile:
    default: None
    description: The name of responsefile
    required: true

storage_type:
    aliases:
    - storage
    choices:
    - FS
    - ASM
    default: FS
    description: Type of underlying storage (Filesystem or ASM)
    required: false

sys_password:
    aliases:
    - syspw
    - sysdbapassword
    - sysdbapw
    default: None
    description: Password for the sys user
    required: false

customscripts:
    description:
    - List of scripts to run after database is created
    - 'e.g customScripts: [/tmp/xxx.sql, /tmp/yyy.sql]'
    required: false

datafile_dest:
    aliases:
    - dfd
    description: Where the database files should be placed (ASM diskgroup or filesystem
      path)
    required: true

dbconfig_type:
    choices:
    - SI
    - RAC
    - RACONENODE
    default: SI on standalone, RAC on clustered environment
    description: Type of database (SI,RAC,RON)
    required: false

force_logging:
    choices:
    - 'True'
    - 'False'
    default: false
    description: Enables force logging for the Database
    required: false
    type: bool

db_unique_name:
    aliases:
    - dbunqn
    - unique_name
    default: None
    description: The database db_unique_name
    required: false

memory_totalmb:
    default:
    - '2048'
    description: The database total memory in MB. Defaults to 2G
    required: false

racone_service:
    aliases:
    - ron_service
    default: None
    description:
    - If dbconfig_type = RACONENODE, a service has to be created along with the DB. This
      is the name of that service
    - If no name is defined, the service will be called "{{ db_name }}_ronserv"
    required: false

dbsnmp_password:
    aliases:
    - dbsnmppw
    default: None
    description:
    - Password for the dbsnmp user
    - If not set, defaults to sys_password
    required: false

system_password:
    aliases:
    - systempw
    default: None
    description:
    - Password for the system user
    - If not set, defaults to sys_password
    required: false

memory_percentage:
    description: The database total memory in % of available memory
    required: false

recoveryfile_dest:
    aliases:
    - rfd
    default: None
    description: Where the database files should be placed (ASM diskgroup or filesystem
      path)
    required: false

default_tablespace:
    default: None
    description: Database default permanent tablespace (DEFAULT_PERMANENT_TABLESPACE)
    required: false

supplemental_logging:
    choices:
    - 'True'
    - 'False'
    default: false
    description: Enables supplemental (minimal) logging for the Database (basically 'add
      supplemental log data')
    required: false
    type: bool

default_tablespace_type:
    choices:
    - smallfile
    - bigfile
    default: bigfile
    description: Database default tablespace type (DEFAULT_TBS_TYPE)

default_temp_tablespace:
    default: None
    description: Database default temporary tablespace (DEFAULT_TEMP_TABLESPACE)
    required: false