Configuring Environment Variables

You can configure environment variables to change the behavior of the agent.

About this task

Note: For Windows platform, user can edit the environment variable that will change the behavior of the specific agent instance.
For non-Windows platform, environment variable setting will impact all the running agent instances.

Procedure

  1. Stop all the agent instances.
  2. Locate the environment variable file.
    • Windows:
      Locate the KVMENV_instance_name file by navigating to the agent folder, where instance_name is the agent instance name.
      • Agent of 32-bit system: %CANDLEHOME%\TMAITM6
      • Agent of 64-bit system:%CANDLEHOME%\TMAITM6_x64
    • Non-Windows:
      Locate the .vm.environment file by navigating to the agent folder.
      • Agent of 32-bit system: $CANDLEHOME/config
      • Agent of 64-bit system: $CANDLEHOME/config
  3. Edit environment variables according to the requirement and save the file.
    • KVM_DATA_PROVIDER_CONNECTION_RETRY_COUNT
      Example:
      KVM_DATA_PROVIDER_CONNECTION_RETRY_COUNT=0
      Note:

      In the event of connection failure, if the environment variable KVM_DATA_PROVIDER_CONNECTION_RETRY_COUNT is not configured or set to 0, the agent will continuously attempt connection to data source every 30 seconds.

      In the event of connection failure, user can limit the number of connection attempts by setting the environment variable KVM_DATA_PROVIDER_CONNECTION_RETRY_COUNT to a valid non-zero value.

    • KVM_VIRTUAL_MACHINE_IP_TIMEOUT
      Example:
      KVM_VIRTUAL_MACHINE_IP_TIMEOUT=200
      Note: The environment variable KVM_VIRTUAL_MACHINE_IP_TIMEOUT in attribute group Virtual Machines allows the agent to wait for the configured duration (in milliseconds) before returning the value of FQDN and subsequently all other attributes. If this field is not configured or if this field is set to 0, the timeout functionality is disabled and attribute group collection follows the default behavior.
  4. Start the agent instance.