Configuring communication between the Discovery Agent and the Discovery Data Service

This topic describes the process to configure the communication parameters between the agent and the server.

Before you begin

Deploy and set up the Discovery Agent. For information, see Deploying and configuring the Discovery Agent.

About this task

Before you run the IBM Z® Resource Discovery Data Service Agent (Discovery Agent), you must first customize the agent to communicate with the data service. This process configures the communication parameters between the agent and the server. It is only required when establishing a new connection or when the communication parameters with the server have been altered.

Procedure

  1. Run the cd discovery-agent-<version>/config command to access the configuration file.
  2. To establish a connection from the Discovery Agent to the Discovery Server, in the discovery-agent-<version>/config/CONFIG.YML configuration file, update the following values as shown in the following configuration sample.
    • ZRDDS_HOST_NAME─The hostname of the system on which the Discovery Server is installed.
    • GATEWAY_PORT─The value of the externally accessible port of the gateway service, as specified in the IZOA_GATEWAY_PORT property in the zoa_env.config file of the Discovery Server.
    • JCL_BATCH_SIZE─Number of JCLs to be sent as a single batch to the Discovery Server.
    • IDML_FILE_BATCH─The batch size for the IdML file.
    • EXPIRED_INTERVAL─The time frame after which the CI must be considered expired. If a CI remains undetected by the IBM Z Discovery Library Adapter for the specified number of days, it is considered expired.
    • PASSWORD─The password used to communicate with the Discovery Server. The password is 56ab24c15b72a457069c5ea42fcfc640.
    • KEYCLOAK_CLIENT_ID─A user ID value that is defined in authentication service and is associated with the default-roles-izoakeycloak role in the IzoaKeycloak realm. Any user ID in the IzoaKeycloak realm is defined in the authentication service used by the Discovery Server.
    • KEYCLOAK_CLIENT_USERNAME─The username of the client in the IzoaKeycloak realm.
    • KEYCLOAK_CLIENT_PASSWORD─The password of the client in the IzoaKeycloak realm. This value must be the base64-encoded representation of the actual password configured for the specified client ID.
    • GETJOBNAME_LINE_PREFIX─The defined prefix is displayed at the start of each line in the ZAGETJOB output.
    • JOB_LINE_CHAR_LIMIT─The maximum number of characters allowed per line in the ZAGETJOB output. The minimum value must be 5 characters.
    • ENABLE_COPY_INTO_ORIENT─The setting that determines whether the CopyIntoOrientDB process is automatically executed after each data transfer. The default value is NO, which means the copy process is not triggered. If you select YES, the copy process is automatically triggered after a data transfer.
    • COPY_INTO_ORIENT_MODE─The setting that defines how the CopyIntoOrientDB process handles the OrientDB database during execution. The default value is NO, which means the process will update the existing OrientDB database if one is available. If no database exists, a new one is created and the data is copied. If you select YES, a new database is created. If an database is available, the existing database is removed and a new one is created before the data copy begins.
    • POPULATE_FULL_DLA─A transfer type that sends all the configuration items to ServiceNow if you specify YES. By default, the value is NO, which sends a subset of the configuration items that are newly discovered or have changed since the previous discovery cycle.