Difference between revisions of "ars.cfg"

Jump to navigation Jump to search
3,663 bytes added ,  19:43, 2 November 2017
Complete overhaul of IBM CMOD ars.cfg configuration file parameters.
(Updated IBM CMOD ARS_ORIGINAL_CODEPAGE section.)
(Complete overhaul of IBM CMOD ars.cfg configuration file parameters.)
Line 222: Line 222:


{| class="mw-collapsible mw-collapsed wikitable"
{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand DB2 TSM Configuration Parameters     
! Sample Content Manager OnDemand Oracle Configuration Parameters     
|-
|-
|
|
Line 235: Line 235:


== CMOD Miscellaneous Configuration ==
== CMOD Miscellaneous Configuration ==
 
{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand Miscellaneous Configuration Parameters   
|-
|
   #
   #
   # OnDemand Temporary Work Directory (Library/Object Server)
   # OnDemand Temporary Work Directory (Library/Object Server)
Line 244: Line 247:
   ARS_TMP=/tmp
   ARS_TMP=/tmp
   ARS_PRINT_PATH=/tmp
   ARS_PRINT_PATH=/tmp
  ARS_MESSAGE_OF_THE_DAY=
  ARS_TRACE_SETTINGS=
|}


;ARS_TMP
;ARS_TMP
Line 251: Line 258:
: This specifies the temporary directory used for creating temporary files for printing.
: This specifies the temporary directory used for creating temporary files for printing.


  ARS_MESSAGE_OF_THE_DAY=
;ARS_MESSAGE_OF_THE_DAY=
  ARS_TRACE_SETTINGS=
: Specifies a text file that will be displayed when users log in.  Excellent for advising all users of upcoming outages or maintenance, or problems experienced by the CMOD server.


;ARS_TRACE_SETTINGS=
: When tracing is enabled, these settings determine the level of information written to the trace file.


=== Special Considerations for IBM CMOD temporary files ===
=== Special Considerations for IBM CMOD temporary files ===
Line 259: Line 268:


== CMOD LDAP Configuration ==
== CMOD LDAP Configuration ==
 
{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand LDAP Configuration Parameters   
|-
|
   ###########################################
   ###########################################
   # LDAP Parameters (Library Server Only)  #
   # LDAP Parameters (Library Server Only)  #
Line 271: Line 283:
   ARS_LDAP_MAPPED_ATTRIBUTE=
   ARS_LDAP_MAPPED_ATTRIBUTE=
   ARS_LDAP_ALLOW_ANONYMOUS=
   ARS_LDAP_ALLOW_ANONYMOUS=
|}


;ARS_LDAP_SERVER
;ARS_LDAP_SERVER
Line 276: Line 289:
;ARS_LDAP_PORT
;ARS_LDAP_PORT
: The TCP/IP port number used by your LDAP server's software.
: The TCP/IP port number used by your LDAP server's software.
: The default port is 389 if no value is specified. 
: A popular optional port number is 3389.
;ARS_LDAP_BASE_DN
;ARS_LDAP_BASE_DN
: The LDAP Base Distinguishing Name.
;ARS_LDAP_BIND_DN
;ARS_LDAP_BIND_DN
: If your LDAP server requires a User ID and password to authenticate, this is the user name parameter.
;ARS_LDAP_BIND_DN_PWD
;ARS_LDAP_BIND_DN_PWD
: If your LDAP server requires a User ID and password to authenticate, this is the password parameter.
;ARS_LDAP_BIND_ATTRIBUTE
;ARS_LDAP_BIND_ATTRIBUTE
: The name of the attribute that will be searched for on the LDAP server, and returned to CMOD.
;ARS_LDAP_MAPPED_ATTRIBUTE
;ARS_LDAP_MAPPED_ATTRIBUTE
: This value can be the same as, or different from the ARS_LDAP_MAPPED_ATTRIBUTE.
: Specify the LDAP field that should be returned and used as the CMOD User ID.
;ARS_LDAP_ALLOW_ANONYMOUS
;ARS_LDAP_ALLOW_ANONYMOUS
: Set to TRUE if your LDAP server allows access without authentication.
: Set to FALSE if your LDAP server requires a Distinguishing Name ("ARS_LDAP_BIND_DN") and password ("ARS_LDAP_BIND_DN_PWD").




== CMOD Storage Management Configuration ==  
== CMOD Storage Management Configuration ==  
{| class="mw-collapsible mw-collapsed wikitable"
! Sample Content Manager OnDemand TSM Configuration Parameters   
|-
|
   ######################################################
   ######################################################
   # Storage Manager Parameters (Library/Object Server) #
   # Storage Manager Parameters (Library/Object Server) #
Line 308: Line 335:
   DSMI_CONFIG=/opt/tivoli/tsm/client/api/bin64/dsm.opt
   DSMI_CONFIG=/opt/tivoli/tsm/client/api/bin64/dsm.opt
   DSMI_LOG=/tmp
   DSMI_LOG=/tmp
|}
The majority of these configuration parameters are only of interest if you are using the ars_adsm script.  Only the DSM_CONFIG and DSMI_CONFIG parameters are required if your TSM server is on another separate server.
;DSMSERV_DIR
: The directory where Tivoli Storage Manager (now Spectrum Protect) is installed.
;DSMSERV_CONFIG
: The configuration file for the TSM server.
: If your TSM/SP server is remote, these files aren't used.
;DSM_DIR / DSMG_DIR / DSMI_DIR
: The directory where the 64-bit TSM/SP Client API is installed.
;DSM_CONFIG / DSMG_CONFIG / DSMI_CONFIG
: Points to the file containing the TSM Configuration file.
;DSM_LOG / DSMG_LOG / DSMI_LOG
: Points to the directory where the TSM Client files should be written.


=== Special Considerations for TSM Log files ===
The configuration parameters above that end in _LOG are log files.  By default, the logs all go to /tmp, which is, frankly, a terrible idea.  Instead, these log files should all go to a directory specifically for IBM CMOD Logs.  This will prevent errors arising from conflicting permissions, or filling up the server's temporary space.  Also, these logs should be rotated on a regular basis.  If you feel the need to place these log files in a 'standardized' space, place them in /var/log, but also create the files in advance, and provide them with generous permissions, to minimize frustration and errors.


== Unlisted Parameters ==
== Unlisted Parameters ==
These parameters aren't listed in the CMOD Configuration File by default.


=== IBM CMOD Upgrade Parameters ===
=== IBM CMOD Server Parameters ===
When upgrading a server from v7.1.x to v8.5 and above, you must specify the original codepage of the database for Unicode support.
When upgrading a server from v7.1.x to v8.5 and above, you must specify the original codepage of the database for Unicode support.
;ARS_ORIGINAL_CODEPAGE
;ARS_ORIGINAL_CODEPAGE
: Set this value to the numeric codepage value of the database.  This allows OnDemand to translate the contents of the database to Unicode.
: Set this value to the numeric codepage value of the database.  This allows OnDemand to translate the contents of the database to Unicode.
: Where possible, servers should be migrated to support Unicode in their databases.
: Where possible, servers should be migrated to support Unicode in their databases.
;ARS_DB_TABLESPACE
: Set this value to an already-existing tablespace name to keep the OnDemand configuration database tables in.
;ARS_DB_TABLESPACE_USEREXIT
: Specify the full directory path to the User Exit that is called when creating CMOD tablespaces.
: The tablespace user exit allows you to customize the creation of tablespaces, tables, and indexes for CMOD metadata tables.
;ARS_SUPPORT_CFSOD
: Set this parameter to 1 if you are licensed to use the Content Federation System for OnDemand ("CFS:OD") feature.
;ARS_SUPPORT_HOLD
: Set this parameter to 1 if you are licensed to use the Content Manager OnDemand Enhanced Retention Management ("IBM CMOD ERM") feature.


=== ODWEK Load Parameters ===
=== ODWEK Load Parameters ===

Navigation menu