ari_stark.ansible_oracle_modules.oracle_parameter (1.2.1) — module

Manage parameters in an Oracle database

| "added in version" 0.8.0 of ari_stark.ansible_oracle_modules"

Authors: Mikael Sandström (@oravirt), Ari Stark (@ari-stark)

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 manages parameters in an Oracle database.

Parameters value comparison is case sensitive, module wise. To avoid Ansible I(changed) state, check the case of the value.

Hidden parameters can be changed using sysdba privileges.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the value of db_recovery_file_dest
  oracle_parameter:
    hostname: remote-db-server
    service_name: orcl
    username: system
    password: manager
    name: db_recovery_file_dest
    value: '+FRA'
    state: defined
    scope: both
    sid: '*'
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set the value of db_recovery_file_dest_size
  oracle_parameter:
    hostname: remote-db-server
    service_name: orcl
    username: system
    password: manager
    name: db_recovery_file_dest_size
    value: 100G
    state: defined
    scope: both
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Reset the value of open_cursors
  oracle_parameter:
    hostname: remote-db-server
    service_name: orcl
    username: system
    password: manager
    name: open_cursors
    state: default
    scope: spfile

Inputs

    
sid:
    default: '*'
    description:
    - Specify the SID of the instance where the value will take effect.
    type: str

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

name:
    description:
    - Name of the parameter to change.
    required: true
    type: str

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

scope:
    choices:
    - both
    - memory
    - spfile
    default: both
    description:
    - Lets you specify when the change takes effect.
    - If I(scope=memory), takes effect immediatly but doesn't persist.
    - If I(scope=spfile), takes effect after next shutdown and persists.
    - If I(scope=both), takes effect immediatly and persists.
    type: str

state:
    choices:
    - absent
    - default
    - defined
    - present
    default: defined
    description:
    - The intended state of the parameter.
    - I(state=present) is synonymous of I(state=defined).
    - I(state=absent) is synonymous of I(state=default).
    type: str

value:
    aliases:
    - parameter
    description:
    - The value of the parameter.
    - I(value) is mandatory is I(state=defined).
    required: false
    type: str

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

Outputs

ddls:
  description: Ordered list of DDL requests executed during module execution.
  elements: str
  returned: always
  type: list