Connection parameters

oracle_home

You must set this resource.

The oracle_home resource variable must contain a path to a valid Oracle client installation.

oracle_service_name

Setting this resource is optional for local Oracle databases. If not set, you must set the resource oracle_sid.

If the oracle service name is set, this resource must contain the name of a valid service configured for Oracle Net in the tnsnames.ora file. The value is used as the connect string to Oracle.

oracle_sid

This resource is required if oracle_service_name is not set.

The value of oracle_sid is used with oracle_local_template to generate a connect string to a local database instance.

oracle_local_template

The oracle_local_template resource contains a template of the connect string used to connect to Oracle if the oracle_service_name resource is not set.

Before use, some special characters in this template are replaced by the actual values of some resource values: the symbol @ is replaced with oracle_sid, and ? is replaced with oracle_server_name.

Depending on the platform and installed Oracle version, one of these build-in templates is used:

(DESCRIPTION =                         Oracle 11g/12c + Windows
  (SDU=32768)(TDU=32768)
  (ADDRESS =
    (PROTOCOL = beq) 
    (PROGRAM  = oracle )
    (ARGV0    = oracle@ )
    (ARGS='(DESCRIPTION=(LOCAL=YES)(SDU=32768)(TDU=32768)(ADDRESS=(PROTOCOL=beq)))')
    (ENVS='ORACLE_SID=@')
  )
  (CONNECT_DATA = (SID = @))
)
(DESCRIPTION =                                 Oracle 11g/12c + Unix
  (SDU=32768)(TDU=32768)
  (ADDRESS =
    (PROTOCOL = beq) 
    (PROGRAM  = ?/bin/oracle )
    (ARGV0    = oracle@ )
    (ARGS='(DESCRIPTION=(LOCAL=YES)(SDU=32768)(TDU=32768)(ADDRESS=(PROTOCOL=beq)))')
    (ENVS='ORACLE_SID=@')
  )
  (CONNECT_DATA = (SID = @))
)