You're viewing version 1.2 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
OpenSearch plugin installation
You can install individual plugins on an OpenSearch cluster.
Table of contents
Install a plugin
The install command takes a plugin id, which may be any of the following:
- An official OpenSearch plugin name
- Maven coordinates to a plugin zip file
- A URL to a plugin zip file
If you’re installing an official OpenSearch plugin, use:
bin/opensearch-plugin install <plugin-name>
For a plugin installed via zip, use:
bin/opensearch-plugin install <name|Zip File|Url>
Restart your OpenSearch node after installing a plugin.
Remove a plugin
bin/opensearch-plugin remove <plugin-name>
Restart your OpenSearch node after removing a plugin.
List installed plugins
To check which plugins are currently installed:
bin/opensearch-plugin list
Available plugins
| OpenSearch version | Plugin versions |
|---|---|
| 1.2.4 | opensearch-alerting 1.2.4.0 opensearch-anomaly-detection 1.2.4.0 opensearch-asynchronous-search 1.2.4.0 opensearch-cross-cluster-replication 1.2.4.0 opensearch-index-management 1.2.4.0 opensearch-job-scheduler 1.2.4.0 opensearch-knn 1.2.4.0 opensearch-observability 1.2.4.0 opensearch-performance-analyzer 1.2.4.0 opensearch-reports-scheduler 1.2.4.0 opensearch-security 1.2.4.0 opensearch-sql 1.2.4.0 | 1.2.3 | opensearch-alerting 1.2.3.0 opensearch-anomaly-detection 1.2.3.0 opensearch-asynchronous-search 1.2.3.0 opensearch-cross-cluster-replication 1.2.3.0 opensearch-index-management 1.2.3.0 opensearch-job-scheduler 1.2.3.0 opensearch-knn 1.2.3.0 opensearch-observability 1.2.3.0 opensearch-performance-analyzer 1.2.3.0 opensearch-reports-scheduler 1.2.3.0 opensearch-security 1.2.3.0 opensearch-sql 1.2.3.0 |
| 1.2.2 | opensearch-alerting 1.2.2.0 opensearch-anomaly-detection 1.2.2.0 opensearch-asynchronous-search 1.2.2.0 opensearch-cross-cluster-replication 1.2.2.0 opensearch-index-management 1.2.2.0 opensearch-job-scheduler 1.2.2.0 opensearch-knn 1.2.2.0 opensearch-observability 1.2.2.0 opensearch-performance-analyzer 1.2.2.0 opensearch-reports-scheduler 1.2.2.0 opensearch-security 1.2.2.0 opensearch-sql 1.2.2.0 |
| 1.2.1 | opensearch-alerting 1.2.1.0 opensearch-anomaly-detection 1.2.1.0 opensearch-asynchronous-search 1.2.1.0 opensearch-cross-cluster-replication 1.2.1.0 opensearch-index-management 1.2.1.0 opensearch-job-scheduler 1.2.1.0 opensearch-knn 1.2.1.0 opensearch-observability 1.2.1.0 opensearch-performance-analyzer 1.2.1.0 opensearch-reports-scheduler 1.2.1.0 opensearch-security 1.2.1.0 opensearch-sql 1.2.1.0 |
| 1.2.0 | opensearch-alerting 1.2.0.0 opensearch-anomaly-detection 1.2.0.0 opensearch-asynchronous-search 1.2.0.0 opensearch-cross-cluster-replication 1.2.0.0 opensearch-index-management 1.2.0.0 opensearch-job-scheduler 1.2.0.0 opensearch-knn 1.2.0.0 opensearch-observability 1.2.0.0 opensearch-performance-analyzer 1.2.0.0 opensearch-reports-scheduler 1.2.0.0 opensearch-security 1.2.0.0 opensearch-sql 1.2.0.0 |
| 1.1.0 | opensearch-alerting 1.1.0.0 opensearch-anomaly-detection 1.1.0.0 opensearch-asynchronous-search 1.1.0.0 opensearch-cross-cluster-replication 1.1.0.0 opensearch-index-management 1.1.0.0 opensearch-job-scheduler 1.1.0.0 opensearch-knn 1.1.0.0 opensearch-notebooks 1.1.0.0 opensearch-performance-analyzer 1.1.0.0 opensearch-reports-scheduler 1.1.0.0 opensearch-security 1.1.0.0 opensearch-sql 1.1.0.0 |
| 1.0.1 | opensearch-alerting 1.0.0.0 opensearch-anomaly-detection 1.0.0.0 opensearch-asynchronous-search 1.0.0.0 opensearch-index-management 1.0.1.0 opensearch-job-scheduler 1.0.0.0 opensearch-knn 1.0.0.0 opensearch-notebooks 1.0.0.0 opensearch-performance-analyzer 1.0.1.0 opensearch-reports-scheduler 1.0.0.0 opensearch-security 1.0.1.0 opensearch-sql 1.0.0.0 |
| 1.0.0 | opensearch-alerting 1.0.0.0 opensearch-anomaly-detection 1.0.0.0 opensearch-asynchronous-search 1.0.0.0 opensearch-index-management 1.0.0.0 opensearch-job-scheduler 1.0.0.0 opensearch-knn 1.0.0.0 opensearch-notebooks 1.0.0.0 opensearch-performance-analyzer 1.0.0.0 opensearch-reports-scheduler 1.0.0.0 opensearch-security 1.0.0.0 opensearch-sql 1.0.0.0 |