ari_stark.ansible_oracle_modules.oracle_facts (1.2.1) — module

Install collection

Install with ansible-galaxy collection install ari_stark.ansible_oracle_modules:==1.2.1

Add to requirements.yml

  collections:
    - name: ari_stark.ansible_oracle_modules
      version: 1.2.1

Description

This module returns some facts about Oracle database.

It has several subsets and will gather all subsets by default.

Requirements

• Python module cx_Oracle
• Oracle basic tools.

Usage examples

Scanned by Steampunk Spotter

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

- name: gather all database facts
  oracle_facts:
    hostname: "192.168.56.101"
    port: 1521
    service_name: "orcl"
    username: "system"
    password: "oracle"
  register: dbfacts

Scanned by Steampunk Spotter

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

- name: gather 'min' and 'parameter' facts
  oracle_facts:
    hostname: "192.168.56.101"
    port: 1521
    service_name: "orcl"
    username: "system"
    password: "oracle"
    gather_subset: "parameter"
  register: dbfacts

Scanned by Steampunk Spotter

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

- name: gather 'min', 'parameter' and 'tablespace' facts
  oracle_facts:
    hostname: "192.168.56.101"
    port: 1521
    service_name: "orcl"
    username: "system"
    password: "oracle"
    gather_subset:
        - "parameter"
        - "tablespace"
  register: dbfacts

Inputs

    
mode:
    choices:
    - normal
    - sysdba
    default: normal
    description:
    - This option is the database administration privileges.
    type: str

port:
    default: 1521
    description:
    - Specify the listening port on the database server.
    type: int

hostname:
    default: localhost
    description:
    - Specify the host name or IP address of the database server computer.
    type: str

password:
    description:
    - Set the password to use to connect the database server.
    - Must not be set if using Oracle wallet.
    type: str

username:
    aliases:
    - user
    description:
    - Set the login to use to connect the database server.
    - Must not be set if using Oracle wallet.
    type: str

oracle_home:
    description:
    - Define the directory into which all Oracle software is installed.
    - Define ORACLE_HOME environment variable if set.
    type: str

service_name:
    description:
    - Specify the service name of the database you want to access.
    required: true
    type: str

gather_subset:
    choices:
    - all
    - database
    - instance
    - min
    - option
    - parameter
    - pdb
    - rac
    - redolog
    - tablespace
    - userenv
    - user
    default: all
    description:
    - Specify the subset to gather.
    - I(min) and 'database' are aliases and will get the same facts.
    - I(all) will gather all possible facts.
    - Every other choice will lead to get I(min) facts and others asked for.
    elements: str
    type: list

Outputs

database:
  description: Contains content of v$database.
  elements: str
  returned: always
  type: dict
instance:
  description: Contains content of v$instance.
  elements: str
  returned: if I(instance) or I(all) is in requested subset.
  type: dict
options:
  description: Contains content of v$option.
  elements: str
  returned: if I(option) or I(all) is in requested subset.
  type: dict
parameters:
  description: Contains content of v$parameter.
  elements: dict
  returned: if I(parameter) or I(all) is in requested subset.
  type: dict
pdbs:
  description: Contains content of v$pdb.
  elements: dict
  returned: if I(pdb) or I(all) is in requested subset.
  type: list
racs:
  description: Contains content of gv$instance.
  elements: dict
  returned: if I(rac) or I(all) is in requested subset.
  type: list
redologs:
  description: Contains content of v$log.
  elements: dict
  returned: if I(redolog) or I(all) is in requested subset.
  type: list
tablespaces:
  description: Contains content of v$tablespace and v$datafile.
  elements: dict
  returned: if I(tablespace) or I(all) is in requested subset.
  type: list
temp_tablespaces:
  description: Contains content of v$tablespace and v$tempfile.
  elements: dict
  returned: if I(tablespace) or I(all) is in requested subset.
  type: list
userenv:
  description: Contains some data of current user.
  elements: str
  returned: if I(userenv) or I(all) is in requested subset.
  type: dict
users:
  description: Contains content of all_users.
  elements: dict
  returned: if I(user) or I(all) is in requested subset.
  type: list
version:
  description: Contains the database version
  returned: always
  type: str