Performing the agent installation
Task 1: To extract the agent files from the TAR file
Use the tar command in the z/OS UNIX shell to extract the agent files. During extraction, all agent files are saved in the same directory. Only users with the following permission can run the agent files in the FACILITY class:
- BPX.FILEATTR.APF ACC(READ)
- BPX.FILEATTR.PROGCTL ACC(READ)
- BPX.FILEATTR.SHARELIB ACC(READ)
Use the first tar command to extract the agent .tar file from the product package.
Use the second tar command to extract the agent component files into a directory.
The directory name usually includes the agent’s release number. We recommend creating an alias that does not include the release number for the directory. This makes future upgrades more transparent, as shown in the following example:
su
cd /usr/lpp/model9
tar -xpf model9-data-vault-zos-package-4.1.1.tar "model9-data-vault-zos-package-v4.1.1/model9-m9agent-v4.1.1.tar"
tar -xpf model9-data-vault-zos-package-v4.1.1/model9-m9agent-v4.1.1.tar
# define the alias name "agent"
ln -s model9-m9agent-v4.1.1 agent
Task 2: To create and populate the configuration directory
Create and copy the BMC AMI Cloud sample configuration directory by using the following commands:
mkdir conf
cp agent/sampleConf/* conf/
Task 3: To create a program-controlled version of PAX
The BMC AMI Cloud z/OS UNIX files backup uses PAX. To create a program-controlled version of PAX, use the following commands:
mkdir bin
cp -p /bin/pax bin
# Set program-control flag
extattr +p bin/pax
Task 4: To copy the BMC AMI Cloud libraries from USS to PDS
Edit and submit the JCL CPY#PDS located in /usr/lpp/model9/agent/installation/ to create the BMC AMI Cloud LOADLIB, SAMPLIB, and EXEC PDS files.
oedit agent/installation/CPY#PDS
Task 5: To install the BMC AMI Cloud Command Line Interface
You can use the BMC AMI Cloud CLI (command line interface) as an interface for issuing BMC AMI Cloud commands from TSO / JCL. Use the following procedure to install the CLI:
Create a listener directory:
cd /usr/lpp/model9/
mkdir listener
chmod 777 listener
chmod +t listenerCustomize the M9CLI REXX in the SYS2.MODEL9.EXEC PDS to match installation standards:
fifodir = "/usr/lpp/model9/listener"
loaddir = "SYS2.MODEL9.V411.LOADLIB"- Copy the M9CLI EXEC to your site’s local EXEC library.
Task 6: To define the agent with security permissions
To define the security settings required by the agent, use the sample JCL as mentioned in the following list:
- RACF: Use the sample JCL M9PRMRCF in the SAMPLIB PDS.
- ACF2: Use the sample JCL M9PRMACF in the SAMPLIB PDS.
- TSS: Use the sample JCL M9PRMTSS in the SAMPLIB PDS.
(Optional - RACF only) To use the RACF TRUSTED attribute
By default, the M9PRMRCF JCL contains a definition for the M9USER with the OPERATIONS attribute. BMC AMI Cloud also supports the RACF TRUSTED attribute when extended auditing is required. To perform this change, follow the steps below:
- Remove OPERATIONS from ADDUSER M9USER command in the M9PRMRCF JCL.
- Add TRUSTED(YES) attribute to all RDEFINE STARTED commands within the STDATA section. For example, RDEFINE STARTED M9AGENT.** STDATA(USER(M9USER) GROUP(SYS1) TRUSTED(YES))
Add an RDEFINE statement for the life cycle procedure as the TRUSTED attribute. This attribute is supported only for stated tasks.
RDEFINE STARTED M9LIFECY.** STDATA(USER(M9USER) GROUP(SYS1) TRUSTED(YES))
Submit the JCL and verify that all the commands were performed. If necessary, review the output.
Task 7: To customize the BMC AMI Cloud agent start procedure
Copy the sample JCL M9AGENT from the SAMPLIB PDS to a local PROCLIB member, and update the variables in the JCL as follows:
Variable | Update |
---|---|
DD STEPLIB | BMC AMI Cloudinstallation LOADLIB |
PWD environment variable | BMC AMI Cloudagent installation path |
CONF_HOME environment variable | BMC AMI Cloudagent configuration directory path |
You can use CONF_HOME to activate more than one agent in the same LPAR, allowing each agent to use the same BMC AMI Cloud installation files and libraries but have a different configuration directory. We recommend that you have one agent per LPAR and point all agents in the same GRS-complex to the same BMC AMI Cloud complex. However, additional agents in the same LPAR might be required in the following scenarios:
- You are using a sub-plex.
- You have both development and production environments.
- You are pointing the agents to a different cloud storage.
CONF_HOME must precede the stdenv-main.sh statement.
Task 8: To update the BMC AMI Cloud agent configuration
Before starting the agent, update the model9-stdenv.sh and agent.yml configuration files located in /usr/lpp/model9/conf. For more information, see Updating the BMC AMI Cloud agent configuration files.
Task 9: To update the BMC AMI Cloud agent license
Update the license file at /usr/lpp/model9/conf/model9-licenses.txt. The file can accommodate several licenses, for example, the license of all the LPARS in the sysplex and the Disaster Recovery site’s license.
Write each license on a separate line. Comments should be preceded by a # sign.
When multiple licenses are specified in the file, the CPUID must correlate with the CPUID of the executing LPAR. The license with the latest expiration date is used.
The details of the license to be used are displayed in the agent’s log and in the UI. If the agent cannot find a valid license, an error message is displayed as a WTO. The full error message is available in STDOUT.
Task 10: To install automatic recall
You can use the BMC AMI Cloud automatic recall intercept to recall archived files from within z/OS in a transparent manner. To install the automatic recall intercept:
Update the PROGxx configuration by adding the following statements:
APF ADD DSNAME(SYS2.MODEL9.V411.LOADLIB) SMS
LPA ADD DSNAME(SYS2.MODEL9.V411.LOADLIB) MOD(ZM9CPTN)
LPA ADD DSNAME(SYS2.MODEL9.V411.LOADLIB) MOD(ZM9S26X)
EXIT ADD EXITNAME(ZM9P_S026) MOD(ZM9S26X) PARM('M9ARCH')Apply the changes by using the following operator command from any console:
SET PROG=xxCopy the M9HOOK and M9UNHOOK JCL from the SAMPLIB PDS to a local PROCLIB member. Customize the M9HOOK JCL accordingly and activate it by using the following command:
S M9HOOKIf an existing BMC AMI Cloud intercept has been uninstalled, then you must load a new copy of the ZM9CPTN module to the dynamic LPA by using the following command:
SETPROG LPA ADD DSNAME=SYS2.MODEL9.V411.LOADLIB MOD=ZM9CPTNIf you are using another data management product together withBMC AMI Cloud , add the following DD statement to the other product’s procedure to avoid collisions:
//ZM9$NORC DD DUMMY- Restart the address space after applying the DD.
Task 11: To update the life cycle management JCL
The BMC AMI Cloud life cycle management JCL is responsible for automatically deleting data sets (archives, backups and imports) that have expired. A sample JCL, M9LIFECY, is available in the BMC AMI Cloud SAMPLIB PDS.
Grant your site scheduler permission for surrogate access to the M9USER:
RDEFINE SURROGAT M9USER.SUBMIT UACC(NONE)
PERMIT M9USER.SUBMIT CLASS(SURROGAT) ID(<scheduler>) ACC(READ)
SETR REFRESH RACLIST(SURROGAT)Update the variables in the life cycle management JCL as follows:
Variable
Update
DD STEPLIB
BMC AMI Cloudinstallation LOADLIB
PWD environment variable
BMC AMI Cloudagent’s installation path
- To submit the life cycle management JCL in the simulate mode, set --simulate to yes.
The life cycle management JCL lists all the data sets that would have been deleted without actually deleting them. - To submit the life cycle management JCL in the initial mode, set --simulate to no or remove.
The life cycle management JCL scans all archived data sets with expiration dates in the past up until today’s date. The next time the life cycle runs, it will resume where the previous process ended. (Optional) To set M9LIFECY to use the RACF TRUSTED attribute instead of OPERATIONS, define the JCL as a started task and replace the M9LIFECY's JOB card with //M9LIFECY PROC.
Task 12: To start the BMC AMI Cloud agent
Start the agent from any console by issuing the following command:
S M9AGENTVerify that the agent was started successfully. The following messages should appear:
ZM91002I MODEL9 BACKUP AGENT VERSION 4.1.1 INITIALIZING
ZM91000I MODEL9 BACKUP AGENT INITIALIZEDVerify that the agent is connected to the object storage by searching for the following message in STDOUT:
Object store connectivity has been established successfully
Task 13: To configure the Remote Server API M9SAPI
You can use the optional Remote Server API feature to run BMC AMI Cloud policies from within z/OS by using standard JCL. To enable the Remote Server API feature:
- Copy the sample JCL PROC M9SAPI from the SAMPLIB PDS to a local PROCLIB file and edit the procedure according to the instructions in the file. You can use the JCL M9SAPIJ sample to run a policy.
- The Remote Server API uses HTTPS to communicate with the server.
- If a trusted certificate is not defined for the server, set VRFYCERT=NO in the M9SAPI procedure to skip certificate validations.
If a valid certificate is defined, make sure that the user running the M9APIJ has the correct SAF keyring defined to enable validation of the server certificate. You can use the SAPI_KEYRING_NAME setting defined in the sample model9-stdenv.sh configuration to specify the keyring name.
- When verifying the certificate used by the Remote Server API, you must define it for a Resource Access Control Facility (RACF) by using a keyring.