Install and configure the z/OS agent

This topic explains how to install and set up a Deployment Automation agent on z/OS.

z/OS mainframe system requirements:

  • z/OS Java Virtual Machine 86 (JVMLDM86)
  • Java 8 64-bit

To install, you need these names:

  • The PDS/E load library where JVMLDM86 is installed.
  • The UNIX directory where Java 64-bit is installed.

Note: ssh, sudo, or su impersonation is not available with the z/OS agent.

To install the z/OS Deployment Automation agent:

  1. Download the z/OS agent archive, for example, zos-agent-6.3.0.243.24.zip.
  2. Unpack the downloaded file. This creates a folder called zos-agent-install.
  3. Create the z/OS mainframe PDS dataset where the DA agent JCL procedure and batch job will be deployed, for example:

    MF.DAAGENT.JCLLIB

  4. Edit the zos.properties file to set values for the following z/OS installation properties:

    z/OS DA agent environment properties
    zos.agent.name Agent name, for example, ZOS_DA-Agent.
    zos.agent.home.dir

    Home directory where the agent will be installed, for example:

    /MicroFocus/DA-Agent

    zos.java.home.dir Java home directory where Java 8 64-bit is installed.
    da.server.hostname Deployment Automation server host name.
    zos.java.debug.opts

    (Optional) Java virtual machine debug options, for example:

    "-Xdebug -Xrunjdwp:transport=dt_socket,address=localhost:10001,server=y,suspend=n -Dcom.sun.management.jmxremote"

    zos.java.opts

    (Optional) Java virtual machine debug options, for example:

    "-Xmx512m"

    z/OS DA agent encoding properties
    zos.agent.stdout.encoding z/OS encoding used for plugin steps output, for example, Cp1047.
    zos.agent.console.encoding z/OS console encoding, for example, Cp1047.
    zos.agent.file.encoding z/OS file encoding, for example, Cp1047.
    z/OS connection properties
    zos.hostname The host name where the DA agent will be installed.
    zos.ftp.port The port used for FTP on z/OS.
    zos.ftp.userid The user that will install the DA agent into z/OS.
    zos.ftp.pwd: The user's password.

    z/OS DA agent Batch Job or Started Task properties
    zos.da.jcllib

    The mainframe PDS dataset where the batch or started task procedure and batch job will be deployed, for example:

    CHGMAN.B.CMN.DAAGENT.JCLLIB

    zos.java.loadlib

    the mainframe PDS dataset load library where the Java Virtual Machine module is installed, for example:

    CHGMAN.B.CMN.JZOS.LOAD

    zos.taskname The DA agent task name to use.
    zos.jobname The DA agent batch job name to use when the batch job is submitted.
    zos.jobclass The system job class assigned to the DA agent batch job. The class will determine the dispatching priority of the batch job.
    zos.jobowner The job owner of the DA agent batch job.
    zos.java.use.lpa Specifies whether to run JZOS in LPA (true/false).

  5. Use the following command to deploy the z/OS agent to DA:

    Windows deploy-agent.bat
    UNIX/Linux deploy-agent.sh
  6. Choose an installation option:

    installAgent Configure the DA agent properties based on information specified in zos.properties. Deploys the DA agent to z/OS.
    uninstallAgent Remove the DA agent from z/OS based on information specified in zos.properties.
    reinstallAgent Run uninstallAgent and then installAgent, as described above.
  7. To start the agent, run this z/OS command:

    Copy code
    /S zos.taskname

     

    To stop the agent, run this z/OS command:

    Copy code
    /P zos.taskname

     

    Replace zos.taskname with the DA agent task name specified in zos.properties.

  8. When running the agent as a started task, set a RACF STARTED profile:

    Copy code
    RDEF STARTED procname*.* STDATA(USER(userid) TRUSTED(NO))
  9. When running with JZOS in LPA, run this command once per LPAR IPL:

    Copy code
    SETPROG ADD,LPA,DSN=java.loadlib,MEMBER=JVMLDM86
  10. To run the DA agent as a batch job, run this TSO command:

    Copy code
    TSO SUBMIT 'zos.da.jcllib(zos.jobname)'

     

    Replace the zos.da.jcllib variable with the name of the mainframe PDS dataset where the DA agent procedure and batch job is installed, specified in zos.properties.

    Replace the zos.jobname variable with the name of the batch job specified in zos.properties.

    Verify that the owner or submitter of the z/OS DA agent batch job has full permission to access the z/OS DA agent home directory.

Back to top

See also: