Response file keywords
You can use response file keywords to install or uninstall Db2® database products or features.
Response files use keywords. You can use a response file to perform tasks such as: Sample response files are provided for both an installation and uninstallation. The following response file keywords are explained in a sample response file. The sample response file can be edited. The edited response file must then be copied to your shared network drive or network file system where it will be used by your installation server.
You can use the following response file keywords to install a Db2 database product or feature, or language. On Linux® or UNIX operating systems, some keywords are valid for root installation only.
- PROD
- Specifies the product that you want to install. You can install only one Db2 database product at a
time. Therefore, you can specify only one product with this keyword. Note:
- You should not comment out the PROD keyword as you might have some missing components even with a successful response file installation.
- You cannot use the PROD keyword with the db2isetup command -r response_file parameter.
- FILE
- Specifies the destination directory for a Db2 database product.
- Windows
- On Windows operating systems, this keyword is limited to 110 characters.
- Linux or UNIX
- On Linux or UNIX
operating systems, this keyword is mandatory for root installations.Db2 installation paths have the following rules:
- Can include lowercase letters (a-z), uppercase letters (A-Z), and the underscore character ( _ )
- Cannot exceed 128 characters
- Cannot contain spaces
- Cannot contain characters that are other than English characters
- The path name cannot be a subdirectory of an existing Db2 installation.
- The installation paths cannot be symbolic links.
- INSTALL_OPTION
- Windows operating systems only and specific to
Db2 Enterprise Server
Edition. This
keyword specifies the installation. The default is SINGLE_PARTITION.The options are:
- INSTANCE_OWNING
- NEW_NODE
- SINGLE_PARTITION
- LIC_AGREEMENT
- Indicates that you have read and agree to the license agreement file in the
db2/license directory on the Db2 database product DVD.
The default is DECLINE. The options are:
- DECLINE
- ACCEPT
Note:- You must change this keyword to ACCEPT to signify your acceptance of the Db2 license agreement for the installation to proceed.
- You cannot use this keyword with the db2isetup command -r response_file parameter.
- INTERACTIVE
- Linux or UNIX operating systems only. Determines if installation
provides prompting for location of the national language package (either on DVDs or file set
location) and progress reports. The default is NONE.The options are:
- NONE
- YES
- MACHINE
Note:- When NONE is specified, there is no interaction.
- When YES is specified, progress information and prompt information is displayed to the console. During installation, if a language is missing, you are prompted for the location of the national language package.
- Specify MACHINE to receive progress or prompt information in a format that is easily parsed by another program. If you are embedding the Db2 installation image, a sample program is provided.
- CONFIG_ONLY
- This keyword is
deprecated and will be discontinued in a future release. Linux or UNIX operating
systems only. Specifies that this response file is for performing configuration tasks only. For
example, create an instance by running the db2isetup command. The default is
NO.The options are:
- YES
- NO
- DB2DSDRIVER_CFG_SOURCE_PATH
- Windows operating systems only. Starting with Db2 Version 10.1 Fix Pack 2 and later fix packs, specifies the full path of a customized db2dsdriver configuration file. The file is copied to the common application data path during silent installation as db2dsdriver.cfg.
- DB2_ODBC_DSN_TYPE
-
Windows operating systems only. Starting with Db2 Version 10.1 Fix Pack
2 and later fix packs, specifies the type of an ODBC data source name (DSN) during silent
installation.The options are:
- USER: Installation process registers DSNs that are listed in the db2dsdriver.cfg file as user DSNs for ODBC.
- SYSTEM: Installation process registers DSNs that are listed in the db2dsdriver.cfg file as system DSNs for ODBC.
- BOTH: Installation process registers DSNs that are listed in the db2dsdriver.cfg file as both user and system DSNs for ODBC.
DSNs are registered during silent installation for the current copy name only. Installation does not update ODBC DSN registries of any other copy available on the same client system.
For a 32-bit client package, installation creates ODBC DSNs under 32-bit registry hierarchy. For a 64-bit client package, installation creates ODBC DSNs under both the 32-bit and 64-bit registry hierarchy. However, forUSER
DSNs in a 64-bit client package, because Windows maintains a common ODBC DSN registry entry for both 32-bit and 64-bit product environments, installation modifies only the 64-bit user DSNs.Note: The Windows platform maintains different registry paths to track 32-bit and 64-bit product environment settings forSYSTEM
DSNs. So this restriction is not applicable forSYSTEM
DSNs and installation adds system DSNs to both 32-bit and 64-bit registry hierarchy. - DB2_ODBC_DSN_ACTION
-
Windows operating systems only. Starting with Db2 Version 10.1 Fix Pack
2 and later fix packs, specifies whether to add ODBC DSNs or clear
stale ODBC DSNs during silent
installation.The options are:
- ADD: Installation process adds the available DSNs from the db2dsdriver.cfg file to be used as ODBC DSNs.
- REPLACE: Installation process deletes all the DSNs for the current copy before adding the available DSNs from the db2dsdriver.cfg file to be used as ODBC DSNs.
- INSTALL_TYPE
- Specifies the type of installation. The options are:A compact or typical installation type ignores any custom keywords (COMP).
- COMPACT
- TYPICAL
- CUSTOM
Note: You cannot use this keyword with the db2isetup command -r response_file parameter. - DB2_COPY_NAME
- Windows operating systems only. An identifier that represents the name that is used to refer to a set of Db2 database products that are installed in the same location. This name is limited to 64 characters.
- DEFAULT_COPY
- Windows operating systems only. Specifies if the copy
that is being installed or modified will be set as the default Db2 copy used by Db2 applications. The
default is NO unless it is the only Db2 copy installed.
The options are:
- NO
- YES
- COPY_NAME
- Windows operating systems only. Represents the name that is used to refer to the IBM® Data Server Driver Package installed. Valid only when the PROD keyword is set to IBM_DATA_SERVER_DRIVER. This name is limited to 64 characters.
- DEFAULT_CLIENT_INTERFACE_COPY
- Windows operating systems only. Specifies if the copy
of Db2 database
products, or the
IBM Data Server Driver Package, installed will be set as the default IBM database client interface copy. If this keyword is set to
YES, the IBM data server client interface
(ODBC/CLI driver and .NET data provider) in the copy is the default driver to be used by the
applications. If you are installing the IBM Data Server
Driver, the default is NO unless the computer does not have a Db2 database product, or
the
IBM Data Server Driver Package installed. If you are installing other products, the default is the value of
the DEFAULT_COPY keyword.The options are:
- YES
- NO
- AUTOSTART_SSH_SERVER
- Windows operating systems only. Specifies whether you
want to autostart the IBM SSH Server for Windows service. The default is to autostart the service.The options are:
- YES
- NO
- SSH_SERVER_INSTALL_DIR
- Windows operating systems only. Determines the base installation path for the IBM Secure Shell (SSH) Server for Windows service. This keyword is only evaluated when the SSH Server is first installed. If this keyword is not specified in the response file and SSH is to be installed, the default installation directory is used. The default directory is: %program files%\IBM\IBM SSH Server. If the default directory is not empty, the directory name is append with "_01", "_02", and so on. For example, %program files%\IBM\IBM SSH Server_01
- POPULATE_XML_FROM_CATALOG
- Specifies whether the db2dsdriver.cfg configuration file is populated with
catalog information. The default is FALSE.The options are:
- TRUE
- FALSE
- INSTALL_TSAMP
-
Important: The INSTALL_TSAMP response file keyword has been deprecated in version 10.1 and might be removed in a future release. Starting in version 10.1, IBM Tivoli® System Automation for Multiplatforms (SA MP) is automatically installed when SA MP is a required component for other components selected for installation. For more information, see IBM Tivoli System Automation for Multiplatforms (SA MP) is now automatically installed.
- INSTALL_ENCRYPTION
- Specifies whether to install the IBM Global Security Kit (GSKit). The default value is
YES.The options are:
- YES
- NO
- MIGRATE_PRIOR_VERSIONS
- This keyword is deprecated, use the
UPGRADE_PRIOR_VERSIONS keyword instead.
Windows operating systems only. Specifies if an existing
version of the Db2 database product is to be updated. The default is FALSE. The options are:
- TRUE
- FALSE
- UPGRADE_PRIOR_VERSIONS
- Specifies if an existing version of the Db2 database product is
to be upgraded. The default is FALSE. The options are:
- TRUE
- FALSE
- UPGRADE_DBCK_IGNORE_TYPE1
- Linux and UNIX
operating systems only, and specific to non-root installation. Forces the
db2setup command to ignore type-1 index checking. The default is
NO. The options are:
- YES
- NO
- PACKAGE_LOCATION
- Linux or UNIX
operating systems only. This keyword is used only when "nlpack" is removed from the image and NL
languages are selected to install. This keyword specifies the location of the nlpack. The path can
be the location of the product DVD or the location where the contents of the DVD are saved.
Built-in search paths allow automatic searching of the same parent directory. For example, if the contents of a Db2 database product DVD are copied into the following subdirectories:
The subdirectories are automatically searched without specifying each subdirectory (including searching subdirectories for the national language DVD):/db2images/ese/dvd /db2images/nlpack/dvd
PACKAGE_LOCATION=/db2images/ese/disk1
If the contents of a Db2 database product DVD are copied into different parent directories, you can repeat this keyword as many times as required. For example:PACKAGE_LOCATION=/db2images1/dvd PACKAGE_LOCATION=/db2images2/nlpack/dvd
- COMP
- Specifies the components that you want to install. The setup program automatically installs
components that are required for a product.
In a custom installation, you must select components individually. To select components, uncomment the COMP keywords for the components that you want installed (components differ depending on the product).
Note: This keyword is ignored unless your INSTALL_TYPE is CUSTOM. - LANG
- Specifies which languages to install. You must uncomment any additional languages that you want to install. The English language is mandatory and is always selected.
- CLIENT_IMPORT_PROFILE
- Specifies a configuration profile exported by the db2cfexp command. The
profile contains instance-related parameters.
- Windows operating systems:
- If the value provided is a full path name, it must be on a local drive (not a remote network drive). If it is not a full path name, the configuration profile must be in the same directory as the response file.
- Linux or UNIX
operating systems:
- Specifies a file name with a full path to the configuration profile.
- Windows operating systems:
- REBOOT
- Windows operating systems only. Specifies whether to
restart the system when the installation or uninstallation has completed. The default is
NO. The options are:
- YES
- NO
- KILL_PROCESSES
- Windows operating systems only. If you have an
existing version of Db2 running and this
keyword is set to YES, it will terminate your running Db2 processes without a
prompt. The options are:
- YES
- NO
- NEW_CONTACT
- Specifies if the email address contact on the notification and contact list is new or existing.
A new contact is not required if there is an existing email address. On Linux or UNIX operating systems, this
keyword is valid only for root installation. The options are:
- YES
- NO
- DB2_OLEDB_GUID
- Windows operating systems only. Use this keyword to enter the GUID used by Db2 applications using OLE DB. If you do not specify this keyword, it is generated.
- CREATE_DAS
- Important: The Db2 Administration Server (DAS) has been deprecated in Version 9.7 and might be removed in a future release. The DAS is not supported in Db2 pureScale® environments. Use software programs that use the Secure Shell protocol for remote administration. For more information, see Db2 administration server (DAS) has been deprecated .Windows operating systems only. Specifies whether to create the Database Administration Server (DAS) or not. There can be one DAS only for all Db2 copies on the same system. Keep this keyword commented out in the response file because if this keyword is specified and set to YES, and a DAS instance exists on the system, the installation fails.When this keyword is commented out in the response file (or is not specified), the Db2 installer determines whether a DAS must be created. In the case where:
- A DAS instance does not exist, a DAS is created.
- A DAS instance exists, this keyword is ignored.
The options are:- YES
- NO
- CHECK_UNCPATH
- Windows operating systems only. Specifies to check
that the Universal Naming Convention (UNC) path is in the PATH environment
variable. The default value is YES. The options are:
- YES
- NO
- DB2_COMMON_APP_DATA_TOP_PATH
- Windows operating systems only. Specifies a
user-defined location to hold the Db2 common application
data for the Db2
copy to be installed. You can use this keyword only during the initial installation of Db2 product in a new
location. The path specified for this keyword is used to populate the
DB2_COMMON_APP_DATA_PATH registry variable. Db2 common application
data is placed in the IBM\DB2\<COPYNAME> subdirectory, which is created
under a path specified in the DB2_COMMON_APP_DATA_PATH registry variable.For example, when the Db2 product is installed with the DB2_COMMON_APP_DATA_TOP_PATH keyword set to a specific path:
DB2_COMMON_APP_DATA_TOP_PATH=C:\User\MyCommonAppData\
After the Db2 product is successfully installed, the DB2_COMMON_APP_DATA_PATH registry variable is set to following value:
Db2 common application data is stored in following path :DB2_COMMON_APP_DATA_PATH=C:\User\MyCommonAppData\
After installation, this variable cannot be altered.C:\User\MyCommonAppData\IBM\DB2\DB2COPY1\
If this keyword is not set, the Windows' default common application data path is used to hold the Db2 common application data.- For Windows operating systems: C:\ProgramData\
Note:- You cannot use this keyword to change the Db2 Common Application Data path during a Db2 upgrade.
- Use of the network drive is not supported.
- You can use only alphanumeric characters for the DB2_COMMON_APP_DATA_TOP_PATH path.
- Db2 Administration Server settings
- To enable any of the following Db2 Administrator Server
(DAS) settings, remove the * (uncomment). This setting is applicable for Windows, Linux, and
UNIX environments but on Linux or UNIX operating systems, this keyword is valid
for root installation only.
- On Linux or UNIX
operating systems:
*DAS_USERNAME = dasuser *DAS_PASSWORD = dasp *DAS_GID = 100 *DAS_UID = 100 *DAS_GROUP_NAME = dasgroup *DAS_SMTP_SERVER = jsmith.torolab.ibm.com
- On Windows operating systems:
You can also specify LOCALSYSTEM as a valid user name that does not require a password. The LOCALSYSTEM user name is available for all products, except Db2 Enterprise Server Edition.*DAS_USERNAME = dasuser *DAS_DOMAIN = domain *DAS_PASSWORD = dasp *DAS_SMTP_SERVER = jsmith.torolab.ibm.com
The following options specify where the DAS contact list will be kept. On Linux or UNIX operating systems, these options are valid for root installation only. If the contact list is remote, you must specify a user name and password that has authority to add a contact to the system.*DAS_CONTACT_LIST = LOCAL or REMOTE (DEFAULT = LOCAL) *DAS_CONTACT_LIST_HOSTNAME = hostname *DAS_CONTACT_LIST_USERNAME = username *DAS_CONTACT_LIST_PASSWORD = password
- On Linux or UNIX
operating systems:
- Special instance specifications
- The special instance specifications takes the instance section not instance name. The instance
section must exist in the response file.
- Windows operating systems:
- DEFAULT_INSTANCE - This is the default instance.
- Linux or UNIX
operating systems:
- none
- Windows operating systems:
- Instance specifications
- For root installations,
you can use the response file to create as many instances as you want. To create an instance you
must specify an instance section with the INSTANCE keyword. Any keywords that
contain the value specified in INSTANCE as a prefix belong to that instance. On
Windows operating systems, you can also specify
LOCALSYSTEM as a valid user ID that does not require a password. The
LOCALSYSTEM user ID is available for all products, except Db2 Enterprise Server
Edition.
The START_DURING_INSTALL keyword determines if the instance is started after installation. The AUTOSTART keyword determines if the instance is auto started after system reboot. If START_DURING_INSTALL is not specified, AUTOSTART also determines if the instance is started after installation.
The following are examples of instance specifications for Windows, Linux, and UNIX operating systems:
To create an instance for an existing user, do not specify the PASSWORD, UID, GID, GROUP_NAME, or HOME_DIRECTORY keywords. To create the user or the fenced user, you must specify all of the previous keywords in the db2setup command.- On Linux or UNIX
operating systems:
*INSTANCE=DB2_INST *DB2_INST.NAME = db2inst1 *DB2_INST.TYPE = ESE *DB2_INST.PASSWORD = PASSWORD (valid for root installation only) *DB2_INST.UID = 100 (valid for root installation only) *DB2_INST.GID = 100 (valid for root installation only) *DB2_INST.GROUP_NAME = db2grp1 (valid for root installation only)) *DB2_INST.HOME_DIRECTORY = /home/db2inst1 (valid for root installation only) *DB2_INST.SVCENAME = db2cdb2inst1 *DB2_INST.PORT_NUMBER = 50000 *DB2_INST.FCM_PORT_NUMBER = 60000 (valid for root installation only) *DB2_INST.MAX_LOGICAL_NODES = 4 (valid for root installation only) *DB2_INST.AUTOSTART = YES *DB2_INST.START_DURING_INSTALL = YES *DB2_INST.FENCED_USERNAME = USERNAME (valid for root installation only) *DB2_INST.FENCED_PASSWORD = PASSWORD *DB2_INST.FENCED_UID = 100 *DB2_INST.FENCED_GID = 100 *DB2_INST.FENCED_GROUP_NAME = db2grp1 *DB2_INST.FENCED_HOME_DIRECTORY =/home/db2inst1 *DB2_INST.CONFIGURE_TEXT_SEARCH = NO *DB2_INST.TEXT_SEARCH_HTTP_SERVICE_NAME = db2j_DB2_INSTANCE (valid for root installation only) *DB2_INST.TEXT_SEARCH_HTTP_PORT_NUMBER = 55000*DB2_INST.FEDERATED = YES *DB2_INST.INFORMIX_CLIENT_HOME = BLANK (valid for root installation only) *DB2_INST.INFORMIX_SERVER_HOME = BLANK
- To create multiple instances:
*INSTANCE=DB2_INS2 *DB2_INS2.NAME = db2inst2 *DB2_INS2.TYPE = ESE *DB2_INS2.PASSWORD = PASSWORD (valid for root installation only) *DB2_INS2.UID = 100 (valid for root installation only) *DB2_INS2.GID = 100 (valid for root installation only) *DB2_INS2.GROUP_NAME = db2grp1 (valid for root installation only)) *DB2_INS2.HOME_DIRECTORY = /home/db2inst1 (valid for root installation only) *DB2_INS2.SVCENAME = db2cdb2inst1 *DB2_INS2.PORT_NUMBER = 50000 *DB2_INS2.FCM_PORT_NUMBER = 60000 (valid for root installation only) *DB2_INS2.MAX_LOGICAL_NODES = 4 (valid for root installation only) *DB2_INS2.AUTOSTART = YES *DB2_INS2.START_DURING_INSTALL = YES *DB2_INS2.FENCED_USERNAME = USERNAME (valid for root installation only) *DB2_INS2.FENCED_PASSWORD = PASSWORD *DB2_INS2.FENCED_UID = 100 *DB2_INS2.FENCED_GID = 100 *DB2_INS2.FENCED_GROUP_NAME = db2grp1 *DB2_INS2.FENCED_HOME_DIRECTORY =/home/db2inst1 *DB2_INS2.CONFIGURE_TEXT_SEARCH = NO *DB2_INS2.TEXT_SEARCH_HTTP_SERVICE_NAME = db2j_DB2_INSTANCE (valid for root installation only) *DB2_INS2.TEXT_SEARCH_HTTP_PORT_NUMBER = 55000*DB2_INST.FEDERATED = YES *DB2_INST.INFORMIX_CLIENT_HOME = BLANK (valid for root installation only) *DB2_INST.INFORMIX_SERVER_HOME = BLANK
- On Windows operating system:
DEFAULT_INSTANCE = DB2_INST INSTANCE = DB2_INST DB2_INST.NAME = DB2 *DB2_INST.TYPE = ESE DB2_INST.USERNAME = username *DB2_INST.DOMAIN = domainname DB2_INST.PASSWORD = password DB2_INST.AUTOSTART = YES DB2_INST.START_DURING_INSTALL = YES *DB2_INST.MAX_LOGICAL_NODES = 4 *DB2_INST.CONFIGURE_TEXT_SEARCH = NO *DB2_INST.TEXT_SEARCH_HTTP_SERVICE_NAME = db2j_DB2_INSTANCE *DB2_INST.TEXT_SEARCH_HTTP_PORT_NUMBER = 55000
- To create multiple instances:
*INSTANCE = DB2_INS2 *DB2_INS2.NAME = DB2_01 *DB2_INS2.TYPE = ESE *DB2_INS2.USERNAME = username *DB2_INS2.DOMAIN = domainname *DB2_INS2.PASSWORD = password *DB2_INS2.AUTOSTART = YES *DB2_INS2.START_DURING_INSTALL = YES *DB2_INS2.MAX_LOGICAL_NODES = 4 *DB2_INS2.CONFIGURE_TEXT_SEARCH = NO *DB2_INS2.TEXT_SEARCH_HTTP_SERVICE_NAME = db2j_DB2_INSTANCE *DB2_INS2.TEXT_SEARCH_HTTP_PORT_NUMBER = 55000
Note: On Windows operating system, in the case of the second and subsequent instances, the DEFAULT_INSTANCE keyword is not specified. This keyword is specified on the first instance only. - On Linux or UNIX
operating systems:
- Database Section
- These keywords can be used to have the installation create or catalog a database on the machine
that is being installed.
DATABASE = DATABASE_SECTION DATABASE_SECTION.INSTANCE = db2inst1 DATABASE_SECTION.DATABASE_NAME = MYDB DATABASE_SECTION.LOCATION = LOCAL DATABASE_SECTION.ALIAS = MYDB DATABASE_SECTION.USERNAME = username DATABASE_SECTION.PASSWORD = password * these keywords are only used for REMOTE databases that are being cataloged DATABASE_SECTION.SYSTEM_NAME = hostname DATABASE_SECTION.SVCENAME = db2c_db2inst1
- Contact Section
- These keywords define a contact section that will be created by the installation process if it
does not yet exist. The Health notifications for the instance that is specified will be sent to this
contact.
On Linux or UNIX operating systems, these keywords are valid for root installation only.CONTACT = contact_section contact_section.NEW_CONTACT = YES contact_section.CONTACT_NAME = contact name contact_section.INSTANCE = DB2_INSTANCE contact_section.EMAIL = Email address contact_section.PAGER = NO
- Extended security section
- Windows operating systems only. These keywords define
a security section.
*DB2_EXTSECURITY = YES *DB2_ADMINGROUP_NAME = DB2ADMNS *DB2_USERSGROUP_NAME = DB2USER *DB2_ADMINGROUP_DOMAIN = BLANK *DB2_USERSGROUP_DOMAIN = BLANK
- No configuration option
- Windows operating systems only. This keyword gives you
the option to install a Db2 database product with
only the mandatory configuration. The Db2 instance must be
created manually. The default is NO.
*NO_CONFIG = NO
The options are:- YES
- NO
IBM Db2 pureScale Feature installation keywords
The following response file keywords are used in a Db2 pureScale Feature installation. Special considerations and interdependencies are required when using these keywords. For details, see Response file considerations for a Db2 pureScale environment.
- HOST
- Specifies the hosts to which the Db2 product is to be
installed. There can be multiple occurrences of this HOST keyword in the response file, one of each
distinct host. This keyword is limited to 14 characters, and is a mandatory keyword for a Db2
pureScale instance or
update. The maximum number of hosts is 130 (two cluster caching facilities, and 128 members.) This keyword is
used as the ID of a host set, to differentiate the other host sets, and acts as the prefix of the
keyword HOSTNAME and CLUSTER_INTERCONNECT_NETNAME. For example:
HOST = host1 host1.HOSTNAME = hostname1 host1.CLUSTER_INTERCONNECT_NETNAME = ibname1 HOST = host2 host2.HOSTNAME = hostname2 host2.CLUSTER_INTERCONNECT_NETNAME = ibname2
- HOSTNAME
- Specifies a host name to a physical machine or LPAR on which a Db2 member or cluster caching facility is running. This host name must be a unique host name across the network, and is limited to 255 characters. This keyword is prefixed with the HOST keyword value, and is a mandatory keyword for a Db2 pureScale instance or update. If an alias or IP is provided, the name is converted to a canonical host name for instance creation. The host name format can be: long name (for example, hostname1.ibm.com), short name (for example, hostname1), or an IPv4 or IPv6 address.
- CLUSTER_INTERCONNECT_NETNAME
- Specifies the IP address or host name of the interconnect used for high speed communication between members and cluster caching facilities in the Db2 instance. This keyword is limited to 255 characters, and is a mandatory keyword for a Db2 pureScale instance or update. The host high speed name format can be: long name (for example, host1.ibm.com), short name (for example, host1), or an IPv4 or IPv6 address. You must use the same format for all hosts specified.
- DB2_CLUSTER_SERVICES_TIEBREAKER_DEVICE_PATH
- Identifies the device path being used to set up a cluster services tiebreaker. All hosts specified in the HOST sections must have direct access to this path. A shared disk is required for cluster recovery purposes. This disk should be at least 25 MB. For example, /dev/hdisk2. However, this keyword cannot have the same value as keyword INSTANCE_SHARED_DEVICE_PATH.
- INSTANCE_SHARED_DEVICE_PATH
- Identifies the device path used to create a Db2 Managed clustered file system for shared files from a Db2 pureScale instance. All hosts specified in the HOST sections must have direct access to this path. This path must be at least 2 GBs. This is a mandatory keyword for the first Db2 pureScale instance. For example, /dev/hdisk3.
- INSTANCE_SHARED_MOUNT
- Specifies the mount point for a new General Parallel File System (GPFS). The specified path must be a new and empty path that is not nested inside an existing GPFS file system.
- INSTANCE_SHARED_DIR
- Identifies the path to an existing file system for storing shared files from a Db2 pureScale instance. When this keyword is specified, a User-Managed file system method is used, and the value specified must be an existing GPFS type file system which is mounted on all hosts. All hosts specified in the HOST sections must have direct access to this directory. This partition must be at least 1 GB. If either the INSTANCE_SHARED_DEVICE_PATH keyword is specified, or a DEFAULT_INSTPROF record exists in the Global Registry, this keyword is ignored.
- Instance specifications
-
The following are examples of instance specifications for the Db2 pureScale Feature:
- On AIX operating systems:
INSTANCE = db2inst1 db2inst1.NAME = db2sdin1 *db2inst1.UID = 100 db2inst1.GROUP_NAME = db2isdm1 *db2inst1.GID = 100 db2inst1.HOME_DIRECTORY = /home/db2inst1 db2inst1.PASSWORD = password db2inst1.START_DURING_INSTALL = YES db2inst1.PREFERRED_PRIMARY_CF = host1 db2inst1.PREFERRED_SECONDARY_CF = host3 db2inst1.MEMBER = host2 db2inst1.MEMBER = host4 *db2inst1.SVCENAME = db2c_db2sdin1 *db2inst1.PORT_NUMBER = 50000 *db2inst1.FCM_PORT_NUMBER = 60000 *db2inst1.MAX_LOGICAL_NODES = 1 . *db2inst1.DB2CF_PORT_NUMBER = 56001 *db2inst1.DB2CF_MGMT_PORT_NUMBER = 56000 *db2inst1.TYPE = DSF *db2inst1.AUTHENTICATION = SERVER
Note:- The keyword PREFERRED_PRIMARY_CF identifies the host that is designated as the preferred primary cluster caching facility for the instance being set up. This is a mandatory keyword for a Db2 pureScale instance.
- The keyword PREFERRED_SECONDARY_CF identifies the host that is designated as the secondary cluster caching facility for the instance being set up.
- The keyword MEMBER identifies the host that is designated as a member for the instance being set up. This is a mandatory keyword for a Db2 pureScale instance.
- The keywords DB2CF_PORT_NUMBER and DB2CF_MGMT_PORT_NUMBER are reserved for the cluster caching facility. The cluster caching facility is an instance designation, therefore the port names will be predefined based on the name of the instance. For example: When the instance name is db2sdin1, the names required for the cluster caching facility ports are DB2CF_db2sdin1 and DB2CF_db2sdin1_MGMT_PORT_NUMBER. Ensure that all port names are the same on all participating hosts. The two cluster caching facility ports must be available on all the participating hosts. The DB2CF port keywords are optional. If they are not specified, the Db2 installer generates unique ports across all hosts.
- On AIX operating systems:
Keywords for the db2rfe configuration file
Use the following keywords to select features and settings to create the db2rfe configuration file:
- INSTANCENAME
- Specifies the user name who owns the non-root installation copy.Note: Do not comment out the INSTANCENAME keyword. This is a required keyword.
- SET_ULIMIT
- AIX only. For other operating systems, see the system
documentation for information about setting this manually. On AIX, when this keyword is set to YES, the db2rfe command
sets the hard and soft data parameter to unlimited, the hard and soft file size to unlimited, and
sets the hard and soft nofile parameter to 65536. The options are:
- YES
- NO
- ENABLE_DB2_ACS
- AIX, Linux on
AMD64/EM64T, and Linux on Power Systems servers only. Enables the Db2 Advanced Copy
Services (ACS). The default value is NOThe options are:
- NO
- YES
- ENABLE_HA
- Specifies support of
High
Availability using IBM
Tivoli System Automation for Multiplatforms. The default
value is NO.The options are:
- NO
- YES
- ENABLE_OS_AUTHENTICATION
- Specifies support of operating system authentication for database connection. The default value
is NO. The options are:
- NO
- YES
- RESERVE_REMOTE_CONNECTION
- Reserves service for a remote connection. The default value is NO.The options are:
- NO
- YES
Note:- If the database manager configuration parameter svcename has a value, and the keywords SVCENAME or SVCEPORT are also provided in the configuration file, all three values must match.
- If the database manager configuration parameter svcename has a value, and either keyword SVCENAME or SVCEPORT is not provided, either port_number or service_name of svcename is used with a generated service_name or port_number respectively.
- If the database manager configuration parameter svcename is not set, and neither keyword SVCENAME and SVCEPORT are provided, a default service name and port number is generated and reserved.
- SVCENAME
- Used with the keyword RESERVE_REMOTE_CONNECTION. Specifies the service name of a remote connection. This keyword is limited to 14 characters.
- SVCEPORT
- Used with the keyword RESERVE_REMOTE_CONNECTION. Specifies a port number of a remote connection within the range 1024 - 65535.
- RESERVE_TEXT_SEARCH_CONNECTION
- Reserves the service entry for the port used by Db2 Text Search. The
default value is NO.The options are:
- NO
- YES
- SVCENAME_TEXT_SEARCH
- Used with the keyword RESERVE_REMOTE_CONNECTION. Specifies the service name of the service entry for the port used by Db2 Text Search. This keyword is limited to 14 characters.
- SVCEPORT_TEXT_SEARCH
- Used with the keyword RESERVE_REMOTE_CONNECTION. Specifies a port number of the service entry for the port used by Db2 Text Search.
See the related links for the configuration parameters summary and Db2 registry and environment variables.
Uninstallation keywords
You can use the following response file keywords to uninstall a product or feature:
The following response file keywords can be used to uninstall a product, feature, or language:
- REMOVE_PROD
- Specifies the Db2 database product that you want to uninstall. You can uninstall the database products individually or you can uninstall all the database products. To uninstall all products in the current Db2 copy, specify REMOVE_PROD=ALL. The Db2 products in other Db2 copies are not affected. On Windows operating systems, you cannot combine this keyword with REMOVE_COMP or REMOVE_LANG.
- REMOVE_COMP
- Specifies the Db2 components that you want to uninstall. On Windows operating systems, you cannot combine this keyword with REMOVE_PROD.
- REMOVE_LANG
- Specifies the languages you want to uninstall. You cannot uninstall English. To uninstall all languages, except English, from the current Db2 copy, specify REMOVE_LANG=ALL. English will not be removed until the last Db2 product in the Db2 copy is uninstalled. On Windows operating systems, you cannot combine this keyword with REMOVE_PROD.
- REMOVE_TSAMP
- Specifies the IBM
Tivoli System Automation for Multiplatforms to be
uninstalled. The default is YES. The options are:
- YES
- NO
REMOVE_PROD=ALL
.When removing Db2 pureScale Feature, if Tivoli SA MP was originally installed as part of the Db2 installation, it is also automatically uninstalled when the last Db2 pureScale copy is removed. If you want to keep the RSCT peer domain but remove the Db2 copy, you can skip the removal by specifying REMOVE_TSAMP=NO.
- REMOVE_GPFS
- Specifies the IBM General Parallel File System (GPFS) to be uninstalled. The default is
YES. The options are:
- YES
- NO
REMOVE_PROD=ALL
.When removing Db2 pureScale Feature, if GPFS was originally installed as part of the Db2 installation, it is also automatically uninstalled when the last Db2 pureScale copy is removed. If you want to keep the GPFS cluster and its file systems but remove the Db2 copy, you can skip the removal by specifying REMOVE_GPFS=NO.
- REMOVE_DAS
- Windows operating systems only. Determines if the DAS is to be
deleted. The default is NO.The options are:
- NO
- YES
Depending on your environment setup, the installation action varies.- If you have only one Db2 copy with only one server product installed, and the server product is being removed, the DAS is removed without checking the value of this keyword.
- If you have only one Db2 copy and 2 or more server products installed, and one server product is being removed, the value of this keyword is not checked and the DAS is not removed.
- If you have two or more Db2 copies, this keyword
is only examined when both the following are also true:
- The DAS is configured and active under the Db2 copy that is being removed, and
- You are removing all server products in the Db2 copy.
When this keyword is set to YES, and the conditions specified previously are met, the uninstallation always remove the DAS when removing the current Db2 copy. In this case, other Db2 copies that require the use of a DAS will not function properly after the DAS is removed. Before removing the DAS, you must move the DAS to another Db2 copy using the dasupdt command.
- REMOVE_INSTALL_CREATED_USERS_GROUPS
- Removes the users and groups created by the Db2 installer for the
current Db2
copy. The default is NO. The options are:
- YES
- NO
- REBOOT
- Windows operating systems only. Specifies whether to
restart the system when the installation or uninstallation has completed. The default is
NO. The options are:
- YES
- NO