client
Overview
Installs the Oracle client software.
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
.
Attributes
Attribute Name | Short Description |
---|---|
allow_insecure | When set to true Ignore HTTPS certificate errors |
architecture | The type of architecture client you want to install. |
bash_profile | Create a bash profile for the specified user or not. |
db_port | The IP port to use for database communication. |
download_dir | The directory where the Puppet software puts all downloaded files. |
file | The source file to use. |
group | The os group to use for these Oracle puppet definitions. |
group_install | The os group to use for installation. |
install_options | The list of Client Components you would like to install. |
install_type | Installation type of the Oracle client. |
logoutput | log the outputs of Puppet exec or not. |
ora_inventory_dir | The directory that contains the oracle inventory. |
oracle_base | A directory to use as Oracle base directory. |
oracle_home | A directory to be used as Oracle home directory for this software. |
puppet_download_mnt_point | The base path of all remote files for the defined type or class. |
temp_dir | Directory to use for temporary files. |
umask | The umask to use for commands that run in the context of either the grid user or the oracle user. |
user | The user used for the specified installation. |
user_base_dir | The directory to use as base directory for the users. |
version | The version that is installed in the used Oracle home. |
bash_profile
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
.
Type: Boolean
Default:true
db_port
The IP port to use for database communication.
The default value is: 1521
Type: Integer
Default:1521
download_dir
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
Type: Stdlib::Absolutepath
Default:'/install'
file
The source file to use.
Type: String[1]
Default:undef
group
The os group to use for these Oracle puppet definitions.
The default value is: dba
Type: String[1]
Default:'dba'
group_install
The os group to use for installation.
The default value is: oinstall
Type: String[1]
Default:'oinstall'
logoutput
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
Type: Variant[Boolean,Enum['on_failure']]
Default:lookup({ name => 'logoutput', default_value => 'on_failure' })
ora_inventory_dir
The directory that contains the oracle inventory.
The default value is: /oracle_base/oraInventory
Type: Optional[Stdlib::Absolutepath]
Default:undef
oracle_base
A directory to use as Oracle base directory.
Type: Stdlib::Absolutepath
Default:undef
oracle_home
A directory to be used as Oracle home directory for this software.
Type: Stdlib::Absolutepath
Default:undef
puppet_download_mnt_point
The base path of all remote files for the defined type or class.
The default value is: puppet:///modules/ora_install
Type: Optional[String[1]]
Default:undef
temp_dir
Directory to use for temporary files.
Type: Stdlib::Absolutepath
Default:'/tmp'
umask
The umask to use for commands that run in the context of either the grid user or the oracle user.
The default is 0022
Type: String[1]
Default:'0022'
user
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
Type: String[1]
Default:'oracle'
user_base_dir
The directory to use as base directory for the users.
Type: Stdlib::Absolutepath
Default:'/home'
version
The version that is installed in the used Oracle home.
Puppet uses this value to decide on version specific actions.
Type: Ora_install::Version
Default:undef
allow_insecure
When set to true
Ignore HTTPS certificate errors
(default: false) Type: Boolean
Default:lookup({ name => 'allow_insecure', default_value => false })
install_type
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. Type: Enum['Administrator','Runtime','InstantClient','Custom']
Default:'Administrator'
install_options
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”
Type: Array[String]
Default:[]
architecture
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
Type: Enum['client32','client']
Default:'client'