ari_stark.ansible_oracle_modules.oracle_user (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 manages Oracle user/schema.

It can create, alter or drop users.

It can empty schemas (droping all its content).

It can change password of users ; lock/unlock and expire/unexpire accounts.

It can't be used to give privileges (refer to oracle_grant).

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: Create a new schema on a remote db by running the module on the controlmachine
  oracle_user:
    hostname: "remote-db-server"
    service_name: "orcl"
    username: "system"
    password: "manager"
    schema_name: "myschema"
    schema_password: "mypass"
    default_tablespace: "test"
    state: "present"

Scanned by Steampunk Spotter

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

- name: Drop a user on a remote db
  oracle_user:
    hostname: "remote-db-server"
    service_name: "orcl"
    username: "system"
    password: "manager"
    schema_name: "myschema"
    state: "absent"

Scanned by Steampunk Spotter

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

- name: Empty a schema on a remote db
  oracle_user:
    hostname: "remote-db-server"
    service_name: "orcl"
    username: "system"
    password: "manager"
    schema_name: "myschema"
    state: "empty"

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

state:
    choices:
    - absent
    - empty
    - present
    default: present
    description:
    - Specify the state of the user/schema.
    - If I(state=empty), the schema will be purged, but not dropped.
    - If I(state=absent), the tablespace will be droped, including all datafiles.
    type: str

locked:
    description:
    - Lock or unlock account.
    - If not specified for a new user, Oracle default will be used.
    required: false
    type: bool

expired:
    description:
    - Expire or unexpire account.
    - If not specified for a new user, Oracle default will be used.
    required: false
    type: bool

profile:
    description:
    - Profile of the user.
    - Profile must exist.
    - If not specified for a new user, Oracle default will be used.
    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

schema_name:
    aliases:
    - name
    description:
    - Name of the user to manage.
    required: true
    type: str

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

schema_password:
    description:
    - Password of the user account.
    - Required if I(authentication_type) is I(password).
    required: false
    type: str

default_tablespace:
    description:
    - Default tablespace for the user.
    - Tablespace must exist.
    - If not specified for a new user, Oracle default will be used.
    required: false
    type: str

authentication_type:
    choices:
    - external
    - global
    - no_authentication
    - password
    description:
    - Type of authentication for the user.
    - If not specified for a new user and no I(schema_password) is specified, there won't
      be authentication.
    - If not specified and I(schema_password) is specified, value will be forced to I(password).
    required: false
    type: str

temporary_tablespace:
    description:
    - Default temporary tablespace for the user.
    - Tablespace must exist.
    - If not specified for a new user, Oracle default will be used.
    required: false
    type: str

Outputs

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