Parameters for Installing a Cloud Agent

This section describes the parameters that are required for installing a cloud agent.

If you want to install a cloud agent then you need to edit the response file (agent.rsp) and provide values for the parameters that are required to install a cloud agent.

The following are the list of parameters that are specified in the response file:

For response files samples, see Sample Response Files.

Registration Parameters

This section lists the registration parameters that are required to install a cloud agent. All registration parameters are mandatory. Ensure that your response file has the correct values for the following parameters.

Parameter Parameter Type Description Notes

TENANT_NAME

or

TENANT_ID (supported in older versions and it remains backwards compatible)

Mandatory

Name of the tenant where Oracle Management Cloud is running. You can get the TENANT_NAME value for an agent by navigating to Administration > Agents > Download, and selecting an agent type from the Agent Type drop-down list. The TENANT_NAME value is displayed at the bottom of the page.

Example: inst1–dummytenantid

AGENT_REGISTRATION_KEY

Mandatory

Key to validate the identity of the tenant and the authenticity of the installation. You can get the registration key from Oracle Management Cloud Dashboard, by navigating to Administration > Agents > Registration Keys.

Example: R5bokWss0EC9R1pJlf2SqiAJ9p

AGENT_BASE_DIRECTORY

Optional

Empty directory where the agent must be installed on the host machine.

If a parameter value is provided and the provided value (a directory) does not exist then a directory is created by the installer.

If the parameter AGENT_BASE_DIRECTORY is not provided, the installer will create a new directory, omcagent, in the directory the installer is running from.

Note: For Windows, the length of the directory path including the drive letter should be less than 23 characters.

Example:

Linux: /omc_agent/dc

Windows: D:\omc_agent\dc

Communication Parameters

This section lists the communication parameters that are required to install a cloud agent.

Parameter Parameter Type Description Notes

OMC_URL

or

UPLOAD_ROOT (supported in older versions and it remains backwards compatible)

Mandatory

The absolute URL including the protocol that is required to connect to Oracle Management Cloud for uploading data for the specific TENANT_NAME. To get this value, navigate to Administration > Agents > Download, and select an agent type from the Agent Type drop-down list. The OMC_URL value is displayed at the bottom of the page.

Example: https:/dummytenantid.itom.<datacenter>.oraclecloud.com

GATEWAY_HOST

Mandatory if cloud agent communicates via gateway

If cloud agent or data collector is communicating to OMC using a gateway, then provide the Fully Qualified Domain Name (FQDN) of the gateway. When you install the cloud agent, make sure you provide the same gateway host name that was used to install the gateway.

For example, when deploying the gateway, if you specify ORACLE_HOSTANME=abc.xyz.com and when installing the cloud agent, you specify GATEWAY_HOST=abc, it will result in cloud agent registration failures. A gateway agent must be installed on the host and should be up and running.

Example: GATEWAY_HOST=testgateway.test.oracle.com

GATEWAY_PORT

Mandatory if cloud agent communicates via gateway

If cloud agent or data collector is communicating to OMC using a gateway, the gateway port must be specified.

You can obtain the port number by executing the following command:

$Gateway_Agent_Home/agent_inst/bin/omcli status agent

Example: GATEWAY_PORT=4472

ADDITIONAL_GATEWAYS

Mandatory if cloud agent communicates via gateway

For gateway high availability, additional gateway hosts (comma separated list of gateway URLs) can be specified. You can obtain the URL by running the following command on respective gateway hosts:

$Gateway_Agent_Home/agent_inst/bin/omcli status agent

Note: This parameter should only be used while deploying a cloud agent or a data collector.

Example: ADDITIONAL_GATEWAYS=https://abc.us.com:1872,https://xyz.us.com:4475

Proxy Parameters (Optional)

If you’re installing the cloud agent over a proxy server, then apart from specifying the Registration Parameters and Communication Parameters, ensure that you specify the correct values for the following parameters in your response file.

Parameter Description Notes

OMC_PROXYHOST

Address of your proxy server to be used for connection. Ensure that you don't pass the https:// value with the proxy host details.

Required only if you’re deploying the agent over a proxy server.

Example: www-proxy.company.com

OMC_PROXYPORT

Port of your proxy server.

Required only if you’re deploying the agent over a proxy server.

Example: 80

OMC_PROXYUSER

User name required to access your proxy server.

Required only if you are using a proxy server to communicate with Oracle Management Cloud. It requires a username and password.

Example: johndoe

OMC_PROXYPWD

Password required to access your proxy server.

Required only if you’re deploying the agent over a proxy server.

OMC_PROXYREALM

Authentication realm (if any) to be used to access your proxy server.

Required only if you’re deploying the agent over a proxy server.

Example: MyServer

Other Optional Parameters

This section lists the parameters that you can optionally specify in your response file for installing a cloud agent. However, you need to ensure that your response file contains values for the Registration Parameters and Communication Parameters.

Parameter Description Notes

AGENT_PORT

The port number to which the agent process will be bound. The AgentInstall script stops the installation process if this port is occupied at the time of installation.

If you don’t specify any value, the default port (4459) or an available port in the range 4460-4479 is used.

This applies to new installations only. If you have older agents already running on other port numbers, you can continue to run them as such.

Example: 4461

ORACLE_HOSTNAME

The host name where the agent will be installed. If specified, the value is validated to check if it resembles the agent host name and that it is neither an IP address nor a junk value (such as foobar, test, and so on). It must match the fully qualified domain name (FQDN) specified in the /etc/hosts (in UNIX) and C:\Windows\System32\drivers\etc\hosts (in Windows) file and must map to the correct FQDN and IP address of the host.

Note: Use this parameter when you want to provide a network-resolvable hostname instead of installer-computed hostname.

Note: Ensure the parameter is a fully qualified domain name as most of the services in Oracle Management Cloud require the host to be an FQDN. It must resolve to a valid IP address.

Example: example.tst.acme.com

If you don’t specify any value, the AgentInstall script evaluates the host name using the INetAddress Java class methods.

IGNORE_VALIDATIONS

A flag to disable all validations and prerequisite checks.

  • Example: true

  • Valid values: true or false

  • Default value: false

    To ignore validations, change the value to true, IGNORE_VALIDATIONS=true.

IGNORE_ULIMIT_CHECK

A flag to disable ulimit checks (only on non-windows platforms).

  • Example: true

  • Valid values: true or false

  • Default value: false

    To ignore ulimit checks, change the value to true, IGNORE_ULIMIT_CHECK=true.

DISPLAY_NAME

A display name for the tenant management agent as given by the user.

The default value is <agent host>: <agent port>. For example, host:4459.

AGENT_HOST_DISPLAY_NAME

A display name for the tenant management agent host as given by the user.

The default value is <agent host>: <agent port>. For example, host:4459.