Parameters for Installing a Gateway
This section describes the parameters that are required for installing a gateway.
If you want to install a gateway then you need to edit the response file (gateway.rsp
) and provide values for the parameters that are required to install a gateway.
The following are the list of parameters specified in the response file:
For response files samples, see Sample Response Files.
Registration Parameters
This section lists all the registration parameters that are required to install a gateway. All registration parameters are mandatory. Ensure your response file has the correct values for the these parameters.
The following table lists the Registration Parameters required for gateway installation.
Parameter | Parameter Type | Description | Notes |
---|---|---|---|
or
|
Mandatory |
Name of the tenant where Oracle Management Cloud is running. You can get the The |
Example: |
|
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: |
|
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 Note: For Windows, the length of the directory path including the drive letter should be less than 23 characters. |
Example: Linux: Windows: |
Communication Parameters
The following table lists the Communication Parameters required for gateway installation.
Parameter | Parameter Type | Description | Notes |
---|---|---|---|
or
|
Mandatory |
The absolute URL including the protocol that is required to connect to Oracle Management Cloud for uploading data for the specific |
Example: |
Proxy Parameters (Optional)
If you’re installing a gateway 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 |
---|---|---|
|
Address of your proxy server to be used for connection. Ensure that you don't pass the |
Required only if you’re deploying the agent over a proxy server. Example: |
|
Port of your proxy server. |
Required only if you’re deploying the agent over a proxy server. Example: |
|
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: |
|
Password required to access your proxy server. |
Required only if you’re deploying the agent over a proxy server. Example: |
|
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: |
OMC_PROXYHOST, OMC_PROXYPORT, OMC_PROXYUSER, OMC_PROXYPWD
and OMC_PROXYREALM
. The value of the OMC_PROXYREALM
parameter is specific to the authenticated proxy server in use.
-
For McAfee Web Gateway, the default value is
OMC_PROXYREALM=McAfee Web Gateway
. -
For Squid proxy, the default value is
OMC_PROXYREALM=Squid proxy-caching web server
. -
For other vendors, contact your proxy vendor for instructions about how to get the realm value from the proxy settings.
Other Optional Parameters
This section lists the parameters that you can optionally specify in your response file for installing a gateway. However, you need to ensure that your response file contains values for the Registration Parameters and Communication Parameters.
Parameter | Description | Notes |
---|---|---|
|
The port number to which the agent process will be bound. The If you don’t specify any value, the default port ( 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: |
|
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 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: If you don’t specify any value, the |
|
A flag to enable the agent reinstall option. See Install a Gateway Using Reinstall Option for more details. |
|
|
A flag to disable all validations and prerequisite checks. |
|
|
A flag to disable |
|
|
A display name for the tenant management agent as given by the user. |
The default value is <agent host>: <agent port>. For example, myhost:4459. |
|
A display name for the tenant management agent host as given by the user. |
The default value is <agent host>: <agent port>. For example, myhost:4459. |