Host connection configuration file for p2 installations

You can use a configuration file to define one or more default z/OS host connections for IBM® Developer for z/OS® clients that are installed by using p2-based installations. This approach applies the host connection settings automatically when a user starts in a new workspace.

For more information about installing the client by using p2, see Installing the IBM Developer for z/OS Eclipse client.

Before you begin

The following are required to configure default host connections for a p2-based installation:

  • Install the IBM Developer for z/OS client by using the Eclipse p2 provisioning method.
  • Ensure that you have access to the installation directory of IBM Developer for z/OS.

Procedure

To set up preconfigured host connections, complete the following steps:
  1. A sample remoteconfig.yaml file is included in the installation package. You can modify this sample file to define your own host connections. The configuration file is located in the following directory, depending on your operating system:
    Platform Directory path
    Windows 
    {extraction_directory}\IBM Developer for zOS\idz\bootstrap\
    macOS 
    {extraction_directory}/IBM Developer for zOS.app/Contents/Eclipse/idz/bootstrap/
  2. Define one or more host connections in the YAML file:
    1. Example: single host connections
      - HOST_NAME: some.host1.com
  CONNECTION_NAME: some.host1.com
  DESCRIPTION: ""
  AUTHENTICATION: CERTIFICATE
  DAEMON_PORT: "1000"
    2. Example: multiple host connections
      - HOST_NAME: some.host1.com
  CONNECTION_NAME: some.host1.com
  DESCRIPTION: ""
  AUTHENTICATION: CERTIFICATE
  DAEMON_PORT: "1000"

- HOST_NAME: some.host2.com
  CONNECTION_NAME: some.host2.com
  # DESCRIPTION intentionally left empty
  AUTHENTICATION: USERID
  DAEMON_PORT: "2000"
    Note: YAML syntax sensitivity is crucial for IBM Developer for z/OS to parse the configuration file correctly. Ensure indentation and spacing are consistent.
  3. Field behavior and defaults:
    The following table describes the supported fields in the configuration file and their default behavior:
    Field Required Default behavior if not specified
    HOST_NAME Yes N/A
    CONNECTION_NAME No Defaults to the value of HOST_NAME
    DESCRIPTION No Left blank
    AUTHENTICATION No
    Supported values are  USERID and CERTIFICATE.

    Defaults USERID if left blank or invalid.
    DAEMON_PORT No Defaults to 4035
    When IBM Developer for z/OS starts in a new workspace:
    • Host connection settings are loaded in a defined order of precedence.
    • If a remoteconfig.yaml file exists, all host connections defined in it are automatically applied.
Remember:
  • The bootstrap process is local to the workstation and does not require push-to-client configuration on the host.
  • Recommended for administrators preparing and distributing IBM Developer for z/OS package to multiple users.