Reference

Table of Contents

Classes

• ora_install: ora_install See the file "LICENSE" for the full license governing this code.
• ora_install::clear_caches: This class contains the puppet code that implements the default facter cache invainvalidationlidatin rules.
• ora_install::fact_caching: This class ensure's that the ora_install facts that can be cached and are cached with the correct settings.
• ora_install::prepareautostart: Prepare autostart of the database for linux.

Defined types

• ora_install::autostartdatabase: This defined type create's a startup script for the specified database and enables the service.
• ora_install::client: Installs the Oracle client software.
• ora_install::database: This defined type allows you to create or delete a database.
• ora_install::database_pluggable: Creates or delete a pluggable database.
• ora_install::dbactions: Defined type to start and stop a database.
• ora_install::goldengate: Installs the Oracle goldengate software.
• ora_install::installasm: Installs and configures Oracle grid.
• ora_install::installdb: You can use this class to install a working oracle database on your system.
• ora_install::installem: Installs the Oracle Enterprse Manager.
• ora_install::installem_agent: Installs the Oracle Enterprise Manager Agent.
• ora_install::net: Installs and configures Oracle SQL*Net
• ora_install::opatchupgrade: Installs or upgrades the specified version of the Oracle OPatch utility.
• ora_install::prepareautostart_for: Prepare autostart of the database for linux.
• ora_install::rcu: Install the repository for several Oracle Fusion products.
• ora_install::tnsnames: Manages an entry in a `tnsnames.
• ora_install::utils::dborainst: Internal utility to create the required Oracle directories.

Resource types

• db_control: control the database instance state like running,stop,restart
• db_directory_structure: add all the directories needed by the oracle db or asm installation
• db_listener: control the oracle db listener state like running,stop,restart
• db_opatch: This is the Oracle Patch process called OPatch
• db_rcu: This is the Oracle RCU ( Repository creation utility) installer type
• ora_home: This resource allows you to manage Oracle homes.
• ora_install: Start the setup for applying ora_install classes.
• ora_opatch: This resource allows you to manage opatch patches on a specific database home.
• ora_tab_entry: With this type you can manage entries in the systems oratab file. Here is an example on how to use this: ora_tab_entry { 'MYDB': en

Functions

• opatch_version: See the file "LICENSE" for the full license governing this code. Returns the the installed Opatch version for a specfied Oracle home
• ora_install::changed_oracle_home_for: See the file "LICENSE" for the full license governing this code. This function checks if the specified home, is the current home for the sp
• ora_install::opatch_version: See the file "LICENSE" for the full license governing this code. Returns the the installed Opatch version for a specfied Oracle home
• ora_install::ora_patches_installed: See the file "LICENSE" for the full license governing this code. This function checks if the specfied patches are installed. The patch list
• ora_install::ora_patches_missing: See the file "LICENSE" for the full license governing this code. This function checks if the specfied patches are installed. For type = db
• ora_install::ora_physical_patches: See the file "LICENSE" for the full license governing this code. This function parses a Hash of patches and looks for resources with sub_pa
• ora_install::oracle_exists
• ora_patches_installed: See the file "LICENSE" for the full license governing this code. This function checks if the specfied patches are installed. The patch list
• ora_physical_patches: See the file "LICENSE" for the full license governing this code. This function parses a Hash of patches and looks for resources with sub_pa
• oracle_exists

Data types

• Ora_install::DatabaseVersion
• Ora_install::ShortVersion
• Ora_install::Version

Tasks

• agent_action: Enable, disable or start a puppet agent run.
• apply_psu_db: Execute the PSU database update for specified SID.
• db_action: Execute an action pn the specified Oracle instance
• grid_action: Execute actions (stop/start) on Oracle Grid installations for patching.
• listener_action: Execute an action on the Oracle listener
• opatch_upgrade: Apply patch(es) to an Oracle home.
• restart: Restart the specified Oracle instance on the specified node
• shutdown: Shutdown the specified Oracle instance on the specified node
• startup: Startup the specified Oracle instance on the specified node
• switch_grid_home: Switch a running instance to an other already available Oracle home.
• switch_oracle_home: Switch a running instance to an other already available Oracle home.
• upgrade_db: Execute the database upgrade for specified SID.

Plans

• ora_install::install_grid_home_and_patch: This plan will install a new GRID_HOME and apply the specified patches to it.
• ora_install::install_oracle_home: This plan will install a new ORACLE_HOME.
• ora_install::install_oracle_home_and_patch: This plan will install a new ORACLE_HOME and apply the specified patches to it.
• ora_install::opatch_upgrade: This plan will install a new version of OPatch in specified ORACLE_HOME.
• ora_install::patch_home: This plan will install patches into specified home.
• ora_install::switch_home_and_apply_psu: This plan will switch an Oracle database to an already existing other ORACLE_HOME and apply the patches in the database.
• ora_install::switch_home_asm: This plan will switch an Grid Infrastructure installation to an already existing other GRID_HOME.

Classes

ora_install

ora_install

See the file "LICENSE" for the full license governing this code.

ora_install::clear_caches

ora_install::clear_caches

Whenever a certain set of Puppet classes or defined types is applied, it will clear the facter caches for those facts that are implemented.

See the file "LICENSE" for the full license governing this code.

ora_install::fact_caching

ora_install::fact_caching

You can change all TTL settings for the facts if an other setting is more fitting for your setup.

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::fact_caching class:

• enabled
• product_version_ttl
• opatch_version_ttl
• installed_patches_ttl
• running_processes_ttl
• defined_sids_ttl
• ora_install_inventory_loc_ttl

enabled

Data type: Boolean

When set to true, this enables facter caching for the ora_install module facts. Beware that you need to have Facter version 4.1.0 or higher to enabled this. When you set this value to true, automatically TTL settings for most of the ora_install facts are set to a default value. For most installations, the default settings are fine. When you set this value to true, the facter setting force-dot-resolution is enabled. You have to ensure that all of your facts keep on working with this setting.

product_version_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_homes. product_version part of the ora_install_homes fact.

opatch_version_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_homes. opatch_version part of the ora_install_homes fact.

installed_patches_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_homes. installed_patches part of the ora_install_homes fact.

running_processes_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_homes. running_processes part of the ora_install_homes fact.

defined_sids_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_homes. defined_sids part of the ora_install_homes fact.

ora_install_inventory_loc_ttl

Data type: Optional[String[1]]

The Time to Live for the ora_install_inventory_loc fact.

ora_install::prepareautostart

ora_install::prepareautostart

This class creates the script needed to start the database after a system reboot. It supports both systemd and the older startup scripts.

Here is an example on how to use it:

  class { 'class ora_install::prepareautostart':
    oracle_home  => '/oracle/db1',
    user         => 'oracle',
    service_name => 'start_db1',
  }

This class is a conveneance class around the defined type prepareautostart_for.

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::prepareautostart class:

• oracle_home
• user
• service_name
• logoutput

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

service_name

Data type: String[1]

The name of the init service to use. The default value is: dbora

Default value: 'dbora'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

Defined types

ora_install::autostartdatabase

ora_install::autostartdatabase

The end result is that the named Oracle database is restarted after a system restart.

Here is an example on how to use it:

ora_install::autostartdatabase{ 'autostart oracle':
  oracle_home             => '/oracle/product/12.1/db',
  user                    => 'oracle',
  db_name                 => 'test',
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::autostartdatabase defined type:

• db_domain
• db_name
• db_policy
• db_type
• group
• limits
• logoutput
• oracle_home
• service_name
• start_option
• systemd_template
• systemd_template_vars
• user

db_domain

Data type: Optional[String[1]]

The domain of the database.

Default value: undef

db_name

Data type: String[1]

The name of the database.

Default value: undef

db_policy

Data type: Enum['AUTOMATIC','MANUAL','NORESTART']

The srvctl management policy for the database Valid values are:

• AUTOMATIC
• MANUAL
• NORESTART The default value is: AUTOMATIC

Default value: 'AUTOMATIC'

db_type

Data type: Enum['database','grid']

The type of the database used to specify if the database should be started by an init script or srvctl. Valid values are:

• grid
• database The default value is: 'database'

Default value: 'database'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

limits

Data type: Optional[Hash]

The limits for the systemd service. The default value is: undef Below is an axample. Currently only the 'hard' values are used.

ora_install::autostartdatabase::limits:
  '*/nofile':
    soft: 2048
    hard: 8192
  'oracle/nofile':
    soft: 65536
    hard: 65536
  'oracle/nproc':
    soft: 2048
    hard: 16384
  'oracle/stack':
    soft: 10240
    hard: 32768

Default value: undef

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

service_name

Data type: String[1]

The service name to start.

Default value: 'dbora'

start_option

Data type: Enum['OPEN','MOUNT','READ ONLY']

The srvctl startup options for the database. Valid values are:

• OPEN
• MOUNT
• READ ONLY The default value is: OPEN

Default value: 'OPEN'

systemd_template

Data type: Optional[String[1]]

Use custom EPP template for systemd service The default value is: undef

Default value: undef

systemd_template_vars

Data type: Optional[Hash]

The variables to use when specifying a custom EPP template for systemd service The default value is: undef

Default value: undef

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

ora_install::client

ora_install::client

Using this defined type you can install the Oracle client software on your system.

Here is an example on how to use it:

ora_install::client{ '12.1.0.1_Linux-x86-64':
  version                   => '12.1.0.1',
  file                      => 'linuxamd64_12c_client.zip',
  oracle_base               => '/oracle',
  oracle_home               => '/oracle/product/12.1/client',
  user                      => 'oracle',
  group                     => 'dba',
  group_install             => 'oinstall',
  download_dir              => '/install',
  bash_profile              => true,
  puppet_download_mnt_point => "puppet:///modules/ora_install/",
  ora_inventory_dir         => '/oracle/product',
  logoutput                 => true,
}

support for multiple versions

This defined type has support for installing different versions of the client software on your system. In order to do this use the defined type multiple times in you manifest and use a different oracle_home and a different file.

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::client defined type:

• bash_profile
• db_port
• download_dir
• file
• group
• group_install
• logoutput
• ora_inventory_dir
• oracle_base
• oracle_home
• puppet_download_mnt_point
• temp_dir
• umask
• user
• user_base_dir
• version
• allow_insecure
• install_type
• install_options
• architecture

bash_profile

Data type: Boolean

Create a bash profile for the specified user or not. Valid values are true and false. When you specify a true for the parameter, Puppet will create a standard bash profile for the specified user. The bash profile will be placed in a directory named user_base_dir/user.

ora_install::client { 'Oracle client':
  ...
  bash_profile  => true,
  user          => 'oracle',
  user_base_dir => '/home',
  ...
}

This snippet will create a bash profile called /home/oracle/.bash_profile.

Default value: true

db_port

Data type: Integer

The IP port to use for database communication. The default value is: 1521

Default value: 1521

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

file

Data type: String[1]

The source file to use.

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

group_install

Data type: String[1]

The os group to use for installation. The default value is: oinstall

Default value: 'oinstall'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

oracle_base

Data type: Stdlib::Absolutepath

A directory to use as Oracle base directory.

Default value: undef

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

umask

Data type: String[1]

The umask to use for commands that run in the context of either the grid user or the oracle user. The default is 0022

Default value: '0022'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

user_base_dir

Data type: Stdlib::Absolutepath

The directory to use as base directory for the users.

Default value: '/home'

version

Data type: Ora_install::Version

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: undef

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

install_type

Data type: Enum['Administrator','Runtime','InstantClient','Custom']

Installation type of the Oracle client. The following choices are available. The value should contain only one of these choices:

- Administrator
- Runtime
- InstantClient
- Custom

The default is administrator.

Default value: 'Administrator'

install_options

Data type: Array[String]

The list of Client Components you would like to install. This property is considered only if INSTALL_TYPE is set to "Custom"

The following choices are available. You may specify any combination of these choices. The components you choose should be specified in the form "internal-component-name:version" Below is a list of components you may specify to install for Oracle 21.

• oracle.sqlj:21.0.0.0.0 -- "Oracle SQLJ"
• oracle.rdbms.util:21.0.0.0.0 -- "Oracle Database Utilities"
• oracle.javavm.client:21.0.0.0.0 -- "Oracle Java Client"
• oracle.sqlplus:21.0.0.0.0 -- "SQL*Plus"
• oracle.dbjava.jdbc:21.0.0.0.0 -- "Oracle JDBC/THIN Interfaces"
• oracle.ldap.client:21.0.0.0.0 -- "Oracle Internet Directory Client"
• oracle.rdbms.oci:21.0.0.0.0 -- "Oracle Call Interface (OCI)"
• oracle.precomp:21.0.0.0.0 -- "Oracle Programmer"
• oracle.xdk:21.0.0.0.0 -- "Oracle XML Development Kit"
• oracle.network.aso:21.0.0.0.0 -- "Oracle Advanced Security"
• oracle.oraolap.mgmt:21.0.0.0.0 -- "OLAP Analytic Workspace Manager and Worksheet"
• oracle.network.client:21.0.0.0.0 -- "Oracle Net"
• oracle.network.cman:21.0.0.0.0 -- "Oracle Connection Manager"
• oracle.network.listener:21.0.0.0.0 -- "Oracle Net Listener"
• oracle.ordim.client:21.0.0.0.0 -- "Oracle Multimedia Client Option"
• oracle.odbc:21.0.0.0.0 -- "Oracle ODBC Driver"
• oracle.dbdev:21.0.0.0.0 -- "Oracle SQL Developer"
• oracle.rdbms.scheduler:21.0.0.0.0 -- "Oracle Scheduler Agent"
• oracle.rdbms.drdaas:21.0.0.0.0 -- "Oracle Database Provider for DRDA"

Default value: []

architecture

Data type: Enum['client32','client']

The type of architecture client you want to install. This MUST match the file you are provinding to the installed. Valid values are:

• client
• client32 The default is client

Default value: 'client'

ora_install::database

ora_install::database

Under the hood the calls the dbca utility to do the work. When you need more control over the individual settings when creating the database, you must use the ora_database custom type of the ora_config module

Here is an example on how to use this defined type to create a database:

ora_install::database{ 'testDb_Create':
  action                    => 'create',
  oracle_base               => '/oracle',
  oracle_home               => '/oracle/product/11.2/db',
  version                   => '11.2',
  user                      => 'oracle',
  group                     => 'dba',
  download_dir              => '/install',
  action                    => 'create',
  db_name                   => 'test',
  db_domain                 => 'oracle.com',
  db_port                   => '1521',
  sys_password              => 'Welcome01',
  system_password           => 'Welcome01',
  data_file_destination     => "/oracle/oradata",
  recovery_area_destination => "/oracle/flash_recovery_area",
  character_set             => "AL32UTF8",
  nationalcharacter_set     => "UTF8",
  init_params               => {'open_cursors'        => '1000',
                                'processes'           => '600',
                                'job_queue_processes' => '4' },
  sample_schema             => 'TRUE',
  memory_percentage         => "40",
  memory_total              => "800",
  database_type             => "MULTIPURPOSE",
  em_configuration          => "NONE",
  require                   => Ora_install::Listener['start listener'],
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::database defined type:

• action
• asm_diskgroup
• asm_snmp_password
• character_set
• cluster_nodes
• container_database
• data_file_destination
• database_type
• db_conf_type
• db_domain
• db_name
• db_port
• db_snmp_password
• download_dir
• em_configuration
• group
• init_params
• logoutput
• memory_percentage
• memory_total
• nationalcharacter_set
• oracle_base
• oracle_home
• puppet_download_mnt_point
• recovery_area_destination
• recovery_diskgroup
• sample_schema
• storage_type
• sys_password
• system_password
• template
• template_type
• user
• memory_mgmt_type
• version

action

Data type: Enum['create','delete']

The action that must be taken. create or delete. Valid values are:

• create
• delete The default value is: create

Default value: 'create'

asm_diskgroup

Data type: String[1]

The ASM diskgroup to use for the database. The default value is: DATA

Default value: 'DATA'

asm_snmp_password

Data type: Optional[Easy_type::Password]

The password to use for the ASMSNMP user.

Default value: undef

character_set

Data type: String[1]

The character set to use for running the database. The default value is: AL32UTF8

Default value: 'AL32UTF8'

cluster_nodes

Data type: Optional[String[1]]

A comma seperated list of the nodes running in the RAC cluster. Example: node1,node2

Default value: undef

container_database

Data type: Boolean

Database is a container for pluggable databases. When you want to add pluggable database to this database, specify a value of true. The default value is: false

Default value: false

data_file_destination

Data type: Optional[String[1]]

The location of the data file's.

Default value: undef

database_type

Data type: Enum['MULTIPURPOSE','DATA_WAREHOUSING','OLTP']

The kind of database you want to create. Valid values are:

• MULTIPURPOSE
• DATA_WAREHOUSING
• OLTP The default value is: MULTIPURPOSE

Default value: 'MULTIPURPOSE'

db_conf_type

Data type: Enum['SINGLE','RAC','RACONE']

The type of database that needs to be installed. Valid values are:

• SINGLE
• RAC
• RACONE

Default value: 'SINGLE'

db_domain

Data type: Optional[String[1]]

The domain of the database.

Default value: undef

db_name

Data type: String[1]

The name of the database.

Default value: 'orcl'

db_port

Data type: Integer

The IP port to use for the database. The default value is: 1521

Default value: 1521

db_snmp_password

Data type: Optional[Easy_type::Password]

Password to use for the dbsnmp user.

Default value: undef

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

em_configuration

Data type: Enum['CENTRAL','LOCAL','ALL','NONE','DBEXPRESS','BOTH']

The type of Enterprise Manager configuration. Valid values are:

• CENTRAL (all versions)
• LOCAL (version < 12.2)
• ALL (version < 12.2)
• NONE (all versions)
• DBEXPRESS (version >= 12.2)
• BOTH (version >= 12.2) The default value is: NONE

Default value: 'NONE'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

init_params

Data type: Optional[Variant[String[1], Hash]]

The init parameters to use for the database. You can use either a comma separated string for init_params or a Hash.

Using comma separated string

Here is an example using a comma separated string:

ora_install::database{'my_database'
  ...
  init_params => "open_cursors=1000,processes=600,job_queue_processes=4",
  ...
}

Using a Hash

Here is an example using a Hash:

ora_install::database{'my_database'
  ...
  init_params  => {'open_cursors'        => '1000',
                  'processes'           => '600',
                  'job_queue_processes' => '4' },
  }
  ...
}

Default value: undef

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

memory_percentage

Data type: Integer

The percentage of physical memory for Oracle. The default value is: 40

Default value: 40

memory_total

Data type: Integer

The total memory in MB to allocate to Oracle. The default value is: 800

Default value: 1000

nationalcharacter_set

Data type: String[1]

Use this NLS Character set. The default value is: UTF8

Default value: 'AL16UTF16'

oracle_base

Data type: String[1]

A directory to use as Oracle base directory.

Default value: undef

oracle_home

Data type: String[1]

A directory to be used as Oracle home directory for this software.

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

recovery_area_destination

Data type: Optional[String[1]]

Location of the recovary files.

Default value: undef

recovery_diskgroup

Data type: Optional[String[1]]

Diskgroup to use for recovery files.

Default value: undef

sample_schema

Data type: Enum['TRUE','FALSE']

Load the sample schema or not. Attention This is a string and not a boolean value. The default value is: TRUE

Default value: 'TRUE'

storage_type

Data type: Enum['FS','CFS','ASM']

The storage type to use. Valid values are:

• FS
• CFS
• ASM FS

Default value: 'FS'

sys_password

Data type: Easy_type::Password

The password to use for the SYS user.

system_password

Data type: Easy_type::Password

The password to use for the SYSTEM user.

template

Data type: Optional[String[1]]

Use the specified template to create the database. You can choose between a set of pre-delivered templates, but also specify your own templates.

Using a pre-delivered template

ora_install delivers a few predefined templates.

• dbtemplate_11GR2
• dbtemplate_12.1
• dbtemplate_12.1_asm Here is an example on how to use this:

ora_install::database{ 'testDb_Create':
  ...
  template                  => 'dbtemplate_12.1',
  ...
}

Using your own template

When you specify a template name not pre-delivered by ora_install, the defined type will look in the directory specified by puppet_download_mnt_point for your own template. Here is an example:

  template                   => 'my_dbtemplate_11gR2_asm',
  puppet_download_mnt_point  => '/vagrant', # 'ora_install' etc

The template must be have the following extension dbt.erb like dbtemplate_12.1.dbt.erb

• Click here for an 12.1 db instance template example
• Click here for an 11.2 db asm instance template example

Default value: undef

template_type

Data type: Enum['non-seed','seed']

The template type DBCA uses. There are two types of templates:

• non-seed
• seed The default value is: non-seed

Default value: 'non-seed'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

memory_mgmt_type

Data type: Enum['AUTO','AUTO_SGA','CUSTOM_SGA']

The type of memory management to use for the database. The options are:

• AUTO
• AUTO_SGA
• CUSTOM_SGA The default is AUTO_SGA

Default value: 'AUTO_SGA'

version

Data type: Ora_install::ShortVersion

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: '12.2'

ora_install::database_pluggable

ora_install::database_pluggable

Under the hood, this defined type calls the dbca utility to create or delete a pluggable database in the specified source database.

Here is an example on how to create pluggable database:

ora_install::database_pluggable{'pdb1':
  ensure                   => 'present',
  version                  => '12.1',
  oracle_home_dir          => '/oracle/product/12.1/db',
  user                     => 'oracle',
  group                    => 'dba',
  source_db                => 'orcl',
  pdb_name                 => 'pdb1',
  pdb_admin_username       => 'pdb_adm',
  pdb_admin_password       => 'Welcome01',
  pdb_datafile_destination => "/oracle/oradata/orcl/pdb1",
  create_user_tablespace   => true,
  logoutput                => true,
}

Here is an example on how to remove a pluggable database:

ora_install::database_pluggable{'pdb1':
  ensure                   => 'absent',
  version                  => '12.1',
  oracle_home_dir          => '/oracle/product/12.1/db',
  user                     => 'oracle',
  group                    => 'dba',
  source_db                => 'orcl',
  pdb_name                 => 'pdb1',
  pdb_datafile_destination => "/oracle/oradata/orcl/pdb1",
  logoutput                => true,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::database_pluggable defined type:

• create_user_tablespace
• ensure
• group
• logoutput
• oracle_home_dir
• pdb_admin_password
• pdb_admin_username
• pdb_datafile_destination
• pdb_name
• source_db
• user
• version

create_user_tablespace

Data type: Boolean

Create a user tablespace in the PDB. The default value is: false

Default value: true

ensure

Data type: Enum[present,absent]

State to obtain. The ensure attribute can be one of two values:

• present
• absent When you specify present, Puppet will make sure the resource is available with all specified options and properties. When the resource is already available(installed), and all attributes are as the are specified, Puppet will do nothing. When you specify absent, Puppet will remove the resource if it is available. If it is not installed, Puppet will do nothing.

Default value: present

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

oracle_home_dir

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

pdb_admin_password

Data type: Easy_type::Password

Password for the admin user in the PDB.

Default value: undef

pdb_admin_username

Data type: String[1]

Username for the admin user in the pluggable database. The default value is: pdb_adm

Default value: 'pdb_adm'

pdb_datafile_destination

Data type: String[1]

The location where the PDB datafiles will be stored.

Default value: undef

pdb_name

Data type: String[1]

Name of the pluggable database.

Default value: undef

source_db

Data type: String[1]

The database name of the container(source) database.

Default value: undef

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

version

Data type: Enum['12.1','12.2', '18.0', '19.0', '21.0']

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: '12.1'

ora_install::dbactions

ora_install::dbactions

[DEPRECATED]

This is defined type to start or stop a database. Usage of this type is discouraged. Please use db_control for this function.

Here is an example on how to use this:

ora_install::dbactions{ 'stop testDb':
  db_name     => 'test',
  oracle_home => '/oracle/product/11.2/db',
  user        => 'oracle',
  group       => 'dba',
  action      => 'stop',
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::dbactions defined type:

• action
• db_name
• db_type
• grid_home
• group
• oracle_home
• user

action

Data type: Enum['running','start','stop','abort']

The action you want to take. Valid values are:

• start
• running
• stop
• abort Default value is: start

Default value: 'start'

db_name

Data type: String[1]

The database you want to do the action on.

Default value: 'orcl'

db_type

Data type: Enum['database','asm','grid']

The type of service you want to manage. Valid values are:

• database
• grid
• asm

Default value: 'database'

grid_home

Data type: Optional[Stdlib::Absolutepath]

The oracle home directory to use for the GRID software.

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

ora_install::goldengate

ora_install::goldengate

This module supports the following versions:

• 12.1.2
• 12.2.1
• 18.1.0
• 19.1.0
• 21.3.0

Here is an example on how to use this:

ora_install::goldengate{ 'ggate12.1.2':
  version                  => '12.1.2',
  file                     => '121200_fbo_ggs_Linux_x64_shiphome.zip',
  database_type            => 'Oracle',
  database_version         => 'ORA11g',
  database_home            => '/oracle/product/12.1/db',
  oracle_base              => '/oracle',
  goldengate_home          => "/oracle/product/12.1/ggate",
  manager_port             => 16000,
  user                     => 'ggate',
  group                    => 'dba',
  group_install            => 'oinstall',
  download_dir             => '/install',
  puppet_download_mnt_point => puppet://modules/software,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::goldengate defined type:

• database_home
• database_type
• database_version
• download_dir
• file
• goldengate_home
• group
• group_install
• logoutput
• manager_port
• oracle_base
• puppet_download_mnt_point
• temp_dir
• umask
• user
• version
• allow_insecure
• ora_inventory_dir

database_home

Data type: Stdlib::Absolutepath

The home directory of the database.

Default value: undef

database_type

Data type: Enum['Oracle']

The type of database. The default value is: Oracle

Default value: 'Oracle'

database_version

Data type: Ora_install::DatabaseVersion

The version of the database. Valid values are:

• ORA11g
• ORA12c
• ORA18c
• ORA19c Default version is ORA11g

Default value: 'ORA11g'

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

file

Data type: String[1]

The file containing the software.

Default value: undef

goldengate_home

Data type: Stdlib::Absolutepath

The home to use for the goldengate software.

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

group_install

Data type: String[1]

The os group to use for installation. The default value is: oinstall

Default value: 'oinstall'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

manager_port

Data type: Integer

The IP port number of the manager. This is a required value.

Default value: undef

oracle_base

Data type: Stdlib::Absolutepath

A directory to use as Oracle base directory.

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

umask

Data type: String[1]

The umask to use for commands that run in the context of either the grid user or the oracle user. The default is 0022

Default value: '0022'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'ggate'

version

Data type: Enum['12.1.2','12.2.1', '12.3.0','18.1.0', '19.1.0', '21.3.0']

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: '12.3.0'

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

ora_install::installasm

ora_install::installasm

This defined class supports the following versions of grid:

• 11.2.0.4
• 12.1.0.1
• 12.1.0.2
• 12.2.0.1
• 18.0.0.0
• 19.0.0.0 (and all sub versions)
• 21.0.0.0 (and all sub versions)

Here is an example on how to use this:

ora_install::installasm{ 'db_linux-x64':
  version                   => hiera('db_version'),
  file                      => hiera('asm_file'),
  grid_type                 => 'HA_CONFIG',
  grid_base                 => hiera('grid_base_dir'),
  grid_home                 => hiera('grid_home_dir'),
  ora_inventory_dir         => hiera('oraInventory_dir'),
  user_base_dir             => '/home',
  user                      => hiera('grid_os_user'),
  group                     => 'asmdba',
  group_install             => 'oinstall',
  group_oper                => 'asmoper',
  group_asm                 => 'asmadmin',
  sys_asm_password          => 'Welcome01',
  asm_monitor_password      => 'Welcome01',
  asm_diskgroup             => 'DATA',
  disk_discovery_string     => "/nfs_client/asm*",
  disks                     => "/nfs_client/asm_sda_nfs_b1,/nfs_client/asm_sda_nfs_b2",
  # disk_discovery_string   => "ORCL:*",
  # disks                   => "ORCL:DISK1,ORCL:DISK2",
  disk_redundancy           => "EXTERNAL",
  download_dir              => hiera('oracle_download_dir'),
  remote_file               => false,
  puppet_download_mnt_point => hiera('oracle_source'),
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::installasm defined type:

• asm_diskgroup
• asm_monitor_password
• cluster_name
• cluster_nodes
• configure_afd
• disk_au_size
• disk_discovery_string
• disk_redundancy
• disks_failgroup_names
• bash_profile
• bash_additions
• disks
• download_dir
• file
• gimr_configure
• gimr_dg_ausize
• gimr_dg_disks
• gimr_dg_disks_failgroup_names
• gimr_dg_fg_names
• gimr_dg_name
• gimr_dg_redundancy
• grid_base
• grid_home
• grid_type
• group
• group_asm
• group_install
• group_oper
• logoutput
• network_interface_list
• ora_inventory_dir
• puppet_download_mnt_point
• scan_name
• scan_port
• stand_alone
• storage_option
• sys_asm_password
• temp_dir
• user
• umask
• user_base_dir
• version
• zip_extract
• install_task
• gimr_dg
• allow_insecure

asm_diskgroup

Data type: String[1]

The name of the ASM diskgroup to use. DATA

Default value: 'DATA'

asm_monitor_password

Data type: Easy_type::Password

The password for the ASMSNMP user for monitoring in EM.

cluster_name

Data type: Optional[String[1]]

The name of the cluster.

Default value: undef

cluster_nodes

Data type: Optional[String[1]]

The names of the nodes in the RAC cluster. Valid values are:

• node1:node1-vip,node2:node2-vip (version >= 11 <= 12.1)
• node1:node1-vip:HUB,node2:node2-vip:LEAF (version >= 12.1 Flex Cluster)
• node1,node2 (version = 12.2 Application Cluster)
• node1:node1-vip:HUB:site1,node2:node2-vip:HUB:site2 (version = 12.2 Extended Cluster)

Default value: undef

configure_afd

Data type: Boolean

Specify whether or not to configure ASM Filter Driver instead of ASMLib. The default value is: false

Default value: false

disk_au_size

Data type: Enum['1','2','4','8','16','32','64']

The disk_au size to use for the ASM disks. Attention this is a String value not an Integer. The default value is: 1

Default value: '1'

disk_discovery_string

Data type: Optional[String[1]]

The search string to use for discovering disks for ASM.

Default value: undef

disk_redundancy

Data type: Enum['NORMAL','HIGH','EXTERNAL']

The type of redundancy to use. Valid values are:

• NORMAL
• HIGH
• EXTERNAL The default value is: NORMAL

Default value: 'NORMAL'

disks_failgroup_names

Data type: Optional[String[1]]

A comma seperated list of device and failure group name. Valid values are:

• /dev/sdb,CRSFG1,/dev/sdc,CRSFG2,/dev/sdd,CRSFG3 (NORMAL redundancy)
• /dev/sdb,,/dev/sdc,,/dev/sdd,,/dev/sde, (EXTERNAL redundancy)
• /dev/sdb,CRSFG1,/dev/sdc,CRSFG2,/dev/sdd,CRSFG3,/dev/sde,CRSFG4,/dev/sdf,CRSFG5 (HIGH redundancy)

Default value: undef

bash_profile

Data type: Boolean

Create a bash profile for the specified user or not. Valid values are true and false. When you specify a true for the parameter, Puppet will create a standard bash profile for the specified user. The bash profile will be placed in a directory named user_base_dir/user.

ora_install::client { 'Oracle client':
  ...
  bash_profile  => true,
  user          => 'oracle',
  user_base_dir => '/home',
  ...
}

This snippet will create a bash profile called /home/oracle/.bash_profile.

Default value: true

bash_additions

Data type: String

The text to add at the end of the bash_profile. This parameter will only be used when you have specified true for the parameter bash_profile The default value is an empty string.

Default value: ''

disks

Data type: Optional[String[1]]

List of disks to create a ASM DiskGroup.

Default value: undef

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

file

Data type: String[1]

The source file to use.

Default value: undef

gimr_configure

Data type: Boolean

Specify whether or not to configure GIMR database (MGMTDB), 19c and higher only. The default value is: false

Default value: false

gimr_dg_ausize

Data type: Enum['1','2','4','8','16','32','64']

The disk_au size to use for the for the GIMR database (MGMTDB) diskgroup. Attention this is a String value not an Integer. The default value is: 1

Default value: '1'

gimr_dg_disks

Data type: Optional[String[1]]

List of disks to create the GIMR database (MGMTDB).

Default value: undef

gimr_dg_disks_failgroup_names

Data type: Optional[String[1]]

A comma seperated list of device and failure group name for the GIMR database (MGMTDB). Valid values are:

• /dev/sdb,GIMRFG1,/dev/sdc,GIMRFG2,/dev/sdd,GIMRFG3 (NORMAL redundancy)
• /dev/sdb,,/dev/sdc,,/dev/sdd,,/dev/sde, (EXTERNAL redundancy)
• /dev/sdb,GIMRFG1,/dev/sdc,GIMRFG2,/dev/sdd,GIMRFG3,/dev/sde,GIMRFG4,/dev/sdf,GIMRFG5 (HIGH redundancy)

Default value: undef

gimr_dg_fg_names

Data type: Optional[String[1]]

Failure Groups for the GIMR storage data ASM disk group.

Default value: undef

gimr_dg_name

Data type: Optional[String[1]]

Specify the name of the diskgroup for the GIMR database (MGMTDB), 12. 2 and up only.

Default value: undef

gimr_dg_redundancy

Data type: Optional[Enum['NORMAL','HIGH','EXTERNAL']]

The type of redundancy to use for the GIMR database (MGMTDB) diskgroup. Valid values are:

• NORMAL
• HIGH
• EXTERNAL

Default value: undef

grid_base

Data type: Stdlib::Absolutepath

The directory to use as grid base.

Default value: undef

grid_home

Data type: Stdlib::Absolutepath

The directory to use as grid home.

Default value: undef

grid_type

Data type: Enum['CRS_CONFIG','HA_CONFIG','UPGRADE','CRS_SWONLY','HA_SWONLY']

The type of grid. Valid values are:

• HA_CONFIG
• CRS_CONFIG
• HA_SWONLY (versions > 11)
• UPGRADE
• CRS_SWONLY The default value is: HA_CONFIG

Default value: 'HA_CONFIG'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'asmdba'

group_asm

Data type: String[1]

The OS group to use. The default value is: asmdba

Default value: 'asmadmin'

group_install

Data type: String[1]

The os group to use for installation. The default value is: oinstall

Default value: 'oinstall'

group_oper

Data type: String[1]

The OS group to allow ASM oper operations. The default value is: asmoper

Default value: 'asmoper'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

network_interface_list

Data type: Optional[String[1]]

The list of interfaces to use for RAC. The value should be a comma separated strings where each string is as shown below

InterfaceName:SubnetAddress:InterfaceType

where InterfaceType can be either "1", "2", or "3" (1 indicates public, 2 indicates private, and 3 indicates the interface is not used) An example on how to use this:

installasm{'asm12':
  ...
  network_interface_list => 'eth0:140.87.24.0:1,eth1:10.2.1.0:2,eth2:140.87.52.0:3'
  ...
}

Default value: undef

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

scan_name

Data type: Optional[String[1]]

The name to use for the SCAN service.

Default value: undef

scan_port

Data type: Optional[Integer]

The IP portnumber to use for the SCAN service.

Default value: undef

stand_alone

Data type: Boolean

Configuring Grid Infrastructure for a Stand-Alone Server. The default value is: true

Default value: true

storage_option

Data type: Optional[Enum['FLEX_ASM_STORAGE','CLIENT_ASM_STORAGE','LOCAL_ASM_STORAGE','FILE_SYSTEM_STORAGE','ASM_STORAGE']]

The type of storage to use. Valid values are:

• ASM_STORAGE (versions = 11)
• FILE_SYSTEM_STORAGE (versions <= 12.1)
• LOCAL_ASM_STORAGE (versions >= 12.1)
• CLIENT_ASM_STORAGE (versions >= 12.2)
• FLEX_ASM_STORAGE (versions >= 12.1)

Default value: undef

sys_asm_password

Data type: Easy_type::Password

The password to use for the SYSASM user.

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'grid'

umask

Data type: String[1]

The umask to use for commands that run in the context of either the grid user or the oracle user. The default is 0022

Default value: '0022'

user_base_dir

Data type: Stdlib::Absolutepath

The directory to use as base directory for the users.

Default value: '/home'

version

Data type: Ora_install::Version

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: undef

zip_extract

Data type: Boolean

The specified source file is a zip file that needs te be extracted. When you specify a value of false, the source attribute must contain a reference to a directory instead of a zip file. The default value is: true

Default value: true

install_task

Data type: Enum['ALL','EXTRACT','SETUP']

Kind of install task you want the class to do.

Default value: 'ALL'

gimr_dg

Data type: Boolean

Specify whether or not to configure a seperate diskgroup for the GIMR database (MGMTDB), 12. 2 and up only. The default value is: false

Default value: false

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

ora_install::installdb

ora_install::installdb

This defined type supports the following versions of Oracle:

• 11.2.0.1
• 11.2.0.3
• 11.2.0.4
• 12.1.0.1
• 12.1.0.2
• 12.2.0.1
• 18.0.0.0
• 19.0.0.0 ( and all subversions)
• 21.0.0.0 ( and all subversions)

Example

Here is an example on how you can use this class to install an Oracle database on your system.

ora_install::installdb{ '12.1.0.2_Linux-x86-64':
  version                   => '12.1.0.2',
  file                      => 'V46095-01',
  database_type             => 'SE',
  oracle_base               => '/oracle',
  oracle_home               => '/oracle/product/12.1/db',
  bash_profile              => true,
  user                      => 'oracle',
  group                     => 'dba',
  group_install             => 'oinstall',
  group_oper                => 'oper',
  download_dir              => '/data/install',
  zip_extract               => true,
  puppet_download_mnt_point => $puppet_download_mnt_point,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::installdb defined type:

• database_type
• download_dir
• bash_profile
• bash_additions
• cleanup_install_files
• cluster_nodes
• ee_optional_components
• ee_options_selection
• file
• group
• group_install
• group_oper
• is_rack_one_install
• ora_inventory_dir
• oracle_base
• oracle_home
• puppet_download_mnt_point
• temp_dir
• bypass_tmp_noexec
• user
• umask
• user_base_dir
• version
• zip_extract
• user_password
• logoutput
• allow_insecure

database_type

Data type: Enum['SE2', 'SE', 'EE', 'SEONE']

Selects the type of database you want to install. At this point in time the following database types are supported and allowed:

• EE : Enterprise Edition (all versions)
• SE : Standard Edition (versions <= 12.1.0.1)
• SEONE : Standard Edition One (versions <= 12.1.0.1)
• SE2 : Standard Edition Two (versions >= 12.1.0.2) The default value is: SE2

Default value: 'SE2'

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

bash_profile

Data type: Boolean

Create a bash profile for the specified user or not. Valid values are true and false. When you specify a true for the parameter, Puppet will create a standard bash profile for the specified user. The bash profile will be placed in a directory named user_base_dir/user.

ora_install::client { 'Oracle client':
  ...
  bash_profile  => true,
  user          => 'oracle',
  user_base_dir => '/home',
  ...
}

This snippet will create a bash profile called /home/oracle/.bash_profile.

Default value: true

bash_additions

Data type: String

The text to add at the end of the bash_profile. This parameter will only be used when you have specified true for the parameter bash_profile The default value is an empty string.

Default value: ''

cleanup_install_files

Data type: Boolean

Cleanup extracted files after use. This is a boolean value. When you set this value to true. The installer class will remove all extracted zip files after it has done its work. The default value is: true Here is an example:

ora_install::....{...
  ...
  cleanup_install_files => false,  # Keep all unzipped files
  ...
}

Default value: true

cluster_nodes

Data type: Optional[String[1]]

A comma seperated list of the nodes running in the RAC cluster. Example: node1,node2

Default value: undef

ee_optional_components

Data type: Optional[String[1]]

This variable is used to enable or disable custom install. When its is set to true, the attribute ee_options_selection is used. When this value is false, the attribute ee_options_selection is ignored.

Default value: undef

ee_options_selection

Data type: Boolean

List of Enterprise Edition Options you would like to install. Check the oracle documentation what values are valid.

Default value: false

file

Data type: String[1]

The source file to use.

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

group_install

Data type: String[1]

The os group to use for installation. The default value is: oinstall

Default value: 'oinstall'

group_oper

Data type: String[1]

The OS group to allow operator rights. The default value is: oper

Default value: 'oper'

is_rack_one_install

Data type: Boolean

This variable is used to enable or disable RAC One Node install.

• true : Value of RAC One Node service name is used.
• false : Value of RAC One Node service name is not used. The default value is: false

Default value: false

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

oracle_base

Data type: Stdlib::Absolutepath

A directory to use as Oracle base directory.

Default value: undef

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

bypass_tmp_noexec

Data type: Boolean

This variable is used to enable or disable bypassing noexec mount option on $temp_dir.

• true : The $temp_dir filesystem will be remounted with exec option for the duration of the database software installation, provided $temp_dir is a filesystem.
• false : The $temp_dir filesystem will be left alone. The default value is: true

Default value: true

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

umask

Data type: String[1]

The umask to use for commands that run in the context of either the grid user or the oracle user. The default is 0022

Default value: '0022'

user_base_dir

Data type: Stdlib::Absolutepath

The directory to use as base directory for the users.

Default value: '/home'

version

Data type: Ora_install::Version

Specifies the version of the component you want to manage or install. At this point in type we support the installation of:

• 11.2.0.1
• 11.2.0.3
• 11.2.0.4
• 12.1.0.1
• 12.1.0.2
• 12.2.0.1
• 18.0.0.0
• 19.0.0.0 (and all subversions)
• 21.0.0.0 (and all subversions) Here is an example on how to specify the version:

ora_install::....{...
  ...
  version => '12.1.0.2',
  ...
}

Default value: undef

zip_extract

Data type: Boolean

The specified source file is a zip file that needs te be extracted. When you specify a value of false, the source attribute must contain a reference to a directory instead of a zip file. The default value is: true

Default value: true

user_password

Data type: Optional[String[1]]

The password for the Oracle user on Windows. This parameter is only used on windows systems

Default value: undef

logoutput

Data type: Variant[Boolean, Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

ora_install::installem

ora_install::installem

Here is an example on how to use this:

ora_install::installem{ 'em13200':
  version                     => '13.2.0.0',
  file                        => 'em13200p1_linux64',
  oracle_base_dir             => '/u01/app/oracle',
  oracle_home_dir             => '/u01/app/oracle/product/13.2.0.0/em_home1',
  agent_base_dir              => '/u01/app/oracle/agent',
  software_library_dir        => '/u01/app/oracle/swlib',
  weblogic_user               => 'weblogic',
  weblogic_password           => 'Welcome01',
  database_hostname           => 'em1320.example.com',
  database_listener_port      => 1521,
  database_service_sid_name   => 'EM122.domain.local',
  database_sys_password       => 'Welcome01',
  sysman_password             => 'Welcome01',
  agent_registration_password => 'Welcome01',
  deployment_size             => 'SMALL',
  user                        => 'oracle',
  group                       => 'oinstall',
  download_dir                => '/install',
  zip_extract                 => true,
  puppet_download_mnt_point   => 'puppet:///modules/software',
  logoutput                   => true,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::installem defined type:

• admin_server_https_port
• agent_base_dir
• agent_port
• agent_registration_password
• bi_publisher_http_port
• bi_publisher_https_port
• database_hostname
• database_listener_port
• database_service_sid_name
• database_sys_password
• deployment_size
• download_dir
• em_central_console_http_port
• em_central_console_https_port
• em_upload_http_port
• em_upload_https_port
• file
• group
• logoutput
• managed_server_http_port
• managed_server_https_port
• nodemanager_https_port
• ora_inventory_dir
• oracle_base_dir
• oracle_home_dir
• puppet_download_mnt_point
• software_library_dir
• swonly
• sysman_password
• temp_dir
• user
• version
• weblogic_password
• weblogic_user
• zip_extract
• allow_insecure
• tablespace_location

admin_server_https_port

Data type: Integer

The https IP port from the WLS Admin server. The default value is: 7101

Default value: 7101

agent_base_dir

Data type: Stdlib::Absolutepath

The directory to use as base for the agent software.

Default value: undef

agent_port

Data type: Integer

The IP port to use to for the agent. The default value is: 3872

Default value: 3872

agent_registration_password

Data type: Easy_type::Password

The password to use to register the agent.

bi_publisher_http_port

Data type: Integer

The http port to use for the BI Publisher. The default value is: 9701

Default value: 9701

bi_publisher_https_port

Data type: Integer

The https port to use for the BI Publisher. The default value is: 9801

Default value: 9801

database_hostname

Data type: String[1]

The DNS name of the database host.

Default value: undef

database_listener_port

Data type: Integer

The IP port for the database listener. The default value is: 1521

Default value: 1521

database_service_sid_name

Data type: String[1]

The database service SID name for the database.

Default value: undef

database_sys_password

Data type: Easy_type::Password

The password of the SYS user of the database.

deployment_size

Data type: Enum['SMALL','MEDIUM','LARGE']

The size of the deployment. Valid values are:

• SMALL
• MEDIUM
• LARGE The default value is: SMALL

Default value: 'SMALL'

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

em_central_console_http_port

Data type: Integer

The port number of the HTTP port for the central console. The default value is: 7788

Default value: 7788

em_central_console_https_port

Data type: Integer

The port number of the HTTPS port for the central console. The default value is: 7799

Default value: 7799

em_upload_http_port

Data type: Integer

The port number of the HTTP port for the upload service. The default value is: 1159

Default value: 4889

em_upload_https_port

Data type: Integer

The port number of the HTTPS port for the upload service. The default value is: 4889

Default value: 1159

file

Data type: String[1]

The source file to use.

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'oinstall'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

managed_server_http_port

Data type: Integer

The port number of the HTTP port for the Managed server. The default value is: 7201

Default value: 7201

managed_server_https_port

Data type: Integer

The port number of the HTTPS port for the Managed server. The default value is: 7301

Default value: 7301

nodemanager_https_port

Data type: Integer

The port number of the HTTPS port for the Node manager. The default value is: 7401

Default value: 7401

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

oracle_base_dir

Data type: Stdlib::Absolutepath

A directory to use as Oracle base directory.

Default value: undef

oracle_home_dir

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

puppet_download_mnt_point

Data type: String[1]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

software_library_dir

Data type: Stdlib::Absolutepath

The directory to use for the software library.

Default value: undef

swonly

Data type: Boolean

Only install the software without configuration (true) or not (false). The default value is: false

Default value: false

sysman_password

Data type: Easy_type::Password

The password to use for sysman.

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

version

Data type: Enum[ '12.1.0.4', '12.1.0.5', '13.1.0.0', '13.2.0.0', '13.3.0.0', '13.4.0.0', '13.5.0.0']

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: '12.1.0.5'

weblogic_password

Data type: Easy_type::Password

The password to use for WebLogic.

weblogic_user

Data type: String[1]

The username to use for WebLogic. The default value is: weblogic

Default value: 'weblogic'

zip_extract

Data type: Boolean

The specified source file is a zip file that needs te be extracted. When you specify a value of false, the source attribute must contain a reference to a directory instead of a zip file. The default value is: true

Default value: true

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

tablespace_location

Data type: Optional[String[1]]

The location where the tablespace datafiles should be located. Only needed to specify when using ASM as underlying storage.

Default value: undef

ora_install::installem_agent

ora_install::installem_agent

This defined type supports the following versions of Enterprise Manager:

• 12.1.0.4
• 12.1.0.5
• 13.1.0.0
• 13.2.0.0
• 13.3.0.0
• 13.3.0.0
• 13.4.0.0
• 13.5.0.0

Here is an example:

ora_install::installem_agent{ 'Install em agent':
  version                     => '13.2.0.0',
  install_type                => 'agentPull',
  install_version             => '13.2.0.0.0',
  oracle_base_dir             => '/u01/app',
  agent_base_dir              => '/u01/app/agent/product',
  agent_instance_home_dir     => '/u01/app/agent/product/agent_inst',
  agent_registration_password => 'regme',
  agent_port                  => 3872,
  sysman_password             => 'Welkom01',
  oms_host                    => 'em1320.example.com',
  oms_port                    => 7799,
  em_upload_port              => 1159,
  logoutput                   => true,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::installem_agent defined type:

• agent_base_dir
• agent_instance_home_dir
• agent_port
• agent_registration_password
• download_dir
• em_upload_port
• group
• install_platform
• install_type
• install_version
• logoutput
• oms_host
• oms_port
• ora_inventory_dir
• oracle_base_dir
• source
• sysman_password
• sysman_user
• user
• version
• temp_dir
• allow_insecure

agent_base_dir

Data type: Stdlib::Absolutepath

The directory to use as base for the agent software.

Default value: undef

agent_instance_home_dir

Data type: Optional[Stdlib::Absolutepath]

The directory to use as instance home.

Default value: undef

agent_port

Data type: Integer

The IP port to use to for the agent. The default value is: 3872

Default value: 1830

agent_registration_password

Data type: Optional[Easy_type::Password]

The password to use to register the agent.

Default value: undef

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

em_upload_port

Data type: Integer

The port number of the HTTP port for the upload service. The default value is: 1159

Default value: undef

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'oinstall'

install_platform

Data type: String[1]

The type of platform you want to install. The default value is: Linux x86-64

Default value: 'Linux x86-64'

install_type

Data type: Enum['agentPull','agentDeploy']

The type of install. valid values are:

• undefined
• agentPull
• agentDeploy The default value is: undefined

Default value: undef

install_version

Data type: Enum[ '12.1.0.4.0', '12.1.0.5.0', '13.1.0.0.0', '13.2.0.0.0', '13.3.0.0.0', '13.4.0.0.0', '13.5.0.0.0']

The version you want to install. The default value is: 12.1.0.5.0

Default value: '12.1.0.5.0'

logoutput

Data type: Variant[Boolean, Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

oms_host

Data type: String[1]

The OMS host to use.

Default value: undef

oms_port

Data type: Integer

The IP port to use for connecting to the OMS host.

Default value: undef

ora_inventory_dir

Data type: Optional[Stdlib::Absolutepath]

The directory that contains the oracle inventory. The default value is: /oracle_base/oraInventory

Default value: undef

oracle_base_dir

Data type: Stdlib::Absolutepath

A directory to use as Oracle base directory.

Default value: undef

source

Data type: Optional[String[1]]

The source to use for the installation of the EM agent. Valid values are:

• an URL like: https://<OMS_HOST>:<OMS_PORT>/em/install/getAgentImage
• a local file like: /tmp/12.1.0.4.0_AgentCore_226_Linux_x64.zip

Default value: undef

sysman_password

Data type: Optional[Easy_type::Password]

The password to use for sysman.

Default value: undef

sysman_user

Data type: String[1]

The sysman user. The default value is: sysman

Default value: 'sysman'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

version

Data type: Enum[ '12.1.0.4', '12.1.0.5', '13.1.0.0', '13.2.0.0', '13.3.0.0', '13.4.0.0', '13.5.0.0']

The agent version to be installed

• 12.1.0.4
• 12.1.0.5
• 13.1.0.0
• 13.2.0.0

Default value: '12.1.0.5'

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

ora_install::net

ora_install::net

This defined type allows you to install and configure Oracle SQL*net.

ora_install::net{ 'config net8':
  oracle_home   => '/oracle/product/11.2/db',
  version       => '11.2',
  user          => 'oracle',
  group         => 'dba',
  download_dir  => '/install',
  db_port       => 1521,
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::net defined type:

• db_port
• download_dir
• group
• logoutput
• oracle_home
• temp_dir
• user
• version
• listener_name

db_port

Data type: Integer

The IP port number to use for connecting to the database. The default value is: 1521

Default value: 1521

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

temp_dir

Data type: Stdlib::Absolutepath

Directory to use for temporary files.

Default value: '/tmp'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

version

Data type: Ora_install::ShortVersion

The version that is installed in the used Oracle home. Puppet uses this value to decide on version specific actions.

Default value: '11.2'

listener_name

Data type: String[1]

The name of the listener process. The default value is: listener

Default value: 'listener'

ora_install::opatchupgrade

ora_install::opatchupgrade

For opatchupgrade you need to provide the Oracle support csi_number and supportId and need to be online. Or leave them empty but it needs the Expect rpm to emulate OCM.

Here is an example on how to use this:

ora_install::opatchupgrade{'112000_opatch_upgrade':
  oracle_home               => '/oracle/product/11.2/db',
  patch_file                => 'p6880880_112000_Linux-x86-64.zip',
  csi_number                => '11111',
  support_id                => 'john.doe@gmail.com',
  csi_number                => undef,
  support_id                => undef,
  opversion                 => '11.2.0.3.6',
  user                      => 'oracle',
  group                     => 'dba',
  download_dir              => '/install',
  puppet_download_mnt_point => 'puppet:///modules/software',
}

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::opatchupgrade defined type:

• csi_number
• download_dir
• group
• logoutput
• opversion
• oracle_home
• patch_file
• puppet_download_mnt_point
• support_id
• umask
• user
• allow_insecure

csi_number

Data type: Optional[Integer]

The Customer Service Identification number. This is used to generate an OCMRF file.

Default value: undef

download_dir

Data type: Stdlib::Absolutepath

The directory where the Puppet software puts all downloaded files. Before Puppet can actually use remote files, they must be downloaded first. Puppet uses this directory to put all files in. The default value is: /install

Default value: '/install'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

opversion

Data type: String[1]

The version of Opatch you want to install.

Default value: undef

oracle_home

Data type: Stdlib::Absolutepath

A directory to be used as Oracle home directory for this software.

Default value: undef

patch_file

Data type: String[1]

The zip file containing the Opatch utility.

Default value: undef

puppet_download_mnt_point

Data type: Optional[String[1]]

The base path of all remote files for the defined type or class. The default value is: puppet:///modules/ora_install

Default value: undef

support_id

Data type: Optional[String[1]]

Your support ID. This is used to generate an OCMRF file.

Default value: undef

umask

Data type: String[1]

The umask to use for commands that run in the context of either the grid user or the oracle user. The default is 0022

Default value: '0022'

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

allow_insecure

Data type: Boolean

When set to true Ignore HTTPS certificate errors (default: false)

Default value: lookup( { name => 'allow_insecure', default_value => false })

ora_install::prepareautostart_for

ora_install::prepareautostart_for

This defined creates the script needed to start the database after a system reboot. It supports both systemd and the older startup scripts.

Here is an example on how to use it:

  ora_install::prepareautostart_for {'DB1':
    oracle_home  => '/oracle/db1',
    user         => 'oracle',
    service_name => 'start_db1',
  }

See the file "LICENSE" for the full license governing this code.

Parameters

The following parameters are available in the ora_install::prepareautostart_for defined type:

• oracle_home
• user
• group
• limits
• logoutput
• systemd_template
• systemd_template_vars

oracle_home

Data type: String[1]

A directory to be used as Oracle home directory for this software.

Default value: undef

user

Data type: String[1]

The user used for the specified installation. The install class will not create the user for you. You must do that yourself. The default value is: oracle

Default value: 'oracle'

group

Data type: String[1]

The os group to use for these Oracle puppet definitions. The default value is: dba

Default value: 'dba'

limits

Data type: Optional[Hash]

The limits for the systemd service. The default value is: undef Below is an axample. Currently only the 'hard' values are used.

ora_install::autostartdatabase::limits:
  '*/nofile':
    soft: 2048
    hard: 8192
  'oracle/nofile':
    soft: 65536
    hard: 65536
  'oracle/nproc':
    soft: 2048
    hard: 16384
  'oracle/stack':
    soft: 10240
    hard: 32768

Default value: undef

logoutput

Data type: Variant[Boolean,Enum['on_failure']]

log the outputs of Puppet exec or not. When you specify true Puppet will log all output of exec types. Valid values are:

• true
• false
• on_failure

Default value: lookup( { name => 'logoutput', default_value => 'on_failure' })

systemd_template

Data type: Optional[String[1]]

Use custom EPP template for systemd service The default value is: undef

Default value: undef

systemd_template_vars

Data type: Optional[Hash]

The variables to use when specifying a custom EPP template for systemd service The default value is: undef

Default value: undef

ora_install::rcu

ora_install::rcu

Creating a repository

Using this defined class, you can create repositories for several Oracle products. Here are some examples.

Here is an example on how to use it:

SOA suite repository