For the complete documentation index, see llms.txt. This page is also available as Markdown.

Standalone variables

This table describes all the fields available in the YaK and their purpose when declaring your Oracle 2.1.0 standalone component.

Name
Mandatory
Purpose
Example

Version of the Oracle instance

Version of the release update to install. Default value: 19_26_250121_JVM_v0

19_26_250121_JVM_v0

Oracle Software Edition

Oracle Software Edition to install (Standard Edition or Enterprise Edition).

SE2

Instance name (oracle_sid)

This is the Oracle SID.

CDB1

Instance unique name

Unique name of the database.

CDB1_SITE1

Domain name

Fully qualified name of the domain (db_domain).

example.com

Character Set

Character Set of the database. Default value: AL32UTF8

AL32UTF8

National Character Set

National Character Set of the database. Default value: AL16UTF16

AL16UTF16

RMAN connect string

Connect string to use for RMAN backups. Default value: /

/

PDB Configuration

Name
Mandatory
Purpose
Example

PDB (Max. 3)

List of PDBs to be created. A maximum of 3 PDBs is allowed without the corresponding license and on Cloud providers other than OCI

  • PDB1

  • PDB2

  • PDB3

PDB Admin username

Admin user for all the PDBs. Default value: PDBADMIN

JOHN

PDB Admin password

Password for the PDB admin user. Default value: manager

6CZCkjfM

OFA

Name
Mandatory
Purpose
Example

Oracle base directory

Base directory for Oracle software.

Default value: /u01/app/oracle

/u00/app/oracle

Oracle inventory directory

Directory for Oracle inventory (oraInventory). Default value: /u01/app/oraInventory

/u00/app/oraIventory

Data files directory

Directory for Oracle data files. Default value: /u02/oradata

/oradata

Redo log files directory

First location for Oracle redo log files and control file. Default value: /u03/oradata

/u02/oradata

Second Redo log files directory

Second location for Oracle redo log files and control file (multiplexing). Default value: /u04/oradata

/u90/fast_recovery_area

Fast Recovery Area (FRA) directory

/u90/fast_recovery_area

/u99/fra

TNS configuration

Name
Mandatory
Purpose
Example

Default domain for TNS alias

Domain name to use in TNS alias. By default, db_domain will be used.

example.com

Hostname for TNS alias

Hostname to use in TNS alias. Default value: localhost

localhost

Protocol for TNS alias

Protocol to use in TNS alias. Default value: TCP

TCP

Port for TNS alias

Port to use in TNS alias. Default value: 1521

1521

SQL*NET configuration

Name
Mandatory
Purpose
Example

SQL*Net default domain

Domain name to append to any unqualified service name (usually same as db_domain). By default, db_domain will be used.

example.com

SQL*Net server side encryption (SQLNET.ENCRYPTION_SERVER)

Enable server side encryption. Default value: TRUE

N/A

SQL*Net client side encryption (SQLNET.ENCRYPTION_CLIENT)

Enable client side encryption. Default value: TRUE

N/A

SQL*Net server side crypto checksum (SQLNET.CRYPTO_CHECKSUM_SERVER)

Enable server side crypto checksum. Default value: TRUE

N/A

SQL*Net client side crypto checksum (SQLNET.CRYPTO_CHECKSUM_CLIENT)

Enable client side crypto checksum. Default value: TRUE

N/A

Listener configuration

Name
Mandatory
Purpose
Example

Listener name

Name of the Oracle Listener (usually 'LISTENER' for the first Listener). Default value: LISTENER

LISTENER

Listener hostname FQDN

Hostname to set in the Oracle Listener. By default, the hostname of the server will be used.

linux_srv.example.com

Listener protocol

Listener port protocol to use. Default value: TCP

TCP

Listener port

Listener port to use. Default value: 1521

1521

RMAN backups notifications

Name
Mandatory
Purpose
Example

SMTP Server

IP or Hostname of the SMTP server or relay host dmk_dbbackup notifications.

smtp_server.example.com

Mail from

Email address from which the notifications are send.

oracle_server@example.com

Mail to

Comma separated list of email addresses to which the notifications are send.

dba@example.com, infra@example.com, admin@example.com

Mail subject prefix

Prefix to use for the mail subject.

dbi

Send notification on failure only

0 : always send notifications 1 : send notifications on failure only

1

Deploy A New Oracle Single Instance

Name
Mandatory
Purpose
Example

Golden Image (optional)

This is the golden image that will be used to install the Oracle binaries. It must be same version as the version of Oracle defined in the component.

The golden image must be located in the artifact repository and the full path must be specified. If not specified, the base release 19.3 will be used.

rdbms/oracle/gold_images/19c/LINUX.X64_19_21_231017_JVM_v0_db_home.zip

Patch An Existing Oracle Single Instance

Name
Mandatory
Purpose
Example

Oracle version

Target version to upgrade the Oracle database to. Default value: 19_26_250121_JVM_v0

19_26_250121_JVM_v0

Golden Image (optional)

This is the golden image that will be used to install the Oracle binaries. It must be same version as the version of Oracle selected above.

The golden image must be located in the artifact repository and the full path must be specified. If not specified, the base release 19.3 will be used.

rdbms/oracle/gold_images/19c/LINUX.X64_19_21_231017_JVM_v0_db_home.zip

Version to remove

Version of the Oracle home to remove after the patching is done. The home should not be removed if there are still databases assigned to it.

19_25_241015_JVM_v0

Force patching (AT YOUR OWN RISKS)

By default the patching will fail if there are invalid SYS or SYSTEM objects. Checking this checkbox will allow the patching even if there are invalid SYS/SYSTEM objects. Default value: FALSE

N/A

Last updated