Installing the Agent for NSK

The following guide describes how to install an agent in an AE system in which authentication is not used. Additional installation steps are required before the agent can be started and used if you intend to use one of the available authentication methods. For more information, see Agent Authentication.

A three-character code is assigned to each supported NSK version. It is shown in the agent's file name (NS1 for NSK, Version D40 and later).

This page includes the following:

Requirements

Ensure that the agent runs with the SUPER.SUPER user in order to avoid problems when processes are canceled.

For information about CallAPI files and their implementation, see CallAPI for NSK.

Installing the Agent for NSK

  1. Transfer the files to the host.

    • Admin computer

    • Establish a connection to the host via an FTP client and transfer the two supplied files OINSTALL and UC4AR to a common sub-volume.

      Notes:

      • The file OINSTALL must be transferred in text mode (code 101) and UC4AR in binary mode (code 0).

      • It is best to store these files in an empty sub-volume.

      • The file UC4AR is a self-extracting archive that contains all the files that the NSK agent requires.

  2. Start the installation procedure.

    • Host
    • Start a terminal emulation program and log on using the user who should be the program owner. 
    • Change to the sub-volume to which the two files have been transferred.
    • Set the following command in the TACL input line: O OINSTALL
    • This unpacks the file INSTINI in the sub-volume. It must remain in the same sub-volume as the other installation files in order to ensure that the installation can continue.
  3. Adjust the configuration file INSTINI.

    • Host
    • The file INSTINI contains several parameters that must be adjusted to your system environment.
    • Lines that start with the characters with %% are comments. Blanks can be ignored, they are irrelevant.

    • Specify the parameters in the following format: <parameter name>=<value>.
      The parameter name is predefined and cannot be changed. Its corresponding value depends on your system.

      The file INSTINI must be stored in the same sub-volume as all other installation files (OINSTALL, INSTALL).

      It is best to use empty sub-volumes for volume specifications in order to avoid conflicts with other programs.

      Parameters

      • AE-PROGRAM-SUBVOLUME=

        Description: Sub-volume for the executable agent files.

      • AE-STATUS-STORE-SUBVOLUME

        Description: Sub-volume for the StatusStore files of file transfers.

        The agent automatically created StatusStore files. They store the restart information of active file transfers. This mechanism ensures that aborted file transfers can be restarted from a particular file position (= last restart point). Restart points are created in regular intervals (setting FT_RESTART_INTERVAL in the UC_HOSTCHAR_DEFAULT variable). On Nonstop systems, the StatusStore files are the following 4 Enscribe Files with the default names: UC4SST, UC4SSD, UC4SSL, UC4SSH. You can subsequently change these file names in the INI file of the NSK agent. For more information, see Agent NSK.

      • AE-STATUS-STORE-AUDITED=

        Description: Stores StatusStore files of file transfers as Audited Files (TMF protection)

        Allowed values: Y (default) and N

      • AE-TCPIP-PROCESS=

        Description: Name of the NonStop TCP/IP process name that the agent should us. By default, $ZTC0 is specified (system standard).

        Note: If you specify a different process name, the required ADD DEFINE TACL statement is automatically inserted in the startup obey file.

      • AE-SERVER-PORT

        Description: Port number of the Automation Engine's communication process to which the agent should connect. Ensure that all affected firewalls are configured for this port.

      • AE-AGENT-PORT=

        Description: Port number that the agent should use in order to contact other agents. This port cannot be used by other programs.

      • AE-SERVER-IP-ADDRESS=

        Description: IP address or computer name of the Automation Engine.

      • AE-AGENT-PROCESS=

        Description: Process name of the agent process.

      • AE-OC-PROCESS=

        Description: Process name of the Automation Engine output collector process.

      • AE-TSIM-PROCESS=

        Description: Process name of the Automation Engine terminal simulator process.

      • AE-SYSTEM-NAME=

        Description: Logical name of the Automation Engine system.

      • AE-AGENT-NAME=

      • Description: Logical name of the agent instance. By default, the system name of the NonStop Server without \ is used as the agent name:

        • AE-AGENT-NAME=%NODENAME%

        You can also extend the agent name using pre- or postfixes.

          AE-AGENT-NAME=UC4%NODENAME%EXE

      • AE-TEMP-SUBVOLUME

        Description: All temporary files, such as job reports and job files, are stored in this sub-volume.

    • The INI file of the Agent NSK is completed using the data that is specified here. After a successful installation, you can change these values at any time.
  4. Continue the installation.

    • Host
    • Set the following command in the TACL input line:RUN INSTALL
    • You receive notifications about the installation progress and can terminate it at any time. In this case, a manual cleanup process can be required.
    • A connection to the Automation Engine is established when the installation is complete.
    • Admin computer or Server computer
    • Verify that the agent is logged on.

      Start the Automic Web Interface for client 0000. Information about agents is available in the Administration perspective. Newly logged-on agents have not been assigned a client, so they can only be viewed in client 0000. The newly installed agent can then be assigned to clients using the required rights via the Agent object. For more information, see Authorizations Page.

  5. Start and stop the agent.

    • Host
    • Change to the agent's subvolume and set the following command in the TACL input line: O EXSTART
    • The following command stops the agent: O EXSTOP

See also:

EMS Template File