Difference between revisions of "ars.ini"

From CMOD.wiki
Jump to navigation Jump to search
m (Added ARS_LDAP_BIND_MESSAGES_FILE arsldap.ini)
(Added definitions for most of the ars.ini parameters.)
Line 13: Line 13:
   SRVR_SM_CFG=/opt/ibm/ondemand/V9.5/config/ars.cache  
   SRVR_SM_CFG=/opt/ibm/ondemand/V9.5/config/ars.cache  


; [@SRV@_ARCHIVE]
: This is the header that defines a server.  Any of the parameters below refer to this server - ARCHIVE.
; HOST=cmod.example.com
: The fully qualified domain name of the server.
; PROTOCOL=2
: The protocol to use between the server and client.  Leave the default value for the version of CMOD you've installed.
; PORT=0
: The TCP/IP port number to use for CMOD.  0 uses the default, 1445.
: Each server must have it's own port number, servers cannot share a port.
: This port number must be entered in the client software when defining a server.
; SRVR_INSTANCE=archive
: Name of the instance.
; SRVR_INSTANCE_OWNER=archive
: The operating system User ID that owns / controls this instance.  This parameter may be case sensitive depending on your Operating System.
; SRVR_OD_CFG=/opt/ibm/ondemand/V9.5/config/ars.cfg
: Defines the location of your configuration file for the server.
; SRVR_DB_CFG=/opt/ibm/ondemand/V9.5/config/ars.dbfs
: Defines the location of your configuration file for the database manager.
; SRVR_SM_CFG=/opt/ibm/ondemand/V9.5/config/ars.cache
: Defines the locatio nof your configuration file for defining cache filesystems.


== arsstash related ars.ini configuration parameters ==
== arsstash related ars.ini configuration parameters ==


   SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash
   SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash
; SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash
: This parameter defines the location of the default stash file to use for database connections, arsload, and LDAP authentication.


== SSL / TLS related ars.ini configuration parameters ==
== SSL / TLS related ars.ini configuration parameters ==
Line 25: Line 56:
   SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
   SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
   SSL_CLNT_USE_SSL=1
   SSL_CLNT_USE_SSL=1
; SSL_PORT=1446
: Defines the port number for encrypted connections to CMOD.
: There is no default port number, common choices are 1443 and 1446, but may be any number between 1024 and 65535 not already in use on your server by other services like TSM (1500, 1501) or DB2 (50000-50006, 60000-60006).
; SSL_KEYRING_FILE=/opt/IBM/ondemand/V9.5/config/ondemand.kdb
: Defines the location of the key database that contains all the requisite certificates and keys.
; SSL_KEYRING_STASH=/opt/IBM/ondemand/V9.5/config/ondemand.sth
: Defines the location of the stash file that contains passwords to the keys and certificates in the key database.
: This file should have very restrictive permissions.
; SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
: Defines the label of the SSL Certificate to be used to identify the IBM CMOD server.
; SSL_CLNT_USE_SSL=1
: Determines if utility clients like arsload should use SSL to connect to IBM CMOD.
: This is not necessary if you're not performing remote loads (via arsload), or queries or retrievals (via arsdoc).


== LDAP related ars.ini configuration parameters ==
== LDAP related ars.ini configuration parameters ==
Line 38: Line 87:
   ARS_LDAP_IGN_USERIDS=ADMIN,ARSLOAD,ARSMAINT
   ARS_LDAP_IGN_USERIDS=ADMIN,ARSLOAD,ARSMAINT
   ARS_LDAP_BIND_MESSAGES_FILE=/opt/IBM/ondemand/V9.5/config/arsldap.ini
   ARS_LDAP_BIND_MESSAGES_FILE=/opt/IBM/ondemand/V9.5/config/arsldap.ini
== Related Articles ==
[https://www.ibm.com/support/knowledgecenter/SSEPCD_9.5.0/com.ibm.ondemand.installmp.doc/dodso059.htm LDAP Messages File]

Revision as of 02:07, 9 March 2017

The ars.ini configuration file defines one or more IBM Content Manager OnDemand ("IBM CMOD") instances on a server. While most systems only contain a single IBM CMOD server, it is possible to combine multiple OnDemand instances onto a single server -- usually for combining development and test instances.

Default ars.ini configuration parameters

 [@SRV@_ARCHIVE]
 HOST=cmod.example.com
 PROTOCOL=2
 PORT=0
 SRVR_INSTANCE=archive
 SRVR_INSTANCE_OWNER=archive
 SRVR_OD_CFG=/opt/ibm/ondemand/V9.5/config/ars.cfg
 SRVR_DB_CFG=/opt/ibm/ondemand/V9.5/config/ars.dbfs
 SRVR_SM_CFG=/opt/ibm/ondemand/V9.5/config/ars.cache 
[@SRV@_ARCHIVE]
This is the header that defines a server. Any of the parameters below refer to this server - ARCHIVE.
HOST=cmod.example.com
The fully qualified domain name of the server.
PROTOCOL=2
The protocol to use between the server and client. Leave the default value for the version of CMOD you've installed.
PORT=0
The TCP/IP port number to use for CMOD. 0 uses the default, 1445.
Each server must have it's own port number, servers cannot share a port.
This port number must be entered in the client software when defining a server.
SRVR_INSTANCE=archive
Name of the instance.
SRVR_INSTANCE_OWNER=archive
The operating system User ID that owns / controls this instance. This parameter may be case sensitive depending on your Operating System.
SRVR_OD_CFG=/opt/ibm/ondemand/V9.5/config/ars.cfg
Defines the location of your configuration file for the server.
SRVR_DB_CFG=/opt/ibm/ondemand/V9.5/config/ars.dbfs
Defines the location of your configuration file for the database manager.
SRVR_SM_CFG=/opt/ibm/ondemand/V9.5/config/ars.cache
Defines the locatio nof your configuration file for defining cache filesystems.

arsstash related ars.ini configuration parameters

 SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash
SRVR_OD_STASH=/opt/IBM/ondemand/V9.5/config/ars.stash
This parameter defines the location of the default stash file to use for database connections, arsload, and LDAP authentication.

SSL / TLS related ars.ini configuration parameters

 SSL_PORT=1446
 SSL_KEYRING_FILE=/opt/IBM/ondemand/V9.5/config/ondemand.kdb
 SSL_KEYRING_STASH=/opt/IBM/ondemand/V9.5/config/ondemand.sth 
 SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
 SSL_CLNT_USE_SSL=1
SSL_PORT=1446
Defines the port number for encrypted connections to CMOD.
There is no default port number, common choices are 1443 and 1446, but may be any number between 1024 and 65535 not already in use on your server by other services like TSM (1500, 1501) or DB2 (50000-50006, 60000-60006).
SSL_KEYRING_FILE=/opt/IBM/ondemand/V9.5/config/ondemand.kdb
Defines the location of the key database that contains all the requisite certificates and keys.
SSL_KEYRING_STASH=/opt/IBM/ondemand/V9.5/config/ondemand.sth
Defines the location of the stash file that contains passwords to the keys and certificates in the key database.
This file should have very restrictive permissions.
SSL_KEYRING_LABEL=IBM CMOD SSL Certificate
Defines the label of the SSL Certificate to be used to identify the IBM CMOD server.
SSL_CLNT_USE_SSL=1
Determines if utility clients like arsload should use SSL to connect to IBM CMOD.
This is not necessary if you're not performing remote loads (via arsload), or queries or retrievals (via arsdoc).

LDAP related ars.ini configuration parameters

 ARS_LDAP_SERVER= ldap.example.com
 ARS_LDAP_PORT=
 ARS_LDAP_USE_SSL=FALSE
 ARS_LDAP_BASE_DN=ou=examplegroup,o=example.com
 ARS_LDAP_BIND_ATTRIBUTE=userid
 ARS_LDAP_MAPPED_ATTRIBUTE=userid
 ARS_LDAP_ALLOW_ANONYMOUS=TRUE
 ARS_LDAP_BIND_MESSAGES_FILE=/var/log/LDAPmessages.log
 ARS_LDAP_IGN_USERIDS=ADMIN,ARSLOAD,ARSMAINT
 ARS_LDAP_BIND_MESSAGES_FILE=/opt/IBM/ondemand/V9.5/config/arsldap.ini


Related Articles

LDAP Messages File