OpenSearch plugin installation

You can install individual plugins on an OpenSearch cluster.

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:

  1. bin/opensearch-plugin install <plugin-name>

For a plugin installed via zip, use:

  1. bin/opensearch-plugin install <name|Zip File|Url>

Restart your OpenSearch node after installing a plugin.

Remove a plugin

  1. bin/opensearch-plugin remove <plugin-name>

Restart your OpenSearch node after removing a plugin.

List installed plugins

To check which plugins are currently installed:

  1. bin/opensearch-plugin list

Available plugins

OpenSearch versionPlugin versions
2.1.0.0
  1. opensearch-alerting                  2.1.0.0
  2. opensearch-anomaly-detection         2.1.0.0
  3. opensearch-asynchronous-search       2.1.0.0
  4. opensearch-cross-cluster-replication 2.1.0.0
  5. opensearch-index-management          2.1.0.0
  6. opensearch-job-scheduler             2.1.0.0
  7. opensearch-knn                       2.1.0.0
  8. opensearch-ml                        2.1.0.0
  9. opensearch-notifications             2.1.0.0
  10. opensearch-observability             2.1.0.0
  11. opensearch-performance-analyzer      2.1.0.0
  12. opensearch-reports-scheduler         2.1.0.0
  13. opensearch-security                  2.1.0.0
  14. opensearch-sql                       2.1.0.0
2.0.1.0
  1. opensearch-alerting                  2.0.1.0
  2. opensearch-anomaly-detection         2.0.1.0
  3. opensearch-asynchronous-search       2.0.1.0
  4. opensearch-cross-cluster-replication 2.0.1.0
  5. opensearch-index-management          2.0.1.0
  6. opensearch-job-scheduler             2.0.1.0
  7. opensearch-knn                       2.0.1.0
  8. opensearch-ml                        2.0.1.0
  9. opensearch-notifications             2.0.1.0
  10. opensearch-observability             2.0.1.0
  11. opensearch-performance-analyzer      2.0.1.0
  12. opensearch-reports-scheduler         2.0.1.0
  13. opensearch-security                  2.0.1.0
  14. opensearch-sql                       2.0.1.0
2.0.0.0
  1. opensearch-alerting                  2.0.0.0
  2. opensearch-anomaly-detection         2.0.0.0
  3. opensearch-asynchronous-search       2.0.0.0
  4. opensearch-cross-cluster-replication 2.0.0.0
  5. opensearch-index-management          2.0.0.0
  6. opensearch-job-scheduler             2.0.0.0
  7. opensearch-knn                       2.0.0.0
  8. opensearch-ml                        2.0.0.0
  9. opensearch-notifications             2.0.0.0
  10. opensearch-observability             2.0.0.0
  11. opensearch-performance-analyzer      2.0.0.0
  12. opensearch-reports-scheduler         2.0.0.0
  13. opensearch-security                  2.0.0.0
  14. opensearch-sql                       2.0.0.0
2.0.0.0-rc1
  1. opensearch-alerting                  2.0.0.0-rc1
  2. opensearch-anomaly-detection         2.0.0.0-rc1
  3. opensearch-asynchronous-search       2.0.0.0-rc1
  4. opensearch-cross-cluster-replication 2.0.0.0-rc1
  5. opensearch-index-management          2.0.0.0-rc1
  6. opensearch-job-scheduler             2.0.0.0-rc1
  7. opensearch-knn                       2.0.0.0-rc1
  8. opensearch-ml                        2.0.0.0-rc1
  9. opensearch-observability             2.0.0.0-rc1
  10. opensearch-performance-analyzer      2.0.0.0-rc1
  11. opensearch-reports-scheduler         2.0.0.0-rc1
  12. opensearch-security                  2.0.0.0-rc1
  13. opensearch-sql                       2.0.0.0-rc1
1.3.3
  1. opensearch-alerting                  1.3.3.0
  2. opensearch-anomaly-detection         1.3.3.0
  3. opensearch-asynchronous-search       1.3.3.0
  4. opensearch-cross-cluster-replication 1.3.3.0
  5. opensearch-index-management          1.3.3.0
  6. opensearch-job-scheduler             1.3.3.0
  7. opensearch-knn                       1.3.3.0
  8. opensearch-ml                        1.3.3.0
  9. opensearch-observability             1.3.3.0
  10. opensearch-performance-analyzer      1.3.3.0
  11. opensearch-reports-scheduler         1.3.3.0
  12. opensearch-security                  1.3.3.0
  13. opensearch-sql                       1.3.3.0
1.3.2
  1. opensearch-alerting                  1.3.2.0
  2. opensearch-anomaly-detection         1.3.2.0
  3. opensearch-asynchronous-search       1.3.2.0
  4. opensearch-cross-cluster-replication 1.3.2.0
  5. opensearch-index-management          1.3.2.0
  6. opensearch-job-scheduler             1.3.2.0
  7. opensearch-knn                       1.3.2.0
  8. opensearch-ml                        1.3.2.0
  9. opensearch-observability             1.3.2.0
  10. opensearch-performance-analyzer      1.3.2.0
  11. opensearch-reports-scheduler         1.3.2.0
  12. opensearch-security                  1.3.2.0
  13. opensearch-sql                       1.3.2.0
1.3.1
  1. opensearch-alerting                  1.3.1.0
  2. opensearch-anomaly-detection         1.3.1.0
  3. opensearch-asynchronous-search       1.3.1.0
  4. opensearch-cross-cluster-replication 1.3.1.0
  5. opensearch-index-management          1.3.1.0
  6. opensearch-job-scheduler             1.3.1.0
  7. opensearch-knn                       1.3.1.0
  8. opensearch-ml                        1.3.1.0
  9. opensearch-observability             1.3.1.0
  10. opensearch-performance-analyzer      1.3.1.0
  11. opensearch-reports-scheduler         1.3.1.0
  12. opensearch-security                  1.3.1.0
  13. opensearch-sql                       1.3.1.0
1.3.0
  1. opensearch-alerting                  1.3.0.0
  2. opensearch-anomaly-detection         1.3.0.0
  3. opensearch-asynchronous-search       1.3.0.0
  4. opensearch-cross-cluster-replication 1.3.0.0
  5. opensearch-index-management          1.3.0.0
  6. opensearch-job-scheduler             1.3.0.0
  7. opensearch-knn                       1.3.0.0
  8. opensearch-ml                        1.3.0.0
  9. opensearch-observability             1.3.0.0
  10. opensearch-performance-analyzer      1.3.0.0
  11. opensearch-reports-scheduler         1.3.0.0
  12. opensearch-security                  1.3.0.0
  13. opensearch-sql                       1.3.0.0
1.2.4
  1. opensearch-alerting                  1.2.4.0
  2. opensearch-anomaly-detection         1.2.4.0
  3. opensearch-asynchronous-search       1.2.4.0
  4. opensearch-cross-cluster-replication 1.2.4.0
  5. opensearch-index-management          1.2.4.0
  6. opensearch-job-scheduler             1.2.4.0
  7. opensearch-knn                       1.2.4.0
  8. opensearch-observability             1.2.4.0
  9. opensearch-performance-analyzer      1.2.4.0
  10. opensearch-reports-scheduler         1.2.4.0
  11. opensearch-security                  1.2.4.0
  12. opensearch-sql                       1.2.4.0
1.2.3
  1. opensearch-alerting                  1.2.3.0
  2. opensearch-anomaly-detection         1.2.3.0
  3. opensearch-asynchronous-search       1.2.3.0
  4. opensearch-cross-cluster-replication 1.2.3.0
  5. opensearch-index-management          1.2.3.0
  6. opensearch-job-scheduler             1.2.3.0
  7. opensearch-knn                       1.2.3.0
  8. opensearch-observability             1.2.3.0
  9. opensearch-performance-analyzer      1.2.3.0
  10. opensearch-reports-scheduler         1.2.3.0
  11. opensearch-security                  1.2.3.0
  12. opensearch-sql                       1.2.3.0
1.2.2
  1. opensearch-alerting                  1.2.2.0
  2. opensearch-anomaly-detection         1.2.2.0
  3. opensearch-asynchronous-search       1.2.2.0
  4. opensearch-cross-cluster-replication 1.2.2.0
  5. opensearch-index-management          1.2.2.0
  6. opensearch-job-scheduler             1.2.2.0
  7. opensearch-knn                       1.2.2.0
  8. opensearch-observability             1.2.2.0
  9. opensearch-performance-analyzer      1.2.2.0
  10. opensearch-reports-scheduler         1.2.2.0
  11. opensearch-security                  1.2.2.0
  12. opensearch-sql                       1.2.2.0
1.2.1
  1. opensearch-alerting                  1.2.1.0
  2. opensearch-anomaly-detection         1.2.1.0
  3. opensearch-asynchronous-search       1.2.1.0
  4. opensearch-cross-cluster-replication 1.2.1.0
  5. opensearch-index-management          1.2.1.0
  6. opensearch-job-scheduler             1.2.1.0
  7. opensearch-knn                       1.2.1.0
  8. opensearch-observability             1.2.1.0
  9. opensearch-performance-analyzer      1.2.1.0
  10. opensearch-reports-scheduler         1.2.1.0
  11. opensearch-security                  1.2.1.0
  12. opensearch-sql                       1.2.1.0
1.2.0
  1. opensearch-alerting                  1.2.0.0
  2. opensearch-anomaly-detection         1.2.0.0
  3. opensearch-asynchronous-search       1.2.0.0
  4. opensearch-cross-cluster-replication 1.2.0.0
  5. opensearch-index-management          1.2.0.0
  6. opensearch-job-scheduler             1.2.0.0
  7. opensearch-knn                       1.2.0.0
  8. opensearch-observability             1.2.0.0
  9. opensearch-performance-analyzer      1.2.0.0
  10. opensearch-reports-scheduler         1.2.0.0
  11. opensearch-security                  1.2.0.0
  12. opensearch-sql                       1.2.0.0
1.1.0
  1. opensearch-alerting                  1.1.0.0
  2. opensearch-anomaly-detection         1.1.0.0
  3. opensearch-asynchronous-search       1.1.0.0
  4. opensearch-cross-cluster-replication 1.1.0.0
  5. opensearch-index-management          1.1.0.0
  6. opensearch-job-scheduler             1.1.0.0
  7. opensearch-knn                       1.1.0.0
  8. opensearch-notebooks                 1.1.0.0
  9. opensearch-performance-analyzer      1.1.0.0
  10. opensearch-reports-scheduler         1.1.0.0
  11. opensearch-security                  1.1.0.0
  12. opensearch-sql                       1.1.0.0
1.0.1
  1. opensearch-alerting             1.0.0.0
  2. opensearch-anomaly-detection    1.0.0.0
  3. opensearch-asynchronous-search  1.0.0.0
  4. opensearch-index-management     1.0.1.0
  5. opensearch-job-scheduler        1.0.0.0
  6. opensearch-knn                  1.0.0.0
  7. opensearch-notebooks            1.0.0.0
  8. opensearch-performance-analyzer 1.0.1.0
  9. opensearch-reports-scheduler    1.0.0.0
  10. opensearch-security             1.0.1.0
  11. opensearch-sql                  1.0.0.0
1.0.0
  1. opensearch-alerting             1.0.0.0
  2. opensearch-anomaly-detection    1.0.0.0
  3. opensearch-asynchronous-search  1.0.0.0
  4. opensearch-index-management     1.0.0.0
  5. opensearch-job-scheduler        1.0.0.0
  6. opensearch-knn                  1.0.0.0
  7. opensearch-notebooks            1.0.0.0
  8. opensearch-performance-analyzer 1.0.0.0
  9. opensearch-reports-scheduler    1.0.0.0
  10. opensearch-security             1.0.0.0
  11. opensearch-sql                  1.0.0.0