OCI and On-premises Windows

This section describes the steps to set up the Oracle Management Agent and deploy the JMS plug-ins on an OCI or on-premises Windows host using the installation script. JMS Fleets does not support Oracle Cloud Agent for OCI Windows, hence the script installs OMA on all Windows platforms.

Prerequisites:

Run the installation script with administrator privileges.

Note

By default, the installation script will:

Generate usage tracker with additional functionality to collect the user.name property for better identification of applications running on Application Servers like WebLogic and Tomcat. If you do not want to enable this feature, update the parameter --enable-user-name=false in the installation script. You can modify the Java Usage Tracker properties file in the future to add or remove user.name from the additionalProperties section.
Install the agent with JMS lower telemetry frequency configuration.
In Windows 64 bit systems, you have an option to use MACS default telemetry frequency instead of JMS lower telemetry frequency. Change the value of the parameter low-telemetry-interval to false in the installation script. The default value is true.
Create the OVERRIDE_VERSION_CHECK environment variable if it is not present and set it to true on Windows 10 instances, overriding the Management Agent Service's version check. Management Agent Service supports only Java Management service on Windows 10 platform.

Run the --help command to view the description of options such as enabling or disabling user name, proxy settings, and so on.

The following are the optional parameters along with the description:


-u, --uninstall              Uninstall plug-ins, delete configuration files or restore originals from backups and exit.
-r, --reinstall              Uninstall plug-ins, delete configuration files or restore originals from backups and continue installation.
-h, --help                   Print usage message end exit.
--diagnostic                 Determine if prerequisite conditions are met on the host machine to allow successful 
                             agent installation and plug-in deployment.
--enable-user-name           Generate usage tracker with additional functionality to collect the 'user.name' property for better identification 
                             of applications running on Application Servers like WebLogic and Tomcat servers. 
                             Default value is 'true'. 
--force-32bit-installer      Force 32 bit Management Agent installation. Use this parameter to monitor a 32 bit Windows instance.
--proxy-host                 Add proxy host to curl commands, add or replace line 'ProxyHost = VALUE' in install key before Management Agent setup.
                             Format is --proxy-host="VALUE" (for example, --proxy-host="100.0.0.10").
                             Default is no proxy.
--proxy-port                 Add proxy port to curl commands, add or replace line 'ProxyPort = VALUE' in install key before Management Agent setup.
                             Format is --proxy-port="VALUE" (for example, --proxy-port="8050"). 
--proxy-password             Add proxy password to curl commands, add or replace line 'ProxyPassword = VALUE' in install key before Management Agent setup.
                             Format is --proxy-password="VALUE" (for example, --proxy-password="example"). 
--proxy-realm                Add or replace line 'ProxyRealm = VALUE' in install key before Management  Agent setup.
                             Format is --proxy-realm="VALUE" (for example, --proxy-realm="OC1").
--proxy-user                 Add proxy user to curl commands, add or replace line 'ProxyUser = VALUE' in install key before Management Agent setup.
                             Format is --proxy-user="VALUE" (for example, --proxy-user="opc").
--use-agent-installer-path   Path to management agent installation file if it isn't in the same folder as the install script. 
--use-java-path              Specify the Oracle Java 8 installation path for agent installation; 
                             if the path is not specified, the script will attempt to find a suitable Oracle Java 8 installation path from the file system. 
                             Format is --use-java-path={CUSTOM_PATH}(for example, --use-java-path="C:\Program Files\Java\jdk1.8.0_361").
--low-metrics-frequency      Installs the agent with low frequency telemetry configuration instead of MACS default frequency. 
                             Default value is 'true'. Applicable on Windows 64 bit instances only. 
--use-agent-display-name     Specify the name to be displayed on the MACS console of your Management Agent.
                             If the name is not specified, the script will generate the name automatically.

Steps

Open PowerShell as administrator.
To ensure you have the correct permissions to run the script, type Set-ExecutionPolicy RemoteSigned and answer A.

(Optional diagnostic check) Navigate to the folder where you saved the installation script and management agent software. Run the script using the following command:

.\JMS_YourFleetName_windows.ps1 --diagnostic

Depending on the operating system and agent type, the results will be similar to:

Diagnostic failed:

======================================================================================================
Diagnostic Summary
======================================================================================================
User has administrator privileges? : Yes
Powershell version meets requirements? : Yes
Certified OS? : Yes
Able to reach OCI endpoint? : No 
Check your internet connection and proxy setting.
Is clock sync with OCI platform? : Unknown 
The clock sync check was skipped. Can't read headers from provided OCI endpoint.
Certificate verification has been passed? : Unknown 
The certificate check was skipped. Can't read certificate from provided OCI endpoint.
Meets minimum disk requirements? : Yes
Meets minimum memory requirements? : Yes
Available Java for agent installation ? : Yes
Management Agent installer available? : Yes
======================================================================================================
Diagnostics have failed. Please resolve all issues and run the deployMgmtAgent.ps1 script again.

Diagnostic completed successfully:

======================================================================================================
Diagnostic Summary
======================================================================================================
User has administrator privileges? : Yes
Powershell version meets requirements? : Yes
Certified OS? : Yes
Able to reach OCI endpoint? : Yes
Meets minimum disk requirements? : Yes
Meets minimum memory requirements? : Yes
Available Java for agent installation ? : Yes
Management Agent installer available? : Yes
======================================================================================================
Diagnostics have finished running and no error occurred.

See Running Agent Installation Diagnostics for the complete list of question with solutions or recommendations.

Go to the folder where you downloaded the script and management agent software. Run the script using the following command:
```
.\JMS_YourFleetName_windows.ps1
```
- If installation is successful, you'll see a message similar to the following:
```
...
Agent was successfully registered using key YourFleetName (ocid1.managementagentinstallkey.oc1.<ocid hash>) and assigned to fleet YourFleetName (ocid1.jmsfleet.oc1.<ocid hash>)
Management Agent with plugins installation has been completed.
```
- In case the agent is already installed, the script will update the agent software to the latest version, if applicable. If JMS plug-ins are not deployed yet, deploy Java Usage Tracking and Java Management Service plug-ins manually as described in the Deploy a Service Plug-in Using the Agents Page. Or, you can reinstall the agent along with JMS plug-in deployment; run the script with the --force parameter.
(Optional) Type the following to verify if installation is successful: Get-Service -name mgmt_agent.

The log files are located in the C:\Oracle\mgmt_agent\plugins\jm\stateDir\log directory.

Oracle Cloud Infrastructure Documentation