Verifying the installation of Db2 Administration Foundation
You can test the successful installation of Db2
Administration Foundation using steps listed in the
following section. The installation verification program uses REST
APIs
, GET
, PUT
, and POST
operations to verify the Db2
Administration Foundation
installation verification program sample objects.
Before you begin
- Ensure that the Unified Management Server and Db2 Administration Foundation are installed.
- Ensure that the Db2 for z/OS installation verification program sample database is installed in one of the Db2 Subsystems to be used in the Unified Management Server/Db2 Administration Foundation installation verification program.
- The installation verification program is a Python 3.0 program that confirms Python 3.0
environment availability. To install Python 3.0, see Python 3 Installation & Setup Guide. Ensure that
Python 3.0 with the following plug-ins is installed on a workstation connected
to the network.
getpass
urllib
andurllib3
requests
json
datetime
pyyaml
Note: Other modules can be used, and must be available with modern UNIX and macOS platforms as per the Python documentation. - Ensure that you have an ID that is established as a Super User in the Unified Management Server/Db2 Administration Foundation installation. Ensure that the ID you create has access to read the selected Db2 catalog.
Procedure
-
Accessing the installation verification program: The installation
verification program files are installed in the
components.izp.runtimeDirectory/ivp
folder. Usesftp-r
orftp-r
inbin
mode to copy all files into a dedicated directory on your workstation.The files contained in this folder are described below.Table 1. The installation verification program folder contents File name Description /Resources/Common/config.json
File for configuring the following UMS host and port variables: IZP_UMS_HOST
IZP_UMS_HTTP_PORT
/Resources/adminFoundation/ivpAFDData.json
File for defining the default values of the installation verification program parameters. Ensure that you customize this file before running the installation verification program. /Resources/db2_subsystems/ssid.NAME.json
If you are using the installation verification program to register a Subsystem, you must edit this template before running the installation verification program to create the Db2 Administration Foundation Subsystem. /Reports
Stores the last run results. afxivp.sh
File for running the Db2 Administration Foundation installation verification program. -
Setting up the installation verification program: After the required
installation verification program files are available in a directory on your
workstation, customize the following files.
- Open the
config.json
file in a text editor. Specify values for the following UMS host and port variables:IZP_UMS_HOST
IZP_UMS_HTTP_PORT
- Open the
ivpAFDData.json
file in a text editor. It is recommended to customize this file for your installation because the installation verification program refers to this file for default values. If this file is not updated, several field updates are required while running the script.Although the following attributes are not mandatory, it is recommended that you edit them in the
ivpAFDData.json
file.Table 2. The ivpAFDData.json
file attributesAttribute name Description Db2Subsystem Change this value to the Db2 Subsystem Identifier that is used by the installation verification program. For example: DSNA
,DB2P
.Database Change this value to the Db2 sample database name that is in the Db2 Subsystem. Ensure that the Db2 Subsystem you select has the Db2 for z/OS installation verification program database defined. For example, database
DSN8DxxA
, where xx denotes the Db2 version.Note: If you want to modify this value, ensure to provide a valid database name which is present in the Db2 subsystem.Db2Plan Change this value to the Db2 plan name that is in the Db2 sample database. Table Change this value to the Db2 table that is in the Db2 sample database. - If you need the installation verification program to register a
Subsystem, customize the sample
ssid.NAME.json
file. If you already have a Subsystem registered in Db2 Administration Foundation and you want to use this Subsystem for the installation verification program, this file customization is not required. - Copy the
ssid.NAME.json
file to a location whereNAME
is replaced with the SSID of your Db2 Administration Foundation Subsystem. To register a Db2 named DSNA, a file namedssid.DSNA.json
must exist in the same directory as the Python program. This is the directory where the installation verification program files were extracted. - Edit the
ssid.<ssid-name>.json
file attributes in a text editor.Note: This file is used as an input into the Subsystem registration API call and must reflect the installation.You must edit the following attributes in the
ssid.<ssid-name>.json
file.Optionally, you can edit the following attributes in theTable 3. The ssid.<ssid-name>.json
file attributesAttribute name Description name
Change the ssid
value to match the Db2 SSID or group name and the value used in the<ssid-name>
node of the file name.url
Change the url.com
value to match the IP address or domain name used when making a JDBC connection to this Subsystem.port
Change the port
value to match the IP port used when making a JDBC connection to this Subsystem.location
Change the location
value to match the database location used when making a JDBC connection to this Subsystem.sdsnexit
Change the prefix.SDSNEXIT
value to match theSDSNEXIT
library name for this Subsystem.sdsnload
Change the prefix.SDSNLOAD
value to match theSDSNLOAD
library name for this Subsystem.runlib
Change the prefix.RUNLIB.LOAD
value to match theRUNLIB.LOAD
library name for this Subsystem.cmbatchDsn
Change the izpPrefix.PROCLIB
value to match the PROCLIB chosen during installation.ssid.<ssid-name>.json
file.Table 4. The ssid.<ssid-name>.json
file attributesAttribute name Description storageGroup
- Lists the Db2 Storage Group that is used when creating Db2 Administration Foundation instance objects in this Subsystem.
- Replace
SYSDEFLT
with this Db2 Storage Group name, if needed.
version
Change this value to match the Db2 version for this Subsystem. installWLM
Required for DDL generation. plan
Change the default plan name, if needed. installSchema
Db2 Administration Foundation objects created for tool management uses has a schema of IZPN01
. Change this value, if needed.installNamingRule
Db2 Administration Foundation objects created for tool management uses has a name starting with IZP1
. Change this value, if needed.dsntep2PlanName
If DSNTEP2
is bound with a plan name other thanDSNTEP2
, change this value.jobcard
Review this attribute as an acceptable jobcard
framework for your system.The installation verification program runs remotely by using Unified Management Server/Db2 Administration Foundation APIs to invoke multiple back-end functions.
- Open the
-
Running the installation verification program: From the directory where
the installation verification program files are located, run the
afxivp.sh
script. This invokes Python 3.0. The script checks whether it is running in a Python 3.0 environment. The script stops if Python 3.0 is not available. -
You are prompted for the following values:
- UMS configuration
The installation verification program gathers the environment details by default. Users can also update details by selecting options. Once the configuration details are set correctly, the values are saved for future use.
- User ID
- Password
The password is not stored after running the script.
- Db2
Administration Foundation data
setup
Specify a subsystem name. You can use the existing object name or add new objects to be used for the installation verification program.
- UMS configuration
-
At the end of the installation verification program, a summary report is
displayed. You can select to save the summary report in the
/Reports
folder. -
You can quit the installation verification program by using the following
options:
q
quits and still writes options and report files.q!
quits without writing the options or report files.