Oracle Cloud Infrastructure Documentation

Configuration Parameters

You can customize the OMA installation process using the JMS_configuration.rsp file obtained using the Download Agent Installer.

The file includes the following parameters:

  • ManagementAgentInstallKey: unique key obtained from Oracle Cloud for installing the agent. For example, ManagementAgentInstallKey = Mi4wLHVzLWFzaGJ1cm4tMSxvY2l-<sameple-key>-N0Qw
  • jms.fleet-ocid: OCID of the JMS fleet that you want to connect to. For example, jms.fleet-ocid = ocid1.jmsfleet.oc1.iad.am<sample-fleet-ocid>
  • jms.key-ocid: OCID of the Management Agent Install Key that is uploaded. For example, jms.key-ocid = ocid1.managementagentinstallkey.oc1.iad.amaa-<sample-key-ocid>
  • jms.key-name: name of the Management Agent Install Key (optional). For example, jms.key-name = sampleKeyName
  • jms.region-realm: the Oracle Cloud region where your JMS fleet is located. For example, jms.region-realm = us-ashburn-1
  • jms.fleet-name: the name of the JMS fleet that you want to connect to. For example, jms.fleet-name = sampleFleetName
  • jms.plugin-name: the name of the plug-in to be installed with the agent (defaults to jms.plugin-name = jm)
  • jms.managedAgentUrl: The region-specific Management Agent API endpoint.

Proxy Configuration (Optional)

The file includes commented lines for proxy configuration. Remove the '#' symbol to uncomment the lines, and provide your proxy details if your network requires a proxy server for internet access.

  • jms.proxy-user: username of the proxy server. For example, jms.proxy-user = opc
  • jms.proxy-password: password of the proxy server. For example, jms.proxy-password = pw
  • jms.proxy-host: hostname or IP address of the proxy server. For example, jms.proxy-host = opt
  • jms.proxy-realm: proxy server realm (if applicable). For example, jms.proxy-realm = us-ashburn-1
  • jms.proxy-port: port number of the proxy server (defaults to 80). For example, jms.proxy-port = 1003

Configuration Options (Optional)

The following are the configuration parameters:

All platforms:
  • jms.diagnostic: determines if prerequisite conditions are met on the host machine to allow for successful agent installation or upgradation, and plug-in deployment. Installation attempt will be skipped. For example, jms.diagnostic = true
  • jms.force: uninstalls the plug-ins, deletes the configuration files or restores the originals from backups, and continues with installation. For example, jms.force = true
  • jms.override-jdk-symlink: replaces the existing JDK symlink that is created by the user with a new symlink pointing to the JDK installed in the agent's directory. For example, jms.override-jdk-symlink = true
  • jms.use-agent-display-name: customize the agent display name. For example, jms.use-agent-display-name = testAgentDisplayName
Windows:
  • jms.force-32bit-installer: Force 32 bit Management Agent installation. Use this parameter to monitor a 32 bit Windows instance. For example, jms.force-32bit-installer = true
  • jms.low-metrics-frequency: installs the agent with low frequency telemetry configuration instead of MACS default frequency. For example, jms.low-metrics-frequency = true
  • jms.custom-installation-directory: path to custom installation directory for agent installation. If not set, it defaults to System HOMEDRIVE environment variable. Use an absolute path and not a relative path. For example, jms-custom-installation-directory = C:\Users\vmuser\Documents\test
macOS and Linux:
  • jms.enable-fips-mode: enable FIPS mode for plug-ins in USGov realms. For example, jms.enable-fips-mode = true
Linux:
  • jms.install-mgmt-agent: force Management Agent installation on an OCI Linux instance. For example, jms.install-mgmt-agent = true