ansible-oracle-modules

Oracle modules for Ansible

• This project was forked from https://github.com/oravirt/ansible-oracle-modules
• This fork uses different layout than original, db connection code is shared via module_utils
• This fork preffers to use connect / as sysdba over using a wallet
• This fork uses oracle_oratab module to store list of databases as ansible facts

See project: https://github.com/ibre5041/automation-infra/tree/master/etc.ansible as an example. To use the modules, import it as submodule and then create two symlinks in your project:

• library -> ansible-oracle-modules/library
• module_utils -> ansible-oracle-modules/module_utils Then just reference them as you would any other module. For more information, check out: http://docs.ansible.com/developing_modules.html

Most (if not all) requires cx_Oracle either on your controlmachine or on the managed node.

The default behaviour for the modules using cx_Oracle is this:

• If mode=='sysdba' connect internal / as sysdba is used
• If neither username or password is passed as input to the module(s), the use of an Oracle wallet is assumed.
• In that case, the cx_Oracle.makedsn step is skipped, and the connection will use the '/@<service_name>' format instead.
• You then need to make sure that you're using the correct tns-entry (service_name) to match the credential stored in the wallet.

These are the different modules: oracle_oratab

pre-req: cx_Oracle

• parses oratab, crs_stat output to get list of databases

• set facts as list of dict

  vars:
  # See list of affected databases, this variable overrides default: sid_list.oracle_list.keys()
  # db_list | default(sid_list.oracle_list.keys())
  # Comment out this variable to apply playbook onto all databases
     db_list: [ TEST ]
  
  tasks:
    - oracle_oratab:
      register: sid_list
    - name: Print Facts
      debug:
        var: sid_list
    - oracle_role:
      mode: sysdba
        role: SOME_ROLE
      environment:
        ORACLE_HOME: "{{ sid_list.oracle_list[item].ORACLE_HOME }}"
        ORACLE_SID:  "{{ sid_list.oracle_list[item].ORACLE_SID }}"
      loop: "{{ db_list | default(sid_list.oracle_list.keys())}}"
  

oracle_user

pre-req: cx_Oracle

• Creates & drops a user.
• Grants privileges only (can not remove them with oracle_user, use oracle_grants for that)

oracle_tablespace

pre-req: cx_Oracle

• Manages normal(permanent), temp & undo tablespaces (create, drop, make read only/read write, offline/online)
• Tablespaces can be created as bigfile, autoextended

oracle_grants

pre-req: cx_Oracle

• Manages privileges for a user
• Grants/revokes privileges
• Handles roles/sys privileges properly. Does NOT yet handle object privs. They can be added but they are not considered while revoking privileges
• The grants can be added as a string (dba,'select any dictionary','create any table'), or in a list (ie.g for use with with_items)

oracle_role

pre-req: cx_Oracle

• Manages roles in the database

oracle_parameter

pre-req: cx_Oracle

• Manages init parameters in the database (i.e alter system set parameter...)
• Also handles underscore parameters. That will require using mode=sysdba, to be able to read the X$ tables needed to verify the existence of the parameter.

Note: When specifying sga-parameters the database requests memory based on granules which are variable in size depending on the size requested, and that means the database may round the requested value to the nearest multiple of a granule. e.g sga_max_size=1500M will be rounded up to 1504 (which is 94 granules of 16MB). That will cause the displayed value to be 1504M, which has the effect that the next time the module is is run with a desired value of 1500M it will be changed again. So that is something to consider when setting parameters that affects the SGA.

oracle_services

pre-req: cx_Oracle (if GI is not running)

• Manages services in an Oracle database (RAC/Single instance)

Note: At the moment, Idempotence only applies to the state (present,absent,started, stopped). No other options are considered.

oracle_pdb

pre-req: cx_Oracle

• Manages pluggable databases in an Oracle container database
• Creates/deletes/opens/closes the pdb
• saves the state if you want it to. Default is yes
• Can place the datafiles in a separate location

oracle_sql

pre-req: cx_Oracle

• 2 modes: sql or script
• Executes arbitrary sql or runs a script

Note: Should be considered as experimental, or an alpha-release

oracle_asmdg

pre-req: cx_Oracle

• Manages ASM diskgroup state. (absent/present)
• Takes a list of disks and makes sure those disks are part of the DG. If the disk is removed from the disk it will be removed from the DG.
• Also manages attributes

Note:

• Supports redundancy levels, but does not yet handle specifying failuregroups

oracle_asmvol

• Manages ASM volumes. (absent/present)

oracle_ldapuser

pre-req: cx_Oracle, ldap, re

• Syncronises users/role grants from LDAP/Active Directory to the database

oracle_privs

pre-req: cx_Oracle, re

• Manages system and object level grants
• Object level grant support wildcards, so now it is possible to grant access to all tables in a schema and maintain it automatically!

oracle_jobclass

pre-req: cx_Oracle

• Manages DBMS_SCHEDULER job classes

oracle_jobschedule

pre-req: cx_Oracle, re

• Manages DBMS_SCHEDULER job schedules

oracle_jobwindow

pre-req: cx_Oracle, datetime

• Manages DBMS_SCHEDULER windows

oracle_job

pre-req: cx_Oracle, re

• Manages DBMS_SCHEDULER jobs

oracle_rsrc_consgroup

pre-req: cx_Oracle, re

• Manages resource manager consumer groups including its mappings and grants

oracle_awr

pre-req: cx_Oracle, datetime

• Manages AWR snapshot settings

oracle_facts

pre-req: cx_Oracle

• Gathers facts about Oracle database

oracle_gi_facts

• Gathers facts about Grid Infrastructure cluster configuration

oracle_stats_prefs

pre-req: cx_Oracle

• Managing DBMS_STATS global preferences

oracle_redo

pre-rec: cx_Oracle

• Manage redo-groups and their size in RAC or single instance environments
• NOTE: For RAC environments, the database needs to be in ARCHIVELOG mode. This is not required for SI environments.

oracle_db

pre-rec: cx_Oracle

• Create/remove databases (cdb/non-cdb)
• Can be created by passing in a responsefile or just by using parameters